datadog_api_client.v2.model package¶

Submodules¶

datadog_api_client.v2.model.account_filtering_config module¶

class AccountFilteringConfig(arg: None)¶

class AccountFilteringConfig(arg: ModelComposed)

class AccountFilteringConfig(*args, **kwargs)

Bases: ModelNormal

The account filtering configuration.

Parameters:

excluded_accounts ([str], optional) – The AWS account IDs to be excluded from your billing dataset. This field is used when include_new_accounts is true.
include_new_accounts (bool, none_type, optional) – Whether or not to automatically include new member accounts by default in your billing dataset.
included_accounts ([str], optional) – The AWS account IDs to be included in your billing dataset. This field is used when include_new_accounts is false.

datadog_api_client.v2.model.action_connection_attributes module¶

class ActionConnectionAttributes(arg: None)¶

class ActionConnectionAttributes(arg: ModelComposed)

class ActionConnectionAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of ActionConnectionAttributes object.

Parameters:

integration (ActionConnectionIntegration) – The definition of ActionConnectionIntegration object.
name (str) – Name of the connection

datadog_api_client.v2.model.action_connection_attributes_update module¶

class ActionConnectionAttributesUpdate(arg: None)¶

class ActionConnectionAttributesUpdate(arg: ModelComposed)

class ActionConnectionAttributesUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of ActionConnectionAttributesUpdate object.

Parameters:

integration (ActionConnectionIntegrationUpdate, optional) – The definition of ActionConnectionIntegrationUpdate object.
name (str, optional) – Name of the connection

datadog_api_client.v2.model.action_connection_data module¶

class ActionConnectionData(arg: None)¶

class ActionConnectionData(arg: ModelComposed)

class ActionConnectionData(*args, **kwargs)

Bases: ModelNormal

Data related to the connection.

Parameters:

attributes (ActionConnectionAttributes) – The definition of ActionConnectionAttributes object.
id (str, optional) – The connection identifier
type (ActionConnectionDataType) – The definition of ActionConnectionDataType object.

datadog_api_client.v2.model.action_connection_data_type module¶

class ActionConnectionDataType(arg: None)¶

class ActionConnectionDataType(arg: ModelComposed)

class ActionConnectionDataType(*args, **kwargs)

Bases: ModelSimple

The definition of ActionConnectionDataType object.

Parameters:

value (str) – If omitted defaults to “action_connection”. Must be one of [“action_connection”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.action_connection_data_update module¶

class ActionConnectionDataUpdate(arg: None)¶

class ActionConnectionDataUpdate(arg: ModelComposed)

class ActionConnectionDataUpdate(*args, **kwargs)

Bases: ModelNormal

Data related to the connection update.

Parameters:

attributes (ActionConnectionAttributesUpdate) – The definition of ActionConnectionAttributesUpdate object.
type (ActionConnectionDataType) – The definition of ActionConnectionDataType object.

datadog_api_client.v2.model.action_connection_integration module¶

class ActionConnectionIntegration(arg: None)¶

class ActionConnectionIntegration(arg: ModelComposed)

class ActionConnectionIntegration(*args, **kwargs)

Bases: ModelComposed

The definition of ActionConnectionIntegration object.

Parameters:

credentials (AWSCredentials) – The definition of AWSCredentials object.
type (AWSIntegrationType) – The definition of AWSIntegrationType object.
base_url (str) – Base HTTP url for the integration

datadog_api_client.v2.model.action_connection_integration_update module¶

class ActionConnectionIntegrationUpdate(arg: None)¶

class ActionConnectionIntegrationUpdate(arg: ModelComposed)

class ActionConnectionIntegrationUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of ActionConnectionIntegrationUpdate object.

Parameters:

credentials (AWSCredentialsUpdate, optional) – The definition of AWSCredentialsUpdate object.
type (AWSIntegrationType) – The definition of AWSIntegrationType object.
base_url (str, optional) – Base HTTP url for the integration

datadog_api_client.v2.model.action_query module¶

class ActionQuery(arg: None)¶

class ActionQuery(arg: ModelComposed)

class ActionQuery(*args, **kwargs)

Bases: ModelNormal

An action query. This query type is used to trigger an action, such as sending a HTTP request.

Parameters:

events ([AppBuilderEvent], optional) – Events to listen for downstream of the action query.
id (UUID) – The ID of the action query.
name (str) – A unique identifier for this action query. This name is also used to access the query’s result throughout the app.
properties (ActionQueryProperties) – The properties of the action query.
type (ActionQueryType) – The action query type.

datadog_api_client.v2.model.action_query_condition module¶

class ActionQueryCondition(arg: None)¶

class ActionQueryCondition(arg: ModelComposed)

class ActionQueryCondition(*args, **kwargs)

Bases: ModelComposed

Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.

datadog_api_client.v2.model.action_query_debounce_in_ms module¶

class ActionQueryDebounceInMs(arg: None)¶

class ActionQueryDebounceInMs(arg: ModelComposed)

class ActionQueryDebounceInMs(*args, **kwargs)

Bases: ModelComposed

The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.

datadog_api_client.v2.model.action_query_mocked_outputs module¶

class ActionQueryMockedOutputs(arg: None)¶

class ActionQueryMockedOutputs(arg: ModelComposed)

class ActionQueryMockedOutputs(*args, **kwargs)

Bases: ModelComposed

The mocked outputs of the action query. This is useful for testing the app without actually running the action.

Parameters:

enabled (ActionQueryMockedOutputsEnabled) – Whether to enable the mocked outputs for testing.
outputs (str, optional) – The mocked outputs of the action query, serialized as JSON.

datadog_api_client.v2.model.action_query_mocked_outputs_enabled module¶

class ActionQueryMockedOutputsEnabled(arg: None)¶

class ActionQueryMockedOutputsEnabled(arg: ModelComposed)

class ActionQueryMockedOutputsEnabled(*args, **kwargs)

Bases: ModelComposed

Whether to enable the mocked outputs for testing.

datadog_api_client.v2.model.action_query_mocked_outputs_object module¶

class ActionQueryMockedOutputsObject(arg: None)¶

class ActionQueryMockedOutputsObject(arg: ModelComposed)

class ActionQueryMockedOutputsObject(*args, **kwargs)

Bases: ModelNormal

The mocked outputs of the action query.

Parameters:

enabled (ActionQueryMockedOutputsEnabled) – Whether to enable the mocked outputs for testing.
outputs (str, optional) – The mocked outputs of the action query, serialized as JSON.

datadog_api_client.v2.model.action_query_only_trigger_manually module¶

class ActionQueryOnlyTriggerManually(arg: None)¶

class ActionQueryOnlyTriggerManually(arg: ModelComposed)

class ActionQueryOnlyTriggerManually(*args, **kwargs)

Bases: ModelComposed

Determines when this query is executed. If set to false , the query will run when the app loads and whenever any query arguments change. If set to true , the query will only run when manually triggered from elsewhere in the app.

datadog_api_client.v2.model.action_query_polling_interval_in_ms module¶

class ActionQueryPollingIntervalInMs(arg: None)¶

class ActionQueryPollingIntervalInMs(arg: ModelComposed)

class ActionQueryPollingIntervalInMs(*args, **kwargs)

Bases: ModelComposed

If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app’s browser tab is active.

datadog_api_client.v2.model.action_query_properties module¶

class ActionQueryProperties(arg: None)¶

class ActionQueryProperties(arg: ModelComposed)

class ActionQueryProperties(*args, **kwargs)

Bases: ModelNormal

The properties of the action query.

Parameters:

condition (ActionQueryCondition, optional) – Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.
debounce_in_ms (ActionQueryDebounceInMs, optional) – The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.
mocked_outputs (ActionQueryMockedOutputs, optional) – The mocked outputs of the action query. This is useful for testing the app without actually running the action.
only_trigger_manually (ActionQueryOnlyTriggerManually, optional) – Determines when this query is executed. If set to false , the query will run when the app loads and whenever any query arguments change. If set to true , the query will only run when manually triggered from elsewhere in the app.
outputs (str, optional) – The post-query transformation function, which is a JavaScript function that changes the query’s .outputs property after the query’s execution.
polling_interval_in_ms (ActionQueryPollingIntervalInMs, optional) – If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app’s browser tab is active.
requires_confirmation (ActionQueryRequiresConfirmation, optional) – Whether to prompt the user to confirm this query before it runs.
show_toast_on_error (ActionQueryShowToastOnError, optional) – Whether to display a toast to the user when the query returns an error.
spec (ActionQuerySpec) – The definition of the action query.

datadog_api_client.v2.model.action_query_requires_confirmation module¶

class ActionQueryRequiresConfirmation(arg: None)¶

class ActionQueryRequiresConfirmation(arg: ModelComposed)

class ActionQueryRequiresConfirmation(*args, **kwargs)

Bases: ModelComposed

Whether to prompt the user to confirm this query before it runs.

datadog_api_client.v2.model.action_query_show_toast_on_error module¶

class ActionQueryShowToastOnError(arg: None)¶

class ActionQueryShowToastOnError(arg: ModelComposed)

class ActionQueryShowToastOnError(*args, **kwargs)

Bases: ModelComposed

Whether to display a toast to the user when the query returns an error.

datadog_api_client.v2.model.action_query_spec module¶

class ActionQuerySpec(arg: None)¶

class ActionQuerySpec(arg: ModelComposed)

class ActionQuerySpec(*args, **kwargs)

Bases: ModelComposed

The definition of the action query.

Parameters:

connection_group (ActionQuerySpecConnectionGroup, optional) – The connection group to use for an action query.
connection_id (str, optional) – The ID of the custom connection to use for this action query.
fqn (str) – The fully qualified name of the action type.
inputs (ActionQuerySpecInputs, optional) – The inputs to the action query. These are the values that are passed to the action when it is triggered.

datadog_api_client.v2.model.action_query_spec_connection_group module¶

class ActionQuerySpecConnectionGroup(arg: None)¶

class ActionQuerySpecConnectionGroup(arg: ModelComposed)

class ActionQuerySpecConnectionGroup(*args, **kwargs)

Bases: ModelNormal

The connection group to use for an action query.

Parameters:

id (UUID, optional) – The ID of the connection group.
tags ([str], optional) – The tags of the connection group.

datadog_api_client.v2.model.action_query_spec_input module¶

class ActionQuerySpecInput(arg: None)¶

class ActionQuerySpecInput(arg: ModelComposed)

class ActionQuerySpecInput(*args, **kwargs)

Bases: ModelNormal

The inputs to the action query. See the Actions Catalog for more detail on each action and its inputs.

datadog_api_client.v2.model.action_query_spec_inputs module¶

class ActionQuerySpecInputs(arg: None)¶

class ActionQuerySpecInputs(arg: ModelComposed)

class ActionQuerySpecInputs(*args, **kwargs)

Bases: ModelComposed

The inputs to the action query. These are the values that are passed to the action when it is triggered.

datadog_api_client.v2.model.action_query_spec_object module¶

class ActionQuerySpecObject(arg: None)¶

class ActionQuerySpecObject(arg: ModelComposed)

class ActionQuerySpecObject(*args, **kwargs)

Bases: ModelNormal

The action query spec object.

Parameters:

connection_group (ActionQuerySpecConnectionGroup, optional) – The connection group to use for an action query.
connection_id (str, optional) – The ID of the custom connection to use for this action query.
fqn (str) – The fully qualified name of the action type.
inputs (ActionQuerySpecInputs, optional) – The inputs to the action query. These are the values that are passed to the action when it is triggered.

datadog_api_client.v2.model.action_query_type module¶

class ActionQueryType(arg: None)¶

class ActionQueryType(arg: ModelComposed)

class ActionQueryType(*args, **kwargs)

Bases: ModelSimple

The action query type.

Parameters:

value (str) – If omitted defaults to “action”. Must be one of [“action”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.active_billing_dimensions_attributes module¶

class ActiveBillingDimensionsAttributes(arg: None)¶

class ActiveBillingDimensionsAttributes(arg: ModelComposed)

class ActiveBillingDimensionsAttributes(*args, **kwargs)

Bases: ModelNormal

List of active billing dimensions.

Parameters:

month (datetime, optional) – Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh].
values ([str], optional) – List of active billing dimensions. Example: [infra_host, apm_host, serverless_infra].

datadog_api_client.v2.model.active_billing_dimensions_body module¶

class ActiveBillingDimensionsBody(arg: None)¶

class ActiveBillingDimensionsBody(arg: ModelComposed)

class ActiveBillingDimensionsBody(*args, **kwargs)

Bases: ModelNormal

Active billing dimensions data.

Parameters:

attributes (ActiveBillingDimensionsAttributes, optional) – List of active billing dimensions.
id (str, optional) – Unique ID of the response.
type (ActiveBillingDimensionsType, optional) – Type of active billing dimensions data.

datadog_api_client.v2.model.active_billing_dimensions_response module¶

class ActiveBillingDimensionsResponse(arg: None)¶

class ActiveBillingDimensionsResponse(arg: ModelComposed)

class ActiveBillingDimensionsResponse(*args, **kwargs)

Bases: ModelNormal

Active billing dimensions response.

Parameters:: data (ActiveBillingDimensionsBody, optional) – Active billing dimensions data.

datadog_api_client.v2.model.active_billing_dimensions_type module¶

class ActiveBillingDimensionsType(arg: None)¶

class ActiveBillingDimensionsType(arg: ModelComposed)

class ActiveBillingDimensionsType(*args, **kwargs)

Bases: ModelSimple

Type of active billing dimensions data.

Parameters:

value (str) – If omitted defaults to “billing_dimensions”. Must be one of [“billing_dimensions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.add_member_team_request module¶

class AddMemberTeamRequest(arg: None)¶

class AddMemberTeamRequest(arg: ModelComposed)

class AddMemberTeamRequest(*args, **kwargs)

Bases: ModelNormal

Request to add a member team to super team’s hierarchy

Parameters:: data (MemberTeam) – A member team

datadog_api_client.v2.model.advisory module¶

class Advisory(arg: None)¶

class Advisory(arg: ModelComposed)

class Advisory(*args, **kwargs)

Bases: ModelNormal

Advisory.

Parameters:

base_severity (str) – Advisory base severity.
id (str) – Advisory id.
severity (str, optional) – Advisory Datadog severity.

datadog_api_client.v2.model.alert_event_attributes module¶

class AlertEventAttributes(arg: None)¶

class AlertEventAttributes(arg: ModelComposed)

class AlertEventAttributes(*args, **kwargs)

Bases: ModelNormal

Alert event attributes.

Parameters:

aggregation_key (str, optional) – Aggregation key of the event.
custom (dict, optional) – JSON object of custom attributes.
evt (EventSystemAttributes, optional) – JSON object of event system attributes.
links ([AlertEventAttributesLinksItem], optional) – The links related to the event.
priority (AlertEventAttributesPriority, optional) – The priority of the alert.
service (str, optional) – Service that triggered the event.
status (AlertEventAttributesStatus, optional) – The status of the alert.
timestamp (int, optional) – POSIX timestamp of the event.
title (str, optional) – The title of the event.

datadog_api_client.v2.model.alert_event_attributes_links_item module¶

class AlertEventAttributesLinksItem(arg: None)¶

class AlertEventAttributesLinksItem(arg: ModelComposed)

class AlertEventAttributesLinksItem(*args, **kwargs)

Bases: ModelNormal

A link.

Parameters:

category (AlertEventAttributesLinksItemCategory, optional) – The category of the link.
title (str, optional) – The display text of the link.
url (str, optional) – The URL of the link.

datadog_api_client.v2.model.alert_event_attributes_links_item_category module¶

class AlertEventAttributesLinksItemCategory(arg: None)¶

class AlertEventAttributesLinksItemCategory(arg: ModelComposed)

class AlertEventAttributesLinksItemCategory(*args, **kwargs)

Bases: ModelSimple

The category of the link.

Parameters:

value (str) – Must be one of [“runbook”, “documentation”, “dashboard”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.alert_event_attributes_priority module¶

class AlertEventAttributesPriority(arg: None)¶

class AlertEventAttributesPriority(arg: ModelComposed)

class AlertEventAttributesPriority(*args, **kwargs)

Bases: ModelSimple

The priority of the alert.

Parameters:

value (str) – Must be one of [“1”, “2”, “3”, “4”, “5”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.alert_event_attributes_status module¶

class AlertEventAttributesStatus(arg: None)¶

class AlertEventAttributesStatus(arg: ModelComposed)

class AlertEventAttributesStatus(*args, **kwargs)

Bases: ModelSimple

The status of the alert.

Parameters:

value (str) – Must be one of [“warn”, “error”, “ok”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.alert_event_custom_attributes module¶

class AlertEventCustomAttributes(arg: None)¶

class AlertEventCustomAttributes(arg: ModelComposed)

class AlertEventCustomAttributes(*args, **kwargs)

Bases: ModelNormal

Alert event attributes.

Parameters:

custom (AlertEventCustomAttributesCustom, optional) – Free form JSON object for arbitrary data. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.
links ([AlertEventCustomAttributesLinksItems], optional) – The links related to the event. Maximum of 20 links allowed.
priority (AlertEventCustomAttributesPriority, optional) – The priority of the alert.
status (AlertEventCustomAttributesStatus) – The status of the alert.

additional_properties_type = None¶

datadog_api_client.v2.model.alert_event_custom_attributes_custom module¶

class AlertEventCustomAttributesCustom(arg: None)¶

class AlertEventCustomAttributesCustom(arg: ModelComposed)

class AlertEventCustomAttributesCustom(*args, **kwargs)

Bases: ModelNormal

Free form JSON object for arbitrary data. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.

datadog_api_client.v2.model.alert_event_custom_attributes_links_items module¶

class AlertEventCustomAttributesLinksItems(arg: None)¶

class AlertEventCustomAttributesLinksItems(arg: ModelComposed)

class AlertEventCustomAttributesLinksItems(*args, **kwargs)

Bases: ModelNormal

A link.

Parameters:

category (AlertEventCustomAttributesLinksItemsCategory) – The category of the link.
title (str, optional) – The display text of the link. Limited to 300 characters.
url (str) – The URL of the link. Limited to 2048 characters.

additional_properties_type = None¶

datadog_api_client.v2.model.alert_event_custom_attributes_links_items_category module¶

class AlertEventCustomAttributesLinksItemsCategory(arg: None)¶

class AlertEventCustomAttributesLinksItemsCategory(arg: ModelComposed)

class AlertEventCustomAttributesLinksItemsCategory(*args, **kwargs)

Bases: ModelSimple

The category of the link.

Parameters:

value (str) – Must be one of [“runbook”, “documentation”, “dashboard”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.alert_event_custom_attributes_priority module¶

class AlertEventCustomAttributesPriority(arg: None)¶

class AlertEventCustomAttributesPriority(arg: ModelComposed)

class AlertEventCustomAttributesPriority(*args, **kwargs)

Bases: ModelSimple

The priority of the alert.

Parameters:

value (str) – If omitted defaults to “5”. Must be one of [“1”, “2”, “3”, “4”, “5”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.alert_event_custom_attributes_status module¶

class AlertEventCustomAttributesStatus(arg: None)¶

class AlertEventCustomAttributesStatus(arg: ModelComposed)

class AlertEventCustomAttributesStatus(*args, **kwargs)

Bases: ModelSimple

The status of the alert.

Parameters:

value (str) – Must be one of [“warn”, “error”, “ok”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.annotation module¶

class Annotation(arg: None)¶

class Annotation(arg: ModelComposed)

class Annotation(*args, **kwargs)

Bases: ModelNormal

A list of annotations used in the workflow. These are like sticky notes for your workflow!

Parameters:

display (AnnotationDisplay) – The definition of AnnotationDisplay object.
id (str) – The Annotation id.
markdown_text_annotation (AnnotationMarkdownTextAnnotation) – The definition of AnnotationMarkdownTextAnnotation object.

datadog_api_client.v2.model.annotation_display module¶

class AnnotationDisplay(arg: None)¶

class AnnotationDisplay(arg: ModelComposed)

class AnnotationDisplay(*args, **kwargs)

Bases: ModelNormal

The definition of AnnotationDisplay object.

Parameters:: bounds (AnnotationDisplayBounds, optional) – The definition of AnnotationDisplayBounds object.

datadog_api_client.v2.model.annotation_display_bounds module¶

class AnnotationDisplayBounds(arg: None)¶

class AnnotationDisplayBounds(arg: ModelComposed)

class AnnotationDisplayBounds(*args, **kwargs)

Bases: ModelNormal

The definition of AnnotationDisplayBounds object.

Parameters:

height (float, optional) – The bounds height.
width (float, optional) – The bounds width.
x (float, optional) – The bounds x.
y (float, optional) – The bounds y.

datadog_api_client.v2.model.annotation_markdown_text_annotation module¶

class AnnotationMarkdownTextAnnotation(arg: None)¶

class AnnotationMarkdownTextAnnotation(arg: ModelComposed)

class AnnotationMarkdownTextAnnotation(*args, **kwargs)

Bases: ModelNormal

The definition of AnnotationMarkdownTextAnnotation object.

Parameters:: text (str, optional) – The markdownTextAnnotation text.

datadog_api_client.v2.model.anthropic_api_key module¶

class AnthropicAPIKey(arg: None)¶

class AnthropicAPIKey(arg: ModelComposed)

class AnthropicAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the AnthropicAPIKey object.

Parameters:

api_token (str) – The AnthropicAPIKey api_token.
type (AnthropicAPIKeyType) – The definition of the AnthropicAPIKey object.

datadog_api_client.v2.model.anthropic_api_key_type module¶

class AnthropicAPIKeyType(arg: None)¶

class AnthropicAPIKeyType(arg: ModelComposed)

class AnthropicAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the AnthropicAPIKey object.

Parameters:

value (str) – If omitted defaults to “AnthropicAPIKey”. Must be one of [“AnthropicAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.anthropic_api_key_update module¶

class AnthropicAPIKeyUpdate(arg: None)¶

class AnthropicAPIKeyUpdate(arg: ModelComposed)

class AnthropicAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the AnthropicAPIKey object.

Parameters:

api_token (str, optional) – The AnthropicAPIKeyUpdate api_token.
type (AnthropicAPIKeyType) – The definition of the AnthropicAPIKey object.

datadog_api_client.v2.model.anthropic_credentials module¶

class AnthropicCredentials(arg: None)¶

class AnthropicCredentials(arg: ModelComposed)

class AnthropicCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the AnthropicCredentials object.

Parameters:

api_token (str) – The AnthropicAPIKey api_token.
type (AnthropicAPIKeyType) – The definition of the AnthropicAPIKey object.

datadog_api_client.v2.model.anthropic_credentials_update module¶

class AnthropicCredentialsUpdate(arg: None)¶

class AnthropicCredentialsUpdate(arg: ModelComposed)

class AnthropicCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the AnthropicCredentialsUpdate object.

Parameters:

api_token (str, optional) – The AnthropicAPIKeyUpdate api_token.
type (AnthropicAPIKeyType) – The definition of the AnthropicAPIKey object.

datadog_api_client.v2.model.anthropic_integration module¶

class AnthropicIntegration(arg: None)¶

class AnthropicIntegration(arg: ModelComposed)

class AnthropicIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the AnthropicIntegration object.

Parameters:

credentials (AnthropicCredentials) – The definition of the AnthropicCredentials object.
type (AnthropicIntegrationType) – The definition of the AnthropicIntegrationType object.

datadog_api_client.v2.model.anthropic_integration_type module¶

class AnthropicIntegrationType(arg: None)¶

class AnthropicIntegrationType(arg: ModelComposed)

class AnthropicIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the AnthropicIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Anthropic”. Must be one of [“Anthropic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.anthropic_integration_update module¶

class AnthropicIntegrationUpdate(arg: None)¶

class AnthropicIntegrationUpdate(arg: ModelComposed)

class AnthropicIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the AnthropicIntegrationUpdate object.

Parameters:

credentials (AnthropicCredentialsUpdate, optional) – The definition of the AnthropicCredentialsUpdate object.
type (AnthropicIntegrationType) – The definition of the AnthropicIntegrationType object.

datadog_api_client.v2.model.api_error_response module¶

class APIErrorResponse(arg: None)¶

class APIErrorResponse(arg: ModelComposed)

class APIErrorResponse(*args, **kwargs)

Bases: ModelNormal

API error response.

Parameters:: errors ([str]) – A list of errors.

datadog_api_client.v2.model.api_key_create_attributes module¶

class APIKeyCreateAttributes(arg: None)¶

class APIKeyCreateAttributes(arg: ModelComposed)

class APIKeyCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes used to create an API Key.

Parameters:

category (str, optional) – The APIKeyCreateAttributes category.
name (str) – Name of the API key.
remote_config_read_enabled (bool, optional) – The APIKeyCreateAttributes remote_config_read_enabled.

datadog_api_client.v2.model.api_key_create_data module¶

class APIKeyCreateData(arg: None)¶

class APIKeyCreateData(arg: ModelComposed)

class APIKeyCreateData(*args, **kwargs)

Bases: ModelNormal

Object used to create an API key.

Parameters:

attributes (APIKeyCreateAttributes) – Attributes used to create an API Key.
type (APIKeysType) – API Keys resource type.

datadog_api_client.v2.model.api_key_create_request module¶

class APIKeyCreateRequest(arg: None)¶

class APIKeyCreateRequest(arg: ModelComposed)

class APIKeyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to create an API key.

Parameters:: data (APIKeyCreateData) – Object used to create an API key.

datadog_api_client.v2.model.api_key_relationships module¶

class APIKeyRelationships(arg: None)¶

class APIKeyRelationships(arg: ModelComposed)

class APIKeyRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to the API key.

Parameters:

created_by (RelationshipToUser, optional) – Relationship to user.
modified_by (NullableRelationshipToUser, none_type, optional) – Relationship to user.

datadog_api_client.v2.model.api_key_response module¶

class APIKeyResponse(arg: None)¶

class APIKeyResponse(arg: ModelComposed)

class APIKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving an API key.

Parameters:

data (FullAPIKey, optional) – Datadog API key.
included ([APIKeyResponseIncludedItem], optional) – Array of objects related to the API key.

datadog_api_client.v2.model.api_key_response_included_item module¶

class APIKeyResponseIncludedItem(arg: None)¶

class APIKeyResponseIncludedItem(arg: ModelComposed)

class APIKeyResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an API key.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.api_key_update_attributes module¶

class APIKeyUpdateAttributes(arg: None)¶

class APIKeyUpdateAttributes(arg: ModelComposed)

class APIKeyUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes used to update an API Key.

Parameters:

category (str, optional) – The APIKeyUpdateAttributes category.
name (str) – Name of the API key.
remote_config_read_enabled (bool, optional) – The APIKeyUpdateAttributes remote_config_read_enabled.

datadog_api_client.v2.model.api_key_update_data module¶

class APIKeyUpdateData(arg: None)¶

class APIKeyUpdateData(arg: ModelComposed)

class APIKeyUpdateData(*args, **kwargs)

Bases: ModelNormal

Object used to update an API key.

Parameters:

attributes (APIKeyUpdateAttributes) – Attributes used to update an API Key.
id (str) – ID of the API key.
type (APIKeysType) – API Keys resource type.

datadog_api_client.v2.model.api_key_update_request module¶

class APIKeyUpdateRequest(arg: None)¶

class APIKeyUpdateRequest(arg: ModelComposed)

class APIKeyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to update an API key.

Parameters:: data (APIKeyUpdateData) – Object used to update an API key.

datadog_api_client.v2.model.api_keys_response module¶

class APIKeysResponse(arg: None)¶

class APIKeysResponse(arg: ModelComposed)

class APIKeysResponse(*args, **kwargs)

Bases: ModelNormal

Response for a list of API keys.

Parameters:

data ([PartialAPIKey], optional) – Array of API keys.
included ([APIKeyResponseIncludedItem], optional) – Array of objects related to the API key.
meta (APIKeysResponseMeta, optional) – Additional information related to api keys response.

datadog_api_client.v2.model.api_keys_response_meta module¶

class APIKeysResponseMeta(arg: None)¶

class APIKeysResponseMeta(arg: ModelComposed)

class APIKeysResponseMeta(*args, **kwargs)

Bases: ModelNormal

Additional information related to api keys response.

Parameters:

max_allowed (int, optional) – Max allowed number of API keys.
page (APIKeysResponseMetaPage, optional) – Additional information related to the API keys response.

datadog_api_client.v2.model.api_keys_response_meta_page module¶

class APIKeysResponseMetaPage(arg: None)¶

class APIKeysResponseMetaPage(arg: ModelComposed)

class APIKeysResponseMetaPage(*args, **kwargs)

Bases: ModelNormal

Additional information related to the API keys response.

Parameters:: total_filtered_count (int, optional) – Total filtered application key count.

datadog_api_client.v2.model.api_keys_sort module¶

class APIKeysSort(arg: None)¶

class APIKeysSort(arg: ModelComposed)

class APIKeysSort(*args, **kwargs)

Bases: ModelSimple

Sorting options

Parameters:

value (str) – If omitted defaults to “name”. Must be one of [“created_at”, “-created_at”, “last4”, “-last4”, “modified_at”, “-modified_at”, “name”, “-name”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.api_keys_type module¶

class APIKeysType(arg: None)¶

class APIKeysType(arg: ModelComposed)

class APIKeysType(*args, **kwargs)

Bases: ModelSimple

API Keys resource type.

Parameters:

value (str) – If omitted defaults to “api_keys”. Must be one of [“api_keys”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.api_trigger module¶

class APITrigger(arg: None)¶

class APITrigger(arg: ModelComposed)

class APITrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from an API request. The workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.api_trigger_wrapper module¶

class APITriggerWrapper(arg: None)¶

class APITriggerWrapper(arg: ModelComposed)

class APITriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for an API-based trigger.

Parameters:

api_trigger (APITrigger) – Trigger a workflow from an API request. The workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.apm_retention_filter_type module¶

class ApmRetentionFilterType(arg: None)¶

class ApmRetentionFilterType(arg: ModelComposed)

class ApmRetentionFilterType(*args, **kwargs)

Bases: ModelSimple

The type of the resource.

Parameters:

value (str) – If omitted defaults to “apm_retention_filter”. Must be one of [“apm_retention_filter”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.app_builder_event module¶

class AppBuilderEvent(arg: None)¶

class AppBuilderEvent(arg: ModelComposed)

class AppBuilderEvent(*args, **kwargs)

Bases: ModelNormal

An event on a UI component that triggers a response or action in an app.

Parameters:

name (AppBuilderEventName, optional) – The triggering action for the event.
type (AppBuilderEventType, optional) – The response to the event.

datadog_api_client.v2.model.app_builder_event_name module¶

class AppBuilderEventName(arg: None)¶

class AppBuilderEventName(arg: ModelComposed)

class AppBuilderEventName(*args, **kwargs)

Bases: ModelSimple

The triggering action for the event.

Parameters:

value (str) – Must be one of [“pageChange”, “tableRowClick”, “_tableRowButtonClick”, “change”, “submit”, “click”, “toggleOpen”, “close”, “open”, “executionFinished”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.app_builder_event_type module¶

class AppBuilderEventType(arg: None)¶

class AppBuilderEventType(arg: ModelComposed)

class AppBuilderEventType(*args, **kwargs)

Bases: ModelSimple

The response to the event.

Parameters:

value (str) – Must be one of [“custom”, “setComponentState”, “triggerQuery”, “openModal”, “closeModal”, “openUrl”, “downloadFile”, “setStateVariableValue”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.app_definition_type module¶

class AppDefinitionType(arg: None)¶

class AppDefinitionType(arg: ModelComposed)

class AppDefinitionType(*args, **kwargs)

Bases: ModelSimple

The app definition type.

Parameters:

value (str) – If omitted defaults to “appDefinitions”. Must be one of [“appDefinitions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.app_deployment_type module¶

class AppDeploymentType(arg: None)¶

class AppDeploymentType(arg: ModelComposed)

class AppDeploymentType(*args, **kwargs)

Bases: ModelSimple

The deployment type.

Parameters:

value (str) – If omitted defaults to “deployment”. Must be one of [“deployment”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.app_key_registration_data module¶

class AppKeyRegistrationData(arg: None)¶

class AppKeyRegistrationData(arg: ModelComposed)

class AppKeyRegistrationData(*args, **kwargs)

Bases: ModelNormal

Data related to the app key registration.

Parameters:

id (UUID, optional) – The app key registration identifier
type (AppKeyRegistrationDataType) – The definition of AppKeyRegistrationDataType object.

datadog_api_client.v2.model.app_key_registration_data_type module¶

class AppKeyRegistrationDataType(arg: None)¶

class AppKeyRegistrationDataType(arg: ModelComposed)

class AppKeyRegistrationDataType(*args, **kwargs)

Bases: ModelSimple

The definition of AppKeyRegistrationDataType object.

Parameters:

value (str) – If omitted defaults to “app_key_registration”. Must be one of [“app_key_registration”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.app_meta module¶

class AppMeta(arg: None)¶

class AppMeta(arg: ModelComposed)

class AppMeta(*args, **kwargs)

Bases: ModelNormal

Metadata of an app.

Parameters:

created_at (datetime, optional) – Timestamp of when the app was created.
deleted_at (datetime, optional) – Timestamp of when the app was deleted.
org_id (int, optional) – The Datadog organization ID that owns the app.
updated_at (datetime, optional) – Timestamp of when the app was last updated.
updated_since_deployment (bool, optional) – Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated.
user_id (int, optional) – The ID of the user who created the app.
user_name (str, optional) – The name (or email address) of the user who created the app.
user_uuid (UUID, optional) – The UUID of the user who created the app.
version (int, optional) – The version number of the app. This starts at 1 and increments with each update.

datadog_api_client.v2.model.app_relationship module¶

class AppRelationship(arg: None)¶

class AppRelationship(arg: ModelComposed)

class AppRelationship(*args, **kwargs)

Bases: ModelNormal

The app’s publication relationship and custom connections.

Parameters:

connections ([CustomConnection], optional) – Array of custom connections used by the app.
deployment (DeploymentRelationship, optional) – Information pointing to the app’s publication status.

datadog_api_client.v2.model.app_trigger_wrapper module¶

class AppTriggerWrapper(arg: None)¶

class AppTriggerWrapper(arg: ModelComposed)

class AppTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for an App-based trigger.

Parameters:

app_trigger (dict) – Trigger a workflow from an App.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.application_key_create_attributes module¶

class ApplicationKeyCreateAttributes(arg: None)¶

class ApplicationKeyCreateAttributes(arg: ModelComposed)

class ApplicationKeyCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes used to create an application Key.

Parameters:

name (str) – Name of the application key.
scopes ([str], none_type, optional) – Array of scopes to grant the application key.

datadog_api_client.v2.model.application_key_create_data module¶

class ApplicationKeyCreateData(arg: None)¶

class ApplicationKeyCreateData(arg: ModelComposed)

class ApplicationKeyCreateData(*args, **kwargs)

Bases: ModelNormal

Object used to create an application key.

Parameters:

attributes (ApplicationKeyCreateAttributes) – Attributes used to create an application Key.
type (ApplicationKeysType) – Application Keys resource type.

datadog_api_client.v2.model.application_key_create_request module¶

class ApplicationKeyCreateRequest(arg: None)¶

class ApplicationKeyCreateRequest(arg: ModelComposed)

class ApplicationKeyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to create an application key.

Parameters:: data (ApplicationKeyCreateData) – Object used to create an application key.

datadog_api_client.v2.model.application_key_relationships module¶

class ApplicationKeyRelationships(arg: None)¶

class ApplicationKeyRelationships(arg: ModelComposed)

class ApplicationKeyRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to the application key.

Parameters:: owned_by (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.application_key_response module¶

class ApplicationKeyResponse(arg: None)¶

class ApplicationKeyResponse(arg: ModelComposed)

class ApplicationKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving an application key.

Parameters:

data (FullApplicationKey, optional) – Datadog application key.
included ([ApplicationKeyResponseIncludedItem], optional) – Array of objects related to the application key.

datadog_api_client.v2.model.application_key_response_included_item module¶

class ApplicationKeyResponseIncludedItem(arg: None)¶

class ApplicationKeyResponseIncludedItem(arg: ModelComposed)

class ApplicationKeyResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an application key.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.application_key_response_meta module¶

class ApplicationKeyResponseMeta(arg: None)¶

class ApplicationKeyResponseMeta(arg: ModelComposed)

class ApplicationKeyResponseMeta(*args, **kwargs)

Bases: ModelNormal

Additional information related to the application key response.

Parameters:

max_allowed_per_user (int, optional) – Max allowed number of application keys per user.
page (ApplicationKeyResponseMetaPage, optional) – Additional information related to the application key response.

datadog_api_client.v2.model.application_key_response_meta_page module¶

class ApplicationKeyResponseMetaPage(arg: None)¶

class ApplicationKeyResponseMetaPage(arg: ModelComposed)

class ApplicationKeyResponseMetaPage(*args, **kwargs)

Bases: ModelNormal

Additional information related to the application key response.

Parameters:: total_filtered_count (int, optional) – Total filtered application key count.

datadog_api_client.v2.model.application_key_update_attributes module¶

class ApplicationKeyUpdateAttributes(arg: None)¶

class ApplicationKeyUpdateAttributes(arg: ModelComposed)

class ApplicationKeyUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes used to update an application Key.

Parameters:

name (str, optional) – Name of the application key.
scopes ([str], none_type, optional) – Array of scopes to grant the application key.

datadog_api_client.v2.model.application_key_update_data module¶

class ApplicationKeyUpdateData(arg: None)¶

class ApplicationKeyUpdateData(arg: ModelComposed)

class ApplicationKeyUpdateData(*args, **kwargs)

Bases: ModelNormal

Object used to update an application key.

Parameters:

attributes (ApplicationKeyUpdateAttributes) – Attributes used to update an application Key.
id (str) – ID of the application key.
type (ApplicationKeysType) – Application Keys resource type.

datadog_api_client.v2.model.application_key_update_request module¶

class ApplicationKeyUpdateRequest(arg: None)¶

class ApplicationKeyUpdateRequest(arg: ModelComposed)

class ApplicationKeyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to update an application key.

Parameters:: data (ApplicationKeyUpdateData) – Object used to update an application key.

datadog_api_client.v2.model.application_keys_sort module¶

class ApplicationKeysSort(arg: None)¶

class ApplicationKeysSort(arg: ModelComposed)

class ApplicationKeysSort(*args, **kwargs)

Bases: ModelSimple

Sorting options

Parameters:

value (str) – If omitted defaults to “name”. Must be one of [“created_at”, “-created_at”, “last4”, “-last4”, “name”, “-name”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_keys_type module¶

class ApplicationKeysType(arg: None)¶

class ApplicationKeysType(arg: ModelComposed)

class ApplicationKeysType(*args, **kwargs)

Bases: ModelSimple

Application Keys resource type.

Parameters:

value (str) – If omitted defaults to “application_keys”. Must be one of [“application_keys”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_custom_rule_action module¶

class ApplicationSecurityWafCustomRuleAction(arg: None)¶

class ApplicationSecurityWafCustomRuleAction(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleAction(*args, **kwargs)

Bases: ModelNormal

The definition of ApplicationSecurityWafCustomRuleAction object.

Parameters:

action (ApplicationSecurityWafCustomRuleActionAction, optional) – Override the default action to take when the WAF custom rule would block.
parameters (ApplicationSecurityWafCustomRuleActionParameters, optional) – The definition of ApplicationSecurityWafCustomRuleActionParameters object.

datadog_api_client.v2.model.application_security_waf_custom_rule_action_action module¶

class ApplicationSecurityWafCustomRuleActionAction(arg: None)¶

class ApplicationSecurityWafCustomRuleActionAction(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleActionAction(*args, **kwargs)

Bases: ModelSimple

Override the default action to take when the WAF custom rule would block.

Parameters:

value (str) – If omitted defaults to “block_request”. Must be one of [“redirect_request”, “block_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_custom_rule_action_parameters module¶

class ApplicationSecurityWafCustomRuleActionParameters(arg: None)¶

class ApplicationSecurityWafCustomRuleActionParameters(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleActionParameters(*args, **kwargs)

Bases: ModelNormal

The definition of ApplicationSecurityWafCustomRuleActionParameters object.

Parameters:

location (str, optional) – The location to redirect to when the WAF custom rule triggers.
status_code (int, optional) – The status code to return when the WAF custom rule triggers.

datadog_api_client.v2.model.application_security_waf_custom_rule_attributes module¶

class ApplicationSecurityWafCustomRuleAttributes(arg: None)¶

class ApplicationSecurityWafCustomRuleAttributes(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleAttributes(*args, **kwargs)

Bases: ModelNormal

A WAF custom rule.

Parameters:

action (ApplicationSecurityWafCustomRuleAction, optional) – The definition of ApplicationSecurityWafCustomRuleAction object.
blocking (bool) – Indicates whether the WAF custom rule will block the request.
conditions ([ApplicationSecurityWafCustomRuleCondition]) – Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF rule to trigger.
enabled (bool) – Indicates whether the WAF custom rule is enabled.
metadata (ApplicationSecurityWafCustomRuleMetadata, optional) – Metadata associated with the WAF Custom Rule.
name (str) – The Name of the WAF custom rule.
path_glob (str, optional) – The path glob for the WAF custom rule.
scope ([ApplicationSecurityWafCustomRuleScope], optional) – The scope of the WAF custom rule.
tags (ApplicationSecurityWafCustomRuleTags) – Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces.

datadog_api_client.v2.model.application_security_waf_custom_rule_condition module¶

class ApplicationSecurityWafCustomRuleCondition(arg: None)¶

class ApplicationSecurityWafCustomRuleCondition(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleCondition(*args, **kwargs)

Bases: ModelNormal

One condition of the WAF Custom Rule.

Parameters:

operator (ApplicationSecurityWafCustomRuleConditionOperator) – Operator to use for the WAF Condition.
parameters (ApplicationSecurityWafCustomRuleConditionParameters) – The scope of the WAF custom rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_condition_input module¶

class ApplicationSecurityWafCustomRuleConditionInput(arg: None)¶

class ApplicationSecurityWafCustomRuleConditionInput(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleConditionInput(*args, **kwargs)

Bases: ModelNormal

Input from the request on which the condition should apply.

Parameters:

address (ApplicationSecurityWafCustomRuleConditionInputAddress) – Input from the request on which the condition should apply.
key_path ([str], optional) – Specific path for the input.

datadog_api_client.v2.model.application_security_waf_custom_rule_condition_input_address module¶

class ApplicationSecurityWafCustomRuleConditionInputAddress(arg: None)¶

class ApplicationSecurityWafCustomRuleConditionInputAddress(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleConditionInputAddress(*args, **kwargs)

Bases: ModelSimple

Input from the request on which the condition should apply.

Parameters:

value (str) – Must be one of [“server.db.statement”, “server.io.fs.file”, “server.io.net.url”, “server.sys.shell.cmd”, “server.request.method”, “server.request.uri.raw”, “server.request.path_params”, “server.request.query”, “server.request.headers.no_cookies”, “server.request.cookies”, “server.request.trailers”, “server.request.body”, “server.response.status”, “server.response.headers.no_cookies”, “server.response.trailers”, “grpc.server.request.metadata”, “grpc.server.request.message”, “grpc.server.method”, “graphql.server.all_resolvers”, “usr.id”, “http.client_ip”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_custom_rule_condition_operator module¶

class ApplicationSecurityWafCustomRuleConditionOperator(arg: None)¶

class ApplicationSecurityWafCustomRuleConditionOperator(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleConditionOperator(*args, **kwargs)

Bases: ModelSimple

Operator to use for the WAF Condition.

Parameters:

value (str) – Must be one of [“match_regex”, “!match_regex”, “phrase_match”, “!phrase_match”, “is_xss”, “is_sqli”, “exact_match”, “!exact_match”, “ip_match”, “!ip_match”, “capture_data”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_custom_rule_condition_options module¶

class ApplicationSecurityWafCustomRuleConditionOptions(arg: None)¶

class ApplicationSecurityWafCustomRuleConditionOptions(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleConditionOptions(*args, **kwargs)

Bases: ModelNormal

Options for the operator of this condition.

Parameters:

case_sensitive (bool, optional) – Evaluate the value as case sensitive.
min_length (int, optional) – Only evaluate this condition if the value has a minimum amount of characters.

datadog_api_client.v2.model.application_security_waf_custom_rule_condition_parameters module¶

class ApplicationSecurityWafCustomRuleConditionParameters(arg: None)¶

class ApplicationSecurityWafCustomRuleConditionParameters(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleConditionParameters(*args, **kwargs)

Bases: ModelNormal

The scope of the WAF custom rule.

Parameters:

data (str, optional) – Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter.
inputs ([ApplicationSecurityWafCustomRuleConditionInput]) – List of inputs on which at least one should match with the given operator.
list ([str], optional) – List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator.
options (ApplicationSecurityWafCustomRuleConditionOptions, optional) – Options for the operator of this condition.
regex (str, optional) – Regex to use with the condition. Only used with match_regex and !match_regex operator.
value (str, optional) – Store the captured value in the specified tag name. Only used with the capture_data operator.

datadog_api_client.v2.model.application_security_waf_custom_rule_create_attributes module¶

class ApplicationSecurityWafCustomRuleCreateAttributes(arg: None)¶

class ApplicationSecurityWafCustomRuleCreateAttributes(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Create a new WAF custom rule.

Parameters:

action (ApplicationSecurityWafCustomRuleAction, optional) – The definition of ApplicationSecurityWafCustomRuleAction object.
blocking (bool) – Indicates whether the WAF custom rule will block the request.
conditions ([ApplicationSecurityWafCustomRuleCondition]) – Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF rule to trigger
enabled (bool) – Indicates whether the WAF custom rule is enabled.
name (str) – The Name of the WAF custom rule.
path_glob (str, optional) – The path glob for the WAF custom rule.
scope ([ApplicationSecurityWafCustomRuleScope], optional) – The scope of the WAF custom rule.
tags (ApplicationSecurityWafCustomRuleTags) – Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces.

datadog_api_client.v2.model.application_security_waf_custom_rule_create_data module¶

class ApplicationSecurityWafCustomRuleCreateData(arg: None)¶

class ApplicationSecurityWafCustomRuleCreateData(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single WAF custom rule.

Parameters:

attributes (ApplicationSecurityWafCustomRuleCreateAttributes) – Create a new WAF custom rule.
type (ApplicationSecurityWafCustomRuleType) – The type of the resource. The value should always be custom_rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_create_request module¶

class ApplicationSecurityWafCustomRuleCreateRequest(arg: None)¶

class ApplicationSecurityWafCustomRuleCreateRequest(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the custom rule to create.

Parameters:: data (ApplicationSecurityWafCustomRuleCreateData) – Object for a single WAF custom rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_data module¶

class ApplicationSecurityWafCustomRuleData(arg: None)¶

class ApplicationSecurityWafCustomRuleData(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleData(*args, **kwargs)

Bases: ModelNormal

Object for a single WAF custom rule.

Parameters:

attributes (ApplicationSecurityWafCustomRuleAttributes, optional) – A WAF custom rule.
id (str, optional) – The ID of the custom rule.
type (ApplicationSecurityWafCustomRuleType, optional) – The type of the resource. The value should always be custom_rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_list_response module¶

class ApplicationSecurityWafCustomRuleListResponse(arg: None)¶

class ApplicationSecurityWafCustomRuleListResponse(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleListResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a list of WAF custom rules.

Parameters:: data ([ApplicationSecurityWafCustomRuleData], optional) – The WAF custom rule data.

datadog_api_client.v2.model.application_security_waf_custom_rule_metadata module¶

class ApplicationSecurityWafCustomRuleMetadata(arg: None)¶

class ApplicationSecurityWafCustomRuleMetadata(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata associated with the WAF Custom Rule.

Parameters:

added_at (datetime, optional) – The date and time the WAF custom rule was created.
added_by (str, optional) – The handle of the user who created the WAF custom rule.
added_by_name (str, optional) – The name of the user who created the WAF custom rule.
modified_at (datetime, optional) – The date and time the WAF custom rule was last updated.
modified_by (str, optional) – The handle of the user who last updated the WAF custom rule.
modified_by_name (str, optional) – The name of the user who last updated the WAF custom rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_response module¶

class ApplicationSecurityWafCustomRuleResponse(arg: None)¶

class ApplicationSecurityWafCustomRuleResponse(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a single WAF custom rule.

Parameters:: data (ApplicationSecurityWafCustomRuleData, optional) – Object for a single WAF custom rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_scope module¶

class ApplicationSecurityWafCustomRuleScope(arg: None)¶

class ApplicationSecurityWafCustomRuleScope(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleScope(*args, **kwargs)

Bases: ModelNormal

The scope of the WAF custom rule.

Parameters:

env (str) – The environment scope for the WAF custom rule.
service (str) – The service scope for the WAF custom rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_tags module¶

class ApplicationSecurityWafCustomRuleTags(arg: None)¶

class ApplicationSecurityWafCustomRuleTags(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleTags(*args, **kwargs)

Bases: ModelNormal

Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces.

Parameters:

category (ApplicationSecurityWafCustomRuleTagsCategory) – The category of the WAF Rule, can be either business_logic , attack_attempt or security_response.
type (str) – The type of the WAF rule, associated with the category will form the security activity.

datadog_api_client.v2.model.application_security_waf_custom_rule_tags_category module¶

class ApplicationSecurityWafCustomRuleTagsCategory(arg: None)¶

class ApplicationSecurityWafCustomRuleTagsCategory(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleTagsCategory(*args, **kwargs)

Bases: ModelSimple

The category of the WAF Rule, can be either business_logic, attack_attempt or security_response.

Parameters:

value (str) – Must be one of [“attack_attempt”, “business_logic”, “security_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_custom_rule_type module¶

class ApplicationSecurityWafCustomRuleType(arg: None)¶

class ApplicationSecurityWafCustomRuleType(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be custom_rule.

Parameters:

value (str) – If omitted defaults to “custom_rule”. Must be one of [“custom_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_custom_rule_update_attributes module¶

class ApplicationSecurityWafCustomRuleUpdateAttributes(arg: None)¶

class ApplicationSecurityWafCustomRuleUpdateAttributes(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Update a WAF custom rule.

Parameters:

action (ApplicationSecurityWafCustomRuleAction, optional) – The definition of ApplicationSecurityWafCustomRuleAction object.
blocking (bool) – Indicates whether the WAF custom rule will block the request.
conditions ([ApplicationSecurityWafCustomRuleCondition]) – Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF rule to trigger.
enabled (bool) – Indicates whether the WAF custom rule is enabled.
name (str) – The Name of the WAF custom rule.
path_glob (str, optional) – The path glob for the WAF custom rule.
scope ([ApplicationSecurityWafCustomRuleScope], optional) – The scope of the WAF custom rule.
tags (ApplicationSecurityWafCustomRuleTags) – Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security activity field associated with the traces.

datadog_api_client.v2.model.application_security_waf_custom_rule_update_data module¶

class ApplicationSecurityWafCustomRuleUpdateData(arg: None)¶

class ApplicationSecurityWafCustomRuleUpdateData(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single WAF Custom Rule.

Parameters:

attributes (ApplicationSecurityWafCustomRuleUpdateAttributes) – Update a WAF custom rule.
type (ApplicationSecurityWafCustomRuleType) – The type of the resource. The value should always be custom_rule.

datadog_api_client.v2.model.application_security_waf_custom_rule_update_request module¶

class ApplicationSecurityWafCustomRuleUpdateRequest(arg: None)¶

class ApplicationSecurityWafCustomRuleUpdateRequest(arg: ModelComposed)

class ApplicationSecurityWafCustomRuleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the Custom Rule to update.

Parameters:: data (ApplicationSecurityWafCustomRuleUpdateData) – Object for a single WAF Custom Rule.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_attributes module¶

class ApplicationSecurityWafExclusionFilterAttributes(arg: None)¶

class ApplicationSecurityWafExclusionFilterAttributes(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes describing a WAF exclusion filter.

Parameters:

description (str, optional) – A description for the exclusion filter.
enabled (bool, optional) – Indicates whether the exclusion filter is enabled.
event_query (str, optional) – The event query matched by the legacy exclusion filter. Cannot be created nor updated.
ip_list ([str], optional) – The client IP addresses matched by the exclusion filter (CIDR notation is supported).
metadata (ApplicationSecurityWafExclusionFilterMetadata, optional) – Extra information about the exclusion filter.
on_match (ApplicationSecurityWafExclusionFilterOnMatch, optional) – The action taken when the exclusion filter matches. When set to monitor , security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked.
parameters ([str], optional) – A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
path_glob (str, optional) – The HTTP path glob expression matched by the exclusion filter.
rules_target ([ApplicationSecurityWafExclusionFilterRulesTarget], optional) – The WAF rules targeted by the exclusion filter.
scope ([ApplicationSecurityWafExclusionFilterScope], optional) – The services where the exclusion filter is deployed.
search_query (str, optional) – Generated event search query for traces matching the exclusion filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_create_attributes module¶

class ApplicationSecurityWafExclusionFilterCreateAttributes(arg: None)¶

class ApplicationSecurityWafExclusionFilterCreateAttributes(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for creating a WAF exclusion filter.

Parameters:

description (str) – A description for the exclusion filter.
enabled (bool) – Indicates whether the exclusion filter is enabled.
ip_list ([str], optional) – The client IP addresses matched by the exclusion filter (CIDR notation is supported).
on_match (ApplicationSecurityWafExclusionFilterOnMatch, optional) – The action taken when the exclusion filter matches. When set to monitor , security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked.
parameters ([str], optional) – A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
path_glob (str, optional) – The HTTP path glob expression matched by the exclusion filter.
rules_target ([ApplicationSecurityWafExclusionFilterRulesTarget], optional) – The WAF rules targeted by the exclusion filter.
scope ([ApplicationSecurityWafExclusionFilterScope], optional) – The services where the exclusion filter is deployed.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_create_data module¶

class ApplicationSecurityWafExclusionFilterCreateData(arg: None)¶

class ApplicationSecurityWafExclusionFilterCreateData(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterCreateData(*args, **kwargs)

Bases: ModelNormal

Object for creating a single WAF exclusion filter.

Parameters:

attributes (ApplicationSecurityWafExclusionFilterCreateAttributes) – Attributes for creating a WAF exclusion filter.
type (ApplicationSecurityWafExclusionFilterType) – Type of the resource. The value should always be exclusion_filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_create_request module¶

class ApplicationSecurityWafExclusionFilterCreateRequest(arg: None)¶

class ApplicationSecurityWafExclusionFilterCreateRequest(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object for creating a single WAF exclusion filter.

Parameters:: data (ApplicationSecurityWafExclusionFilterCreateData) – Object for creating a single WAF exclusion filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_metadata module¶

class ApplicationSecurityWafExclusionFilterMetadata(arg: None)¶

class ApplicationSecurityWafExclusionFilterMetadata(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterMetadata(*args, **kwargs)

Bases: ModelNormal

Extra information about the exclusion filter.

Parameters:

added_at (datetime, optional) – The creation date of the exclusion filter.
added_by (str, optional) – The handle of the user who created the exclusion filter.
added_by_name (str, optional) – The name of the user who created the exclusion filter.
modified_at (datetime, optional) – The last modification date of the exclusion filter.
modified_by (str, optional) – The handle of the user who last modified the exclusion filter.
modified_by_name (str, optional) – The name of the user who last modified the exclusion filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_on_match module¶

class ApplicationSecurityWafExclusionFilterOnMatch(arg: None)¶

class ApplicationSecurityWafExclusionFilterOnMatch(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterOnMatch(*args, **kwargs)

Bases: ModelSimple

The action taken when the exclusion filter matches. When set to monitor, security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked.

Parameters:

value (str) – If omitted defaults to “monitor”. Must be one of [“monitor”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_resource module¶

class ApplicationSecurityWafExclusionFilterResource(arg: None)¶

class ApplicationSecurityWafExclusionFilterResource(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterResource(*args, **kwargs)

Bases: ModelNormal

A JSON:API resource for an WAF exclusion filter.

Parameters:

attributes (ApplicationSecurityWafExclusionFilterAttributes, optional) – Attributes describing a WAF exclusion filter.
id (str, optional) – The identifier of the WAF exclusion filter.
type (ApplicationSecurityWafExclusionFilterType, optional) – Type of the resource. The value should always be exclusion_filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_response module¶

class ApplicationSecurityWafExclusionFilterResponse(arg: None)¶

class ApplicationSecurityWafExclusionFilterResponse(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterResponse(*args, **kwargs)

Bases: ModelNormal

Response object for a single WAF exclusion filter.

Parameters:: data (ApplicationSecurityWafExclusionFilterResource, optional) – A JSON:API resource for an WAF exclusion filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_rules_target module¶

class ApplicationSecurityWafExclusionFilterRulesTarget(arg: None)¶

class ApplicationSecurityWafExclusionFilterRulesTarget(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterRulesTarget(*args, **kwargs)

Bases: ModelNormal

Target WAF rules based either on an identifier or tags.

Parameters:

rule_id (str, optional) – Target a single WAF rule based on its identifier.
tags (ApplicationSecurityWafExclusionFilterRulesTargetTags, optional) – Target multiple WAF rules based on their tags.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_rules_target_tags module¶

class ApplicationSecurityWafExclusionFilterRulesTargetTags(arg: None)¶

class ApplicationSecurityWafExclusionFilterRulesTargetTags(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterRulesTargetTags(*args, **kwargs)

Bases: ModelNormal

Target multiple WAF rules based on their tags.

Parameters:

category (str, optional) – The category of the targeted WAF rules.
type (str, optional) – The type of the targeted WAF rules.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_scope module¶

class ApplicationSecurityWafExclusionFilterScope(arg: None)¶

class ApplicationSecurityWafExclusionFilterScope(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterScope(*args, **kwargs)

Bases: ModelNormal

Deploy on services based on their environment and/or service name.

Parameters:

env (str, optional) – Deploy on this environment.
service (str, optional) – Deploy on this service.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_type module¶

class ApplicationSecurityWafExclusionFilterType(arg: None)¶

class ApplicationSecurityWafExclusionFilterType(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterType(*args, **kwargs)

Bases: ModelSimple

Type of the resource. The value should always be exclusion_filter.

Parameters:

value (str) – If omitted defaults to “exclusion_filter”. Must be one of [“exclusion_filter”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_update_attributes module¶

class ApplicationSecurityWafExclusionFilterUpdateAttributes(arg: None)¶

class ApplicationSecurityWafExclusionFilterUpdateAttributes(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for updating a WAF exclusion filter.

Parameters:

description (str) – A description for the exclusion filter.
enabled (bool) – Indicates whether the exclusion filter is enabled.
ip_list ([str], optional) – The client IP addresses matched by the exclusion filter (CIDR notation is supported).
on_match (ApplicationSecurityWafExclusionFilterOnMatch, optional) – The action taken when the exclusion filter matches. When set to monitor , security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked.
parameters ([str], optional) – A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
path_glob (str, optional) – The HTTP path glob expression matched by the exclusion filter.
rules_target ([ApplicationSecurityWafExclusionFilterRulesTarget], optional) – The WAF rules targeted by the exclusion filter.
scope ([ApplicationSecurityWafExclusionFilterScope], optional) – The services where the exclusion filter is deployed.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_update_data module¶

class ApplicationSecurityWafExclusionFilterUpdateData(arg: None)¶

class ApplicationSecurityWafExclusionFilterUpdateData(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for updating a single WAF exclusion filter.

Parameters:

attributes (ApplicationSecurityWafExclusionFilterUpdateAttributes) – Attributes for updating a WAF exclusion filter.
type (ApplicationSecurityWafExclusionFilterType) – Type of the resource. The value should always be exclusion_filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filter_update_request module¶

class ApplicationSecurityWafExclusionFilterUpdateRequest(arg: None)¶

class ApplicationSecurityWafExclusionFilterUpdateRequest(arg: ModelComposed)

class ApplicationSecurityWafExclusionFilterUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object for updating a single WAF exclusion filter.

Parameters:: data (ApplicationSecurityWafExclusionFilterUpdateData) – Object for updating a single WAF exclusion filter.

datadog_api_client.v2.model.application_security_waf_exclusion_filters_response module¶

class ApplicationSecurityWafExclusionFiltersResponse(arg: None)¶

class ApplicationSecurityWafExclusionFiltersResponse(arg: ModelComposed)

class ApplicationSecurityWafExclusionFiltersResponse(*args, **kwargs)

Bases: ModelNormal

Response object for multiple WAF exclusion filters.

Parameters:: data ([ApplicationSecurityWafExclusionFilterResource], optional) – A list of WAF exclusion filters.

datadog_api_client.v2.model.apps_sort_field module¶

class AppsSortField(arg: None)¶

class AppsSortField(arg: ModelComposed)

class AppsSortField(*args, **kwargs)

Bases: ModelSimple

The field and direction to sort apps by

Parameters:

value (str) – Must be one of [“name”, “created_at”, “updated_at”, “user_name”, “-name”, “-created_at”, “-updated_at”, “-user_name”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.arbitrary_cost_upsert_request module¶

class ArbitraryCostUpsertRequest(arg: None)¶

class ArbitraryCostUpsertRequest(arg: ModelComposed)

class ArbitraryCostUpsertRequest(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequest object.

Parameters:: data (ArbitraryCostUpsertRequestData, optional) – The definition of ArbitraryCostUpsertRequestData object.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data module¶

class ArbitraryCostUpsertRequestData(arg: None)¶

class ArbitraryCostUpsertRequestData(arg: ModelComposed)

class ArbitraryCostUpsertRequestData(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestData object.

Parameters:

attributes (ArbitraryCostUpsertRequestDataAttributes, optional) – The definition of ArbitraryCostUpsertRequestDataAttributes object.
id (str, optional) – The ArbitraryCostUpsertRequestData id.
type (ArbitraryCostUpsertRequestDataType) – Upsert arbitrary rule resource type.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes module¶

class ArbitraryCostUpsertRequestDataAttributes(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributes(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributes object.

Parameters:

costs_to_allocate ([ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems]) – The attributes costs_to_allocate.
enabled (bool, optional) – The attributes enabled.
order_id (int, optional) – The attributes order_id.
provider ([str]) – The attributes provider.
rejected (bool, optional) – The attributes rejected.
rule_name (str) – The attributes rule_name.
strategy (ArbitraryCostUpsertRequestDataAttributesStrategy) – The definition of ArbitraryCostUpsertRequestDataAttributesStrategy object.
type (str) – The attributes type.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_costs_to_allocate_items module¶

class ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_strategy module¶

class ArbitraryCostUpsertRequestDataAttributesStrategy(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesStrategy(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesStrategy(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesStrategy object.

Parameters:

allocated_by ([ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems], optional) – The strategy allocated_by.
allocated_by_filters ([ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems], optional) – The strategy allocated_by_filters.
allocated_by_tag_keys ([str], optional) – The strategy allocated_by_tag_keys.
based_on_costs ([ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems], optional) – The strategy based_on_costs.
based_on_timeseries ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The strategy based_on_timeseries.
evaluate_grouped_by_filters ([ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems], optional) – The strategy evaluate_grouped_by_filters.
evaluate_grouped_by_tag_keys ([str], optional) – The strategy evaluate_grouped_by_tag_keys.
granularity (str, optional) – The strategy granularity.
method (str) – The strategy method.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_strategy_allocated_by_filters_items module¶

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_strategy_allocated_by_items module¶

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems object.

Parameters:

allocated_tags ([ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems]) – The items allocated_tags.
percentage (float) – The items percentage. The numeric value format should be a 32bit float value.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_strategy_allocated_by_items_allocated_tags_items module¶

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems object.

Parameters:

key (str) – The items key.
value (str) – The items value.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_strategy_based_on_costs_items module¶

class ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_attributes_strategy_evaluate_grouped_by_filters_items module¶

class ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems(arg: None)¶

class ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_cost_upsert_request_data_type module¶

class ArbitraryCostUpsertRequestDataType(arg: None)¶

class ArbitraryCostUpsertRequestDataType(arg: ModelComposed)

class ArbitraryCostUpsertRequestDataType(*args, **kwargs)

Bases: ModelSimple

Upsert arbitrary rule resource type.

Parameters:

value (str) – If omitted defaults to “upsert_arbitrary_rule”. Must be one of [“upsert_arbitrary_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.arbitrary_rule_response module¶

class ArbitraryRuleResponse(arg: None)¶

class ArbitraryRuleResponse(arg: ModelComposed)

class ArbitraryRuleResponse(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponse object.

Parameters:: data (ArbitraryRuleResponseData, optional) – The definition of ArbitraryRuleResponseData object.

datadog_api_client.v2.model.arbitrary_rule_response_array module¶

class ArbitraryRuleResponseArray(arg: None)¶

class ArbitraryRuleResponseArray(arg: ModelComposed)

class ArbitraryRuleResponseArray(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseArray object.

Parameters:

data ([ArbitraryRuleResponseData]) – The ArbitraryRuleResponseArray data.
meta (ArbitraryRuleResponseArrayMeta, optional) – The ArbitraryRuleResponseArray meta.

datadog_api_client.v2.model.arbitrary_rule_response_array_meta module¶

class ArbitraryRuleResponseArrayMeta(arg: None)¶

class ArbitraryRuleResponseArrayMeta(arg: ModelComposed)

class ArbitraryRuleResponseArrayMeta(*args, **kwargs)

Bases: ModelNormal

The ArbitraryRuleResponseArray meta.

Parameters:: total_count (int, optional) – The meta total_count.

datadog_api_client.v2.model.arbitrary_rule_response_data module¶

class ArbitraryRuleResponseData(arg: None)¶

class ArbitraryRuleResponseData(arg: ModelComposed)

class ArbitraryRuleResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseData object.

Parameters:

attributes (ArbitraryRuleResponseDataAttributes, optional) – The definition of ArbitraryRuleResponseDataAttributes object.
id (str, optional) – The ArbitraryRuleResponseData id.
type (ArbitraryRuleResponseDataType) – Arbitrary rule resource type.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes module¶

class ArbitraryRuleResponseDataAttributes(arg: None)¶

class ArbitraryRuleResponseDataAttributes(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributes object.

Parameters:

costs_to_allocate ([ArbitraryRuleResponseDataAttributesCostsToAllocateItems]) – The attributes costs_to_allocate.
created (datetime) – The attributes created.
enabled (bool) – The attributes enabled.
last_modified_user_uuid (str) – The attributes last_modified_user_uuid.
order_id (int) – The attributes order_id.
processing_status (str, optional) – The attributes processing_status.
provider ([str]) – The attributes provider.
rejected (bool, optional) – The attributes rejected.
rule_name (str) – The attributes rule_name.
strategy (ArbitraryRuleResponseDataAttributesStrategy) – The definition of ArbitraryRuleResponseDataAttributesStrategy object.
type (str) – The attributes type.
updated (datetime) – The attributes updated.
version (int) – The attributes version.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_costs_to_allocate_items module¶

class ArbitraryRuleResponseDataAttributesCostsToAllocateItems(arg: None)¶

class ArbitraryRuleResponseDataAttributesCostsToAllocateItems(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesCostsToAllocateItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesCostsToAllocateItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_strategy module¶

class ArbitraryRuleResponseDataAttributesStrategy(arg: None)¶

class ArbitraryRuleResponseDataAttributesStrategy(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesStrategy(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesStrategy object.

Parameters:

allocated_by ([ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems], optional) – The strategy allocated_by.
allocated_by_filters ([ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems], optional) – The strategy allocated_by_filters.
allocated_by_tag_keys ([str], optional) – The strategy allocated_by_tag_keys.
based_on_costs ([ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems], optional) – The strategy based_on_costs.
based_on_timeseries ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The rule strategy based_on_timeseries.
evaluate_grouped_by_filters ([ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems], optional) – The strategy evaluate_grouped_by_filters.
evaluate_grouped_by_tag_keys ([str], optional) – The strategy evaluate_grouped_by_tag_keys.
granularity (str, optional) – The strategy granularity.
method (str) – The strategy method.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_strategy_allocated_by_filters_items module¶

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems(arg: None)¶

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_strategy_allocated_by_items module¶

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems(arg: None)¶

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems object.

Parameters:

allocated_tags ([ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems]) – The items allocated_tags.
percentage (float) – The items percentage. The numeric value format should be a 32bit float value.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_strategy_allocated_by_items_allocated_tags_items module¶

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems(arg: None)¶

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems object.

Parameters:

key (str) – The items key.
value (str) – The items value.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_strategy_based_on_costs_items module¶

class ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems(arg: None)¶

class ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_rule_response_data_attributes_strategy_evaluate_grouped_by_filters_items module¶

class ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems(arg: None)¶

class ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems(arg: ModelComposed)

class ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems(*args, **kwargs)

Bases: ModelNormal

The definition of ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems object.

Parameters:

condition (str) – The items condition.
tag (str) – The items tag.
value (str, optional) – The items value.
values ([str], none_type, optional) – The items values.

datadog_api_client.v2.model.arbitrary_rule_response_data_type module¶

class ArbitraryRuleResponseDataType(arg: None)¶

class ArbitraryRuleResponseDataType(arg: ModelComposed)

class ArbitraryRuleResponseDataType(*args, **kwargs)

Bases: ModelSimple

Arbitrary rule resource type.

Parameters:

value (str) – If omitted defaults to “arbitrary_rule”. Must be one of [“arbitrary_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.asana_access_token module¶

class AsanaAccessToken(arg: None)¶

class AsanaAccessToken(arg: ModelComposed)

class AsanaAccessToken(*args, **kwargs)

Bases: ModelNormal

The definition of the AsanaAccessToken object.

Parameters:

access_token (str) – The AsanaAccessToken access_token.
type (AsanaAccessTokenType) – The definition of the AsanaAccessToken object.

datadog_api_client.v2.model.asana_access_token_type module¶

class AsanaAccessTokenType(arg: None)¶

class AsanaAccessTokenType(arg: ModelComposed)

class AsanaAccessTokenType(*args, **kwargs)

Bases: ModelSimple

The definition of the AsanaAccessToken object.

Parameters:

value (str) – If omitted defaults to “AsanaAccessToken”. Must be one of [“AsanaAccessToken”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.asana_access_token_update module¶

class AsanaAccessTokenUpdate(arg: None)¶

class AsanaAccessTokenUpdate(arg: ModelComposed)

class AsanaAccessTokenUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the AsanaAccessToken object.

Parameters:

access_token (str, optional) – The AsanaAccessTokenUpdate access_token.
type (AsanaAccessTokenType) – The definition of the AsanaAccessToken object.

datadog_api_client.v2.model.asana_credentials module¶

class AsanaCredentials(arg: None)¶

class AsanaCredentials(arg: ModelComposed)

class AsanaCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the AsanaCredentials object.

Parameters:

access_token (str) – The AsanaAccessToken access_token.
type (AsanaAccessTokenType) – The definition of the AsanaAccessToken object.

datadog_api_client.v2.model.asana_credentials_update module¶

class AsanaCredentialsUpdate(arg: None)¶

class AsanaCredentialsUpdate(arg: ModelComposed)

class AsanaCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the AsanaCredentialsUpdate object.

Parameters:

access_token (str, optional) – The AsanaAccessTokenUpdate access_token.
type (AsanaAccessTokenType) – The definition of the AsanaAccessToken object.

datadog_api_client.v2.model.asana_integration module¶

class AsanaIntegration(arg: None)¶

class AsanaIntegration(arg: ModelComposed)

class AsanaIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the AsanaIntegration object.

Parameters:

credentials (AsanaCredentials) – The definition of the AsanaCredentials object.
type (AsanaIntegrationType) – The definition of the AsanaIntegrationType object.

datadog_api_client.v2.model.asana_integration_type module¶

class AsanaIntegrationType(arg: None)¶

class AsanaIntegrationType(arg: ModelComposed)

class AsanaIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the AsanaIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Asana”. Must be one of [“Asana”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.asana_integration_update module¶

class AsanaIntegrationUpdate(arg: None)¶

class AsanaIntegrationUpdate(arg: ModelComposed)

class AsanaIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the AsanaIntegrationUpdate object.

Parameters:

credentials (AsanaCredentialsUpdate, optional) – The definition of the AsanaCredentialsUpdate object.
type (AsanaIntegrationType) – The definition of the AsanaIntegrationType object.

datadog_api_client.v2.model.asset module¶

class Asset(arg: None)¶

class Asset(arg: ModelComposed)

class Asset(*args, **kwargs)

Bases: ModelNormal

A single vulnerable asset

Parameters:

attributes (AssetAttributes) – The JSON:API attributes of the asset.
id (str) – The unique ID for this asset.
type (AssetEntityType) – The JSON:API type.

datadog_api_client.v2.model.asset_attributes module¶

class AssetAttributes(arg: None)¶

class AssetAttributes(arg: ModelComposed)

class AssetAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes of the asset.

Parameters:

arch (str, optional) – Asset architecture.
environments ([str]) – List of environments where the asset is deployed.
name (str) – Asset name.
operating_system (AssetOperatingSystem, optional) – Asset operating system.
risks (AssetRisks) – Asset risks.
teams ([str], optional) – List of teams that own the asset.
type (AssetType) – The asset type
version (AssetVersion, optional) – Asset version.

datadog_api_client.v2.model.asset_entity_type module¶

class AssetEntityType(arg: None)¶

class AssetEntityType(arg: ModelComposed)

class AssetEntityType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type.

Parameters:

value (str) – If omitted defaults to “assets”. Must be one of [“assets”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.asset_operating_system module¶

class AssetOperatingSystem(arg: None)¶

class AssetOperatingSystem(arg: ModelComposed)

class AssetOperatingSystem(*args, **kwargs)

Bases: ModelNormal

Asset operating system.

Parameters:

description (str, optional) – Operating system version.
name (str) – Operating system name.

datadog_api_client.v2.model.asset_risks module¶

class AssetRisks(arg: None)¶

class AssetRisks(arg: ModelComposed)

class AssetRisks(*args, **kwargs)

Bases: ModelNormal

Asset risks.

Parameters:

has_access_to_sensitive_data (bool, optional) – Whether the asset has access to sensitive data or not.
has_privileged_access (bool, optional) – Whether the asset has privileged access or not.
in_production (bool) – Whether the asset is in production or not.
is_publicly_accessible (bool, optional) – Whether the asset is publicly accessible or not.
under_attack (bool, optional) – Whether the asset is under attack or not.

datadog_api_client.v2.model.asset_type module¶

class AssetType(arg: None)¶

class AssetType(arg: ModelComposed)

class AssetType(*args, **kwargs)

Bases: ModelSimple

The asset type

Parameters:

value (str) – Must be one of [“Repository”, “Service”, “Host”, “HostImage”, “Image”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.audit_logs_event module¶

class AuditLogsEvent(arg: None)¶

class AuditLogsEvent(arg: ModelComposed)

class AuditLogsEvent(*args, **kwargs)

Bases: ModelNormal

Object description of an Audit Logs event after it is processed and stored by Datadog.

Parameters:

attributes (AuditLogsEventAttributes, optional) – JSON object containing all event attributes and their associated values.
id (str, optional) – Unique ID of the event.
type (AuditLogsEventType, optional) – Type of the event.

datadog_api_client.v2.model.audit_logs_event_attributes module¶

class AuditLogsEventAttributes(arg: None)¶

class AuditLogsEventAttributes(arg: ModelComposed)

class AuditLogsEventAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all event attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of attributes from Audit Logs events.
message (str, optional) – Message of the event.
service (str, optional) – Name of the application or service generating Audit Logs events. This name is used to correlate Audit Logs to APM, so make sure you specify the same value when you use both products.
tags ([str], optional) – Array of tags associated with your event.
timestamp (datetime, optional) – Timestamp of your event.

datadog_api_client.v2.model.audit_logs_event_type module¶

class AuditLogsEventType(arg: None)¶

class AuditLogsEventType(arg: ModelComposed)

class AuditLogsEventType(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “audit”. Must be one of [“audit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.audit_logs_events_response module¶

class AuditLogsEventsResponse(arg: None)¶

class AuditLogsEventsResponse(arg: ModelComposed)

class AuditLogsEventsResponse(*args, **kwargs)

Bases: ModelNormal

Response object with all events matching the request and pagination information.

Parameters:

data ([AuditLogsEvent], optional) – Array of events matching the request.
links (AuditLogsResponseLinks, optional) – Links attributes.
meta (AuditLogsResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.audit_logs_query_filter module¶

class AuditLogsQueryFilter(arg: None)¶

class AuditLogsQueryFilter(arg: ModelComposed)

class AuditLogsQueryFilter(*args, **kwargs)

Bases: ModelNormal

Search and filter query settings.

Parameters:

_from (str, optional) – Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).
query (str, optional) – Search query following the Audit Logs search syntax.
to (str, optional) – Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).

datadog_api_client.v2.model.audit_logs_query_options module¶

class AuditLogsQueryOptions(arg: None)¶

class AuditLogsQueryOptions(arg: ModelComposed)

class AuditLogsQueryOptions(*args, **kwargs)

Bases: ModelNormal

Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.

Parameters:

time_offset (int, optional) – Time offset (in seconds) to apply to the query.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

datadog_api_client.v2.model.audit_logs_query_page_options module¶

class AuditLogsQueryPageOptions(arg: None)¶

class AuditLogsQueryPageOptions(arg: ModelComposed)

class AuditLogsQueryPageOptions(*args, **kwargs)

Bases: ModelNormal

Paging attributes for listing events.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous query.
limit (int, optional) – Maximum number of events in the response.

datadog_api_client.v2.model.audit_logs_response_links module¶

class AuditLogsResponseLinks(arg: None)¶

class AuditLogsResponseLinks(arg: ModelComposed)

class AuditLogsResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. Note that the request can also be made using the POST endpoint.

datadog_api_client.v2.model.audit_logs_response_metadata module¶

class AuditLogsResponseMetadata(arg: None)¶

class AuditLogsResponseMetadata(arg: ModelComposed)

class AuditLogsResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – Time elapsed in milliseconds.
page (AuditLogsResponsePage, optional) – Paging attributes.
request_id (str, optional) – The identifier of the request.
status (AuditLogsResponseStatus, optional) – The status of the response.
warnings ([AuditLogsWarning], optional) – A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.

datadog_api_client.v2.model.audit_logs_response_page module¶

class AuditLogsResponsePage(arg: None)¶

class AuditLogsResponsePage(arg: ModelComposed)

class AuditLogsResponsePage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor].

datadog_api_client.v2.model.audit_logs_response_status module¶

class AuditLogsResponseStatus(arg: None)¶

class AuditLogsResponseStatus(arg: ModelComposed)

class AuditLogsResponseStatus(*args, **kwargs)

Bases: ModelSimple

The status of the response.

Parameters:

value (str) – Must be one of [“done”, “timeout”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.audit_logs_search_events_request module¶

class AuditLogsSearchEventsRequest(arg: None)¶

class AuditLogsSearchEventsRequest(arg: ModelComposed)

class AuditLogsSearchEventsRequest(*args, **kwargs)

Bases: ModelNormal

The request for a Audit Logs events list.

Parameters:

filter (AuditLogsQueryFilter, optional) – Search and filter query settings.
options (AuditLogsQueryOptions, optional) – Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.
page (AuditLogsQueryPageOptions, optional) – Paging attributes for listing events.
sort (AuditLogsSort, optional) – Sort parameters when querying events.

datadog_api_client.v2.model.audit_logs_sort module¶

class AuditLogsSort(arg: None)¶

class AuditLogsSort(arg: ModelComposed)

class AuditLogsSort(*args, **kwargs)

Bases: ModelSimple

Sort parameters when querying events.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.audit_logs_warning module¶

class AuditLogsWarning(arg: None)¶

class AuditLogsWarning(arg: ModelComposed)

class AuditLogsWarning(*args, **kwargs)

Bases: ModelNormal

Warning message indicating something that went wrong with the query.

Parameters:

code (str, optional) – Unique code for this type of warning.
detail (str, optional) – Detailed explanation of this specific warning.
title (str, optional) – Short human-readable summary of the warning.

datadog_api_client.v2.model.authn_mapping module¶

class AuthNMapping(arg: None)¶

class AuthNMapping(arg: ModelComposed)

class AuthNMapping(*args, **kwargs)

Bases: ModelNormal

The AuthN Mapping object returned by API.

Parameters:

attributes (AuthNMappingAttributes, optional) – Attributes of AuthN Mapping.
id (str) – ID of the AuthN Mapping.
relationships (AuthNMappingRelationships, optional) – All relationships associated with AuthN Mapping.
type (AuthNMappingsType) – AuthN Mappings resource type.

datadog_api_client.v2.model.authn_mapping_attributes module¶

class AuthNMappingAttributes(arg: None)¶

class AuthNMappingAttributes(arg: ModelComposed)

class AuthNMappingAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of AuthN Mapping.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.
created_at (datetime, optional) – Creation time of the AuthN Mapping.
modified_at (datetime, optional) – Time of last AuthN Mapping modification.
saml_assertion_attribute_id (str, optional) – The ID of the SAML assertion attribute.

datadog_api_client.v2.model.authn_mapping_create_attributes module¶

class AuthNMappingCreateAttributes(arg: None)¶

class AuthNMappingCreateAttributes(arg: ModelComposed)

class AuthNMappingCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Key/Value pair of attributes used for create request.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.

datadog_api_client.v2.model.authn_mapping_create_data module¶

class AuthNMappingCreateData(arg: None)¶

class AuthNMappingCreateData(arg: ModelComposed)

class AuthNMappingCreateData(*args, **kwargs)

Bases: ModelNormal

Data for creating an AuthN Mapping.

Parameters:

attributes (AuthNMappingCreateAttributes, optional) – Key/Value pair of attributes used for create request.
relationships (AuthNMappingCreateRelationships, optional) – Relationship of AuthN Mapping create object to a Role or Team.
type (AuthNMappingsType) – AuthN Mappings resource type.

datadog_api_client.v2.model.authn_mapping_create_relationships module¶

class AuthNMappingCreateRelationships(arg: None)¶

class AuthNMappingCreateRelationships(arg: ModelComposed)

class AuthNMappingCreateRelationships(*args, **kwargs)

Bases: ModelComposed

Relationship of AuthN Mapping create object to a Role or Team.

Parameters:

role (RelationshipToRole) – Relationship to role.
team (RelationshipToTeam) – Relationship to team.

datadog_api_client.v2.model.authn_mapping_create_request module¶

class AuthNMappingCreateRequest(arg: None)¶

class AuthNMappingCreateRequest(arg: ModelComposed)

class AuthNMappingCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating an AuthN Mapping.

Parameters:: data (AuthNMappingCreateData) – Data for creating an AuthN Mapping.

datadog_api_client.v2.model.authn_mapping_included module¶

class AuthNMappingIncluded(arg: None)¶

class AuthNMappingIncluded(arg: ModelComposed)

class AuthNMappingIncluded(*args, **kwargs)

Bases: ModelComposed

Included data in the AuthN Mapping response.

Parameters:

attributes (SAMLAssertionAttributeAttributes, optional) – Key/Value pair of attributes used in SAML assertion attributes.
id (str) – The ID of the SAML assertion attribute.
type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.
relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.

datadog_api_client.v2.model.authn_mapping_relationship_to_role module¶

class AuthNMappingRelationshipToRole(arg: None)¶

class AuthNMappingRelationshipToRole(arg: ModelComposed)

class AuthNMappingRelationshipToRole(*args, **kwargs)

Bases: ModelNormal

Relationship of AuthN Mapping to a Role.

Parameters:: role (RelationshipToRole) – Relationship to role.

datadog_api_client.v2.model.authn_mapping_relationship_to_team module¶

class AuthNMappingRelationshipToTeam(arg: None)¶

class AuthNMappingRelationshipToTeam(arg: ModelComposed)

class AuthNMappingRelationshipToTeam(*args, **kwargs)

Bases: ModelNormal

Relationship of AuthN Mapping to a Team.

Parameters:: team (RelationshipToTeam) – Relationship to team.

datadog_api_client.v2.model.authn_mapping_relationships module¶

class AuthNMappingRelationships(arg: None)¶

class AuthNMappingRelationships(arg: ModelComposed)

class AuthNMappingRelationships(*args, **kwargs)

Bases: ModelNormal

All relationships associated with AuthN Mapping.

Parameters:

role (RelationshipToRole, optional) – Relationship to role.
saml_assertion_attribute (RelationshipToSAMLAssertionAttribute, optional) – AuthN Mapping relationship to SAML Assertion Attribute.
team (RelationshipToTeam, optional) – Relationship to team.

datadog_api_client.v2.model.authn_mapping_resource_type module¶

class AuthNMappingResourceType(arg: None)¶

class AuthNMappingResourceType(arg: ModelComposed)

class AuthNMappingResourceType(*args, **kwargs)

Bases: ModelSimple

The type of resource being mapped to.

Parameters:

value (str) – Must be one of [“role”, “team”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.authn_mapping_response module¶

class AuthNMappingResponse(arg: None)¶

class AuthNMappingResponse(arg: ModelComposed)

class AuthNMappingResponse(*args, **kwargs)

Bases: ModelNormal

AuthN Mapping response from the API.

Parameters:

data (AuthNMapping, optional) – The AuthN Mapping object returned by API.
included ([AuthNMappingIncluded], optional) – Included data in the AuthN Mapping response.

datadog_api_client.v2.model.authn_mapping_team module¶

class AuthNMappingTeam(arg: None)¶

class AuthNMappingTeam(arg: ModelComposed)

class AuthNMappingTeam(*args, **kwargs)

Bases: ModelNormal

Team.

Parameters:

attributes (AuthNMappingTeamAttributes, optional) – Team attributes.
id (str, optional) – The ID of the Team.
type (TeamType, optional) – Team type

datadog_api_client.v2.model.authn_mapping_team_attributes module¶

class AuthNMappingTeamAttributes(arg: None)¶

class AuthNMappingTeamAttributes(arg: ModelComposed)

class AuthNMappingTeamAttributes(*args, **kwargs)

Bases: ModelNormal

Team attributes.

Parameters:

avatar (str, none_type, optional) – Unicode representation of the avatar for the team, limited to a single grapheme
banner (int, none_type, optional) – Banner selection for the team
handle (str, optional) – The team’s identifier
link_count (int, optional) – The number of links belonging to the team
name (str, optional) – The name of the team
summary (str, none_type, optional) – A brief summary of the team, derived from the description
user_count (int, optional) – The number of users belonging to the team

datadog_api_client.v2.model.authn_mapping_update_attributes module¶

class AuthNMappingUpdateAttributes(arg: None)¶

class AuthNMappingUpdateAttributes(arg: ModelComposed)

class AuthNMappingUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Key/Value pair of attributes used for update request.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.

datadog_api_client.v2.model.authn_mapping_update_data module¶

class AuthNMappingUpdateData(arg: None)¶

class AuthNMappingUpdateData(arg: ModelComposed)

class AuthNMappingUpdateData(*args, **kwargs)

Bases: ModelNormal

Data for updating an AuthN Mapping.

Parameters:

attributes (AuthNMappingUpdateAttributes, optional) – Key/Value pair of attributes used for update request.
id (str) – ID of the AuthN Mapping.
relationships (AuthNMappingUpdateRelationships, optional) – Relationship of AuthN Mapping update object to a Role or Team.
type (AuthNMappingsType) – AuthN Mappings resource type.

datadog_api_client.v2.model.authn_mapping_update_relationships module¶

class AuthNMappingUpdateRelationships(arg: None)¶

class AuthNMappingUpdateRelationships(arg: ModelComposed)

class AuthNMappingUpdateRelationships(*args, **kwargs)

Bases: ModelComposed

Relationship of AuthN Mapping update object to a Role or Team.

Parameters:

role (RelationshipToRole) – Relationship to role.
team (RelationshipToTeam) – Relationship to team.

datadog_api_client.v2.model.authn_mapping_update_request module¶

class AuthNMappingUpdateRequest(arg: None)¶

class AuthNMappingUpdateRequest(arg: ModelComposed)

class AuthNMappingUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request to update an AuthN Mapping.

Parameters:: data (AuthNMappingUpdateData) – Data for updating an AuthN Mapping.

datadog_api_client.v2.model.authn_mappings_response module¶

class AuthNMappingsResponse(arg: None)¶

class AuthNMappingsResponse(arg: ModelComposed)

class AuthNMappingsResponse(*args, **kwargs)

Bases: ModelNormal

Array of AuthN Mappings response.

Parameters:

data ([AuthNMapping], optional) – Array of returned AuthN Mappings.
included ([AuthNMappingIncluded], optional) – Included data in the AuthN Mapping response.
meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

datadog_api_client.v2.model.authn_mappings_sort module¶

class AuthNMappingsSort(arg: None)¶

class AuthNMappingsSort(arg: ModelComposed)

class AuthNMappingsSort(*args, **kwargs)

Bases: ModelSimple

Sorting options for AuthN Mappings.

Parameters:

value (str) – Must be one of [“created_at”, “-created_at”, “role_id”, “-role_id”, “saml_assertion_attribute_id”, “-saml_assertion_attribute_id”, “role.name”, “-role.name”, “saml_assertion_attribute.attribute_key”, “-saml_assertion_attribute.attribute_key”, “saml_assertion_attribute.attribute_value”, “-saml_assertion_attribute.attribute_value”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.authn_mappings_type module¶

class AuthNMappingsType(arg: None)¶

class AuthNMappingsType(arg: ModelComposed)

class AuthNMappingsType(*args, **kwargs)

Bases: ModelSimple

AuthN Mappings resource type.

Parameters:

value (str) – If omitted defaults to “authn_mappings”. Must be one of [“authn_mappings”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_account_create_request module¶

class AWSAccountCreateRequest(arg: None)¶

class AWSAccountCreateRequest(arg: ModelComposed)

class AWSAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

AWS Account Create Request body.

Parameters:: data (AWSAccountCreateRequestData) – AWS Account Create Request data.

datadog_api_client.v2.model.aws_account_create_request_attributes module¶

class AWSAccountCreateRequestAttributes(arg: None)¶

class AWSAccountCreateRequestAttributes(arg: ModelComposed)

class AWSAccountCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The AWS Account Integration Config to be created.

Parameters:

account_tags ([str], none_type, optional) – Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config (AWSAuthConfig) – AWS Authentication config.
aws_account_id (str) – AWS Account ID.
aws_partition (AWSAccountPartition) – AWS partition your AWS account is scoped to. Defaults to aws. See Partitions in the AWS documentation for more information.
aws_regions (AWSRegions, optional) – AWS Regions to collect data from. Defaults to include_all.
logs_config (AWSLogsConfig, optional) – AWS Logs Collection config.
metrics_config (AWSMetricsConfig, optional) – AWS Metrics Collection config.
resources_config (AWSResourcesConfig, optional) – AWS Resources Collection config.
traces_config (AWSTracesConfig, optional) – AWS Traces Collection config.

datadog_api_client.v2.model.aws_account_create_request_data module¶

class AWSAccountCreateRequestData(arg: None)¶

class AWSAccountCreateRequestData(arg: ModelComposed)

class AWSAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

AWS Account Create Request data.

Parameters:

attributes (AWSAccountCreateRequestAttributes) – The AWS Account Integration Config to be created.
type (AWSAccountType) – AWS Account resource type.

datadog_api_client.v2.model.aws_account_partition module¶

class AWSAccountPartition(arg: None)¶

class AWSAccountPartition(arg: ModelComposed)

class AWSAccountPartition(*args, **kwargs)

Bases: ModelSimple

AWS partition your AWS account is scoped to. Defaults to aws.: See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.

Parameters:

value (str) – Must be one of [“aws”, “aws-cn”, “aws-us-gov”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_account_response module¶

class AWSAccountResponse(arg: None)¶

class AWSAccountResponse(arg: ModelComposed)

class AWSAccountResponse(*args, **kwargs)

Bases: ModelNormal

AWS Account response body.

Parameters:: data (AWSAccountResponseData) – AWS Account response data.

datadog_api_client.v2.model.aws_account_response_attributes module¶

class AWSAccountResponseAttributes(arg: None)¶

class AWSAccountResponseAttributes(arg: ModelComposed)

class AWSAccountResponseAttributes(*args, **kwargs)

Bases: ModelNormal

AWS Account response attributes.

Parameters:

account_tags ([str], none_type, optional) – Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config (AWSAuthConfig, optional) – AWS Authentication config.
aws_account_id (str) – AWS Account ID.
aws_partition (AWSAccountPartition, optional) –
AWS partition your AWS account is scoped to. Defaults to aws. See Partitions in the AWS documentation for more information.
aws_regions (AWSRegions, optional) – AWS Regions to collect data from. Defaults to include_all.
created_at (datetime, optional) – Timestamp of when the account integration was created.
logs_config (AWSLogsConfig, optional) – AWS Logs Collection config.
metrics_config (AWSMetricsConfig, optional) – AWS Metrics Collection config.
modified_at (datetime, optional) – Timestamp of when the account integration was updated.
resources_config (AWSResourcesConfig, optional) – AWS Resources Collection config.
traces_config (AWSTracesConfig, optional) – AWS Traces Collection config.

datadog_api_client.v2.model.aws_account_response_data module¶

class AWSAccountResponseData(arg: None)¶

class AWSAccountResponseData(arg: ModelComposed)

class AWSAccountResponseData(*args, **kwargs)

Bases: ModelNormal

AWS Account response data.

Parameters:

attributes (AWSAccountResponseAttributes, optional) – AWS Account response attributes.
id (str) – Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the List all AWS integrations endpoint and query by AWS Account ID.
type (AWSAccountType) – AWS Account resource type.

datadog_api_client.v2.model.aws_account_type module¶

class AWSAccountType(arg: None)¶

class AWSAccountType(arg: ModelComposed)

class AWSAccountType(*args, **kwargs)

Bases: ModelSimple

AWS Account resource type.

Parameters:

value (str) – If omitted defaults to “account”. Must be one of [“account”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_account_update_request module¶

class AWSAccountUpdateRequest(arg: None)¶

class AWSAccountUpdateRequest(arg: ModelComposed)

class AWSAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

AWS Account Update Request body.

Parameters:: data (AWSAccountUpdateRequestData) – AWS Account Update Request data.

datadog_api_client.v2.model.aws_account_update_request_attributes module¶

class AWSAccountUpdateRequestAttributes(arg: None)¶

class AWSAccountUpdateRequestAttributes(arg: ModelComposed)

class AWSAccountUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The AWS Account Integration Config to be updated.

Parameters:

account_tags ([str], none_type, optional) – Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config (AWSAuthConfig, optional) – AWS Authentication config.
aws_account_id (str) – AWS Account ID.
aws_partition (AWSAccountPartition, optional) –
AWS partition your AWS account is scoped to. Defaults to aws. See Partitions in the AWS documentation for more information.
aws_regions (AWSRegions, optional) – AWS Regions to collect data from. Defaults to include_all.
logs_config (AWSLogsConfig, optional) – AWS Logs Collection config.
metrics_config (AWSMetricsConfig, optional) – AWS Metrics Collection config.
resources_config (AWSResourcesConfig, optional) – AWS Resources Collection config.
traces_config (AWSTracesConfig, optional) – AWS Traces Collection config.

datadog_api_client.v2.model.aws_account_update_request_data module¶

class AWSAccountUpdateRequestData(arg: None)¶

class AWSAccountUpdateRequestData(arg: ModelComposed)

class AWSAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

AWS Account Update Request data.

Parameters:

attributes (AWSAccountUpdateRequestAttributes) – The AWS Account Integration Config to be updated.
id (str, optional) –
Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the List all AWS integrations endpoint and query by AWS Account ID.
type (AWSAccountType) – AWS Account resource type.

datadog_api_client.v2.model.aws_accounts_response module¶

class AWSAccountsResponse(arg: None)¶

class AWSAccountsResponse(arg: ModelComposed)

class AWSAccountsResponse(*args, **kwargs)

Bases: ModelNormal

AWS Accounts response body.

Parameters:: data ([AWSAccountResponseData]) – List of AWS Account Integration Configs.

datadog_api_client.v2.model.aws_assume_role module¶

class AWSAssumeRole(arg: None)¶

class AWSAssumeRole(arg: ModelComposed)

class AWSAssumeRole(*args, **kwargs)

Bases: ModelNormal

The definition of AWSAssumeRole object.

Parameters:

account_id (str) – AWS account the connection is created for
external_id (str, optional) – External ID used to scope which connection can be used to assume the role
principal_id (str, optional) – AWS account that will assume the role
role (str) – Role to assume
type (AWSAssumeRoleType) – The definition of AWSAssumeRoleType object.

datadog_api_client.v2.model.aws_assume_role_type module¶

class AWSAssumeRoleType(arg: None)¶

class AWSAssumeRoleType(arg: ModelComposed)

class AWSAssumeRoleType(*args, **kwargs)

Bases: ModelSimple

The definition of AWSAssumeRoleType object.

Parameters:

value (str) – If omitted defaults to “AWSAssumeRole”. Must be one of [“AWSAssumeRole”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_assume_role_update module¶

class AWSAssumeRoleUpdate(arg: None)¶

class AWSAssumeRoleUpdate(arg: ModelComposed)

class AWSAssumeRoleUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of AWSAssumeRoleUpdate object.

Parameters:

account_id (str, optional) – AWS account the connection is created for
generate_new_external_id (bool, optional) – The AWSAssumeRoleUpdate generate_new_external_id.
role (str, optional) – Role to assume
type (AWSAssumeRoleType) – The definition of AWSAssumeRoleType object.

datadog_api_client.v2.model.aws_auth_config module¶

class AWSAuthConfig(arg: None)¶

class AWSAuthConfig(arg: ModelComposed)

class AWSAuthConfig(*args, **kwargs)

Bases: ModelComposed

AWS Authentication config.

Parameters:

access_key_id (str) – AWS Access Key ID.
secret_access_key (str, optional) – AWS Secret Access Key.
external_id (str, optional) – AWS IAM External ID for associated role.
role_name (str) – AWS IAM Role name.

datadog_api_client.v2.model.aws_auth_config_keys module¶

class AWSAuthConfigKeys(arg: None)¶

class AWSAuthConfigKeys(arg: ModelComposed)

class AWSAuthConfigKeys(*args, **kwargs)

Bases: ModelNormal

AWS Authentication config to integrate your account using an access key pair.

Parameters:

access_key_id (str) – AWS Access Key ID.
secret_access_key (str, optional) – AWS Secret Access Key.

datadog_api_client.v2.model.aws_auth_config_role module¶

class AWSAuthConfigRole(arg: None)¶

class AWSAuthConfigRole(arg: ModelComposed)

class AWSAuthConfigRole(*args, **kwargs)

Bases: ModelNormal

AWS Authentication config to integrate your account using an IAM role.

Parameters:

external_id (str, optional) – AWS IAM External ID for associated role.
role_name (str) – AWS IAM Role name.

datadog_api_client.v2.model.aws_credentials module¶

class AWSCredentials(arg: None)¶

class AWSCredentials(arg: ModelComposed)

class AWSCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of AWSCredentials object.

Parameters:

account_id (str) – AWS account the connection is created for
external_id (str, optional) – External ID used to scope which connection can be used to assume the role
principal_id (str, optional) – AWS account that will assume the role
role (str) – Role to assume
type (AWSAssumeRoleType) – The definition of AWSAssumeRoleType object.

datadog_api_client.v2.model.aws_credentials_update module¶

class AWSCredentialsUpdate(arg: None)¶

class AWSCredentialsUpdate(arg: ModelComposed)

class AWSCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of AWSCredentialsUpdate object.

Parameters:

account_id (str, optional) – AWS account the connection is created for
generate_new_external_id (bool, optional) – The AWSAssumeRoleUpdate generate_new_external_id.
role (str, optional) – Role to assume
type (AWSAssumeRoleType) – The definition of AWSAssumeRoleType object.

datadog_api_client.v2.model.aws_cur_config module¶

class AwsCURConfig(arg: None)¶

class AwsCURConfig(arg: ModelComposed)

class AwsCURConfig(*args, **kwargs)

Bases: ModelNormal

AWS CUR config.

Parameters:

attributes (AwsCURConfigAttributes) – Attributes for An AWS CUR config.
id (str, optional) – The ID of the AWS CUR config.
type (AwsCURConfigType) – Type of AWS CUR config.

datadog_api_client.v2.model.aws_cur_config_attributes module¶

class AwsCURConfigAttributes(arg: None)¶

class AwsCURConfigAttributes(arg: ModelComposed)

class AwsCURConfigAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for An AWS CUR config.

Parameters:

account_filters (AccountFilteringConfig, optional) – The account filtering configuration.
account_id (str) – The AWS account ID.
bucket_name (str) – The AWS bucket name used to store the Cost and Usage Report.
bucket_region (str) – The region the bucket is located in.
created_at (str, optional) – The timestamp when the AWS CUR config was created.
error_messages ([str], none_type, optional) – The error messages for the AWS CUR config.
months (int, optional) – The number of months the report has been backfilled. Deprecated.
report_name (str) – The name of the Cost and Usage Report.
report_prefix (str) – The report prefix used for the Cost and Usage Report.
status (str) – The status of the AWS CUR.
status_updated_at (str, optional) – The timestamp when the AWS CUR config status was updated.
updated_at (str, optional) – The timestamp when the AWS CUR config status was updated.

datadog_api_client.v2.model.aws_cur_config_patch_data module¶

class AwsCURConfigPatchData(arg: None)¶

class AwsCURConfigPatchData(arg: ModelComposed)

class AwsCURConfigPatchData(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Patch data.

Parameters:

attributes (AwsCURConfigPatchRequestAttributes) – Attributes for AWS CUR config Patch Request.
type (AwsCURConfigPatchRequestType) – Type of AWS CUR config Patch Request.

datadog_api_client.v2.model.aws_cur_config_patch_request module¶

class AwsCURConfigPatchRequest(arg: None)¶

class AwsCURConfigPatchRequest(arg: ModelComposed)

class AwsCURConfigPatchRequest(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Patch Request.

Parameters:: data (AwsCURConfigPatchData) – AWS CUR config Patch data.

datadog_api_client.v2.model.aws_cur_config_patch_request_attributes module¶

class AwsCURConfigPatchRequestAttributes(arg: None)¶

class AwsCURConfigPatchRequestAttributes(arg: ModelComposed)

class AwsCURConfigPatchRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for AWS CUR config Patch Request.

Parameters:

account_filters (AccountFilteringConfig, optional) – The account filtering configuration.
is_enabled (bool, optional) – Whether or not the Cloud Cost Management account is enabled.

datadog_api_client.v2.model.aws_cur_config_patch_request_type module¶

class AwsCURConfigPatchRequestType(arg: None)¶

class AwsCURConfigPatchRequestType(arg: ModelComposed)

class AwsCURConfigPatchRequestType(*args, **kwargs)

Bases: ModelSimple

Type of AWS CUR config Patch Request.

Parameters:

value (str) – If omitted defaults to “aws_cur_config_patch_request”. Must be one of [“aws_cur_config_patch_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_cur_config_post_data module¶

class AwsCURConfigPostData(arg: None)¶

class AwsCURConfigPostData(arg: ModelComposed)

class AwsCURConfigPostData(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Post data.

Parameters:

attributes (AwsCURConfigPostRequestAttributes, optional) – Attributes for AWS CUR config Post Request.
type (AwsCURConfigPostRequestType) – Type of AWS CUR config Post Request.

datadog_api_client.v2.model.aws_cur_config_post_request module¶

class AwsCURConfigPostRequest(arg: None)¶

class AwsCURConfigPostRequest(arg: ModelComposed)

class AwsCURConfigPostRequest(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Post Request.

Parameters:: data (AwsCURConfigPostData) – AWS CUR config Post data.

datadog_api_client.v2.model.aws_cur_config_post_request_attributes module¶

class AwsCURConfigPostRequestAttributes(arg: None)¶

class AwsCURConfigPostRequestAttributes(arg: ModelComposed)

class AwsCURConfigPostRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for AWS CUR config Post Request.

Parameters:

account_filters (AccountFilteringConfig, optional) – The account filtering configuration.
account_id (str) – The AWS account ID.
bucket_name (str) – The AWS bucket name used to store the Cost and Usage Report.
bucket_region (str, optional) – The region the bucket is located in.
months (int, optional) – The month of the report.
report_name (str) – The name of the Cost and Usage Report.
report_prefix (str) – The report prefix used for the Cost and Usage Report.

datadog_api_client.v2.model.aws_cur_config_post_request_type module¶

class AwsCURConfigPostRequestType(arg: None)¶

class AwsCURConfigPostRequestType(arg: ModelComposed)

class AwsCURConfigPostRequestType(*args, **kwargs)

Bases: ModelSimple

Type of AWS CUR config Post Request.

Parameters:

value (str) – If omitted defaults to “aws_cur_config_post_request”. Must be one of [“aws_cur_config_post_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_cur_config_response module¶

class AwsCurConfigResponse(arg: None)¶

class AwsCurConfigResponse(arg: ModelComposed)

class AwsCurConfigResponse(*args, **kwargs)

Bases: ModelNormal

The definition of AwsCurConfigResponse object.

Parameters:: data (AwsCurConfigResponseData, optional) – The definition of AwsCurConfigResponseData object.

datadog_api_client.v2.model.aws_cur_config_response_data module¶

class AwsCurConfigResponseData(arg: None)¶

class AwsCurConfigResponseData(arg: ModelComposed)

class AwsCurConfigResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of AwsCurConfigResponseData object.

Parameters:

attributes (AwsCurConfigResponseDataAttributes, optional) – The definition of AwsCurConfigResponseDataAttributes object.
id (str, optional) – The AwsCurConfigResponseData id.
type (AwsCurConfigResponseDataType) – AWS CUR config resource type.

datadog_api_client.v2.model.aws_cur_config_response_data_attributes module¶

class AwsCurConfigResponseDataAttributes(arg: None)¶

class AwsCurConfigResponseDataAttributes(arg: ModelComposed)

class AwsCurConfigResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of AwsCurConfigResponseDataAttributes object.

Parameters:

account_filters (AwsCurConfigResponseDataAttributesAccountFilters, optional) – The definition of AwsCurConfigResponseDataAttributesAccountFilters object.
account_id (str, optional) – The attributes account_id.
bucket_name (str, optional) – The attributes bucket_name.
bucket_region (str, optional) – The attributes bucket_region.
created_at (str, optional) – The attributes created_at.
error_messages ([str], none_type, optional) – The attributes error_messages.
months (int, optional) – The attributes months.
report_name (str, optional) – The attributes report_name.
report_prefix (str, optional) – The attributes report_prefix.
status (str, optional) – The attributes status.
status_updated_at (str, optional) – The attributes status_updated_at.
updated_at (str, optional) – The attributes updated_at.

datadog_api_client.v2.model.aws_cur_config_response_data_attributes_account_filters module¶

class AwsCurConfigResponseDataAttributesAccountFilters(arg: None)¶

class AwsCurConfigResponseDataAttributesAccountFilters(arg: ModelComposed)

class AwsCurConfigResponseDataAttributesAccountFilters(*args, **kwargs)

Bases: ModelNormal

The definition of AwsCurConfigResponseDataAttributesAccountFilters object.

Parameters:

excluded_accounts ([str], optional) – The account_filters excluded_accounts.
include_new_accounts (bool, none_type, optional) – The account_filters include_new_accounts.
included_accounts ([str], optional) – The account_filters included_accounts.

datadog_api_client.v2.model.aws_cur_config_response_data_type module¶

class AwsCurConfigResponseDataType(arg: None)¶

class AwsCurConfigResponseDataType(arg: ModelComposed)

class AwsCurConfigResponseDataType(*args, **kwargs)

Bases: ModelSimple

AWS CUR config resource type.

Parameters:

value (str) – If omitted defaults to “aws_cur_config”. Must be one of [“aws_cur_config”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_cur_config_type module¶

class AwsCURConfigType(arg: None)¶

class AwsCURConfigType(arg: ModelComposed)

class AwsCURConfigType(*args, **kwargs)

Bases: ModelSimple

Type of AWS CUR config.

Parameters:

value (str) – If omitted defaults to “aws_cur_config”. Must be one of [“aws_cur_config”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_cur_configs_response module¶

class AwsCURConfigsResponse(arg: None)¶

class AwsCURConfigsResponse(arg: ModelComposed)

class AwsCURConfigsResponse(*args, **kwargs)

Bases: ModelNormal

List of AWS CUR configs.

Parameters:: data ([AwsCURConfig]) – An AWS CUR config.

datadog_api_client.v2.model.aws_event_bridge_account_configuration module¶

class AWSEventBridgeAccountConfiguration(arg: None)¶

class AWSEventBridgeAccountConfiguration(arg: ModelComposed)

class AWSEventBridgeAccountConfiguration(*args, **kwargs)

Bases: ModelNormal

The EventBridge configuration for one AWS account.

Parameters:

account_id (str, optional) – Your AWS Account ID without dashes.
event_hubs ([AWSEventBridgeSource], optional) – Array of AWS event sources associated with this account.
tags ([str], optional) – Array of tags (in the form key:value ) which are added to all hosts and metrics reporting through the main AWS integration.

datadog_api_client.v2.model.aws_event_bridge_create_request module¶

class AWSEventBridgeCreateRequest(arg: None)¶

class AWSEventBridgeCreateRequest(arg: ModelComposed)

class AWSEventBridgeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge create request body.

Parameters:: data (AWSEventBridgeCreateRequestData) – Amazon EventBridge create request data.

datadog_api_client.v2.model.aws_event_bridge_create_request_attributes module¶

class AWSEventBridgeCreateRequestAttributes(arg: None)¶

class AWSEventBridgeCreateRequestAttributes(arg: ModelComposed)

class AWSEventBridgeCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The EventBridge source to be created.

Parameters:

account_id (str) – AWS Account ID.
create_event_bus (bool, optional) – Set to true if Datadog should create the event bus in addition to the event source. Requires the events:CreateEventBus permission.
event_generator_name (str) – The given part of the event source name, which is then combined with an assigned suffix to form the full name.
region (str) – The event source’s AWS region.

datadog_api_client.v2.model.aws_event_bridge_create_request_data module¶

class AWSEventBridgeCreateRequestData(arg: None)¶

class AWSEventBridgeCreateRequestData(arg: ModelComposed)

class AWSEventBridgeCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge create request data.

Parameters:

attributes (AWSEventBridgeCreateRequestAttributes) – The EventBridge source to be created.
type (AWSEventBridgeType) – Amazon EventBridge resource type.

datadog_api_client.v2.model.aws_event_bridge_create_response module¶

class AWSEventBridgeCreateResponse(arg: None)¶

class AWSEventBridgeCreateResponse(arg: ModelComposed)

class AWSEventBridgeCreateResponse(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge create response body.

Parameters:: data (AWSEventBridgeCreateResponseData) – Amazon EventBridge create response data.

datadog_api_client.v2.model.aws_event_bridge_create_response_attributes module¶

class AWSEventBridgeCreateResponseAttributes(arg: None)¶

class AWSEventBridgeCreateResponseAttributes(arg: ModelComposed)

class AWSEventBridgeCreateResponseAttributes(*args, **kwargs)

Bases: ModelNormal

A created EventBridge source.

Parameters:

event_source_name (str, optional) – The event source name.
has_bus (bool, optional) – True if the event bus was created in addition to the source.
region (str, optional) –
The event source’s AWS region.
status (AWSEventBridgeCreateStatus, optional) – The event source status “created”.

datadog_api_client.v2.model.aws_event_bridge_create_response_data module¶

class AWSEventBridgeCreateResponseData(arg: None)¶

class AWSEventBridgeCreateResponseData(arg: ModelComposed)

class AWSEventBridgeCreateResponseData(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge create response data.

Parameters:

attributes (AWSEventBridgeCreateResponseAttributes) – A created EventBridge source.
id (str, optional) – The ID of the Amazon EventBridge create response data.
type (AWSEventBridgeType) – Amazon EventBridge resource type.

datadog_api_client.v2.model.aws_event_bridge_create_status module¶

class AWSEventBridgeCreateStatus(arg: None)¶

class AWSEventBridgeCreateStatus(arg: ModelComposed)

class AWSEventBridgeCreateStatus(*args, **kwargs)

Bases: ModelSimple

The event source status “created”.

Parameters:

value (str) – If omitted defaults to “created”. Must be one of [“created”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_event_bridge_delete_request module¶

class AWSEventBridgeDeleteRequest(arg: None)¶

class AWSEventBridgeDeleteRequest(arg: ModelComposed)

class AWSEventBridgeDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge delete request body.

Parameters:: data (AWSEventBridgeDeleteRequestData) – Amazon EventBridge delete request data.

datadog_api_client.v2.model.aws_event_bridge_delete_request_attributes module¶

class AWSEventBridgeDeleteRequestAttributes(arg: None)¶

class AWSEventBridgeDeleteRequestAttributes(arg: ModelComposed)

class AWSEventBridgeDeleteRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The EventBridge source to be deleted.

Parameters:

account_id (str) – AWS Account ID.
event_generator_name (str) – The event source name.
region (str) –
The event source’s AWS region.

datadog_api_client.v2.model.aws_event_bridge_delete_request_data module¶

class AWSEventBridgeDeleteRequestData(arg: None)¶

class AWSEventBridgeDeleteRequestData(arg: ModelComposed)

class AWSEventBridgeDeleteRequestData(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge delete request data.

Parameters:

attributes (AWSEventBridgeDeleteRequestAttributes) – The EventBridge source to be deleted.
type (AWSEventBridgeType) – Amazon EventBridge resource type.

datadog_api_client.v2.model.aws_event_bridge_delete_response module¶

class AWSEventBridgeDeleteResponse(arg: None)¶

class AWSEventBridgeDeleteResponse(arg: ModelComposed)

class AWSEventBridgeDeleteResponse(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge delete response body.

Parameters:: data (AWSEventBridgeDeleteResponseData) – Amazon EventBridge delete response data.

datadog_api_client.v2.model.aws_event_bridge_delete_response_attributes module¶

class AWSEventBridgeDeleteResponseAttributes(arg: None)¶

class AWSEventBridgeDeleteResponseAttributes(arg: ModelComposed)

class AWSEventBridgeDeleteResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The EventBridge source delete response attributes.

Parameters:: status (AWSEventBridgeDeleteStatus, optional) – The event source status “empty”.

datadog_api_client.v2.model.aws_event_bridge_delete_response_data module¶

class AWSEventBridgeDeleteResponseData(arg: None)¶

class AWSEventBridgeDeleteResponseData(arg: ModelComposed)

class AWSEventBridgeDeleteResponseData(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge delete response data.

Parameters:

attributes (AWSEventBridgeDeleteResponseAttributes) – The EventBridge source delete response attributes.
id (str, optional) – The ID of the Amazon EventBridge list response data.
type (AWSEventBridgeType) – Amazon EventBridge resource type.

datadog_api_client.v2.model.aws_event_bridge_delete_status module¶

class AWSEventBridgeDeleteStatus(arg: None)¶

class AWSEventBridgeDeleteStatus(arg: ModelComposed)

class AWSEventBridgeDeleteStatus(*args, **kwargs)

Bases: ModelSimple

The event source status “empty”.

Parameters:

value (str) – If omitted defaults to “empty”. Must be one of [“empty”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_event_bridge_list_response module¶

class AWSEventBridgeListResponse(arg: None)¶

class AWSEventBridgeListResponse(arg: ModelComposed)

class AWSEventBridgeListResponse(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge list response body.

Parameters:: data (AWSEventBridgeListResponseData) – Amazon EventBridge list response data.

datadog_api_client.v2.model.aws_event_bridge_list_response_attributes module¶

class AWSEventBridgeListResponseAttributes(arg: None)¶

class AWSEventBridgeListResponseAttributes(arg: ModelComposed)

class AWSEventBridgeListResponseAttributes(*args, **kwargs)

Bases: ModelNormal

An object describing the EventBridge configuration for multiple accounts.

Parameters:

accounts ([AWSEventBridgeAccountConfiguration], optional) – List of accounts with their event sources.
is_installed (bool, optional) – True if the EventBridge integration is enabled for your organization.

datadog_api_client.v2.model.aws_event_bridge_list_response_data module¶

class AWSEventBridgeListResponseData(arg: None)¶

class AWSEventBridgeListResponseData(arg: ModelComposed)

class AWSEventBridgeListResponseData(*args, **kwargs)

Bases: ModelNormal

Amazon EventBridge list response data.

Parameters:

attributes (AWSEventBridgeListResponseAttributes) – An object describing the EventBridge configuration for multiple accounts.
id (str) – The ID of the Amazon EventBridge list response data.
type (AWSEventBridgeType) – Amazon EventBridge resource type.

datadog_api_client.v2.model.aws_event_bridge_source module¶

class AWSEventBridgeSource(arg: None)¶

class AWSEventBridgeSource(arg: ModelComposed)

class AWSEventBridgeSource(*args, **kwargs)

Bases: ModelNormal

An EventBridge source.

Parameters:

name (str, optional) – The event source name.
region (str, optional) –
The event source’s AWS region.

datadog_api_client.v2.model.aws_event_bridge_type module¶

class AWSEventBridgeType(arg: None)¶

class AWSEventBridgeType(arg: ModelComposed)

class AWSEventBridgeType(*args, **kwargs)

Bases: ModelSimple

Amazon EventBridge resource type.

Parameters:

value (str) – If omitted defaults to “event_bridge”. Must be one of [“event_bridge”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_integration module¶

class AWSIntegration(arg: None)¶

class AWSIntegration(arg: ModelComposed)

class AWSIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of AWSIntegration object.

Parameters:

credentials (AWSCredentials) – The definition of AWSCredentials object.
type (AWSIntegrationType) – The definition of AWSIntegrationType object.

datadog_api_client.v2.model.aws_integration_iam_permissions_response module¶

class AWSIntegrationIamPermissionsResponse(arg: None)¶

class AWSIntegrationIamPermissionsResponse(arg: ModelComposed)

class AWSIntegrationIamPermissionsResponse(*args, **kwargs)

Bases: ModelNormal

AWS Integration IAM Permissions response body.

Parameters:: data (AWSIntegrationIamPermissionsResponseData) – AWS Integration IAM Permissions response data.

datadog_api_client.v2.model.aws_integration_iam_permissions_response_attributes module¶

class AWSIntegrationIamPermissionsResponseAttributes(arg: None)¶

class AWSIntegrationIamPermissionsResponseAttributes(arg: ModelComposed)

class AWSIntegrationIamPermissionsResponseAttributes(*args, **kwargs)

Bases: ModelNormal

AWS Integration IAM Permissions response attributes.

Parameters:: permissions ([str]) – List of AWS IAM permissions required for the integration.

datadog_api_client.v2.model.aws_integration_iam_permissions_response_data module¶

class AWSIntegrationIamPermissionsResponseData(arg: None)¶

class AWSIntegrationIamPermissionsResponseData(arg: ModelComposed)

class AWSIntegrationIamPermissionsResponseData(*args, **kwargs)

Bases: ModelNormal

AWS Integration IAM Permissions response data.

Parameters:

attributes (AWSIntegrationIamPermissionsResponseAttributes, optional) – AWS Integration IAM Permissions response attributes.
id (str, optional) – The AWSIntegrationIamPermissionsResponseData id.
type (AWSIntegrationIamPermissionsResponseDataType, optional) – The AWSIntegrationIamPermissionsResponseData type.

datadog_api_client.v2.model.aws_integration_iam_permissions_response_data_type module¶

class AWSIntegrationIamPermissionsResponseDataType(arg: None)¶

class AWSIntegrationIamPermissionsResponseDataType(arg: ModelComposed)

class AWSIntegrationIamPermissionsResponseDataType(*args, **kwargs)

Bases: ModelSimple

The AWSIntegrationIamPermissionsResponseData type.

Parameters:

value (str) – If omitted defaults to “permissions”. Must be one of [“permissions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_integration_type module¶

class AWSIntegrationType(arg: None)¶

class AWSIntegrationType(arg: ModelComposed)

class AWSIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of AWSIntegrationType object.

Parameters:

value (str) – If omitted defaults to “AWS”. Must be one of [“AWS”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_integration_update module¶

class AWSIntegrationUpdate(arg: None)¶

class AWSIntegrationUpdate(arg: ModelComposed)

class AWSIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of AWSIntegrationUpdate object.

Parameters:

credentials (AWSCredentialsUpdate, optional) – The definition of AWSCredentialsUpdate object.
type (AWSIntegrationType) – The definition of AWSIntegrationType object.

datadog_api_client.v2.model.aws_lambda_forwarder_config module¶

class AWSLambdaForwarderConfig(arg: None)¶

class AWSLambdaForwarderConfig(arg: ModelComposed)

class AWSLambdaForwarderConfig(*args, **kwargs)

Bases: ModelNormal

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing and new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

Parameters:

lambdas ([str], optional) – List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config (AWSLambdaForwarderConfigLogSourceConfig, optional) – Log source configuration.
sources ([str], optional) – List of service IDs set to enable automatic log collection. Discover the list of available services with the Get list of AWS log ready services endpoint.

datadog_api_client.v2.model.aws_lambda_forwarder_config_log_source_config module¶

class AWSLambdaForwarderConfigLogSourceConfig(arg: None)¶

class AWSLambdaForwarderConfigLogSourceConfig(arg: ModelComposed)

class AWSLambdaForwarderConfigLogSourceConfig(*args, **kwargs)

Bases: ModelNormal

Log source configuration.

Parameters:: tag_filters ([AWSLogSourceTagFilter], optional) – List of AWS log source tag filters. Defaults to [].

datadog_api_client.v2.model.aws_log_source_tag_filter module¶

class AWSLogSourceTagFilter(arg: None)¶

class AWSLogSourceTagFilter(arg: ModelComposed)

class AWSLogSourceTagFilter(*args, **kwargs)

Bases: ModelNormal

AWS log source tag filter list. Defaults to []. Array of log source to AWS resource tag mappings. Each mapping contains a log source and its associated AWS resource tags (in key:value format) used to filter logs submitted to Datadog. Tag filters are applied for tags on the AWS resource emitting logs; tags associated with the log storage entity (such as a CloudWatch Log Group or S3 Bucket) are not considered. For more information on resource tag filter syntax, see AWS resource exclusion in the AWS integration billing page.

Parameters:

source (str, optional) – The AWS log source to which the tag filters defined in tags are applied.
tags ([str], none_type, optional) – The AWS resource tags to filter on for the log source specified by source.

datadog_api_client.v2.model.aws_logs_config module¶

class AWSLogsConfig(arg: None)¶

class AWSLogsConfig(arg: ModelComposed)

class AWSLogsConfig(*args, **kwargs)

Bases: ModelNormal

AWS Logs Collection config.

Parameters:: lambda_forwarder (AWSLambdaForwarderConfig, optional) – Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing and new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

datadog_api_client.v2.model.aws_logs_services_response module¶

class AWSLogsServicesResponse(arg: None)¶

class AWSLogsServicesResponse(arg: ModelComposed)

class AWSLogsServicesResponse(*args, **kwargs)

Bases: ModelNormal

AWS Logs Services response body

Parameters:: data (AWSLogsServicesResponseData) – AWS Logs Services response body

datadog_api_client.v2.model.aws_logs_services_response_attributes module¶

class AWSLogsServicesResponseAttributes(arg: None)¶

class AWSLogsServicesResponseAttributes(arg: ModelComposed)

class AWSLogsServicesResponseAttributes(*args, **kwargs)

Bases: ModelNormal

AWS Logs Services response body

Parameters:: logs_services ([str]) – List of AWS services that can send logs to Datadog

datadog_api_client.v2.model.aws_logs_services_response_data module¶

class AWSLogsServicesResponseData(arg: None)¶

class AWSLogsServicesResponseData(arg: ModelComposed)

class AWSLogsServicesResponseData(*args, **kwargs)

Bases: ModelNormal

AWS Logs Services response body

Parameters:

attributes (AWSLogsServicesResponseAttributes, optional) – AWS Logs Services response body
id (str) – The AWSLogsServicesResponseData id.
type (AWSLogsServicesResponseDataType) – The AWSLogsServicesResponseData type.

datadog_api_client.v2.model.aws_logs_services_response_data_type module¶

class AWSLogsServicesResponseDataType(arg: None)¶

class AWSLogsServicesResponseDataType(arg: ModelComposed)

class AWSLogsServicesResponseDataType(*args, **kwargs)

Bases: ModelSimple

The AWSLogsServicesResponseData type.

Parameters:

value (str) – If omitted defaults to “logs_services”. Must be one of [“logs_services”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_metrics_config module¶

class AWSMetricsConfig(arg: None)¶

class AWSMetricsConfig(arg: ModelComposed)

class AWSMetricsConfig(*args, **kwargs)

Bases: ModelNormal

AWS Metrics Collection config.

Parameters:

automute_enabled (bool, optional) – Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms (bool, optional) – Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics (bool, optional) – Enable custom metrics collection. Defaults to false.
enabled (bool, optional) – Enable AWS metrics collection. Defaults to true.
namespace_filters (AWSNamespaceFilters, optional) – AWS Metrics namespace filters. Defaults to exclude_only.
tag_filters ([AWSNamespaceTagFilter], optional) – AWS Metrics collection tag filters list. Defaults to [].

datadog_api_client.v2.model.aws_namespace_filters module¶

class AWSNamespaceFilters(arg: None)¶

class AWSNamespaceFilters(arg: ModelComposed)

class AWSNamespaceFilters(*args, **kwargs)

Bases: ModelComposed

AWS Metrics namespace filters. Defaults to exclude_only.

Parameters:

exclude_only ([str]) – Exclude only these namespaces from metrics collection. Defaults to [“AWS/SQS”, “AWS/ElasticMapReduce”, “AWS/Usage”]. AWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.
include_only ([str]) – Include only these namespaces.

datadog_api_client.v2.model.aws_namespace_filters_exclude_only module¶

class AWSNamespaceFiltersExcludeOnly(arg: None)¶

class AWSNamespaceFiltersExcludeOnly(arg: ModelComposed)

class AWSNamespaceFiltersExcludeOnly(*args, **kwargs)

Bases: ModelNormal

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"]. AWS/SQS , AWS/ElasticMapReduce , and AWS/Usage are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

Parameters:: exclude_only ([str]) – Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"]. AWS/SQS , AWS/ElasticMapReduce , and AWS/Usage are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

datadog_api_client.v2.model.aws_namespace_filters_include_only module¶

class AWSNamespaceFiltersIncludeOnly(arg: None)¶

class AWSNamespaceFiltersIncludeOnly(arg: ModelComposed)

class AWSNamespaceFiltersIncludeOnly(*args, **kwargs)

Bases: ModelNormal

Include only these namespaces.

Parameters:: include_only ([str]) – Include only these namespaces.

datadog_api_client.v2.model.aws_namespace_tag_filter module¶

class AWSNamespaceTagFilter(arg: None)¶

class AWSNamespaceTagFilter(arg: ModelComposed)

class AWSNamespaceTagFilter(*args, **kwargs)

Bases: ModelNormal

AWS Metrics Collection tag filters list. Defaults to []. The array of custom AWS resource tags (in the form key:value ) defines a filter that Datadog uses when collecting metrics from a specified service. Wildcards, such as ? (match a single character) and * (match multiple characters), and exclusion using ! before the tag are supported. For EC2, only hosts that match one of the defined tags are imported into Datadog. The rest are ignored. For example, env:production,instance-type:c?.*,!region:us-east-1.

Parameters:

namespace (str, optional) – The AWS service for which the tag filters defined in tags will be applied.
tags ([str], none_type, optional) – The AWS resource tags to filter on for the service specified by namespace.

datadog_api_client.v2.model.aws_namespaces_response module¶

class AWSNamespacesResponse(arg: None)¶

class AWSNamespacesResponse(arg: ModelComposed)

class AWSNamespacesResponse(*args, **kwargs)

Bases: ModelNormal

AWS Namespaces response body.

Parameters:: data (AWSNamespacesResponseData) – AWS Namespaces response data.

datadog_api_client.v2.model.aws_namespaces_response_attributes module¶

class AWSNamespacesResponseAttributes(arg: None)¶

class AWSNamespacesResponseAttributes(arg: ModelComposed)

class AWSNamespacesResponseAttributes(*args, **kwargs)

Bases: ModelNormal

AWS Namespaces response attributes.

Parameters:: namespaces ([str]) – AWS CloudWatch namespace.

datadog_api_client.v2.model.aws_namespaces_response_data module¶

class AWSNamespacesResponseData(arg: None)¶

class AWSNamespacesResponseData(arg: ModelComposed)

class AWSNamespacesResponseData(*args, **kwargs)

Bases: ModelNormal

AWS Namespaces response data.

Parameters:

attributes (AWSNamespacesResponseAttributes, optional) – AWS Namespaces response attributes.
id (str) – The AWSNamespacesResponseData id.
type (AWSNamespacesResponseDataType) – The AWSNamespacesResponseData type.

datadog_api_client.v2.model.aws_namespaces_response_data_type module¶

class AWSNamespacesResponseDataType(arg: None)¶

class AWSNamespacesResponseDataType(arg: ModelComposed)

class AWSNamespacesResponseDataType(*args, **kwargs)

Bases: ModelSimple

The AWSNamespacesResponseData type.

Parameters:

value (str) – If omitted defaults to “namespaces”. Must be one of [“namespaces”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_new_external_id_response module¶

class AWSNewExternalIDResponse(arg: None)¶

class AWSNewExternalIDResponse(arg: ModelComposed)

class AWSNewExternalIDResponse(*args, **kwargs)

Bases: ModelNormal

AWS External ID response body.

Parameters:: data (AWSNewExternalIDResponseData) – AWS External ID response body.

datadog_api_client.v2.model.aws_new_external_id_response_attributes module¶

class AWSNewExternalIDResponseAttributes(arg: None)¶

class AWSNewExternalIDResponseAttributes(arg: ModelComposed)

class AWSNewExternalIDResponseAttributes(*args, **kwargs)

Bases: ModelNormal

AWS External ID response body.

Parameters:: external_id (str) – AWS IAM External ID for associated role.

datadog_api_client.v2.model.aws_new_external_id_response_data module¶

class AWSNewExternalIDResponseData(arg: None)¶

class AWSNewExternalIDResponseData(arg: ModelComposed)

class AWSNewExternalIDResponseData(*args, **kwargs)

Bases: ModelNormal

AWS External ID response body.

Parameters:

attributes (AWSNewExternalIDResponseAttributes, optional) – AWS External ID response body.
id (str) – The AWSNewExternalIDResponseData id.
type (AWSNewExternalIDResponseDataType) – The AWSNewExternalIDResponseData type.

datadog_api_client.v2.model.aws_new_external_id_response_data_type module¶

class AWSNewExternalIDResponseDataType(arg: None)¶

class AWSNewExternalIDResponseDataType(arg: ModelComposed)

class AWSNewExternalIDResponseDataType(*args, **kwargs)

Bases: ModelSimple

The AWSNewExternalIDResponseData type.

Parameters:

value (str) – If omitted defaults to “external_id”. Must be one of [“external_id”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_on_demand_attributes module¶

class AwsOnDemandAttributes(arg: None)¶

class AwsOnDemandAttributes(arg: ModelComposed)

class AwsOnDemandAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for the AWS on demand task.

Parameters:

arn (str, optional) – The arn of the resource to scan.
assigned_at (str, optional) – Specifies the assignment timestamp if the task has been already assigned to a scanner.
created_at (str, optional) – The task submission timestamp.
status (str, optional) – Indicates the status of the task. QUEUED: the task has been submitted successfully and the resource has not been assigned to a scanner yet. ASSIGNED: the task has been assigned. ABORTED: the scan has been aborted after a period of time due to technical reasons, such as resource not found, insufficient permissions, or the absence of a configured scanner.

datadog_api_client.v2.model.aws_on_demand_create_attributes module¶

class AwsOnDemandCreateAttributes(arg: None)¶

class AwsOnDemandCreateAttributes(arg: ModelComposed)

class AwsOnDemandCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for the AWS on demand task.

Parameters:: arn (str) – The arn of the resource to scan. Agentless supports the scan of EC2 instances, lambda functions, AMI, ECR, RDS and S3 buckets.

datadog_api_client.v2.model.aws_on_demand_create_data module¶

class AwsOnDemandCreateData(arg: None)¶

class AwsOnDemandCreateData(arg: ModelComposed)

class AwsOnDemandCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single AWS on demand task.

Parameters:

attributes (AwsOnDemandCreateAttributes) – Attributes for the AWS on demand task.
type (AwsOnDemandType) – The type of the on demand task. The value should always be aws_resource.

datadog_api_client.v2.model.aws_on_demand_create_request module¶

class AwsOnDemandCreateRequest(arg: None)¶

class AwsOnDemandCreateRequest(arg: ModelComposed)

class AwsOnDemandCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the on demand task to submit.

Parameters:: data (AwsOnDemandCreateData) – Object for a single AWS on demand task.

datadog_api_client.v2.model.aws_on_demand_data module¶

class AwsOnDemandData(arg: None)¶

class AwsOnDemandData(arg: ModelComposed)

class AwsOnDemandData(*args, **kwargs)

Bases: ModelNormal

Single AWS on demand task.

Parameters:

attributes (AwsOnDemandAttributes, optional) – Attributes for the AWS on demand task.
id (str, optional) – The UUID of the task.
type (AwsOnDemandType, optional) – The type of the on demand task. The value should always be aws_resource.

datadog_api_client.v2.model.aws_on_demand_list_response module¶

class AwsOnDemandListResponse(arg: None)¶

class AwsOnDemandListResponse(arg: ModelComposed)

class AwsOnDemandListResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a list of AWS on demand tasks.

Parameters:: data ([AwsOnDemandData], optional) – A list of on demand tasks.

datadog_api_client.v2.model.aws_on_demand_response module¶

class AwsOnDemandResponse(arg: None)¶

class AwsOnDemandResponse(arg: ModelComposed)

class AwsOnDemandResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes an AWS on demand task.

Parameters:: data (AwsOnDemandData, optional) – Single AWS on demand task.

datadog_api_client.v2.model.aws_on_demand_type module¶

class AwsOnDemandType(arg: None)¶

class AwsOnDemandType(arg: ModelComposed)

class AwsOnDemandType(*args, **kwargs)

Bases: ModelSimple

The type of the on demand task. The value should always be aws_resource.

Parameters:

value (str) – If omitted defaults to “aws_resource”. Must be one of [“aws_resource”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_regions module¶

class AWSRegions(arg: None)¶

class AWSRegions(arg: ModelComposed)

class AWSRegions(*args, **kwargs)

Bases: ModelComposed

AWS Regions to collect data from. Defaults to include_all.

Parameters:

include_all (bool) – Include all regions.
include_only ([str]) – Include only these regions.

datadog_api_client.v2.model.aws_regions_include_all module¶

class AWSRegionsIncludeAll(arg: None)¶

class AWSRegionsIncludeAll(arg: ModelComposed)

class AWSRegionsIncludeAll(*args, **kwargs)

Bases: ModelNormal

Include all regions. Defaults to true.

Parameters:: include_all (bool) – Include all regions.

datadog_api_client.v2.model.aws_regions_include_only module¶

class AWSRegionsIncludeOnly(arg: None)¶

class AWSRegionsIncludeOnly(arg: ModelComposed)

class AWSRegionsIncludeOnly(*args, **kwargs)

Bases: ModelNormal

Include only these regions.

Parameters:: include_only ([str]) – Include only these regions.

datadog_api_client.v2.model.aws_resources_config module¶

class AWSResourcesConfig(arg: None)¶

class AWSResourcesConfig(arg: ModelComposed)

class AWSResourcesConfig(*args, **kwargs)

Bases: ModelNormal

AWS Resources Collection config.

Parameters:

cloud_security_posture_management_collection (bool, optional) – Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.
extended_collection (bool, optional) – Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

datadog_api_client.v2.model.aws_scan_options_attributes module¶

class AwsScanOptionsAttributes(arg: None)¶

class AwsScanOptionsAttributes(arg: ModelComposed)

class AwsScanOptionsAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for the AWS scan options.

Parameters:

_lambda (bool, optional) – Indicates if scanning of Lambda functions is enabled.
sensitive_data (bool, optional) – Indicates if scanning for sensitive data is enabled.
vuln_containers_os (bool, optional) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool, optional) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.aws_scan_options_create_attributes module¶

class AwsScanOptionsCreateAttributes(arg: None)¶

class AwsScanOptionsCreateAttributes(arg: ModelComposed)

class AwsScanOptionsCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for the AWS scan options to create.

Parameters:

_lambda (bool) – Indicates if scanning of Lambda functions is enabled.
sensitive_data (bool) – Indicates if scanning for sensitive data is enabled.
vuln_containers_os (bool) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.aws_scan_options_create_data module¶

class AwsScanOptionsCreateData(arg: None)¶

class AwsScanOptionsCreateData(arg: ModelComposed)

class AwsScanOptionsCreateData(*args, **kwargs)

Bases: ModelNormal

Object for the scan options of a single AWS account.

Parameters:

attributes (AwsScanOptionsCreateAttributes) – Attributes for the AWS scan options to create.
id (str) – The ID of the AWS account.
type (AwsScanOptionsType) – The type of the resource. The value should always be aws_scan_options.

datadog_api_client.v2.model.aws_scan_options_create_request module¶

class AwsScanOptionsCreateRequest(arg: None)¶

class AwsScanOptionsCreateRequest(arg: ModelComposed)

class AwsScanOptionsCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the scan options to create.

Parameters:: data (AwsScanOptionsCreateData) – Object for the scan options of a single AWS account.

datadog_api_client.v2.model.aws_scan_options_data module¶

class AwsScanOptionsData(arg: None)¶

class AwsScanOptionsData(arg: ModelComposed)

class AwsScanOptionsData(*args, **kwargs)

Bases: ModelNormal

Single AWS Scan Options entry.

Parameters:

attributes (AwsScanOptionsAttributes, optional) – Attributes for the AWS scan options.
id (str, optional) – The ID of the AWS account.
type (AwsScanOptionsType, optional) – The type of the resource. The value should always be aws_scan_options.

datadog_api_client.v2.model.aws_scan_options_list_response module¶

class AwsScanOptionsListResponse(arg: None)¶

class AwsScanOptionsListResponse(arg: ModelComposed)

class AwsScanOptionsListResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a list of AWS scan options.

Parameters:: data ([AwsScanOptionsData], optional) – A list of AWS scan options.

datadog_api_client.v2.model.aws_scan_options_response module¶

class AwsScanOptionsResponse(arg: None)¶

class AwsScanOptionsResponse(arg: ModelComposed)

class AwsScanOptionsResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes the scan options of an AWS account.

Parameters:: data (AwsScanOptionsData, optional) – Single AWS Scan Options entry.

datadog_api_client.v2.model.aws_scan_options_type module¶

class AwsScanOptionsType(arg: None)¶

class AwsScanOptionsType(arg: ModelComposed)

class AwsScanOptionsType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be aws_scan_options.

Parameters:

value (str) – If omitted defaults to “aws_scan_options”. Must be one of [“aws_scan_options”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.aws_scan_options_update_attributes module¶

class AwsScanOptionsUpdateAttributes(arg: None)¶

class AwsScanOptionsUpdateAttributes(arg: ModelComposed)

class AwsScanOptionsUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for the AWS scan options to update.

Parameters:

_lambda (bool, optional) – Indicates if scanning of Lambda functions is enabled.
sensitive_data (bool, optional) – Indicates if scanning for sensitive data is enabled.
vuln_containers_os (bool, optional) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool, optional) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.aws_scan_options_update_data module¶

class AwsScanOptionsUpdateData(arg: None)¶

class AwsScanOptionsUpdateData(arg: ModelComposed)

class AwsScanOptionsUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for the scan options of a single AWS account.

Parameters:

attributes (AwsScanOptionsUpdateAttributes) – Attributes for the AWS scan options to update.
id (str) – The ID of the AWS account.
type (AwsScanOptionsType) – The type of the resource. The value should always be aws_scan_options.

datadog_api_client.v2.model.aws_scan_options_update_request module¶

class AwsScanOptionsUpdateRequest(arg: None)¶

class AwsScanOptionsUpdateRequest(arg: ModelComposed)

class AwsScanOptionsUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the scan options to update.

Parameters:: data (AwsScanOptionsUpdateData) – Object for the scan options of a single AWS account.

datadog_api_client.v2.model.aws_traces_config module¶

class AWSTracesConfig(arg: None)¶

class AWSTracesConfig(arg: ModelComposed)

class AWSTracesConfig(*args, **kwargs)

Bases: ModelNormal

AWS Traces Collection config.

Parameters:: xray_services (XRayServicesList, optional) – AWS X-Ray services to collect traces from. Defaults to include_only.

datadog_api_client.v2.model.azure_credentials module¶

class AzureCredentials(arg: None)¶

class AzureCredentials(arg: ModelComposed)

class AzureCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the AzureCredentials object.

Parameters:

app_client_id (str) – The Client ID, also known as the Application ID in Azure, is a unique identifier for an application. It’s used to identify the application during the authentication process. Your Application (client) ID is listed in the application’s overview page. You can navigate to your application via the Azure Directory.
client_secret (str) – The Client Secret is a confidential piece of information known only to the application and Azure AD. It’s used to prove the application’s identity. Your Client Secret is available from the application’s secrets page. You can navigate to your application via the Azure Directory.
custom_scopes (str, optional) – If provided, the custom scope to be requested from Microsoft when acquiring an OAuth 2 access token. This custom scope is used only in conjunction with the HTTP action. A resource’s scope is constructed by using the identifier URI for the resource and .default, separated by a forward slash (/) as follows:{identifierURI}/.default.
tenant_id (str) – The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the ‘Tenant information’ section.
type (AzureTenantType) – The definition of the AzureTenant object.

datadog_api_client.v2.model.azure_credentials_update module¶

class AzureCredentialsUpdate(arg: None)¶

class AzureCredentialsUpdate(arg: ModelComposed)

class AzureCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the AzureCredentialsUpdate object.

Parameters:

app_client_id (str, optional) – The Client ID, also known as the Application ID in Azure, is a unique identifier for an application. It’s used to identify the application during the authentication process. Your Application (client) ID is listed in the application’s overview page. You can navigate to your application via the Azure Directory.
client_secret (str, optional) – The Client Secret is a confidential piece of information known only to the application and Azure AD. It’s used to prove the application’s identity. Your Client Secret is available from the application’s secrets page. You can navigate to your application via the Azure Directory.
custom_scopes (str, optional) – If provided, the custom scope to be requested from Microsoft when acquiring an OAuth 2 access token. This custom scope is used only in conjunction with the HTTP action. A resource’s scope is constructed by using the identifier URI for the resource and .default, separated by a forward slash (/) as follows:{identifierURI}/.default.
tenant_id (str, optional) – The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the ‘Tenant information’ section.
type (AzureTenantType) – The definition of the AzureTenant object.

datadog_api_client.v2.model.azure_integration module¶

class AzureIntegration(arg: None)¶

class AzureIntegration(arg: ModelComposed)

class AzureIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the AzureIntegration object.

Parameters:

credentials (AzureCredentials) – The definition of the AzureCredentials object.
type (AzureIntegrationType) – The definition of the AzureIntegrationType object.

datadog_api_client.v2.model.azure_integration_type module¶

class AzureIntegrationType(arg: None)¶

class AzureIntegrationType(arg: ModelComposed)

class AzureIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the AzureIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Azure”. Must be one of [“Azure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_integration_update module¶

class AzureIntegrationUpdate(arg: None)¶

class AzureIntegrationUpdate(arg: ModelComposed)

class AzureIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the AzureIntegrationUpdate object.

Parameters:

credentials (AzureCredentialsUpdate, optional) – The definition of the AzureCredentialsUpdate object.
type (AzureIntegrationType) – The definition of the AzureIntegrationType object.

datadog_api_client.v2.model.azure_scan_options module¶

class AzureScanOptions(arg: None)¶

class AzureScanOptions(arg: ModelComposed)

class AzureScanOptions(*args, **kwargs)

Bases: ModelNormal

Response object containing Azure scan options for a single subscription.

Parameters:: data (AzureScanOptionsData, optional) – Single Azure scan options entry.

datadog_api_client.v2.model.azure_scan_options_array module¶

class AzureScanOptionsArray(arg: None)¶

class AzureScanOptionsArray(arg: ModelComposed)

class AzureScanOptionsArray(*args, **kwargs)

Bases: ModelNormal

Response object containing a list of Azure scan options.

Parameters:: data ([AzureScanOptionsData]) – A list of Azure scan options.

datadog_api_client.v2.model.azure_scan_options_data module¶

class AzureScanOptionsData(arg: None)¶

class AzureScanOptionsData(arg: ModelComposed)

class AzureScanOptionsData(*args, **kwargs)

Bases: ModelNormal

Single Azure scan options entry.

Parameters:

attributes (AzureScanOptionsDataAttributes, optional) – Attributes for Azure scan options configuration.
id (str) – The Azure subscription ID.
type (AzureScanOptionsDataType) – The type of the resource. The value should always be azure_scan_options.

datadog_api_client.v2.model.azure_scan_options_data_attributes module¶

class AzureScanOptionsDataAttributes(arg: None)¶

class AzureScanOptionsDataAttributes(arg: ModelComposed)

class AzureScanOptionsDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Azure scan options configuration.

Parameters:

vuln_containers_os (bool, optional) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool, optional) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.azure_scan_options_data_type module¶

class AzureScanOptionsDataType(arg: None)¶

class AzureScanOptionsDataType(arg: ModelComposed)

class AzureScanOptionsDataType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be azure_scan_options.

Parameters:

value (str) – If omitted defaults to “azure_scan_options”. Must be one of [“azure_scan_options”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_scan_options_input_update module¶

class AzureScanOptionsInputUpdate(arg: None)¶

class AzureScanOptionsInputUpdate(arg: ModelComposed)

class AzureScanOptionsInputUpdate(*args, **kwargs)

Bases: ModelNormal

Request object for updating Azure scan options.

Parameters:: data (AzureScanOptionsInputUpdateData, optional) – Data object for updating the scan options of a single Azure subscription.

datadog_api_client.v2.model.azure_scan_options_input_update_data module¶

class AzureScanOptionsInputUpdateData(arg: None)¶

class AzureScanOptionsInputUpdateData(arg: ModelComposed)

class AzureScanOptionsInputUpdateData(*args, **kwargs)

Bases: ModelNormal

Data object for updating the scan options of a single Azure subscription.

Parameters:

attributes (AzureScanOptionsInputUpdateDataAttributes, optional) – Attributes for updating Azure scan options configuration.
id (str) – The Azure subscription ID.
type (AzureScanOptionsInputUpdateDataType) – Azure scan options resource type.

datadog_api_client.v2.model.azure_scan_options_input_update_data_attributes module¶

class AzureScanOptionsInputUpdateDataAttributes(arg: None)¶

class AzureScanOptionsInputUpdateDataAttributes(arg: ModelComposed)

class AzureScanOptionsInputUpdateDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for updating Azure scan options configuration.

Parameters:

vuln_containers_os (bool, optional) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool, optional) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.azure_scan_options_input_update_data_type module¶

class AzureScanOptionsInputUpdateDataType(arg: None)¶

class AzureScanOptionsInputUpdateDataType(arg: ModelComposed)

class AzureScanOptionsInputUpdateDataType(*args, **kwargs)

Bases: ModelSimple

Azure scan options resource type.

Parameters:

value (str) – If omitted defaults to “azure_scan_options”. Must be one of [“azure_scan_options”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_storage_destination module¶

class AzureStorageDestination(arg: None)¶

class AzureStorageDestination(arg: ModelComposed)

class AzureStorageDestination(*args, **kwargs)

Bases: ModelNormal

The azure_storage destination forwards logs to an Azure Blob Storage container.

Parameters:

blob_prefix (str, optional) – Optional prefix for blobs written to the container.
container_name (str) – The name of the Azure Blob Storage container to store logs in.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (AzureStorageDestinationType) – The destination type. The value should always be azure_storage.

datadog_api_client.v2.model.azure_storage_destination_type module¶

class AzureStorageDestinationType(arg: None)¶

class AzureStorageDestinationType(arg: ModelComposed)

class AzureStorageDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be azure_storage.

Parameters:

value (str) – If omitted defaults to “azure_storage”. Must be one of [“azure_storage”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_tenant module¶

class AzureTenant(arg: None)¶

class AzureTenant(arg: ModelComposed)

class AzureTenant(*args, **kwargs)

Bases: ModelNormal

The definition of the AzureTenant object.

Parameters:

app_client_id (str) – The Client ID, also known as the Application ID in Azure, is a unique identifier for an application. It’s used to identify the application during the authentication process. Your Application (client) ID is listed in the application’s overview page. You can navigate to your application via the Azure Directory.
client_secret (str) – The Client Secret is a confidential piece of information known only to the application and Azure AD. It’s used to prove the application’s identity. Your Client Secret is available from the application’s secrets page. You can navigate to your application via the Azure Directory.
custom_scopes (str, optional) – If provided, the custom scope to be requested from Microsoft when acquiring an OAuth 2 access token. This custom scope is used only in conjunction with the HTTP action. A resource’s scope is constructed by using the identifier URI for the resource and .default, separated by a forward slash (/) as follows:{identifierURI}/.default.
tenant_id (str) – The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the ‘Tenant information’ section.
type (AzureTenantType) – The definition of the AzureTenant object.

datadog_api_client.v2.model.azure_tenant_type module¶

class AzureTenantType(arg: None)¶

class AzureTenantType(arg: ModelComposed)

class AzureTenantType(*args, **kwargs)

Bases: ModelSimple

The definition of the AzureTenant object.

Parameters:

value (str) – If omitted defaults to “AzureTenant”. Must be one of [“AzureTenant”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_tenant_update module¶

class AzureTenantUpdate(arg: None)¶

class AzureTenantUpdate(arg: ModelComposed)

class AzureTenantUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the AzureTenant object.

Parameters:

app_client_id (str, optional) – The Client ID, also known as the Application ID in Azure, is a unique identifier for an application. It’s used to identify the application during the authentication process. Your Application (client) ID is listed in the application’s overview page. You can navigate to your application via the Azure Directory.
client_secret (str, optional) – The Client Secret is a confidential piece of information known only to the application and Azure AD. It’s used to prove the application’s identity. Your Client Secret is available from the application’s secrets page. You can navigate to your application via the Azure Directory.
custom_scopes (str, optional) – If provided, the custom scope to be requested from Microsoft when acquiring an OAuth 2 access token. This custom scope is used only in conjunction with the HTTP action. A resource’s scope is constructed by using the identifier URI for the resource and .default, separated by a forward slash (/) as follows:{identifierURI}/.default.
tenant_id (str, optional) – The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the ‘Tenant information’ section.
type (AzureTenantType) – The definition of the AzureTenant object.

datadog_api_client.v2.model.azure_uc_config module¶

class AzureUCConfig(arg: None)¶

class AzureUCConfig(arg: ModelComposed)

class AzureUCConfig(*args, **kwargs)

Bases: ModelNormal

Azure config.

Parameters:

account_id (str) – The tenant ID of the Azure account.
client_id (str) – The client ID of the Azure account.
created_at (str, optional) – The timestamp when the Azure config was created.
dataset_type (str) – The dataset type of the Azure config.
error_messages ([str], none_type, optional) – The error messages for the Azure config.
export_name (str) – The name of the configured Azure Export.
export_path (str) – The path where the Azure Export is saved.
id (str, optional) – The ID of the Azure config.
months (int, optional) – The number of months the report has been backfilled. Deprecated.
scope (str) – The scope of your observed subscription.
status (str) – The status of the Azure config.
status_updated_at (str, optional) – The timestamp when the Azure config status was last updated.
storage_account (str) – The name of the storage account where the Azure Export is saved.
storage_container (str) – The name of the storage container where the Azure Export is saved.
updated_at (str, optional) – The timestamp when the Azure config was last updated.

datadog_api_client.v2.model.azure_uc_config_pair module¶

class AzureUCConfigPair(arg: None)¶

class AzureUCConfigPair(arg: ModelComposed)

class AzureUCConfigPair(*args, **kwargs)

Bases: ModelNormal

Azure config pair.

Parameters:

attributes (AzureUCConfigPairAttributes) – Attributes for Azure config pair.
id (str, optional) – The ID of Cloud Cost Management account.
type (AzureUCConfigPairType) – Type of Azure config pair.

datadog_api_client.v2.model.azure_uc_config_pair_attributes module¶

class AzureUCConfigPairAttributes(arg: None)¶

class AzureUCConfigPairAttributes(arg: ModelComposed)

class AzureUCConfigPairAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Azure config pair.

Parameters:

configs ([AzureUCConfig]) – An Azure config.
id (str, optional) – The ID of the Azure config pair.

datadog_api_client.v2.model.azure_uc_config_pair_type module¶

class AzureUCConfigPairType(arg: None)¶

class AzureUCConfigPairType(arg: ModelComposed)

class AzureUCConfigPairType(*args, **kwargs)

Bases: ModelSimple

Type of Azure config pair.

Parameters:

value (str) – If omitted defaults to “azure_uc_configs”. Must be one of [“azure_uc_configs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_uc_config_pairs_response module¶

class AzureUCConfigPairsResponse(arg: None)¶

class AzureUCConfigPairsResponse(arg: ModelComposed)

class AzureUCConfigPairsResponse(*args, **kwargs)

Bases: ModelNormal

Response of Azure config pair.

Parameters:: data (AzureUCConfigPair, optional) – Azure config pair.

datadog_api_client.v2.model.azure_uc_config_patch_data module¶

class AzureUCConfigPatchData(arg: None)¶

class AzureUCConfigPatchData(arg: ModelComposed)

class AzureUCConfigPatchData(*args, **kwargs)

Bases: ModelNormal

Azure config Patch data.

Parameters:

attributes (AzureUCConfigPatchRequestAttributes, optional) – Attributes for Azure config Patch Request.
type (AzureUCConfigPatchRequestType) – Type of Azure config Patch Request.

datadog_api_client.v2.model.azure_uc_config_patch_request module¶

class AzureUCConfigPatchRequest(arg: None)¶

class AzureUCConfigPatchRequest(arg: ModelComposed)

class AzureUCConfigPatchRequest(*args, **kwargs)

Bases: ModelNormal

Azure config Patch Request.

Parameters:: data (AzureUCConfigPatchData) – Azure config Patch data.

datadog_api_client.v2.model.azure_uc_config_patch_request_attributes module¶

class AzureUCConfigPatchRequestAttributes(arg: None)¶

class AzureUCConfigPatchRequestAttributes(arg: ModelComposed)

class AzureUCConfigPatchRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Azure config Patch Request.

Parameters:: is_enabled (bool) – Whether or not the Cloud Cost Management account is enabled.

datadog_api_client.v2.model.azure_uc_config_patch_request_type module¶

class AzureUCConfigPatchRequestType(arg: None)¶

class AzureUCConfigPatchRequestType(arg: ModelComposed)

class AzureUCConfigPatchRequestType(*args, **kwargs)

Bases: ModelSimple

Type of Azure config Patch Request.

Parameters:

value (str) – If omitted defaults to “azure_uc_config_patch_request”. Must be one of [“azure_uc_config_patch_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_uc_config_post_data module¶

class AzureUCConfigPostData(arg: None)¶

class AzureUCConfigPostData(arg: ModelComposed)

class AzureUCConfigPostData(*args, **kwargs)

Bases: ModelNormal

Azure config Post data.

Parameters:

attributes (AzureUCConfigPostRequestAttributes, optional) – Attributes for Azure config Post Request.
type (AzureUCConfigPostRequestType) – Type of Azure config Post Request.

datadog_api_client.v2.model.azure_uc_config_post_request module¶

class AzureUCConfigPostRequest(arg: None)¶

class AzureUCConfigPostRequest(arg: ModelComposed)

class AzureUCConfigPostRequest(*args, **kwargs)

Bases: ModelNormal

Azure config Post Request.

Parameters:: data (AzureUCConfigPostData) – Azure config Post data.

datadog_api_client.v2.model.azure_uc_config_post_request_attributes module¶

class AzureUCConfigPostRequestAttributes(arg: None)¶

class AzureUCConfigPostRequestAttributes(arg: ModelComposed)

class AzureUCConfigPostRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Azure config Post Request.

Parameters:

account_id (str) – The tenant ID of the Azure account.
actual_bill_config (BillConfig) – Bill config.
amortized_bill_config (BillConfig) – Bill config.
client_id (str) – The client ID of the Azure account.
scope (str) – The scope of your observed subscription.

datadog_api_client.v2.model.azure_uc_config_post_request_type module¶

class AzureUCConfigPostRequestType(arg: None)¶

class AzureUCConfigPostRequestType(arg: ModelComposed)

class AzureUCConfigPostRequestType(*args, **kwargs)

Bases: ModelSimple

Type of Azure config Post Request.

Parameters:

value (str) – If omitted defaults to “azure_uc_config_post_request”. Must be one of [“azure_uc_config_post_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.azure_uc_configs_response module¶

class AzureUCConfigsResponse(arg: None)¶

class AzureUCConfigsResponse(arg: ModelComposed)

class AzureUCConfigsResponse(*args, **kwargs)

Bases: ModelNormal

List of Azure accounts with configs.

Parameters:: data ([AzureUCConfigPair]) – An Azure config pair.

datadog_api_client.v2.model.bill_config module¶

class BillConfig(arg: None)¶

class BillConfig(arg: ModelComposed)

class BillConfig(*args, **kwargs)

Bases: ModelNormal

Bill config.

Parameters:

export_name (str) – The name of the configured Azure Export.
export_path (str) – The path where the Azure Export is saved.
storage_account (str) – The name of the storage account where the Azure Export is saved.
storage_container (str) – The name of the storage container where the Azure Export is saved.

datadog_api_client.v2.model.billing_dimensions_mapping_body_item module¶

class BillingDimensionsMappingBodyItem(arg: None)¶

class BillingDimensionsMappingBodyItem(arg: ModelComposed)

class BillingDimensionsMappingBodyItem(*args, **kwargs)

Bases: ModelNormal

The mapping data for each billing dimension.

Parameters:

attributes (BillingDimensionsMappingBodyItemAttributes, optional) – Mapping of billing dimensions to endpoint keys.
id (str, optional) – ID of the billing dimension.
type (ActiveBillingDimensionsType, optional) – Type of active billing dimensions data.

datadog_api_client.v2.model.billing_dimensions_mapping_body_item_attributes module¶

class BillingDimensionsMappingBodyItemAttributes(arg: None)¶

class BillingDimensionsMappingBodyItemAttributes(arg: ModelComposed)

class BillingDimensionsMappingBodyItemAttributes(*args, **kwargs)

Bases: ModelNormal

Mapping of billing dimensions to endpoint keys.

Parameters:

endpoints ([BillingDimensionsMappingBodyItemAttributesEndpointsItems], optional) – List of supported endpoints with their keys mapped to the billing_dimension.
in_app_label (str, optional) – Label used for the billing dimension in the Plan & Usage charts.
timestamp (datetime, optional) – Month in ISO-8601 format, UTC, and precise to the second: [YYYY-MM-DDThh:mm:ss].

datadog_api_client.v2.model.billing_dimensions_mapping_body_item_attributes_endpoints_items module¶

class BillingDimensionsMappingBodyItemAttributesEndpointsItems(arg: None)¶

class BillingDimensionsMappingBodyItemAttributesEndpointsItems(arg: ModelComposed)

class BillingDimensionsMappingBodyItemAttributesEndpointsItems(*args, **kwargs)

Bases: ModelNormal

An endpoint’s keys mapped to the billing_dimension.

Parameters:

id (str, optional) – The URL for the endpoint.
keys ([str], optional) – The billing dimension.
status (BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus, optional) – Denotes whether mapping keys were available for this endpoint.

datadog_api_client.v2.model.billing_dimensions_mapping_body_item_attributes_endpoints_items_status module¶

class BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus(arg: None)¶

class BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus(arg: ModelComposed)

class BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus(*args, **kwargs)

Bases: ModelSimple

Denotes whether mapping keys were available for this endpoint.

Parameters:

value (str) – Must be one of [“OK”, “NOT_FOUND”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.billing_dimensions_mapping_response module¶

class BillingDimensionsMappingResponse(arg: None)¶

class BillingDimensionsMappingResponse(arg: ModelComposed)

class BillingDimensionsMappingResponse(*args, **kwargs)

Bases: ModelNormal

Billing dimensions mapping response.

Parameters:: data ([BillingDimensionsMappingBodyItem], optional) – Billing dimensions mapping data.

datadog_api_client.v2.model.budget module¶

class Budget(arg: None)¶

class Budget(arg: ModelComposed)

class Budget(*args, **kwargs)

Bases: ModelNormal

A budget.

Parameters:

attributes (BudgetAttributes, optional) – The attributes of a budget.
id (str, optional) – The id of the budget.
type (str, optional) – The type of the object, must be budget.

datadog_api_client.v2.model.budget_array module¶

class BudgetArray(arg: None)¶

class BudgetArray(arg: ModelComposed)

class BudgetArray(*args, **kwargs)

Bases: ModelNormal

An array of budgets.

Parameters:: data ([Budget], optional) – The BudgetArray data.

datadog_api_client.v2.model.budget_attributes module¶

class BudgetAttributes(arg: None)¶

class BudgetAttributes(arg: ModelComposed)

class BudgetAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of a budget.

Parameters:

created_at (int, optional) – The timestamp when the budget was created.
created_by (str, optional) – The id of the user that created the budget.
end_month (int, optional) – The month when the budget ends.
entries ([BudgetEntry], optional) – The entries of the budget.
metrics_query (str, optional) – The cost query used to track against the budget.
name (str, optional) – The name of the budget.
org_id (int, optional) – The id of the org the budget belongs to.
start_month (int, optional) – The month when the budget starts.
total_amount (float, optional) – The sum of all budget entries’ amounts.
updated_at (int, optional) – The timestamp when the budget was last updated.
updated_by (str, optional) – The id of the user that created the budget.

datadog_api_client.v2.model.budget_entry module¶

class BudgetEntry(arg: None)¶

class BudgetEntry(arg: ModelComposed)

class BudgetEntry(*args, **kwargs)

Bases: ModelNormal

The entry of a budget.

Parameters:

amount (float, optional) – The amount of the budget entry.
month (int, optional) – The month of the budget entry.
tag_filters ([TagFilter], optional) – The tag_filters of the budget entry.

datadog_api_client.v2.model.budget_with_entries module¶

class BudgetWithEntries(arg: None)¶

class BudgetWithEntries(arg: ModelComposed)

class BudgetWithEntries(*args, **kwargs)

Bases: ModelNormal

The definition of the BudgetWithEntries object.

Parameters:: data (BudgetWithEntriesData, optional) – A budget and all its entries.

datadog_api_client.v2.model.budget_with_entries_data module¶

class BudgetWithEntriesData(arg: None)¶

class BudgetWithEntriesData(arg: ModelComposed)

class BudgetWithEntriesData(*args, **kwargs)

Bases: ModelNormal

A budget and all its entries.

Parameters:

attributes (BudgetAttributes, optional) – The attributes of a budget.
id (str, optional) – The BudgetWithEntriesData id.
type (str, optional) – The type of the object, must be budget.

datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request module¶

class BulkDeleteAppsDatastoreItemsRequest(arg: None)¶

class BulkDeleteAppsDatastoreItemsRequest(arg: ModelComposed)

class BulkDeleteAppsDatastoreItemsRequest(*args, **kwargs)

Bases: ModelNormal

Request to delete items from a datastore.

Parameters:: data (BulkDeleteAppsDatastoreItemsRequestData, optional) – Data wrapper containing the data needed to delete items from a datastore.

datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data module¶

class BulkDeleteAppsDatastoreItemsRequestData(arg: None)¶

class BulkDeleteAppsDatastoreItemsRequestData(arg: ModelComposed)

class BulkDeleteAppsDatastoreItemsRequestData(*args, **kwargs)

Bases: ModelNormal

Data wrapper containing the data needed to delete items from a datastore.

Parameters:

attributes (BulkDeleteAppsDatastoreItemsRequestDataAttributes, optional) – Attributes of request data to delete items from a datastore.
id (str, optional) – ID for the datastore of the items to delete.
type (BulkDeleteAppsDatastoreItemsRequestDataType) – Items resource type.

datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data_attributes module¶

class BulkDeleteAppsDatastoreItemsRequestDataAttributes(arg: None)¶

class BulkDeleteAppsDatastoreItemsRequestDataAttributes(arg: ModelComposed)

class BulkDeleteAppsDatastoreItemsRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of request data to delete items from a datastore.

Parameters:: item_keys ([str], optional) – List of primary keys identifying items to delete from datastore. Up to 100 items can be deleted in a single request.

datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data_type module¶

class BulkDeleteAppsDatastoreItemsRequestDataType(arg: None)¶

class BulkDeleteAppsDatastoreItemsRequestDataType(arg: ModelComposed)

class BulkDeleteAppsDatastoreItemsRequestDataType(*args, **kwargs)

Bases: ModelSimple

Items resource type.

Parameters:

value (str) – If omitted defaults to “items”. Must be one of [“items”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.bulk_mute_findings_request module¶

class BulkMuteFindingsRequest(arg: None)¶

class BulkMuteFindingsRequest(arg: ModelComposed)

class BulkMuteFindingsRequest(*args, **kwargs)

Bases: ModelNormal

The new bulk mute finding request.

Parameters:: data (BulkMuteFindingsRequestData) – Data object containing the new bulk mute properties of the finding.

datadog_api_client.v2.model.bulk_mute_findings_request_attributes module¶

class BulkMuteFindingsRequestAttributes(arg: None)¶

class BulkMuteFindingsRequestAttributes(arg: ModelComposed)

class BulkMuteFindingsRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The mute properties to be updated.

Parameters:: mute (BulkMuteFindingsRequestProperties) – Object containing the new mute properties of the findings.

additional_properties_type = None¶

datadog_api_client.v2.model.bulk_mute_findings_request_data module¶

class BulkMuteFindingsRequestData(arg: None)¶

class BulkMuteFindingsRequestData(arg: ModelComposed)

class BulkMuteFindingsRequestData(*args, **kwargs)

Bases: ModelNormal

Data object containing the new bulk mute properties of the finding.

Parameters:

attributes (BulkMuteFindingsRequestAttributes) – The mute properties to be updated.
id (str) – UUID to identify the request
meta (BulkMuteFindingsRequestMeta) – Meta object containing the findings to be updated.
type (FindingType) – The JSON:API type for findings.

datadog_api_client.v2.model.bulk_mute_findings_request_meta module¶

class BulkMuteFindingsRequestMeta(arg: None)¶

class BulkMuteFindingsRequestMeta(arg: ModelComposed)

class BulkMuteFindingsRequestMeta(*args, **kwargs)

Bases: ModelNormal

Meta object containing the findings to be updated.

Parameters:: findings ([BulkMuteFindingsRequestMetaFindings], optional) – Array of findings.

datadog_api_client.v2.model.bulk_mute_findings_request_meta_findings module¶

class BulkMuteFindingsRequestMetaFindings(arg: None)¶

class BulkMuteFindingsRequestMetaFindings(arg: ModelComposed)

class BulkMuteFindingsRequestMetaFindings(*args, **kwargs)

Bases: ModelNormal

Finding object containing the finding information.

Parameters:: finding_id (str, optional) – The unique ID for this finding.

datadog_api_client.v2.model.bulk_mute_findings_request_properties module¶

class BulkMuteFindingsRequestProperties(arg: None)¶

class BulkMuteFindingsRequestProperties(arg: ModelComposed)

class BulkMuteFindingsRequestProperties(*args, **kwargs)

Bases: ModelNormal

Object containing the new mute properties of the findings.

Parameters:

description (str, optional) – Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.
expiration_date (int, optional) – The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp. If this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.
muted (bool) – Whether those findings should be muted or unmuted.
reason (FindingMuteReason) – The reason why this finding is muted or unmuted.

additional_properties_type = None¶

datadog_api_client.v2.model.bulk_mute_findings_response module¶

class BulkMuteFindingsResponse(arg: None)¶

class BulkMuteFindingsResponse(arg: ModelComposed)

class BulkMuteFindingsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema.

Parameters:: data (BulkMuteFindingsResponseData) – Data object containing the ID of the request that was updated.

datadog_api_client.v2.model.bulk_mute_findings_response_data module¶

class BulkMuteFindingsResponseData(arg: None)¶

class BulkMuteFindingsResponseData(arg: ModelComposed)

class BulkMuteFindingsResponseData(*args, **kwargs)

Bases: ModelNormal

Data object containing the ID of the request that was updated.

Parameters:

id (str, optional) – UUID used to identify the request
type (FindingType, optional) – The JSON:API type for findings.

datadog_api_client.v2.model.bulk_put_apps_datastore_items_request module¶

class BulkPutAppsDatastoreItemsRequest(arg: None)¶

class BulkPutAppsDatastoreItemsRequest(arg: ModelComposed)

class BulkPutAppsDatastoreItemsRequest(*args, **kwargs)

Bases: ModelNormal

Request to insert multiple items into a datastore in a single operation.

Parameters:: data (BulkPutAppsDatastoreItemsRequestData, optional) – Data wrapper containing the items to insert and their configuration for the bulk insert operation.

datadog_api_client.v2.model.bulk_put_apps_datastore_items_request_data module¶

class BulkPutAppsDatastoreItemsRequestData(arg: None)¶

class BulkPutAppsDatastoreItemsRequestData(arg: ModelComposed)

class BulkPutAppsDatastoreItemsRequestData(*args, **kwargs)

Bases: ModelNormal

Data wrapper containing the items to insert and their configuration for the bulk insert operation.

Parameters:

attributes (BulkPutAppsDatastoreItemsRequestDataAttributes, optional) – Configuration for bulk inserting multiple items into a datastore.
type (DatastoreItemsDataType) – The resource type for datastore items.

datadog_api_client.v2.model.bulk_put_apps_datastore_items_request_data_attributes module¶

class BulkPutAppsDatastoreItemsRequestDataAttributes(arg: None)¶

class BulkPutAppsDatastoreItemsRequestDataAttributes(arg: ModelComposed)

class BulkPutAppsDatastoreItemsRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Configuration for bulk inserting multiple items into a datastore.

Parameters:

conflict_mode (DatastoreItemConflictMode, optional) – How to handle conflicts when inserting items that already exist in the datastore.
values ([{str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}]) – An array of items to add to the datastore, where each item is a set of key-value pairs representing the item’s data. Up to 100 items can be updated in a single request.

datadog_api_client.v2.model.calculated_field module¶

class CalculatedField(arg: None)¶

class CalculatedField(arg: ModelComposed)

class CalculatedField(*args, **kwargs)

Bases: ModelNormal

Calculated field.

Parameters:

expression (str) – Expression.
name (str) – Field name.

datadog_api_client.v2.model.cancel_data_deletion_response_body module¶

class CancelDataDeletionResponseBody(arg: None)¶

class CancelDataDeletionResponseBody(arg: ModelComposed)

class CancelDataDeletionResponseBody(*args, **kwargs)

Bases: ModelNormal

The response from the cancel data deletion request endpoint.

Parameters:

data (DataDeletionResponseItem, optional) – The created data deletion request information.
meta (DataDeletionResponseMeta, optional) – The metadata of the data deletion response.

datadog_api_client.v2.model.case module¶

class Case(arg: None)¶

class Case(arg: ModelComposed)

class Case(*args, **kwargs)

Bases: ModelNormal

A case

Parameters:

attributes (CaseAttributes) – Case resource attributes
id (str) – Case’s identifier
relationships (CaseRelationships, optional) – Resources related to a case
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case3rd_party_ticket_status module¶

class Case3rdPartyTicketStatus(arg: None)¶

class Case3rdPartyTicketStatus(arg: ModelComposed)

class Case3rdPartyTicketStatus(*args, **kwargs)

Bases: ModelSimple

Case status

Parameters:

value (str) – If omitted defaults to “IN_PROGRESS”. Must be one of [“IN_PROGRESS”, “COMPLETED”, “FAILED”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_assign module¶

class CaseAssign(arg: None)¶

class CaseAssign(arg: ModelComposed)

class CaseAssign(*args, **kwargs)

Bases: ModelNormal

Case assign

Parameters:

attributes (CaseAssignAttributes) – Case assign attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_assign_attributes module¶

class CaseAssignAttributes(arg: None)¶

class CaseAssignAttributes(arg: ModelComposed)

class CaseAssignAttributes(*args, **kwargs)

Bases: ModelNormal

Case assign attributes

Parameters:: assignee_id (str) – Assignee’s UUID

datadog_api_client.v2.model.case_assign_request module¶

class CaseAssignRequest(arg: None)¶

class CaseAssignRequest(arg: ModelComposed)

class CaseAssignRequest(*args, **kwargs)

Bases: ModelNormal

Case assign request

Parameters:: data (CaseAssign) – Case assign

datadog_api_client.v2.model.case_attributes module¶

class CaseAttributes(arg: None)¶

class CaseAttributes(arg: ModelComposed)

class CaseAttributes(*args, **kwargs)

Bases: ModelNormal

Case resource attributes

Parameters:

archived_at (datetime, none_type, optional) – Timestamp of when the case was archived
attributes (CaseObjectAttributes, optional) – The definition of CaseObjectAttributes object.
closed_at (datetime, none_type, optional) – Timestamp of when the case was closed
created_at (datetime, optional) – Timestamp of when the case was created
custom_attributes ({str: (CustomAttributeValue,)}, optional) – Case custom attributes
description (str, optional) – Description
jira_issue (JiraIssue, none_type, optional) – Jira issue attached to case
key (str, optional) – Key
modified_at (datetime, none_type, optional) – Timestamp of when the case was last modified
priority (CasePriority, optional) – Case priority
service_now_ticket (ServiceNowTicket, none_type, optional) – ServiceNow ticket attached to case
status (CaseStatus, optional) – Case status
title (str, optional) – Title
type (CaseType, optional) – Case type Deprecated.
type_id (str, optional) – Case type UUID

datadog_api_client.v2.model.case_comment module¶

class CaseComment(arg: None)¶

class CaseComment(arg: ModelComposed)

class CaseComment(*args, **kwargs)

Bases: ModelNormal

Case comment

Parameters:

attributes (CaseCommentAttributes) – Case comment attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_comment_attributes module¶

class CaseCommentAttributes(arg: None)¶

class CaseCommentAttributes(arg: ModelComposed)

class CaseCommentAttributes(*args, **kwargs)

Bases: ModelNormal

Case comment attributes

Parameters:: comment (str) – The CaseCommentAttributes message.

datadog_api_client.v2.model.case_comment_request module¶

class CaseCommentRequest(arg: None)¶

class CaseCommentRequest(arg: ModelComposed)

class CaseCommentRequest(*args, **kwargs)

Bases: ModelNormal

Case comment request

Parameters:: data (CaseComment) – Case comment

datadog_api_client.v2.model.case_create module¶

class CaseCreate(arg: None)¶

class CaseCreate(arg: ModelComposed)

class CaseCreate(*args, **kwargs)

Bases: ModelNormal

Case creation data

Parameters:

attributes (CaseCreateAttributes) – Case creation attributes
relationships (CaseCreateRelationships, optional) – Relationships formed with the case on creation
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_create_attributes module¶

class CaseCreateAttributes(arg: None)¶

class CaseCreateAttributes(arg: ModelComposed)

class CaseCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Case creation attributes

Parameters:

description (str, optional) – Description
priority (CasePriority, optional) – Case priority
title (str) – Title
type_id (str) – Case type UUID

datadog_api_client.v2.model.case_create_relationships module¶

class CaseCreateRelationships(arg: None)¶

class CaseCreateRelationships(arg: ModelComposed)

class CaseCreateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships formed with the case on creation

Parameters:

assignee (NullableUserRelationship, none_type, optional) – Relationship to user.
project (ProjectRelationship) – Relationship to project

datadog_api_client.v2.model.case_create_request module¶

class CaseCreateRequest(arg: None)¶

class CaseCreateRequest(arg: ModelComposed)

class CaseCreateRequest(*args, **kwargs)

Bases: ModelNormal

Case create request

Parameters:: data (CaseCreate) – Case creation data

datadog_api_client.v2.model.case_empty module¶

class CaseEmpty(arg: None)¶

class CaseEmpty(arg: ModelComposed)

class CaseEmpty(*args, **kwargs)

Bases: ModelNormal

Case empty request data

Parameters:: type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_empty_request module¶

class CaseEmptyRequest(arg: None)¶

class CaseEmptyRequest(arg: ModelComposed)

class CaseEmptyRequest(*args, **kwargs)

Bases: ModelNormal

Case empty request

Parameters:: data (CaseEmpty) – Case empty request data

datadog_api_client.v2.model.case_object_attributes module¶

class CaseObjectAttributes(arg: None)¶

class CaseObjectAttributes(arg: ModelComposed)

class CaseObjectAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of CaseObjectAttributes object.

datadog_api_client.v2.model.case_priority module¶

class CasePriority(arg: None)¶

class CasePriority(arg: ModelComposed)

class CasePriority(*args, **kwargs)

Bases: ModelSimple

Case priority

Parameters:

value (str) – If omitted defaults to “NOT_DEFINED”. Must be one of [“NOT_DEFINED”, “P1”, “P2”, “P3”, “P4”, “P5”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_relationships module¶

class CaseRelationships(arg: None)¶

class CaseRelationships(arg: ModelComposed)

class CaseRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to a case

Parameters:

assignee (NullableUserRelationship, none_type, optional) – Relationship to user.
created_by (NullableUserRelationship, none_type, optional) – Relationship to user.
modified_by (NullableUserRelationship, none_type, optional) – Relationship to user.
project (ProjectRelationship, optional) – Relationship to project

datadog_api_client.v2.model.case_resource_type module¶

class CaseResourceType(arg: None)¶

class CaseResourceType(arg: ModelComposed)

class CaseResourceType(*args, **kwargs)

Bases: ModelSimple

Case resource type

Parameters:

value (str) – If omitted defaults to “case”. Must be one of [“case”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_response module¶

class CaseResponse(arg: None)¶

class CaseResponse(arg: ModelComposed)

class CaseResponse(*args, **kwargs)

Bases: ModelNormal

Case response

Parameters:: data (Case, optional) – A case

datadog_api_client.v2.model.case_sortable_field module¶

class CaseSortableField(arg: None)¶

class CaseSortableField(arg: ModelComposed)

class CaseSortableField(*args, **kwargs)

Bases: ModelSimple

Case field that can be sorted on

Parameters:

value (str) – Must be one of [“created_at”, “priority”, “status”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_status module¶

class CaseStatus(arg: None)¶

class CaseStatus(arg: ModelComposed)

class CaseStatus(*args, **kwargs)

Bases: ModelSimple

Case status

Parameters:

value (str) – Must be one of [“OPEN”, “IN_PROGRESS”, “CLOSED”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_trigger module¶

class CaseTrigger(arg: None)¶

class CaseTrigger(arg: ModelComposed)

class CaseTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.case_trigger_wrapper module¶

class CaseTriggerWrapper(arg: None)¶

class CaseTriggerWrapper(arg: ModelComposed)

class CaseTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Case-based trigger.

Parameters:

case_trigger (CaseTrigger) – Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.case_type module¶

class CaseType(arg: None)¶

class CaseType(arg: ModelComposed)

class CaseType(*args, **kwargs)

Bases: ModelSimple

Case type

Parameters:

value (str) – If omitted defaults to “STANDARD”. Must be one of [“STANDARD”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_type_create module¶

class CaseTypeCreate(arg: None)¶

class CaseTypeCreate(arg: ModelComposed)

class CaseTypeCreate(*args, **kwargs)

Bases: ModelNormal

Case type

Parameters:

attributes (CaseTypeResourceAttributes) – Case Type resource attributes
type (CaseTypeResourceType) – Case type resource type

datadog_api_client.v2.model.case_type_create_request module¶

class CaseTypeCreateRequest(arg: None)¶

class CaseTypeCreateRequest(arg: ModelComposed)

class CaseTypeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Case type create request

Parameters:: data (CaseTypeCreate) – Case type

datadog_api_client.v2.model.case_type_resource module¶

class CaseTypeResource(arg: None)¶

class CaseTypeResource(arg: ModelComposed)

class CaseTypeResource(*args, **kwargs)

Bases: ModelNormal

The definition of CaseType object.

Parameters:

attributes (CaseTypeResourceAttributes, optional) – Case Type resource attributes
id (str, optional) – Case type’s identifier
type (CaseTypeResourceType, optional) – Case type resource type

datadog_api_client.v2.model.case_type_resource_attributes module¶

class CaseTypeResourceAttributes(arg: None)¶

class CaseTypeResourceAttributes(arg: ModelComposed)

class CaseTypeResourceAttributes(*args, **kwargs)

Bases: ModelNormal

Case Type resource attributes

Parameters:

deleted_at (datetime, none_type, optional) – Timestamp of when the case type was deleted
description (str, optional) – Case type description.
emoji (str, optional) – Case type emoji.
name (str) – Case type name.

datadog_api_client.v2.model.case_type_resource_type module¶

class CaseTypeResourceType(arg: None)¶

class CaseTypeResourceType(arg: ModelComposed)

class CaseTypeResourceType(*args, **kwargs)

Bases: ModelSimple

Case type resource type

Parameters:

value (str) – If omitted defaults to “case_type”. Must be one of [“case_type”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.case_type_response module¶

class CaseTypeResponse(arg: None)¶

class CaseTypeResponse(arg: ModelComposed)

class CaseTypeResponse(*args, **kwargs)

Bases: ModelNormal

Case type response

Parameters:: data (CaseTypeResource, optional) – The definition of CaseType object.

datadog_api_client.v2.model.case_types_response module¶

class CaseTypesResponse(arg: None)¶

class CaseTypesResponse(arg: ModelComposed)

class CaseTypesResponse(*args, **kwargs)

Bases: ModelNormal

Case types response.

Parameters:: data ([CaseTypeResource], optional) – List of case types

datadog_api_client.v2.model.case_update_attributes module¶

class CaseUpdateAttributes(arg: None)¶

class CaseUpdateAttributes(arg: ModelComposed)

class CaseUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Case update attributes

Parameters:

attributes (CaseUpdateAttributesAttributes) – Case update attributes attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_update_attributes_attributes module¶

class CaseUpdateAttributesAttributes(arg: None)¶

class CaseUpdateAttributesAttributes(arg: ModelComposed)

class CaseUpdateAttributesAttributes(*args, **kwargs)

Bases: ModelNormal

Case update attributes attributes

Parameters:: attributes (CaseObjectAttributes) – The definition of CaseObjectAttributes object.

datadog_api_client.v2.model.case_update_attributes_request module¶

class CaseUpdateAttributesRequest(arg: None)¶

class CaseUpdateAttributesRequest(arg: ModelComposed)

class CaseUpdateAttributesRequest(*args, **kwargs)

Bases: ModelNormal

Case update attributes request

Parameters:: data (CaseUpdateAttributes) – Case update attributes

datadog_api_client.v2.model.case_update_custom_attribute module¶

class CaseUpdateCustomAttribute(arg: None)¶

class CaseUpdateCustomAttribute(arg: ModelComposed)

class CaseUpdateCustomAttribute(*args, **kwargs)

Bases: ModelNormal

Case update custom attribute

Parameters:

attributes (CustomAttributeValue) – Custom attribute values
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_update_custom_attribute_request module¶

class CaseUpdateCustomAttributeRequest(arg: None)¶

class CaseUpdateCustomAttributeRequest(arg: ModelComposed)

class CaseUpdateCustomAttributeRequest(*args, **kwargs)

Bases: ModelNormal

Case update custom attribute request

Parameters:: data (CaseUpdateCustomAttribute) – Case update custom attribute

datadog_api_client.v2.model.case_update_description module¶

class CaseUpdateDescription(arg: None)¶

class CaseUpdateDescription(arg: ModelComposed)

class CaseUpdateDescription(*args, **kwargs)

Bases: ModelNormal

Case update description

Parameters:

attributes (CaseUpdateDescriptionAttributes) – Case update description attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_update_description_attributes module¶

class CaseUpdateDescriptionAttributes(arg: None)¶

class CaseUpdateDescriptionAttributes(arg: ModelComposed)

class CaseUpdateDescriptionAttributes(*args, **kwargs)

Bases: ModelNormal

Case update description attributes

Parameters:: description (str) – Case new description

datadog_api_client.v2.model.case_update_description_request module¶

class CaseUpdateDescriptionRequest(arg: None)¶

class CaseUpdateDescriptionRequest(arg: ModelComposed)

class CaseUpdateDescriptionRequest(*args, **kwargs)

Bases: ModelNormal

Case update description request

Parameters:: data (CaseUpdateDescription) – Case update description

datadog_api_client.v2.model.case_update_priority module¶

class CaseUpdatePriority(arg: None)¶

class CaseUpdatePriority(arg: ModelComposed)

class CaseUpdatePriority(*args, **kwargs)

Bases: ModelNormal

Case priority status

Parameters:

attributes (CaseUpdatePriorityAttributes) – Case update priority attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_update_priority_attributes module¶

class CaseUpdatePriorityAttributes(arg: None)¶

class CaseUpdatePriorityAttributes(arg: ModelComposed)

class CaseUpdatePriorityAttributes(*args, **kwargs)

Bases: ModelNormal

Case update priority attributes

Parameters:: priority (CasePriority) – Case priority

datadog_api_client.v2.model.case_update_priority_request module¶

class CaseUpdatePriorityRequest(arg: None)¶

class CaseUpdatePriorityRequest(arg: ModelComposed)

class CaseUpdatePriorityRequest(*args, **kwargs)

Bases: ModelNormal

Case update priority request

Parameters:: data (CaseUpdatePriority) – Case priority status

datadog_api_client.v2.model.case_update_status module¶

class CaseUpdateStatus(arg: None)¶

class CaseUpdateStatus(arg: ModelComposed)

class CaseUpdateStatus(*args, **kwargs)

Bases: ModelNormal

Case update status

Parameters:

attributes (CaseUpdateStatusAttributes) – Case update status attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_update_status_attributes module¶

class CaseUpdateStatusAttributes(arg: None)¶

class CaseUpdateStatusAttributes(arg: ModelComposed)

class CaseUpdateStatusAttributes(*args, **kwargs)

Bases: ModelNormal

Case update status attributes

Parameters:: status (CaseStatus) – Case status

datadog_api_client.v2.model.case_update_status_request module¶

class CaseUpdateStatusRequest(arg: None)¶

class CaseUpdateStatusRequest(arg: ModelComposed)

class CaseUpdateStatusRequest(*args, **kwargs)

Bases: ModelNormal

Case update status request

Parameters:: data (CaseUpdateStatus) – Case update status

datadog_api_client.v2.model.case_update_title module¶

class CaseUpdateTitle(arg: None)¶

class CaseUpdateTitle(arg: ModelComposed)

class CaseUpdateTitle(*args, **kwargs)

Bases: ModelNormal

Case update title

Parameters:

attributes (CaseUpdateTitleAttributes) – Case update title attributes
type (CaseResourceType) – Case resource type

datadog_api_client.v2.model.case_update_title_attributes module¶

class CaseUpdateTitleAttributes(arg: None)¶

class CaseUpdateTitleAttributes(arg: ModelComposed)

class CaseUpdateTitleAttributes(*args, **kwargs)

Bases: ModelNormal

Case update title attributes

Parameters:: title (str) – Case new title

datadog_api_client.v2.model.case_update_title_request module¶

class CaseUpdateTitleRequest(arg: None)¶

class CaseUpdateTitleRequest(arg: ModelComposed)

class CaseUpdateTitleRequest(*args, **kwargs)

Bases: ModelNormal

Case update title request

Parameters:: data (CaseUpdateTitle) – Case update title

datadog_api_client.v2.model.cases_response module¶

class CasesResponse(arg: None)¶

class CasesResponse(arg: ModelComposed)

class CasesResponse(*args, **kwargs)

Bases: ModelNormal

Response with cases

Parameters:

data ([Case], optional) – Cases response data
meta (CasesResponseMeta, optional) – Cases response metadata

datadog_api_client.v2.model.cases_response_meta module¶

class CasesResponseMeta(arg: None)¶

class CasesResponseMeta(arg: ModelComposed)

class CasesResponseMeta(*args, **kwargs)

Bases: ModelNormal

Cases response metadata

Parameters:: page (CasesResponseMetaPagination, optional) – Pagination metadata

datadog_api_client.v2.model.cases_response_meta_pagination module¶

class CasesResponseMetaPagination(arg: None)¶

class CasesResponseMetaPagination(arg: ModelComposed)

class CasesResponseMetaPagination(*args, **kwargs)

Bases: ModelNormal

Pagination metadata

Parameters:

current (int, optional) – Current page number
size (int, optional) – Number of cases in current page
total (int, optional) – Total number of pages

datadog_api_client.v2.model.change_event_attributes module¶

class ChangeEventAttributes(arg: None)¶

class ChangeEventAttributes(arg: ModelComposed)

class ChangeEventAttributes(*args, **kwargs)

Bases: ModelNormal

Change event attributes.

Parameters:

aggregation_key (str, optional) – Aggregation key of the event.
author (ChangeEventAttributesAuthor, optional) – The entity that made the change.
change_metadata (dict, optional) – JSON object of change metadata.
changed_resource (ChangeEventAttributesChangedResource, optional) – A uniquely identified resource.
evt (EventSystemAttributes, optional) – JSON object of event system attributes.
impacted_resources ([ChangeEventAttributesImpactedResourcesItem], optional) – A list of resources impacted by this change.
new_value (dict, optional) – The new state of the changed resource.
prev_value (dict, optional) – The previous state of the changed resource.
service (str, optional) – Service that triggered the event.
timestamp (int, optional) – POSIX timestamp of the event.
title (str, optional) – The title of the event.

datadog_api_client.v2.model.change_event_attributes_author module¶

class ChangeEventAttributesAuthor(arg: None)¶

class ChangeEventAttributesAuthor(arg: ModelComposed)

class ChangeEventAttributesAuthor(*args, **kwargs)

Bases: ModelNormal

The entity that made the change.

Parameters:

name (str, optional) – The name of the user or system that made the change.
type (ChangeEventAttributesAuthorType, optional) – The type of the author.

datadog_api_client.v2.model.change_event_attributes_author_type module¶

class ChangeEventAttributesAuthorType(arg: None)¶

class ChangeEventAttributesAuthorType(arg: ModelComposed)

class ChangeEventAttributesAuthorType(*args, **kwargs)

Bases: ModelSimple

The type of the author.

Parameters:

value (str) – Must be one of [“user”, “system”, “api”, “automation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.change_event_attributes_changed_resource module¶

class ChangeEventAttributesChangedResource(arg: None)¶

class ChangeEventAttributesChangedResource(arg: ModelComposed)

class ChangeEventAttributesChangedResource(*args, **kwargs)

Bases: ModelNormal

A uniquely identified resource.

Parameters:

name (str, optional) – The name of the changed resource.
type (ChangeEventAttributesChangedResourceType, optional) – The type of the changed resource.

datadog_api_client.v2.model.change_event_attributes_changed_resource_type module¶

class ChangeEventAttributesChangedResourceType(arg: None)¶

class ChangeEventAttributesChangedResourceType(arg: ModelComposed)

class ChangeEventAttributesChangedResourceType(*args, **kwargs)

Bases: ModelSimple

The type of the changed resource.

Parameters:

value (str) – Must be one of [“feature_flag”, “configuration”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.change_event_attributes_impacted_resources_item module¶

class ChangeEventAttributesImpactedResourcesItem(arg: None)¶

class ChangeEventAttributesImpactedResourcesItem(arg: ModelComposed)

class ChangeEventAttributesImpactedResourcesItem(*args, **kwargs)

Bases: ModelNormal

A uniquely identified resource.

Parameters:

name (str, optional) – The name of the impacted resource.
type (ChangeEventAttributesImpactedResourcesItemType, optional) – The type of the impacted resource.

datadog_api_client.v2.model.change_event_attributes_impacted_resources_item_type module¶

class ChangeEventAttributesImpactedResourcesItemType(arg: None)¶

class ChangeEventAttributesImpactedResourcesItemType(arg: ModelComposed)

class ChangeEventAttributesImpactedResourcesItemType(*args, **kwargs)

Bases: ModelSimple

The type of the impacted resource.

Parameters:

value (str) – If omitted defaults to “service”. Must be one of [“service”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.change_event_custom_attributes module¶

class ChangeEventCustomAttributes(arg: None)¶

class ChangeEventCustomAttributes(arg: ModelComposed)

class ChangeEventCustomAttributes(*args, **kwargs)

Bases: ModelNormal

Change event attributes.

Parameters:

author (ChangeEventCustomAttributesAuthor, optional) – The entity that made the change. Optional, if provided it must include type and name.
change_metadata ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form JSON object with information related to the change event. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.
changed_resource (ChangeEventCustomAttributesChangedResource) – A uniquely identified resource.
impacted_resources ([ChangeEventCustomAttributesImpactedResourcesItems], optional) – A list of resources impacted by this change. It is recommended to provide an impacted resource to display the change event at the correct location. Only resources of type service are supported. Maximum of 100 impacted resources allowed.
new_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form JSON object representing the new state of the changed resource.
prev_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form JSON object representing the previous state of the changed resource.

additional_properties_type = None¶

datadog_api_client.v2.model.change_event_custom_attributes_author module¶

class ChangeEventCustomAttributesAuthor(arg: None)¶

class ChangeEventCustomAttributesAuthor(arg: ModelComposed)

class ChangeEventCustomAttributesAuthor(*args, **kwargs)

Bases: ModelNormal

The entity that made the change. Optional, if provided it must include type and name.

Parameters:

name (str) – The name of the user or system that made the change. Limited to 128 characters.
type (ChangeEventCustomAttributesAuthorType) – Author’s type.

additional_properties_type = None¶

datadog_api_client.v2.model.change_event_custom_attributes_author_type module¶

class ChangeEventCustomAttributesAuthorType(arg: None)¶

class ChangeEventCustomAttributesAuthorType(arg: ModelComposed)

class ChangeEventCustomAttributesAuthorType(*args, **kwargs)

Bases: ModelSimple

Author’s type.

Parameters:

value (str) – Must be one of [“user”, “system”, “api”, “automation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.change_event_custom_attributes_changed_resource module¶

class ChangeEventCustomAttributesChangedResource(arg: None)¶

class ChangeEventCustomAttributesChangedResource(arg: ModelComposed)

class ChangeEventCustomAttributesChangedResource(*args, **kwargs)

Bases: ModelNormal

A uniquely identified resource.

Parameters:

name (str) – The name of the resource that was changed. Limited to 128 characters.
type (ChangeEventCustomAttributesChangedResourceType) – The type of the resource that was changed.

additional_properties_type = None¶

datadog_api_client.v2.model.change_event_custom_attributes_changed_resource_type module¶

class ChangeEventCustomAttributesChangedResourceType(arg: None)¶

class ChangeEventCustomAttributesChangedResourceType(arg: ModelComposed)

class ChangeEventCustomAttributesChangedResourceType(*args, **kwargs)

Bases: ModelSimple

The type of the resource that was changed.

Parameters:

value (str) – Must be one of [“feature_flag”, “configuration”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.change_event_custom_attributes_impacted_resources_items module¶

class ChangeEventCustomAttributesImpactedResourcesItems(arg: None)¶

class ChangeEventCustomAttributesImpactedResourcesItems(arg: ModelComposed)

class ChangeEventCustomAttributesImpactedResourcesItems(*args, **kwargs)

Bases: ModelNormal

Object representing a uniquely identified resource.

Parameters:

name (str) – The name of the impacted resource. Limited to 128 characters.
type (ChangeEventCustomAttributesImpactedResourcesItemsType) – The type of the impacted resource.

additional_properties_type = None¶

datadog_api_client.v2.model.change_event_custom_attributes_impacted_resources_items_type module¶

class ChangeEventCustomAttributesImpactedResourcesItemsType(arg: None)¶

class ChangeEventCustomAttributesImpactedResourcesItemsType(arg: ModelComposed)

class ChangeEventCustomAttributesImpactedResourcesItemsType(*args, **kwargs)

Bases: ModelSimple

The type of the impacted resource.

Parameters:

value (str) – If omitted defaults to “service”. Must be one of [“service”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.change_event_trigger_wrapper module¶

class ChangeEventTriggerWrapper(arg: None)¶

class ChangeEventTriggerWrapper(arg: ModelComposed)

class ChangeEventTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Change Event-based trigger.

Parameters:

change_event_trigger (dict) – Trigger a workflow from a Change Event.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.chargeback_breakdown module¶

class ChargebackBreakdown(arg: None)¶

class ChargebackBreakdown(arg: ModelComposed)

class ChargebackBreakdown(*args, **kwargs)

Bases: ModelNormal

Charges breakdown.

Parameters:

charge_type (str, optional) – The type of charge for a particular product.
cost (float, optional) – The cost for a particular product and charge type during a given month.
product_name (str, optional) – The product for which cost is being reported.

datadog_api_client.v2.model.ci_app_aggregate_bucket_value module¶

class CIAppAggregateBucketValue(arg: None)¶

class CIAppAggregateBucketValue(arg: ModelComposed)

class CIAppAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

A bucket value, can either be a timeseries or a single value.

datadog_api_client.v2.model.ci_app_aggregate_bucket_value_timeseries module¶

class CIAppAggregateBucketValueTimeseries(arg: None)¶

class CIAppAggregateBucketValueTimeseries(arg: ModelComposed)

class CIAppAggregateBucketValueTimeseries(*args, **kwargs)

Bases: ModelSimple

A timeseries array.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_aggregate_bucket_value_timeseries_point module¶

class CIAppAggregateBucketValueTimeseriesPoint(arg: None)¶

class CIAppAggregateBucketValueTimeseriesPoint(arg: ModelComposed)

class CIAppAggregateBucketValueTimeseriesPoint(*args, **kwargs)

Bases: ModelNormal

A timeseries point.

Parameters:

time (datetime, optional) – The time value for this point.
value (float, optional) – The value for this point.

datadog_api_client.v2.model.ci_app_aggregate_sort module¶

class CIAppAggregateSort(arg: None)¶

class CIAppAggregateSort(arg: ModelComposed)

class CIAppAggregateSort(*args, **kwargs)

Bases: ModelNormal

A sort rule. The aggregation field is required when type is measure.

Parameters:

aggregation (CIAppAggregationFunction, optional) – An aggregation function.
metric (str, optional) – The metric to sort by (only used for type=measure ).
order (CIAppSortOrder, optional) – The order to use, ascending or descending.
type (CIAppAggregateSortType, optional) – The type of sorting algorithm.

datadog_api_client.v2.model.ci_app_aggregate_sort_type module¶

class CIAppAggregateSortType(arg: None)¶

class CIAppAggregateSortType(arg: ModelComposed)

class CIAppAggregateSortType(*args, **kwargs)

Bases: ModelSimple

The type of sorting algorithm.

Parameters:

value (str) – If omitted defaults to “alphabetical”. Must be one of [“alphabetical”, “measure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_aggregation_function module¶

class CIAppAggregationFunction(arg: None)¶

class CIAppAggregationFunction(arg: ModelComposed)

class CIAppAggregationFunction(*args, **kwargs)

Bases: ModelSimple

An aggregation function.

Parameters:

value (str) – Must be one of [“count”, “cardinality”, “pc75”, “pc90”, “pc95”, “pc98”, “pc99”, “sum”, “min”, “max”, “avg”, “median”, “latest”, “earliest”, “most_frequent”, “delta”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_ci_error module¶

class CIAppCIError(arg: None)¶

class CIAppCIError(arg: ModelComposed)

class CIAppCIError(*args, **kwargs)

Bases: ModelNormal

Contains information of the CI error.

Parameters:

domain (CIAppCIErrorDomain, optional) – Error category used to differentiate between issues related to the developer or provider environments.
message (str, none_type, optional) – Error message.
stack (str, none_type, optional) – The stack trace of the reported errors.
type (str, none_type, optional) – Short description of the error type.

datadog_api_client.v2.model.ci_app_ci_error_domain module¶

class CIAppCIErrorDomain(arg: None)¶

class CIAppCIErrorDomain(arg: ModelComposed)

class CIAppCIErrorDomain(*args, **kwargs)

Bases: ModelSimple

Error category used to differentiate between issues related to the developer or provider environments.

Parameters:

value (str) – Must be one of [“provider”, “user”, “unknown”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_compute module¶

class CIAppCompute(arg: None)¶

class CIAppCompute(arg: ModelComposed)

class CIAppCompute(*args, **kwargs)

Bases: ModelNormal

A compute rule to compute metrics or timeseries.

Parameters:

aggregation (CIAppAggregationFunction) – An aggregation function.
interval (str, optional) – The time buckets’ size (only used for type=timeseries) Defaults to a resolution of 150 points.
metric (str, optional) – The metric to use.
type (CIAppComputeType, optional) – The type of compute.

datadog_api_client.v2.model.ci_app_compute_type module¶

class CIAppComputeType(arg: None)¶

class CIAppComputeType(arg: ModelComposed)

class CIAppComputeType(*args, **kwargs)

Bases: ModelSimple

The type of compute.

Parameters:

value (str) – If omitted defaults to “total”. Must be one of [“timeseries”, “total”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_computes module¶

class CIAppComputes(arg: None)¶

class CIAppComputes(arg: ModelComposed)

class CIAppComputes(*args, **kwargs)

Bases: ModelNormal

A map of the metric name to value for regular compute, or a list of values for a timeseries.

datadog_api_client.v2.model.ci_app_create_pipeline_event_request module¶

class CIAppCreatePipelineEventRequest(arg: None)¶

class CIAppCreatePipelineEventRequest(arg: ModelComposed)

class CIAppCreatePipelineEventRequest(*args, **kwargs)

Bases: ModelNormal

Request object.

Parameters:: data (CIAppCreatePipelineEventRequestDataSingleOrArray, optional) – Data of the pipeline events to create.

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_attributes module¶

class CIAppCreatePipelineEventRequestAttributes(arg: None)¶

class CIAppCreatePipelineEventRequestAttributes(arg: ModelComposed)

class CIAppCreatePipelineEventRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the pipeline event to create.

Parameters:

env (str, optional) – The Datadog environment.
provider_name (str, optional) – The name of the CI provider. By default, this is “custom”.
resource (CIAppCreatePipelineEventRequestAttributesResource) – Details of the CI pipeline event.
service (str, optional) – If the CI provider is SaaS, use this to differentiate between instances.

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_attributes_resource module¶

class CIAppCreatePipelineEventRequestAttributesResource(arg: None)¶

class CIAppCreatePipelineEventRequestAttributesResource(arg: ModelComposed)

class CIAppCreatePipelineEventRequestAttributesResource(*args, **kwargs)

Bases: ModelComposed

Details of the CI pipeline event.

Parameters:

dependencies ([str], none_type, optional) – A list of stage IDs that this stage depends on.
end (datetime) – Time when the stage run finished. The time format must be RFC3339.
error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
id (str) – UUID for the stage. It has to be unique at least in the pipeline scope.
level (CIAppPipelineEventStageLevel) – Used to distinguish between pipelines, stages, jobs and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – The name for the stage.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
pipeline_name (str) – The parent pipeline name.
pipeline_unique_id (str) – The parent pipeline UUID.
queue_time (int, none_type, optional) – The queue time in milliseconds, if applicable.
start (datetime) – Time when the stage run started (it should not include any queue time). The time format must be RFC3339.
status (CIAppPipelineEventStageStatus) – The final status of the stage.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.
stage_id (str, none_type, optional) – The parent stage UUID (if applicable).
stage_name (str, none_type, optional) – The parent stage name (if applicable).
url (str) – The URL to look at the job in the CI provider UI.
job_id (str, none_type, optional) – The parent job UUID (if applicable).
job_name (str, none_type, optional) – The parent job name (if applicable).

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data module¶

class CIAppCreatePipelineEventRequestData(arg: None)¶

class CIAppCreatePipelineEventRequestData(arg: ModelComposed)

class CIAppCreatePipelineEventRequestData(*args, **kwargs)

Bases: ModelNormal

Data of the pipeline event to create.

Parameters:

attributes (CIAppCreatePipelineEventRequestAttributes, optional) – Attributes of the pipeline event to create.
type (CIAppCreatePipelineEventRequestDataType, optional) – Type of the event.

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data_single_or_array module¶

class CIAppCreatePipelineEventRequestDataSingleOrArray(arg: None)¶

class CIAppCreatePipelineEventRequestDataSingleOrArray(arg: ModelComposed)

class CIAppCreatePipelineEventRequestDataSingleOrArray(*args, **kwargs)

Bases: ModelComposed

Data of the pipeline events to create.

Parameters:

attributes (CIAppCreatePipelineEventRequestAttributes, optional) – Attributes of the pipeline event to create.
type (CIAppCreatePipelineEventRequestDataType, optional) – Type of the event.

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data_type module¶

class CIAppCreatePipelineEventRequestDataType(arg: None)¶

class CIAppCreatePipelineEventRequestDataType(arg: ModelComposed)

class CIAppCreatePipelineEventRequestDataType(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “cipipeline_resource_request”. Must be one of [“cipipeline_resource_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_event_attributes module¶

class CIAppEventAttributes(arg: None)¶

class CIAppEventAttributes(arg: ModelComposed)

class CIAppEventAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all event attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of attributes from CI Visibility test events.
tags (TagsEventAttribute, optional) – Array of tags associated with your event.
test_level (CIAppTestLevel, optional) – Test run level.

datadog_api_client.v2.model.ci_app_git_info module¶

class CIAppGitInfo(arg: None)¶

class CIAppGitInfo(arg: ModelComposed)

class CIAppGitInfo(*args, **kwargs)

Bases: ModelNormal

If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.

Parameters:

author_email (str) – The commit author email.
author_name (str, none_type, optional) – The commit author name.
author_time (str, none_type, optional) – The commit author timestamp in RFC3339 format.
branch (str, none_type, optional) – The branch name (if a tag use the tag parameter).
commit_time (str, none_type, optional) – The commit timestamp in RFC3339 format.
committer_email (str, none_type, optional) – The committer email.
committer_name (str, none_type, optional) – The committer name.
default_branch (str, none_type, optional) – The Git repository’s default branch.
message (str, none_type, optional) – The commit message.
repository_url (str) – The URL of the repository.
sha (str) – The git commit SHA.
tag (str, none_type, optional) – The tag name (if a branch use the branch parameter).

datadog_api_client.v2.model.ci_app_group_by_histogram module¶

class CIAppGroupByHistogram(arg: None)¶

class CIAppGroupByHistogram(arg: ModelComposed)

class CIAppGroupByHistogram(*args, **kwargs)

Bases: ModelNormal

Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.

Parameters:

interval (float) – The bin size of the histogram buckets.
max (float) – The maximum value for the measure used in the histogram (values greater than this one are filtered out).
min (float) – The minimum value for the measure used in the histogram (values smaller than this one are filtered out).

datadog_api_client.v2.model.ci_app_group_by_missing module¶

class CIAppGroupByMissing(arg: None)¶

class CIAppGroupByMissing(arg: ModelComposed)

class CIAppGroupByMissing(*args, **kwargs)

Bases: ModelComposed

The value to use for logs that don’t have the facet used to group-by.

datadog_api_client.v2.model.ci_app_group_by_total module¶

class CIAppGroupByTotal(arg: None)¶

class CIAppGroupByTotal(arg: ModelComposed)

class CIAppGroupByTotal(*args, **kwargs)

Bases: ModelComposed

A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.ci_app_host_info module¶

class CIAppHostInfo(arg: None)¶

class CIAppHostInfo(arg: ModelComposed)

class CIAppHostInfo(*args, **kwargs)

Bases: ModelNormal

Contains information of the host running the pipeline, stage, job, or step.

Parameters:

hostname (str, optional) – FQDN of the host.
labels ([str], optional) – A list of labels used to select or identify the node.
name (str, optional) – Name for the host.
workspace (str, optional) – The path where the code is checked out.

datadog_api_client.v2.model.ci_app_pipeline_event module¶

class CIAppPipelineEvent(arg: None)¶

class CIAppPipelineEvent(arg: ModelComposed)

class CIAppPipelineEvent(*args, **kwargs)

Bases: ModelNormal

Object description of a pipeline event after being processed and stored by Datadog.

Parameters:

attributes (CIAppPipelineEventAttributes, optional) – JSON object containing all event attributes and their associated values.
id (str, optional) – Unique ID of the event.
type (CIAppPipelineEventTypeName, optional) – Type of the event.

datadog_api_client.v2.model.ci_app_pipeline_event_attributes module¶

class CIAppPipelineEventAttributes(arg: None)¶

class CIAppPipelineEventAttributes(arg: ModelComposed)

class CIAppPipelineEventAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all event attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of attributes from CI Visibility pipeline events.
ci_level (CIAppPipelineLevel, optional) – Pipeline execution level.
tags (TagsEventAttribute, optional) – Array of tags associated with your event.

datadog_api_client.v2.model.ci_app_pipeline_event_finished_pipeline module¶

class CIAppPipelineEventFinishedPipeline(arg: None)¶

class CIAppPipelineEventFinishedPipeline(arg: ModelComposed)

class CIAppPipelineEventFinishedPipeline(*args, **kwargs)

Bases: ModelNormal

Details of a finished pipeline.

Parameters:

end (datetime) – Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.
error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
is_manual (bool, none_type, optional) – Whether or not the pipeline was triggered manually by the user.
is_resumed (bool, none_type, optional) – Whether or not the pipeline was resumed after being blocked.
level (CIAppPipelineEventPipelineLevel) – Used to distinguish between pipelines, stages, jobs, and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – Name of the pipeline. All pipeline runs for the builds should have the same name.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
parent_pipeline (CIAppPipelineEventParentPipeline, none_type, optional) – If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.
partial_retry (bool) – Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one which only runs a subset of the original jobs.
pipeline_id (str, optional) – Any ID used in the provider to identify the pipeline run even if it is not unique across retries. If the pipeline_id is unique, then both unique_id and pipeline_id can be set to the same value.
previous_attempt (CIAppPipelineEventPreviousPipeline, none_type, optional) – If the pipeline is a retry, this should contain the details of the previous attempt.
queue_time (int, none_type, optional) – The queue time in milliseconds, if applicable.
start (datetime) – Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
status (CIAppPipelineEventPipelineStatus) – The final status of the pipeline.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.
unique_id (str) – UUID of the pipeline run. The ID has to be unique across retries and pipelines, including partial retries.
url (str) – The URL to look at the pipeline in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_in_progress_pipeline module¶

class CIAppPipelineEventInProgressPipeline(arg: None)¶

class CIAppPipelineEventInProgressPipeline(arg: ModelComposed)

class CIAppPipelineEventInProgressPipeline(*args, **kwargs)

Bases: ModelNormal

Details of a running pipeline.

Parameters:

error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
is_manual (bool, none_type, optional) – Whether or not the pipeline was triggered manually by the user.
is_resumed (bool, none_type, optional) – Whether or not the pipeline was resumed after being blocked.
level (CIAppPipelineEventPipelineLevel) – Used to distinguish between pipelines, stages, jobs, and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – Name of the pipeline. All pipeline runs for the builds should have the same name.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
parent_pipeline (CIAppPipelineEventParentPipeline, none_type, optional) – If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.
partial_retry (bool) – Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one which only runs a subset of the original jobs.
pipeline_id (str, optional) – Any ID used in the provider to identify the pipeline run even if it is not unique across retries. If the pipeline_id is unique, then both unique_id and pipeline_id can be set to the same value.
previous_attempt (CIAppPipelineEventPreviousPipeline, none_type, optional) – If the pipeline is a retry, this should contain the details of the previous attempt.
queue_time (int, none_type, optional) – The queue time in milliseconds, if applicable.
start (datetime) – Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
status (CIAppPipelineEventPipelineInProgressStatus) – The in progress status of the pipeline.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.
unique_id (str) – UUID of the pipeline run. The ID has to be the same as the finished pipeline.
url (str) – The URL to look at the pipeline in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_job module¶

class CIAppPipelineEventJob(arg: None)¶

class CIAppPipelineEventJob(arg: ModelComposed)

class CIAppPipelineEventJob(*args, **kwargs)

Bases: ModelNormal

Details of a CI job.

Parameters:

dependencies ([str], none_type, optional) – A list of job IDs that this job depends on.
end (datetime) – Time when the job run finished. The time format must be RFC3339.
error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
id (str) – The UUID for the job. It has to be unique within each pipeline execution.
level (CIAppPipelineEventJobLevel) – Used to distinguish between pipelines, stages, jobs, and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – The name for the job.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
pipeline_name (str) – The parent pipeline name.
pipeline_unique_id (str) – The parent pipeline UUID.
queue_time (int, none_type, optional) – The queue time in milliseconds, if applicable.
stage_id (str, none_type, optional) – The parent stage UUID (if applicable).
stage_name (str, none_type, optional) – The parent stage name (if applicable).
start (datetime) – Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.
status (CIAppPipelineEventJobStatus) – The final status of the job.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.
url (str) – The URL to look at the job in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_job_level module¶

class CIAppPipelineEventJobLevel(arg: None)¶

class CIAppPipelineEventJobLevel(arg: ModelComposed)

class CIAppPipelineEventJobLevel(*args, **kwargs)

Bases: ModelSimple

Used to distinguish between pipelines, stages, jobs, and steps.

Parameters:

value (str) – If omitted defaults to “job”. Must be one of [“job”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_job_status module¶

class CIAppPipelineEventJobStatus(arg: None)¶

class CIAppPipelineEventJobStatus(arg: ModelComposed)

class CIAppPipelineEventJobStatus(*args, **kwargs)

Bases: ModelSimple

The final status of the job.

Parameters:

value (str) – Must be one of [“success”, “error”, “canceled”, “skipped”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_parameters module¶

class CIAppPipelineEventParameters(arg: None)¶

class CIAppPipelineEventParameters(arg: ModelComposed)

class CIAppPipelineEventParameters(*args, **kwargs)

Bases: ModelNormal

A map of key-value parameters or environment variables that were defined for the pipeline.

datadog_api_client.v2.model.ci_app_pipeline_event_parent_pipeline module¶

class CIAppPipelineEventParentPipeline(arg: None)¶

class CIAppPipelineEventParentPipeline(arg: ModelComposed)

class CIAppPipelineEventParentPipeline(*args, **kwargs)

Bases: ModelNormal

If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.

Parameters:

id (str) – UUID of a pipeline.
url (str, optional) – The URL to look at the pipeline in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_pipeline module¶

class CIAppPipelineEventPipeline(arg: None)¶

class CIAppPipelineEventPipeline(arg: ModelComposed)

class CIAppPipelineEventPipeline(*args, **kwargs)

Bases: ModelComposed

Details of the top level pipeline, build, or workflow of your CI.

Parameters:

end (datetime) – Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.
error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
is_manual (bool, none_type, optional) – Whether or not the pipeline was triggered manually by the user.
is_resumed (bool, none_type, optional) – Whether or not the pipeline was resumed after being blocked.
level (CIAppPipelineEventPipelineLevel) – Used to distinguish between pipelines, stages, jobs, and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – Name of the pipeline. All pipeline runs for the builds should have the same name.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
parent_pipeline (CIAppPipelineEventParentPipeline, none_type, optional) – If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.
partial_retry (bool) – Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one which only runs a subset of the original jobs.
pipeline_id (str, optional) – Any ID used in the provider to identify the pipeline run even if it is not unique across retries. If the pipeline_id is unique, then both unique_id and pipeline_id can be set to the same value.
previous_attempt (CIAppPipelineEventPreviousPipeline, none_type, optional) – If the pipeline is a retry, this should contain the details of the previous attempt.
queue_time (int, none_type, optional) – The queue time in milliseconds, if applicable.
start (datetime) – Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
status (CIAppPipelineEventPipelineStatus) – The final status of the pipeline.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.
unique_id (str) – UUID of the pipeline run. The ID has to be unique across retries and pipelines, including partial retries.
url (str) – The URL to look at the pipeline in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_in_progress_status module¶

class CIAppPipelineEventPipelineInProgressStatus(arg: None)¶

class CIAppPipelineEventPipelineInProgressStatus(arg: ModelComposed)

class CIAppPipelineEventPipelineInProgressStatus(*args, **kwargs)

Bases: ModelSimple

The in progress status of the pipeline.

Parameters:

value (str) – If omitted defaults to “running”. Must be one of [“running”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_level module¶

class CIAppPipelineEventPipelineLevel(arg: None)¶

class CIAppPipelineEventPipelineLevel(arg: ModelComposed)

class CIAppPipelineEventPipelineLevel(*args, **kwargs)

Bases: ModelSimple

Used to distinguish between pipelines, stages, jobs, and steps.

Parameters:

value (str) – If omitted defaults to “pipeline”. Must be one of [“pipeline”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_pipeline_status module¶

class CIAppPipelineEventPipelineStatus(arg: None)¶

class CIAppPipelineEventPipelineStatus(arg: ModelComposed)

class CIAppPipelineEventPipelineStatus(*args, **kwargs)

Bases: ModelSimple

The final status of the pipeline.

Parameters:

value (str) – Must be one of [“success”, “error”, “canceled”, “skipped”, “blocked”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_previous_pipeline module¶

class CIAppPipelineEventPreviousPipeline(arg: None)¶

class CIAppPipelineEventPreviousPipeline(arg: ModelComposed)

class CIAppPipelineEventPreviousPipeline(*args, **kwargs)

Bases: ModelNormal

If the pipeline is a retry, this should contain the details of the previous attempt.

Parameters:

id (str) – UUID of a pipeline.
url (str, optional) – The URL to look at the pipeline in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_stage module¶

class CIAppPipelineEventStage(arg: None)¶

class CIAppPipelineEventStage(arg: ModelComposed)

class CIAppPipelineEventStage(*args, **kwargs)

Bases: ModelNormal

Details of a CI stage.

Parameters:

dependencies ([str], none_type, optional) – A list of stage IDs that this stage depends on.
end (datetime) – Time when the stage run finished. The time format must be RFC3339.
error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
id (str) – UUID for the stage. It has to be unique at least in the pipeline scope.
level (CIAppPipelineEventStageLevel) – Used to distinguish between pipelines, stages, jobs and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – The name for the stage.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
pipeline_name (str) – The parent pipeline name.
pipeline_unique_id (str) – The parent pipeline UUID.
queue_time (int, none_type, optional) – The queue time in milliseconds, if applicable.
start (datetime) – Time when the stage run started (it should not include any queue time). The time format must be RFC3339.
status (CIAppPipelineEventStageStatus) – The final status of the stage.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.

datadog_api_client.v2.model.ci_app_pipeline_event_stage_level module¶

class CIAppPipelineEventStageLevel(arg: None)¶

class CIAppPipelineEventStageLevel(arg: ModelComposed)

class CIAppPipelineEventStageLevel(*args, **kwargs)

Bases: ModelSimple

Used to distinguish between pipelines, stages, jobs and steps.

Parameters:

value (str) – If omitted defaults to “stage”. Must be one of [“stage”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_stage_status module¶

class CIAppPipelineEventStageStatus(arg: None)¶

class CIAppPipelineEventStageStatus(arg: ModelComposed)

class CIAppPipelineEventStageStatus(*args, **kwargs)

Bases: ModelSimple

The final status of the stage.

Parameters:

value (str) – Must be one of [“success”, “error”, “canceled”, “skipped”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_step module¶

class CIAppPipelineEventStep(arg: None)¶

class CIAppPipelineEventStep(arg: ModelComposed)

class CIAppPipelineEventStep(*args, **kwargs)

Bases: ModelNormal

Details of a CI step.

Parameters:

end (datetime) – Time when the step run finished. The time format must be RFC3339.
error (CIAppCIError, none_type, optional) – Contains information of the CI error.
git (CIAppGitInfo, none_type, optional) – If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. Note that either tag or branch has to be provided, but not both.
id (str) – UUID for the step. It has to be unique within each pipeline execution.
job_id (str, none_type, optional) – The parent job UUID (if applicable).
job_name (str, none_type, optional) – The parent job name (if applicable).
level (CIAppPipelineEventStepLevel) – Used to distinguish between pipelines, stages, jobs and steps.
metrics ([str], none_type, optional) – A list of user-defined metrics. The metrics must follow the key:value pattern and the value must be numeric.
name (str) – The name for the step.
node (CIAppHostInfo, none_type, optional) – Contains information of the host running the pipeline, stage, job, or step.
parameters (CIAppPipelineEventParameters, none_type, optional) – A map of key-value parameters or environment variables that were defined for the pipeline.
pipeline_name (str) – The parent pipeline name.
pipeline_unique_id (str) – The parent pipeline UUID.
stage_id (str, none_type, optional) – The parent stage UUID (if applicable).
stage_name (str, none_type, optional) – The parent stage name (if applicable).
start (datetime) – Time when the step run started. The time format must be RFC3339.
status (CIAppPipelineEventStepStatus) – The final status of the step.
tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern.
url (str, none_type, optional) – The URL to look at the step in the CI provider UI.

datadog_api_client.v2.model.ci_app_pipeline_event_step_level module¶

class CIAppPipelineEventStepLevel(arg: None)¶

class CIAppPipelineEventStepLevel(arg: ModelComposed)

class CIAppPipelineEventStepLevel(*args, **kwargs)

Bases: ModelSimple

Used to distinguish between pipelines, stages, jobs and steps.

Parameters:

value (str) – If omitted defaults to “step”. Must be one of [“step”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_step_status module¶

class CIAppPipelineEventStepStatus(arg: None)¶

class CIAppPipelineEventStepStatus(arg: ModelComposed)

class CIAppPipelineEventStepStatus(*args, **kwargs)

Bases: ModelSimple

The final status of the step.

Parameters:

value (str) – Must be one of [“success”, “error”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_event_type_name module¶

class CIAppPipelineEventTypeName(arg: None)¶

class CIAppPipelineEventTypeName(arg: ModelComposed)

class CIAppPipelineEventTypeName(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “cipipeline”. Must be one of [“cipipeline”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipeline_events_request module¶

class CIAppPipelineEventsRequest(arg: None)¶

class CIAppPipelineEventsRequest(arg: ModelComposed)

class CIAppPipelineEventsRequest(*args, **kwargs)

Bases: ModelNormal

The request for a pipelines search.

Parameters:

filter (CIAppPipelinesQueryFilter, optional) – The search and filter query settings.
options (CIAppQueryOptions, optional) – Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.
page (CIAppQueryPageOptions, optional) – Paging attributes for listing events.
sort (CIAppSort, optional) – Sort parameters when querying events.

datadog_api_client.v2.model.ci_app_pipeline_events_response module¶

class CIAppPipelineEventsResponse(arg: None)¶

class CIAppPipelineEventsResponse(arg: ModelComposed)

class CIAppPipelineEventsResponse(*args, **kwargs)

Bases: ModelNormal

Response object with all pipeline events matching the request and pagination information.

Parameters:

data ([CIAppPipelineEvent], optional) – Array of events matching the request.
links (CIAppResponseLinks, optional) – Links attributes.
meta (CIAppResponseMetadataWithPagination, optional) – The metadata associated with a request.

datadog_api_client.v2.model.ci_app_pipeline_level module¶

class CIAppPipelineLevel(arg: None)¶

class CIAppPipelineLevel(arg: ModelComposed)

class CIAppPipelineLevel(*args, **kwargs)

Bases: ModelSimple

Pipeline execution level.

Parameters:

value (str) – Must be one of [“pipeline”, “stage”, “job”, “step”, “custom”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_pipelines_aggregate_request module¶

class CIAppPipelinesAggregateRequest(arg: None)¶

class CIAppPipelinesAggregateRequest(arg: ModelComposed)

class CIAppPipelinesAggregateRequest(*args, **kwargs)

Bases: ModelNormal

The object sent with the request to retrieve aggregation buckets of pipeline events from your organization.

Parameters:

compute ([CIAppCompute], optional) – The list of metrics or timeseries to compute for the retrieved buckets.
filter (CIAppPipelinesQueryFilter, optional) – The search and filter query settings.
group_by ([CIAppPipelinesGroupBy], optional) – The rules for the group-by.
options (CIAppQueryOptions, optional) – Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.

datadog_api_client.v2.model.ci_app_pipelines_aggregation_buckets_response module¶

class CIAppPipelinesAggregationBucketsResponse(arg: None)¶

class CIAppPipelinesAggregationBucketsResponse(arg: ModelComposed)

class CIAppPipelinesAggregationBucketsResponse(*args, **kwargs)

Bases: ModelNormal

The query results.

Parameters:: buckets ([CIAppPipelinesBucketResponse], optional) – The list of matching buckets, one item per bucket.

datadog_api_client.v2.model.ci_app_pipelines_analytics_aggregate_response module¶

class CIAppPipelinesAnalyticsAggregateResponse(arg: None)¶

class CIAppPipelinesAnalyticsAggregateResponse(arg: ModelComposed)

class CIAppPipelinesAnalyticsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the pipeline events aggregate API endpoint.

Parameters:

data (CIAppPipelinesAggregationBucketsResponse, optional) – The query results.
links (CIAppResponseLinks, optional) – Links attributes.
meta (CIAppResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.ci_app_pipelines_bucket_response module¶

class CIAppPipelinesBucketResponse(arg: None)¶

class CIAppPipelinesBucketResponse(arg: ModelComposed)

class CIAppPipelinesBucketResponse(*args, **kwargs)

Bases: ModelNormal

Bucket values.

Parameters:

by ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The key-value pairs for each group-by.
computes (CIAppComputes, optional) – A map of the metric name to value for regular compute, or a list of values for a timeseries.

datadog_api_client.v2.model.ci_app_pipelines_group_by module¶

class CIAppPipelinesGroupBy(arg: None)¶

class CIAppPipelinesGroupBy(arg: ModelComposed)

class CIAppPipelinesGroupBy(*args, **kwargs)

Bases: ModelNormal

A group-by rule.

Parameters:

facet (str) – The name of the facet to use (required).
histogram (CIAppGroupByHistogram, optional) – Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.
limit (int, optional) – The maximum buckets to return for this group-by.
missing (CIAppGroupByMissing, optional) – The value to use for logs that don’t have the facet used to group-by.
sort (CIAppAggregateSort, optional) – A sort rule. The aggregation field is required when type is measure.
total (CIAppGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.ci_app_pipelines_query_filter module¶

class CIAppPipelinesQueryFilter(arg: None)¶

class CIAppPipelinesQueryFilter(arg: ModelComposed)

class CIAppPipelinesQueryFilter(*args, **kwargs)

Bases: ModelNormal

The search and filter query settings.

Parameters:

_from (str, optional) – The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds).
query (str, optional) – The search query following the CI Visibility Explorer search syntax.
to (str, optional) – The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds).

datadog_api_client.v2.model.ci_app_query_options module¶

class CIAppQueryOptions(arg: None)¶

class CIAppQueryOptions(arg: ModelComposed)

class CIAppQueryOptions(*args, **kwargs)

Bases: ModelNormal

Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.

Parameters:

time_offset (int, optional) – The time offset (in seconds) to apply to the query.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

datadog_api_client.v2.model.ci_app_query_page_options module¶

class CIAppQueryPageOptions(arg: None)¶

class CIAppQueryPageOptions(arg: ModelComposed)

class CIAppQueryPageOptions(*args, **kwargs)

Bases: ModelNormal

Paging attributes for listing events.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous query.
limit (int, optional) – Maximum number of events in the response.

datadog_api_client.v2.model.ci_app_response_links module¶

class CIAppResponseLinks(arg: None)¶

class CIAppResponseLinks(arg: ModelComposed)

class CIAppResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. The request can also be made using the POST endpoint.

datadog_api_client.v2.model.ci_app_response_metadata module¶

class CIAppResponseMetadata(arg: None)¶

class CIAppResponseMetadata(arg: ModelComposed)

class CIAppResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds.
request_id (str, optional) – The identifier of the request.
status (CIAppResponseStatus, optional) – The status of the response.
warnings ([CIAppWarning], optional) – A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.

datadog_api_client.v2.model.ci_app_response_metadata_with_pagination module¶

class CIAppResponseMetadataWithPagination(arg: None)¶

class CIAppResponseMetadataWithPagination(arg: ModelComposed)

class CIAppResponseMetadataWithPagination(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds.
page (CIAppResponsePage, optional) – Paging attributes.
request_id (str, optional) – The identifier of the request.
status (CIAppResponseStatus, optional) – The status of the response.
warnings ([CIAppWarning], optional) – A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.

datadog_api_client.v2.model.ci_app_response_page module¶

class CIAppResponsePage(arg: None)¶

class CIAppResponsePage(arg: ModelComposed)

class CIAppResponsePage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor].

datadog_api_client.v2.model.ci_app_response_status module¶

class CIAppResponseStatus(arg: None)¶

class CIAppResponseStatus(arg: ModelComposed)

class CIAppResponseStatus(*args, **kwargs)

Bases: ModelSimple

The status of the response.

Parameters:

value (str) – Must be one of [“done”, “timeout”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_sort module¶

class CIAppSort(arg: None)¶

class CIAppSort(arg: ModelComposed)

class CIAppSort(*args, **kwargs)

Bases: ModelSimple

Sort parameters when querying events.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_sort_order module¶

class CIAppSortOrder(arg: None)¶

class CIAppSortOrder(arg: ModelComposed)

class CIAppSortOrder(*args, **kwargs)

Bases: ModelSimple

The order to use, ascending or descending.

Parameters:

value (str) – Must be one of [“asc”, “desc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_test_event module¶

class CIAppTestEvent(arg: None)¶

class CIAppTestEvent(arg: ModelComposed)

class CIAppTestEvent(*args, **kwargs)

Bases: ModelNormal

Object description of test event after being processed and stored by Datadog.

Parameters:

attributes (CIAppEventAttributes, optional) – JSON object containing all event attributes and their associated values.
id (str, optional) – Unique ID of the event.
type (CIAppTestEventTypeName, optional) – Type of the event.

datadog_api_client.v2.model.ci_app_test_event_type_name module¶

class CIAppTestEventTypeName(arg: None)¶

class CIAppTestEventTypeName(arg: ModelComposed)

class CIAppTestEventTypeName(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “citest”. Must be one of [“citest”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_test_events_request module¶

class CIAppTestEventsRequest(arg: None)¶

class CIAppTestEventsRequest(arg: ModelComposed)

class CIAppTestEventsRequest(*args, **kwargs)

Bases: ModelNormal

The request for a tests search.

Parameters:

filter (CIAppTestsQueryFilter, optional) – The search and filter query settings.
options (CIAppQueryOptions, optional) – Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.
page (CIAppQueryPageOptions, optional) – Paging attributes for listing events.
sort (CIAppSort, optional) – Sort parameters when querying events.

datadog_api_client.v2.model.ci_app_test_events_response module¶

class CIAppTestEventsResponse(arg: None)¶

class CIAppTestEventsResponse(arg: ModelComposed)

class CIAppTestEventsResponse(*args, **kwargs)

Bases: ModelNormal

Response object with all test events matching the request and pagination information.

Parameters:

data ([CIAppTestEvent], optional) – Array of events matching the request.
links (CIAppResponseLinks, optional) – Links attributes.
meta (CIAppResponseMetadataWithPagination, optional) – The metadata associated with a request.

datadog_api_client.v2.model.ci_app_test_level module¶

class CIAppTestLevel(arg: None)¶

class CIAppTestLevel(arg: ModelComposed)

class CIAppTestLevel(*args, **kwargs)

Bases: ModelSimple

Test run level.

Parameters:

value (str) – Must be one of [“session”, “module”, “suite”, “test”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ci_app_tests_aggregate_request module¶

class CIAppTestsAggregateRequest(arg: None)¶

class CIAppTestsAggregateRequest(arg: ModelComposed)

class CIAppTestsAggregateRequest(*args, **kwargs)

Bases: ModelNormal

The object sent with the request to retrieve aggregation buckets of test events from your organization.

Parameters:

compute ([CIAppCompute], optional) – The list of metrics or timeseries to compute for the retrieved buckets.
filter (CIAppTestsQueryFilter, optional) – The search and filter query settings.
group_by ([CIAppTestsGroupBy], optional) – The rules for the group-by.
options (CIAppQueryOptions, optional) – Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.

datadog_api_client.v2.model.ci_app_tests_aggregation_buckets_response module¶

class CIAppTestsAggregationBucketsResponse(arg: None)¶

class CIAppTestsAggregationBucketsResponse(arg: ModelComposed)

class CIAppTestsAggregationBucketsResponse(*args, **kwargs)

Bases: ModelNormal

The query results.

Parameters:: buckets ([CIAppTestsBucketResponse], optional) – The list of matching buckets, one item per bucket.

datadog_api_client.v2.model.ci_app_tests_analytics_aggregate_response module¶

class CIAppTestsAnalyticsAggregateResponse(arg: None)¶

class CIAppTestsAnalyticsAggregateResponse(arg: ModelComposed)

class CIAppTestsAnalyticsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the test events aggregate API endpoint.

Parameters:

data (CIAppTestsAggregationBucketsResponse, optional) – The query results.
links (CIAppResponseLinks, optional) – Links attributes.
meta (CIAppResponseMetadataWithPagination, optional) – The metadata associated with a request.

datadog_api_client.v2.model.ci_app_tests_bucket_response module¶

class CIAppTestsBucketResponse(arg: None)¶

class CIAppTestsBucketResponse(arg: ModelComposed)

class CIAppTestsBucketResponse(*args, **kwargs)

Bases: ModelNormal

Bucket values.

Parameters:

by ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The key-value pairs for each group-by.
computes (CIAppComputes, optional) – A map of the metric name to value for regular compute, or a list of values for a timeseries.

datadog_api_client.v2.model.ci_app_tests_group_by module¶

class CIAppTestsGroupBy(arg: None)¶

class CIAppTestsGroupBy(arg: ModelComposed)

class CIAppTestsGroupBy(*args, **kwargs)

Bases: ModelNormal

A group-by rule.

Parameters:

facet (str) – The name of the facet to use (required).
histogram (CIAppGroupByHistogram, optional) – Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.
limit (int, optional) – The maximum buckets to return for this group-by.
missing (CIAppGroupByMissing, optional) – The value to use for logs that don’t have the facet used to group-by.
sort (CIAppAggregateSort, optional) – A sort rule. The aggregation field is required when type is measure.
total (CIAppGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.ci_app_tests_query_filter module¶

class CIAppTestsQueryFilter(arg: None)¶

class CIAppTestsQueryFilter(arg: ModelComposed)

class CIAppTestsQueryFilter(*args, **kwargs)

Bases: ModelNormal

The search and filter query settings.

Parameters:

_from (str, optional) – The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds).
query (str, optional) – The search query following the CI Visibility Explorer search syntax.
to (str, optional) – The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds).

datadog_api_client.v2.model.ci_app_warning module¶

class CIAppWarning(arg: None)¶

class CIAppWarning(arg: ModelComposed)

class CIAppWarning(*args, **kwargs)

Bases: ModelNormal

A warning message indicating something that went wrong with the query.

Parameters:

code (str, optional) – A unique code for this type of warning.
detail (str, optional) – A detailed explanation of this specific warning.
title (str, optional) – A short human-readable summary of the warning.

datadog_api_client.v2.model.circle_ci_credentials module¶

class CircleCICredentials(arg: None)¶

class CircleCICredentials(arg: ModelComposed)

class CircleCICredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the CircleCICredentials object.

Parameters:

api_token (str) – The CircleCIAPIKey api_token.
type (CircleCIAPIKeyType) – The definition of the CircleCIAPIKey object.

datadog_api_client.v2.model.circle_ci_credentials_update module¶

class CircleCICredentialsUpdate(arg: None)¶

class CircleCICredentialsUpdate(arg: ModelComposed)

class CircleCICredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the CircleCICredentialsUpdate object.

Parameters:

api_token (str, optional) – The CircleCIAPIKeyUpdate api_token.
type (CircleCIAPIKeyType) – The definition of the CircleCIAPIKey object.

datadog_api_client.v2.model.circle_ci_integration module¶

class CircleCIIntegration(arg: None)¶

class CircleCIIntegration(arg: ModelComposed)

class CircleCIIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the CircleCIIntegration object.

Parameters:

credentials (CircleCICredentials) – The definition of the CircleCICredentials object.
type (CircleCIIntegrationType) – The definition of the CircleCIIntegrationType object.

datadog_api_client.v2.model.circle_ci_integration_type module¶

class CircleCIIntegrationType(arg: None)¶

class CircleCIIntegrationType(arg: ModelComposed)

class CircleCIIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the CircleCIIntegrationType object.

Parameters:

value (str) – If omitted defaults to “CircleCI”. Must be one of [“CircleCI”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.circle_ci_integration_update module¶

class CircleCIIntegrationUpdate(arg: None)¶

class CircleCIIntegrationUpdate(arg: ModelComposed)

class CircleCIIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the CircleCIIntegrationUpdate object.

Parameters:

credentials (CircleCICredentialsUpdate, optional) – The definition of the CircleCICredentialsUpdate object.
type (CircleCIIntegrationType) – The definition of the CircleCIIntegrationType object.

datadog_api_client.v2.model.circle_ciapi_key module¶

class CircleCIAPIKey(arg: None)¶

class CircleCIAPIKey(arg: ModelComposed)

class CircleCIAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the CircleCIAPIKey object.

Parameters:

api_token (str) – The CircleCIAPIKey api_token.
type (CircleCIAPIKeyType) – The definition of the CircleCIAPIKey object.

datadog_api_client.v2.model.circle_ciapi_key_type module¶

class CircleCIAPIKeyType(arg: None)¶

class CircleCIAPIKeyType(arg: ModelComposed)

class CircleCIAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the CircleCIAPIKey object.

Parameters:

value (str) – If omitted defaults to “CircleCIAPIKey”. Must be one of [“CircleCIAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.circle_ciapi_key_update module¶

class CircleCIAPIKeyUpdate(arg: None)¶

class CircleCIAPIKeyUpdate(arg: ModelComposed)

class CircleCIAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the CircleCIAPIKey object.

Parameters:

api_token (str, optional) – The CircleCIAPIKeyUpdate api_token.
type (CircleCIAPIKeyType) – The definition of the CircleCIAPIKey object.

datadog_api_client.v2.model.clickup_api_key module¶

class ClickupAPIKey(arg: None)¶

class ClickupAPIKey(arg: ModelComposed)

class ClickupAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the ClickupAPIKey object.

Parameters:

api_token (str) – The ClickupAPIKey api_token.
type (ClickupAPIKeyType) – The definition of the ClickupAPIKey object.

datadog_api_client.v2.model.clickup_api_key_type module¶

class ClickupAPIKeyType(arg: None)¶

class ClickupAPIKeyType(arg: ModelComposed)

class ClickupAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the ClickupAPIKey object.

Parameters:

value (str) – If omitted defaults to “ClickupAPIKey”. Must be one of [“ClickupAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.clickup_api_key_update module¶

class ClickupAPIKeyUpdate(arg: None)¶

class ClickupAPIKeyUpdate(arg: ModelComposed)

class ClickupAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the ClickupAPIKey object.

Parameters:

api_token (str, optional) – The ClickupAPIKeyUpdate api_token.
type (ClickupAPIKeyType) – The definition of the ClickupAPIKey object.

datadog_api_client.v2.model.clickup_credentials module¶

class ClickupCredentials(arg: None)¶

class ClickupCredentials(arg: ModelComposed)

class ClickupCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the ClickupCredentials object.

Parameters:

api_token (str) – The ClickupAPIKey api_token.
type (ClickupAPIKeyType) – The definition of the ClickupAPIKey object.

datadog_api_client.v2.model.clickup_credentials_update module¶

class ClickupCredentialsUpdate(arg: None)¶

class ClickupCredentialsUpdate(arg: ModelComposed)

class ClickupCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the ClickupCredentialsUpdate object.

Parameters:

api_token (str, optional) – The ClickupAPIKeyUpdate api_token.
type (ClickupAPIKeyType) – The definition of the ClickupAPIKey object.

datadog_api_client.v2.model.clickup_integration module¶

class ClickupIntegration(arg: None)¶

class ClickupIntegration(arg: ModelComposed)

class ClickupIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the ClickupIntegration object.

Parameters:

credentials (ClickupCredentials) – The definition of the ClickupCredentials object.
type (ClickupIntegrationType) – The definition of the ClickupIntegrationType object.

datadog_api_client.v2.model.clickup_integration_type module¶

class ClickupIntegrationType(arg: None)¶

class ClickupIntegrationType(arg: ModelComposed)

class ClickupIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the ClickupIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Clickup”. Must be one of [“Clickup”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.clickup_integration_update module¶

class ClickupIntegrationUpdate(arg: None)¶

class ClickupIntegrationUpdate(arg: ModelComposed)

class ClickupIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the ClickupIntegrationUpdate object.

Parameters:

credentials (ClickupCredentialsUpdate, optional) – The definition of the ClickupCredentialsUpdate object.
type (ClickupIntegrationType) – The definition of the ClickupIntegrationType object.

datadog_api_client.v2.model.cloud_asset_type module¶

class CloudAssetType(arg: None)¶

class CloudAssetType(arg: ModelComposed)

class CloudAssetType(*args, **kwargs)

Bases: ModelSimple

The cloud asset type

Parameters:

value (str) – Must be one of [“Host”, “HostImage”, “Image”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloud_configuration_compliance_rule_options module¶

class CloudConfigurationComplianceRuleOptions(arg: None)¶

class CloudConfigurationComplianceRuleOptions(arg: ModelComposed)

class CloudConfigurationComplianceRuleOptions(*args, **kwargs)

Bases: ModelNormal

Options for cloud_configuration rules. Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

Parameters:

complex_rule (bool, optional) – Whether the rule is a complex one. Must be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.
rego_rule (CloudConfigurationRegoRule, optional) – Rule details.
resource_type (str, optional) – Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.

datadog_api_client.v2.model.cloud_configuration_rego_rule module¶

class CloudConfigurationRegoRule(arg: None)¶

class CloudConfigurationRegoRule(arg: ModelComposed)

class CloudConfigurationRegoRule(*args, **kwargs)

Bases: ModelNormal

Rule details.

Parameters:

policy (str) – The policy written in rego , see: https://www.openpolicyagent.org/docs/latest/policy-language/
resource_types ([str]) – List of resource types that will be evaluated upon. Must have at least one element.

datadog_api_client.v2.model.cloud_configuration_rule_case_create module¶

class CloudConfigurationRuleCaseCreate(arg: None)¶

class CloudConfigurationRuleCaseCreate(arg: ModelComposed)

class CloudConfigurationRuleCaseCreate(*args, **kwargs)

Bases: ModelNormal

Description of signals.

Parameters:

notifications ([str], optional) – Notification targets for each rule case.
status (SecurityMonitoringRuleSeverity) – Severity of the Security Signal.

datadog_api_client.v2.model.cloud_configuration_rule_compliance_signal_options module¶

class CloudConfigurationRuleComplianceSignalOptions(arg: None)¶

class CloudConfigurationRuleComplianceSignalOptions(arg: ModelComposed)

class CloudConfigurationRuleComplianceSignalOptions(*args, **kwargs)

Bases: ModelNormal

How to generate compliance signals. Useful for cloud_configuration rules only.

Parameters:

default_activation_status (bool, none_type, optional) – The default activation status.
default_group_by_fields ([str], none_type, optional) – The default group by fields.
user_activation_status (bool, none_type, optional) – Whether signals will be sent.
user_group_by_fields ([str], none_type, optional) – Fields to use to group findings by when sending signals.

datadog_api_client.v2.model.cloud_configuration_rule_create_payload module¶

class CloudConfigurationRuleCreatePayload(arg: None)¶

class CloudConfigurationRuleCreatePayload(arg: ModelComposed)

class CloudConfigurationRuleCreatePayload(*args, **kwargs)

Bases: ModelNormal

Create a new cloud configuration rule.

Parameters:

cases ([CloudConfigurationRuleCaseCreate]) – Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions) – How to generate compliance signals. Useful for cloud_configuration rules only.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message in markdown format for generated findings and signals.
name (str) – The name of the rule.
options (CloudConfigurationRuleOptions) – Options on cloud configuration rules.
tags ([str], optional) – Tags for generated findings and signals.
type (CloudConfigurationRuleType, optional) – The rule type.

datadog_api_client.v2.model.cloud_configuration_rule_options module¶

class CloudConfigurationRuleOptions(arg: None)¶

class CloudConfigurationRuleOptions(arg: ModelComposed)

class CloudConfigurationRuleOptions(*args, **kwargs)

Bases: ModelNormal

Options on cloud configuration rules.

Parameters:: compliance_rule_options (CloudConfigurationComplianceRuleOptions) – Options for cloud_configuration rules. Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.

datadog_api_client.v2.model.cloud_configuration_rule_payload module¶

class CloudConfigurationRulePayload(arg: None)¶

class CloudConfigurationRulePayload(arg: ModelComposed)

class CloudConfigurationRulePayload(*args, **kwargs)

Bases: ModelNormal

The payload of a cloud configuration rule.

Parameters:

cases ([CloudConfigurationRuleCaseCreate]) – Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions) – How to generate compliance signals. Useful for cloud_configuration rules only.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message in markdown format for generated findings and signals.
name (str) – The name of the rule.
options (CloudConfigurationRuleOptions) – Options on cloud configuration rules.
tags ([str], optional) – Tags for generated findings and signals.
type (CloudConfigurationRuleType, optional) – The rule type.

datadog_api_client.v2.model.cloud_configuration_rule_type module¶

class CloudConfigurationRuleType(arg: None)¶

class CloudConfigurationRuleType(arg: ModelComposed)

class CloudConfigurationRuleType(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

value (str) – If omitted defaults to “cloud_configuration”. Must be one of [“cloud_configuration”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloud_workload_security_agent_policies_list_response module¶

class CloudWorkloadSecurityAgentPoliciesListResponse(arg: None)¶

class CloudWorkloadSecurityAgentPoliciesListResponse(arg: ModelComposed)

class CloudWorkloadSecurityAgentPoliciesListResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a list of Agent policies

Parameters:: data ([CloudWorkloadSecurityAgentPolicyData], optional) – A list of Agent policy objects

datadog_api_client.v2.model.cloud_workload_security_agent_policy_attributes module¶

class CloudWorkloadSecurityAgentPolicyAttributes(arg: None)¶

class CloudWorkloadSecurityAgentPolicyAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyAttributes(*args, **kwargs)

Bases: ModelNormal

A Cloud Workload Security Agent policy returned by the API

Parameters:

blocking_rules_count (int, optional) – The number of rules with the blocking feature in this policy
datadog_managed (bool, optional) – Whether the policy is managed by Datadog
description (str, optional) – The description of the policy
disabled_rules_count (int, optional) – The number of rules that are disabled in this policy
enabled (bool, optional) – Whether the Agent policy is enabled
host_tags ([str], optional) – The host tags defining where this policy is deployed
host_tags_lists ([[str]], optional) – The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
monitoring_rules_count (int, optional) – The number of rules in the monitoring state in this policy
name (str, optional) – The name of the policy
pinned (bool, optional) – Whether the policy is pinned
policy_version (str, optional) – The version of the policy
priority (int, optional) – The priority of the policy
rule_count (int, optional) – The number of rules in this policy
update_date (int, optional) – Timestamp in milliseconds when the policy was last updated
updated_at (int, optional) – When the policy was last updated, timestamp in milliseconds
updater (CloudWorkloadSecurityAgentPolicyUpdaterAttributes, optional) – The attributes of the user who last updated the policy
versions ([CloudWorkloadSecurityAgentPolicyVersion], optional) – The versions of the policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_create_attributes module¶

class CloudWorkloadSecurityAgentPolicyCreateAttributes(arg: None)¶

class CloudWorkloadSecurityAgentPolicyCreateAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Create a new Cloud Workload Security Agent policy

Parameters:

description (str, optional) – The description of the policy
enabled (bool, optional) – Whether the policy is enabled
host_tags ([str], optional) – The host tags defining where this policy is deployed
host_tags_lists ([[str]], optional) – The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
name (str) – The name of the policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_create_data module¶

class CloudWorkloadSecurityAgentPolicyCreateData(arg: None)¶

class CloudWorkloadSecurityAgentPolicyCreateData(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule

Parameters:

attributes (CloudWorkloadSecurityAgentPolicyCreateAttributes) – Create a new Cloud Workload Security Agent policy
type (CloudWorkloadSecurityAgentPolicyType) – The type of the resource, must always be policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_create_request module¶

class CloudWorkloadSecurityAgentPolicyCreateRequest(arg: None)¶

class CloudWorkloadSecurityAgentPolicyCreateRequest(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the Agent policy to create

Parameters:: data (CloudWorkloadSecurityAgentPolicyCreateData) – Object for a single Agent rule

datadog_api_client.v2.model.cloud_workload_security_agent_policy_data module¶

class CloudWorkloadSecurityAgentPolicyData(arg: None)¶

class CloudWorkloadSecurityAgentPolicyData(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent policy

Parameters:

attributes (CloudWorkloadSecurityAgentPolicyAttributes, optional) – A Cloud Workload Security Agent policy returned by the API
id (str, optional) – The ID of the Agent policy
type (CloudWorkloadSecurityAgentPolicyType, optional) – The type of the resource, must always be policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_response module¶

class CloudWorkloadSecurityAgentPolicyResponse(arg: None)¶

class CloudWorkloadSecurityAgentPolicyResponse(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes an Agent policy

Parameters:: data (CloudWorkloadSecurityAgentPolicyData, optional) – Object for a single Agent policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_type module¶

class CloudWorkloadSecurityAgentPolicyType(arg: None)¶

class CloudWorkloadSecurityAgentPolicyType(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyType(*args, **kwargs)

Bases: ModelSimple

The type of the resource, must always be policy

Parameters:

value (str) – If omitted defaults to “policy”. Must be one of [“policy”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloud_workload_security_agent_policy_update_attributes module¶

class CloudWorkloadSecurityAgentPolicyUpdateAttributes(arg: None)¶

class CloudWorkloadSecurityAgentPolicyUpdateAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Update an existing Cloud Workload Security Agent policy

Parameters:

description (str, optional) – The description of the policy
enabled (bool, optional) – Whether the policy is enabled
host_tags ([str], optional) – The host tags defining where this policy is deployed
host_tags_lists ([[str]], optional) – The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR
name (str, optional) – The name of the policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_update_data module¶

class CloudWorkloadSecurityAgentPolicyUpdateData(arg: None)¶

class CloudWorkloadSecurityAgentPolicyUpdateData(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent policy

Parameters:

attributes (CloudWorkloadSecurityAgentPolicyUpdateAttributes) – Update an existing Cloud Workload Security Agent policy
id (str, optional) – The ID of the Agent policy
type (CloudWorkloadSecurityAgentPolicyType) – The type of the resource, must always be policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_update_request module¶

class CloudWorkloadSecurityAgentPolicyUpdateRequest(arg: None)¶

class CloudWorkloadSecurityAgentPolicyUpdateRequest(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the Agent policy with the attributes to update

Parameters:: data (CloudWorkloadSecurityAgentPolicyUpdateData) – Object for a single Agent policy

datadog_api_client.v2.model.cloud_workload_security_agent_policy_updater_attributes module¶

class CloudWorkloadSecurityAgentPolicyUpdaterAttributes(arg: None)¶

class CloudWorkloadSecurityAgentPolicyUpdaterAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentPolicyUpdaterAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the user who last updated the policy

Parameters:

handle (str, optional) – The handle of the user
name (str, none_type, optional) – The name of the user

datadog_api_client.v2.model.cloud_workload_security_agent_rule_action module¶

class CloudWorkloadSecurityAgentRuleAction(arg: None)¶

class CloudWorkloadSecurityAgentRuleAction(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleAction(*args, **kwargs)

Bases: ModelNormal

The action the rule can perform if triggered

Parameters:

filter (str, optional) – SECL expression used to target the container to apply the action on
hash (CloudWorkloadSecurityAgentRuleActionHash, optional) – An empty object indicating the hash action
kill (CloudWorkloadSecurityAgentRuleKill, optional) – Kill system call applied on the container matching the rule
metadata (CloudWorkloadSecurityAgentRuleActionMetadata, optional) – The metadata action applied on the scope matching the rule
set (CloudWorkloadSecurityAgentRuleActionSet, optional) – The set action applied on the scope matching the rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_action_hash module¶

class CloudWorkloadSecurityAgentRuleActionHash(arg: None)¶

class CloudWorkloadSecurityAgentRuleActionHash(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleActionHash(*args, **kwargs)

Bases: ModelNormal

An empty object indicating the hash action

datadog_api_client.v2.model.cloud_workload_security_agent_rule_action_metadata module¶

class CloudWorkloadSecurityAgentRuleActionMetadata(arg: None)¶

class CloudWorkloadSecurityAgentRuleActionMetadata(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleActionMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata action applied on the scope matching the rule

Parameters:

image_tag (str, optional) – The image tag of the metadata action
service (str, optional) – The service of the metadata action
short_image (str, optional) – The short image of the metadata action

datadog_api_client.v2.model.cloud_workload_security_agent_rule_action_set module¶

class CloudWorkloadSecurityAgentRuleActionSet(arg: None)¶

class CloudWorkloadSecurityAgentRuleActionSet(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleActionSet(*args, **kwargs)

Bases: ModelNormal

The set action applied on the scope matching the rule

Parameters:

append (bool, optional) – Whether the value should be appended to the field.
default_value (str, optional) – The default value of the set action
expression (str, optional) – The expression of the set action.
field (str, optional) – The field of the set action
inherited (bool, optional) – Whether the value should be inherited.
name (str, optional) – The name of the set action
scope (str, optional) – The scope of the set action.
size (int, optional) – The size of the set action.
ttl (int, optional) – The time to live of the set action.
value (str, optional) – The value of the set action

datadog_api_client.v2.model.cloud_workload_security_agent_rule_attributes module¶

class CloudWorkloadSecurityAgentRuleAttributes(arg: None)¶

class CloudWorkloadSecurityAgentRuleAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleAttributes(*args, **kwargs)

Bases: ModelNormal

A Cloud Workload Security Agent rule returned by the API

Parameters:

actions ([CloudWorkloadSecurityAgentRuleAction], none_type, optional) – The array of actions the rule can perform if triggered
agent_constraint (str, optional) – The version of the Agent
blocking ([str], optional) – The blocking policies that the rule belongs to
category (str, optional) – The category of the Agent rule
creation_author_uu_id (str, optional) – The ID of the user who created the rule
creation_date (int, optional) – When the Agent rule was created, timestamp in milliseconds
creator (CloudWorkloadSecurityAgentRuleCreatorAttributes, optional) – The attributes of the user who created the Agent rule
default_rule (bool, optional) – Whether the rule is included by default
description (str, optional) – The description of the Agent rule
disabled ([str], optional) – The disabled policies that the rule belongs to
enabled (bool, optional) – Whether the Agent rule is enabled
expression (str, optional) – The SECL expression of the Agent rule
filters ([str], optional) – The platforms the Agent rule is supported on
monitoring ([str], optional) – The monitoring policies that the rule belongs to
name (str, optional) – The name of the Agent rule
product_tags ([str], optional) – The list of product tags associated with the rule
silent (bool, optional) – Whether the rule is silent.
update_author_uu_id (str, optional) – The ID of the user who updated the rule
update_date (int, optional) – Timestamp in milliseconds when the Agent rule was last updated
updated_at (int, optional) – When the Agent rule was last updated, timestamp in milliseconds
updater (CloudWorkloadSecurityAgentRuleUpdaterAttributes, optional) – The attributes of the user who last updated the Agent rule
version (int, optional) – The version of the Agent rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_create_attributes module¶

class CloudWorkloadSecurityAgentRuleCreateAttributes(arg: None)¶

class CloudWorkloadSecurityAgentRuleCreateAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Create a new Cloud Workload Security Agent rule.

Parameters:

actions ([CloudWorkloadSecurityAgentRuleAction], none_type, optional) – The array of actions the rule can perform if triggered
agent_version (str, optional) – Constrain the rule to specific versions of the Datadog Agent.
blocking ([str], optional) – The blocking policies that the rule belongs to.
description (str, optional) – The description of the Agent rule.
disabled ([str], optional) – The disabled policies that the rule belongs to.
enabled (bool, optional) – Whether the Agent rule is enabled.
expression (str) – The SECL expression of the Agent rule.
filters ([str], optional) – The platforms the Agent rule is supported on.
monitoring ([str], optional) – The monitoring policies that the rule belongs to.
name (str) – The name of the Agent rule.
policy_id (str, optional) – The ID of the policy where the Agent rule is saved.
product_tags ([str], optional) – The list of product tags associated with the rule.
silent (bool, optional) – Whether the rule is silent.

datadog_api_client.v2.model.cloud_workload_security_agent_rule_create_data module¶

class CloudWorkloadSecurityAgentRuleCreateData(arg: None)¶

class CloudWorkloadSecurityAgentRuleCreateData(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule

Parameters:

attributes (CloudWorkloadSecurityAgentRuleCreateAttributes) – Create a new Cloud Workload Security Agent rule.
type (CloudWorkloadSecurityAgentRuleType) – The type of the resource, must always be agent_rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_create_request module¶

class CloudWorkloadSecurityAgentRuleCreateRequest(arg: None)¶

class CloudWorkloadSecurityAgentRuleCreateRequest(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the Agent rule to create

Parameters:: data (CloudWorkloadSecurityAgentRuleCreateData) – Object for a single Agent rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_creator_attributes module¶

class CloudWorkloadSecurityAgentRuleCreatorAttributes(arg: None)¶

class CloudWorkloadSecurityAgentRuleCreatorAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleCreatorAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the user who created the Agent rule

Parameters:

handle (str, optional) – The handle of the user
name (str, none_type, optional) – The name of the user

datadog_api_client.v2.model.cloud_workload_security_agent_rule_data module¶

class CloudWorkloadSecurityAgentRuleData(arg: None)¶

class CloudWorkloadSecurityAgentRuleData(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule

Parameters:

attributes (CloudWorkloadSecurityAgentRuleAttributes, optional) – A Cloud Workload Security Agent rule returned by the API
id (str, optional) – The ID of the Agent rule
type (CloudWorkloadSecurityAgentRuleType, optional) – The type of the resource, must always be agent_rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_kill module¶

class CloudWorkloadSecurityAgentRuleKill(arg: None)¶

class CloudWorkloadSecurityAgentRuleKill(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleKill(*args, **kwargs)

Bases: ModelNormal

Kill system call applied on the container matching the rule

Parameters:: signal (str, optional) – Supported signals for the kill system call

datadog_api_client.v2.model.cloud_workload_security_agent_rule_response module¶

class CloudWorkloadSecurityAgentRuleResponse(arg: None)¶

class CloudWorkloadSecurityAgentRuleResponse(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes an Agent rule

Parameters:: data (CloudWorkloadSecurityAgentRuleData, optional) – Object for a single Agent rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_type module¶

class CloudWorkloadSecurityAgentRuleType(arg: None)¶

class CloudWorkloadSecurityAgentRuleType(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleType(*args, **kwargs)

Bases: ModelSimple

The type of the resource, must always be agent_rule

Parameters:

value (str) – If omitted defaults to “agent_rule”. Must be one of [“agent_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloud_workload_security_agent_rule_update_attributes module¶

class CloudWorkloadSecurityAgentRuleUpdateAttributes(arg: None)¶

class CloudWorkloadSecurityAgentRuleUpdateAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Update an existing Cloud Workload Security Agent rule

Parameters:

actions ([CloudWorkloadSecurityAgentRuleAction], none_type, optional) – The array of actions the rule can perform if triggered
agent_version (str, optional) – Constrain the rule to specific versions of the Datadog Agent
blocking ([str], optional) – The blocking policies that the rule belongs to
description (str, optional) – The description of the Agent rule
disabled ([str], optional) – The disabled policies that the rule belongs to
enabled (bool, optional) – Whether the Agent rule is enabled
expression (str, optional) – The SECL expression of the Agent rule
monitoring ([str], optional) – The monitoring policies that the rule belongs to
policy_id (str, optional) – The ID of the policy where the Agent rule is saved
product_tags ([str], optional) – The list of product tags associated with the rule
silent (bool, optional) – Whether the rule is silent.

datadog_api_client.v2.model.cloud_workload_security_agent_rule_update_data module¶

class CloudWorkloadSecurityAgentRuleUpdateData(arg: None)¶

class CloudWorkloadSecurityAgentRuleUpdateData(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule

Parameters:

attributes (CloudWorkloadSecurityAgentRuleUpdateAttributes) – Update an existing Cloud Workload Security Agent rule
id (str, optional) – The ID of the Agent rule
type (CloudWorkloadSecurityAgentRuleType) – The type of the resource, must always be agent_rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_update_request module¶

class CloudWorkloadSecurityAgentRuleUpdateRequest(arg: None)¶

class CloudWorkloadSecurityAgentRuleUpdateRequest(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the Agent rule with the attributes to update

Parameters:: data (CloudWorkloadSecurityAgentRuleUpdateData) – Object for a single Agent rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_updater_attributes module¶

class CloudWorkloadSecurityAgentRuleUpdaterAttributes(arg: None)¶

class CloudWorkloadSecurityAgentRuleUpdaterAttributes(arg: ModelComposed)

class CloudWorkloadSecurityAgentRuleUpdaterAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the user who last updated the Agent rule

Parameters:

handle (str, optional) – The handle of the user
name (str, none_type, optional) – The name of the user

datadog_api_client.v2.model.cloud_workload_security_agent_rules_list_response module¶

class CloudWorkloadSecurityAgentRulesListResponse(arg: None)¶

class CloudWorkloadSecurityAgentRulesListResponse(arg: ModelComposed)

class CloudWorkloadSecurityAgentRulesListResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a list of Agent rule

Parameters:: data ([CloudWorkloadSecurityAgentRuleData], optional) – A list of Agent rules objects

datadog_api_client.v2.model.cloudflare_account_create_request module¶

class CloudflareAccountCreateRequest(arg: None)¶

class CloudflareAccountCreateRequest(arg: ModelComposed)

class CloudflareAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when adding a Cloudflare account.

Parameters:: data (CloudflareAccountCreateRequestData) – Data object for creating a Cloudflare account.

datadog_api_client.v2.model.cloudflare_account_create_request_attributes module¶

class CloudflareAccountCreateRequestAttributes(arg: None)¶

class CloudflareAccountCreateRequestAttributes(arg: ModelComposed)

class CloudflareAccountCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for creating a Cloudflare account.

Parameters:

api_key (str) – The API key (or token) for the Cloudflare account.
email (str, optional) – The email associated with the Cloudflare account. If an API key is provided (and not a token), this field is also required.
name (str) – The name of the Cloudflare account.
resources ([str], optional) – An allowlist of resources to restrict pulling metrics for including 'web', 'dns', 'lb' (load balancer), 'worker'.
zones ([str], optional) – An allowlist of zones to restrict pulling metrics for.

datadog_api_client.v2.model.cloudflare_account_create_request_data module¶

class CloudflareAccountCreateRequestData(arg: None)¶

class CloudflareAccountCreateRequestData(arg: ModelComposed)

class CloudflareAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for creating a Cloudflare account.

Parameters:

attributes (CloudflareAccountCreateRequestAttributes) – Attributes object for creating a Cloudflare account.
type (CloudflareAccountType) – The JSON:API type for this API. Should always be cloudflare-accounts.

datadog_api_client.v2.model.cloudflare_account_response module¶

class CloudflareAccountResponse(arg: None)¶

class CloudflareAccountResponse(arg: ModelComposed)

class CloudflareAccountResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting a Cloudflare account.

Parameters:: data (CloudflareAccountResponseData, optional) – Data object of a Cloudflare account.

datadog_api_client.v2.model.cloudflare_account_response_attributes module¶

class CloudflareAccountResponseAttributes(arg: None)¶

class CloudflareAccountResponseAttributes(arg: ModelComposed)

class CloudflareAccountResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object of a Cloudflare account.

Parameters:

email (str, optional) – The email associated with the Cloudflare account.
name (str) – The name of the Cloudflare account.
resources ([str], optional) – An allowlist of resources, such as web , dns , lb (load balancer), worker , that restricts pulling metrics from those resources.
zones ([str], optional) – An allowlist of zones to restrict pulling metrics for.

datadog_api_client.v2.model.cloudflare_account_response_data module¶

class CloudflareAccountResponseData(arg: None)¶

class CloudflareAccountResponseData(arg: ModelComposed)

class CloudflareAccountResponseData(*args, **kwargs)

Bases: ModelNormal

Data object of a Cloudflare account.

Parameters:

attributes (CloudflareAccountResponseAttributes) – Attributes object of a Cloudflare account.
id (str) – The ID of the Cloudflare account, a hash of the account name.
type (CloudflareAccountType) – The JSON:API type for this API. Should always be cloudflare-accounts.

datadog_api_client.v2.model.cloudflare_account_type module¶

class CloudflareAccountType(arg: None)¶

class CloudflareAccountType(arg: ModelComposed)

class CloudflareAccountType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for this API. Should always be cloudflare-accounts.

Parameters:

value (str) – If omitted defaults to “cloudflare-accounts”. Must be one of [“cloudflare-accounts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloudflare_account_update_request module¶

class CloudflareAccountUpdateRequest(arg: None)¶

class CloudflareAccountUpdateRequest(arg: ModelComposed)

class CloudflareAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when updating a Cloudflare account.

Parameters:: data (CloudflareAccountUpdateRequestData) – Data object for updating a Cloudflare account.

datadog_api_client.v2.model.cloudflare_account_update_request_attributes module¶

class CloudflareAccountUpdateRequestAttributes(arg: None)¶

class CloudflareAccountUpdateRequestAttributes(arg: ModelComposed)

class CloudflareAccountUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for updating a Cloudflare account.

Parameters:

api_key (str) – The API key of the Cloudflare account.
email (str, optional) – The email associated with the Cloudflare account. If an API key is provided (and not a token), this field is also required.
name (str, optional) – The name of the Cloudflare account.
resources ([str], optional) – An allowlist of resources to restrict pulling metrics for including 'web', 'dns', 'lb' (load balancer), 'worker'.
zones ([str], optional) – An allowlist of zones to restrict pulling metrics for.

datadog_api_client.v2.model.cloudflare_account_update_request_data module¶

class CloudflareAccountUpdateRequestData(arg: None)¶

class CloudflareAccountUpdateRequestData(arg: ModelComposed)

class CloudflareAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Cloudflare account.

Parameters:

attributes (CloudflareAccountUpdateRequestAttributes, optional) – Attributes object for updating a Cloudflare account.
type (CloudflareAccountType, optional) – The JSON:API type for this API. Should always be cloudflare-accounts.

datadog_api_client.v2.model.cloudflare_accounts_response module¶

class CloudflareAccountsResponse(arg: None)¶

class CloudflareAccountsResponse(arg: ModelComposed)

class CloudflareAccountsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Cloudflare accounts.

Parameters:: data ([CloudflareAccountResponseData], optional) – The JSON:API data schema.

datadog_api_client.v2.model.cloudflare_api_token module¶

class CloudflareAPIToken(arg: None)¶

class CloudflareAPIToken(arg: ModelComposed)

class CloudflareAPIToken(*args, **kwargs)

Bases: ModelNormal

The definition of the CloudflareAPIToken object.

Parameters:

api_token (str) – The CloudflareAPIToken api_token.
type (CloudflareAPITokenType) – The definition of the CloudflareAPIToken object.

datadog_api_client.v2.model.cloudflare_api_token_type module¶

class CloudflareAPITokenType(arg: None)¶

class CloudflareAPITokenType(arg: ModelComposed)

class CloudflareAPITokenType(*args, **kwargs)

Bases: ModelSimple

The definition of the CloudflareAPIToken object.

Parameters:

value (str) – If omitted defaults to “CloudflareAPIToken”. Must be one of [“CloudflareAPIToken”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloudflare_api_token_update module¶

class CloudflareAPITokenUpdate(arg: None)¶

class CloudflareAPITokenUpdate(arg: ModelComposed)

class CloudflareAPITokenUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the CloudflareAPIToken object.

Parameters:

api_token (str, optional) – The CloudflareAPITokenUpdate api_token.
type (CloudflareAPITokenType) – The definition of the CloudflareAPIToken object.

datadog_api_client.v2.model.cloudflare_credentials module¶

class CloudflareCredentials(arg: None)¶

class CloudflareCredentials(arg: ModelComposed)

class CloudflareCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the CloudflareCredentials object.

Parameters:

api_token (str) – The CloudflareAPIToken api_token.
type (CloudflareAPITokenType) – The definition of the CloudflareAPIToken object.
auth_email (str) – The CloudflareGlobalAPIToken auth_email.
global_api_key (str) – The CloudflareGlobalAPIToken global_api_key.

datadog_api_client.v2.model.cloudflare_credentials_update module¶

class CloudflareCredentialsUpdate(arg: None)¶

class CloudflareCredentialsUpdate(arg: ModelComposed)

class CloudflareCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the CloudflareCredentialsUpdate object.

Parameters:

api_token (str, optional) – The CloudflareAPITokenUpdate api_token.
type (CloudflareAPITokenType) – The definition of the CloudflareAPIToken object.
auth_email (str, optional) – The CloudflareGlobalAPITokenUpdate auth_email.
global_api_key (str, optional) – The CloudflareGlobalAPITokenUpdate global_api_key.

datadog_api_client.v2.model.cloudflare_global_api_token module¶

class CloudflareGlobalAPIToken(arg: None)¶

class CloudflareGlobalAPIToken(arg: ModelComposed)

class CloudflareGlobalAPIToken(*args, **kwargs)

Bases: ModelNormal

The definition of the CloudflareGlobalAPIToken object.

Parameters:

auth_email (str) – The CloudflareGlobalAPIToken auth_email.
global_api_key (str) – The CloudflareGlobalAPIToken global_api_key.
type (CloudflareGlobalAPITokenType) – The definition of the CloudflareGlobalAPIToken object.

datadog_api_client.v2.model.cloudflare_global_api_token_type module¶

class CloudflareGlobalAPITokenType(arg: None)¶

class CloudflareGlobalAPITokenType(arg: ModelComposed)

class CloudflareGlobalAPITokenType(*args, **kwargs)

Bases: ModelSimple

The definition of the CloudflareGlobalAPIToken object.

Parameters:

value (str) – If omitted defaults to “CloudflareGlobalAPIToken”. Must be one of [“CloudflareGlobalAPIToken”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloudflare_global_api_token_update module¶

class CloudflareGlobalAPITokenUpdate(arg: None)¶

class CloudflareGlobalAPITokenUpdate(arg: ModelComposed)

class CloudflareGlobalAPITokenUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the CloudflareGlobalAPIToken object.

Parameters:

auth_email (str, optional) – The CloudflareGlobalAPITokenUpdate auth_email.
global_api_key (str, optional) – The CloudflareGlobalAPITokenUpdate global_api_key.
type (CloudflareGlobalAPITokenType) – The definition of the CloudflareGlobalAPIToken object.

datadog_api_client.v2.model.cloudflare_integration module¶

class CloudflareIntegration(arg: None)¶

class CloudflareIntegration(arg: ModelComposed)

class CloudflareIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the CloudflareIntegration object.

Parameters:

credentials (CloudflareCredentials) – The definition of the CloudflareCredentials object.
type (CloudflareIntegrationType) – The definition of the CloudflareIntegrationType object.

datadog_api_client.v2.model.cloudflare_integration_type module¶

class CloudflareIntegrationType(arg: None)¶

class CloudflareIntegrationType(arg: ModelComposed)

class CloudflareIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the CloudflareIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Cloudflare”. Must be one of [“Cloudflare”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cloudflare_integration_update module¶

class CloudflareIntegrationUpdate(arg: None)¶

class CloudflareIntegrationUpdate(arg: ModelComposed)

class CloudflareIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the CloudflareIntegrationUpdate object.

Parameters:

credentials (CloudflareCredentialsUpdate, optional) – The definition of the CloudflareCredentialsUpdate object.
type (CloudflareIntegrationType) – The definition of the CloudflareIntegrationType object.

datadog_api_client.v2.model.code_location module¶

class CodeLocation(arg: None)¶

class CodeLocation(arg: ModelComposed)

class CodeLocation(*args, **kwargs)

Bases: ModelNormal

Code vulnerability location.

Parameters:

file_path (str, optional) – Vulnerability location file path.
location (str) – Vulnerability extracted location.
method (str, optional) – Vulnerability location method.

datadog_api_client.v2.model.completion_condition module¶

class CompletionCondition(arg: None)¶

class CompletionCondition(arg: ModelComposed)

class CompletionCondition(*args, **kwargs)

Bases: ModelNormal

The definition of CompletionCondition object.

Parameters:

operand1 (bool, date, datetime, dict, float, int, list, str, UUID, none_type) – The CompletionCondition operand1.
operand2 (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The CompletionCondition operand2.
operator (CompletionConditionOperator) – The definition of CompletionConditionOperator object.

datadog_api_client.v2.model.completion_condition_operator module¶

class CompletionConditionOperator(arg: None)¶

class CompletionConditionOperator(arg: ModelComposed)

class CompletionConditionOperator(*args, **kwargs)

Bases: ModelSimple

The definition of CompletionConditionOperator object.

Parameters:

value (str) – Must be one of [“OPERATOR_EQUAL”, “OPERATOR_NOT_EQUAL”, “OPERATOR_GREATER_THAN”, “OPERATOR_LESS_THAN”, “OPERATOR_GREATER_THAN_OR_EQUAL_TO”, “OPERATOR_LESS_THAN_OR_EQUAL_TO”, “OPERATOR_CONTAINS”, “OPERATOR_DOES_NOT_CONTAIN”, “OPERATOR_IS_NULL”, “OPERATOR_IS_NOT_NULL”, “OPERATOR_IS_EMPTY”, “OPERATOR_IS_NOT_EMPTY”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.completion_gate module¶

class CompletionGate(arg: None)¶

class CompletionGate(arg: ModelComposed)

class CompletionGate(*args, **kwargs)

Bases: ModelNormal

Used to create conditions before running subsequent actions.

Parameters:

completion_condition (CompletionCondition) – The definition of CompletionCondition object.
retry_strategy (RetryStrategy) – The definition of RetryStrategy object.

datadog_api_client.v2.model.component module¶

class Component(arg: None)¶

class Component(arg: ModelComposed)

class Component(*args, **kwargs)

Bases: ModelNormal

Definition of a UI component in the app

Parameters:

events ([AppBuilderEvent], optional) – Events to listen for on the UI component.
id (str, none_type, optional) – The ID of the UI component. This property is deprecated; use name to identify individual components instead.
name (str) – A unique identifier for this UI component. This name is also visible in the app editor.
properties (ComponentProperties) – Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.
type (ComponentType) – The UI component type.

datadog_api_client.v2.model.component_grid module¶

class ComponentGrid(arg: None)¶

class ComponentGrid(arg: ModelComposed)

class ComponentGrid(*args, **kwargs)

Bases: ModelNormal

A grid component. The grid component is the root canvas for an app and contains all other components.

Parameters:

events ([AppBuilderEvent], optional) – Events to listen for on the grid component.
id (str, optional) – The ID of the grid component. This property is deprecated; use name to identify individual components instead.
name (str) – A unique identifier for this grid component. This name is also visible in the app editor.
properties (ComponentGridProperties) – Properties of a grid component.
type (ComponentGridType) – The grid component type.

datadog_api_client.v2.model.component_grid_properties module¶

class ComponentGridProperties(arg: None)¶

class ComponentGridProperties(arg: ModelComposed)

class ComponentGridProperties(*args, **kwargs)

Bases: ModelNormal

Properties of a grid component.

Parameters:

background_color (str, optional) – The background color of the grid.
children ([Component], optional) – The child components of the grid.
is_visible (ComponentGridPropertiesIsVisible, optional) – Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.

datadog_api_client.v2.model.component_grid_properties_is_visible module¶

class ComponentGridPropertiesIsVisible(arg: None)¶

class ComponentGridPropertiesIsVisible(arg: ModelComposed)

class ComponentGridPropertiesIsVisible(*args, **kwargs)

Bases: ModelComposed

Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.

datadog_api_client.v2.model.component_grid_type module¶

class ComponentGridType(arg: None)¶

class ComponentGridType(arg: ModelComposed)

class ComponentGridType(*args, **kwargs)

Bases: ModelSimple

The grid component type.

Parameters:

value (str) – If omitted defaults to “grid”. Must be one of [“grid”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.component_properties module¶

class ComponentProperties(arg: None)¶

class ComponentProperties(arg: ModelComposed)

class ComponentProperties(*args, **kwargs)

Bases: ModelNormal

Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.

Parameters:

children ([Component], optional) – The child components of the UI component.
is_visible (ComponentPropertiesIsVisible, optional) – Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

datadog_api_client.v2.model.component_properties_is_visible module¶

class ComponentPropertiesIsVisible(arg: None)¶

class ComponentPropertiesIsVisible(arg: ModelComposed)

class ComponentPropertiesIsVisible(*args, **kwargs)

Bases: ModelComposed

Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

datadog_api_client.v2.model.component_recommendation module¶

class ComponentRecommendation(arg: None)¶

class ComponentRecommendation(arg: ModelComposed)

class ComponentRecommendation(*args, **kwargs)

Bases: ModelNormal

Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs.

Parameters:: estimation (Estimation) – Recommended resource values for a Spark driver or executor, derived from recent real usage metrics. Used by SPA to propose more efficient pod sizing.

datadog_api_client.v2.model.component_type module¶

class ComponentType(arg: None)¶

class ComponentType(arg: ModelComposed)

class ComponentType(*args, **kwargs)

Bases: ModelSimple

The UI component type.

Parameters:

value (str) – Must be one of [“table”, “textInput”, “textArea”, “button”, “text”, “select”, “modal”, “schemaForm”, “checkbox”, “tabs”, “vegaChart”, “radioButtons”, “numberInput”, “fileInput”, “jsonInput”, “gridCell”, “dateRangePicker”, “search”, “container”, “calloutValue”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.config_cat_credentials module¶

class ConfigCatCredentials(arg: None)¶

class ConfigCatCredentials(arg: ModelComposed)

class ConfigCatCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the ConfigCatCredentials object.

Parameters:

api_password (str) – The ConfigCatSDKKey api_password.
api_username (str) – The ConfigCatSDKKey api_username.
sdk_key (str) – The ConfigCatSDKKey sdk_key.
type (ConfigCatSDKKeyType) – The definition of the ConfigCatSDKKey object.

datadog_api_client.v2.model.config_cat_credentials_update module¶

class ConfigCatCredentialsUpdate(arg: None)¶

class ConfigCatCredentialsUpdate(arg: ModelComposed)

class ConfigCatCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the ConfigCatCredentialsUpdate object.

Parameters:

api_password (str, optional) – The ConfigCatSDKKeyUpdate api_password.
api_username (str, optional) – The ConfigCatSDKKeyUpdate api_username.
sdk_key (str, optional) – The ConfigCatSDKKeyUpdate sdk_key.
type (ConfigCatSDKKeyType) – The definition of the ConfigCatSDKKey object.

datadog_api_client.v2.model.config_cat_integration module¶

class ConfigCatIntegration(arg: None)¶

class ConfigCatIntegration(arg: ModelComposed)

class ConfigCatIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the ConfigCatIntegration object.

Parameters:

credentials (ConfigCatCredentials) – The definition of the ConfigCatCredentials object.
type (ConfigCatIntegrationType) – The definition of the ConfigCatIntegrationType object.

datadog_api_client.v2.model.config_cat_integration_type module¶

class ConfigCatIntegrationType(arg: None)¶

class ConfigCatIntegrationType(arg: ModelComposed)

class ConfigCatIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the ConfigCatIntegrationType object.

Parameters:

value (str) – If omitted defaults to “ConfigCat”. Must be one of [“ConfigCat”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.config_cat_integration_update module¶

class ConfigCatIntegrationUpdate(arg: None)¶

class ConfigCatIntegrationUpdate(arg: ModelComposed)

class ConfigCatIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the ConfigCatIntegrationUpdate object.

Parameters:

credentials (ConfigCatCredentialsUpdate, optional) – The definition of the ConfigCatCredentialsUpdate object.
type (ConfigCatIntegrationType) – The definition of the ConfigCatIntegrationType object.

datadog_api_client.v2.model.config_cat_sdk_key module¶

class ConfigCatSDKKey(arg: None)¶

class ConfigCatSDKKey(arg: ModelComposed)

class ConfigCatSDKKey(*args, **kwargs)

Bases: ModelNormal

The definition of the ConfigCatSDKKey object.

Parameters:

api_password (str) – The ConfigCatSDKKey api_password.
api_username (str) – The ConfigCatSDKKey api_username.
sdk_key (str) – The ConfigCatSDKKey sdk_key.
type (ConfigCatSDKKeyType) – The definition of the ConfigCatSDKKey object.

datadog_api_client.v2.model.config_cat_sdk_key_type module¶

class ConfigCatSDKKeyType(arg: None)¶

class ConfigCatSDKKeyType(arg: ModelComposed)

class ConfigCatSDKKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the ConfigCatSDKKey object.

Parameters:

value (str) – If omitted defaults to “ConfigCatSDKKey”. Must be one of [“ConfigCatSDKKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.config_cat_sdk_key_update module¶

class ConfigCatSDKKeyUpdate(arg: None)¶

class ConfigCatSDKKeyUpdate(arg: ModelComposed)

class ConfigCatSDKKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the ConfigCatSDKKey object.

Parameters:

api_password (str, optional) – The ConfigCatSDKKeyUpdate api_password.
api_username (str, optional) – The ConfigCatSDKKeyUpdate api_username.
sdk_key (str, optional) – The ConfigCatSDKKeyUpdate sdk_key.
type (ConfigCatSDKKeyType) – The definition of the ConfigCatSDKKey object.

datadog_api_client.v2.model.confluent_account_create_request module¶

class ConfluentAccountCreateRequest(arg: None)¶

class ConfluentAccountCreateRequest(arg: ModelComposed)

class ConfluentAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when adding a Confluent account.

Parameters:: data (ConfluentAccountCreateRequestData) – The data body for adding a Confluent account.

datadog_api_client.v2.model.confluent_account_create_request_attributes module¶

class ConfluentAccountCreateRequestAttributes(arg: None)¶

class ConfluentAccountCreateRequestAttributes(arg: ModelComposed)

class ConfluentAccountCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes associated with the account creation request.

Parameters:

api_key (str) – The API key associated with your Confluent account.
api_secret (str) – The API secret associated with your Confluent account.
resources ([ConfluentAccountResourceAttributes], optional) – A list of Confluent resources associated with the Confluent account.
tags ([str], optional) – A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

datadog_api_client.v2.model.confluent_account_create_request_data module¶

class ConfluentAccountCreateRequestData(arg: None)¶

class ConfluentAccountCreateRequestData(arg: ModelComposed)

class ConfluentAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

The data body for adding a Confluent account.

Parameters:

attributes (ConfluentAccountCreateRequestAttributes) – Attributes associated with the account creation request.
type (ConfluentAccountType) – The JSON:API type for this API. Should always be confluent-cloud-accounts.

datadog_api_client.v2.model.confluent_account_resource_attributes module¶

class ConfluentAccountResourceAttributes(arg: None)¶

class ConfluentAccountResourceAttributes(arg: ModelComposed)

class ConfluentAccountResourceAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for updating a Confluent resource.

Parameters:

enable_custom_metrics (bool, optional) – Enable the custom.consumer_lag_offset metric, which contains extra metric tags.
id (str, optional) – The ID associated with a Confluent resource.
resource_type (str) – The resource type of the Resource. Can be kafka , connector , ksql , or schema_registry.
tags ([str], optional) – A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

datadog_api_client.v2.model.confluent_account_response module¶

class ConfluentAccountResponse(arg: None)¶

class ConfluentAccountResponse(arg: ModelComposed)

class ConfluentAccountResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting a Confluent account.

Parameters:: data (ConfluentAccountResponseData, optional) – An API key and API secret pair that represents a Confluent account.

datadog_api_client.v2.model.confluent_account_response_attributes module¶

class ConfluentAccountResponseAttributes(arg: None)¶

class ConfluentAccountResponseAttributes(arg: ModelComposed)

class ConfluentAccountResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of a Confluent account.

Parameters:

api_key (str) – The API key associated with your Confluent account.
resources ([ConfluentResourceResponseAttributes], optional) – A list of Confluent resources associated with the Confluent account.
tags ([str], optional) – A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

datadog_api_client.v2.model.confluent_account_response_data module¶

class ConfluentAccountResponseData(arg: None)¶

class ConfluentAccountResponseData(arg: ModelComposed)

class ConfluentAccountResponseData(*args, **kwargs)

Bases: ModelNormal

An API key and API secret pair that represents a Confluent account.

Parameters:

attributes (ConfluentAccountResponseAttributes) – The attributes of a Confluent account.
id (str) – A randomly generated ID associated with a Confluent account.
type (ConfluentAccountType) – The JSON:API type for this API. Should always be confluent-cloud-accounts.

datadog_api_client.v2.model.confluent_account_type module¶

class ConfluentAccountType(arg: None)¶

class ConfluentAccountType(arg: ModelComposed)

class ConfluentAccountType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for this API. Should always be confluent-cloud-accounts.

Parameters:

value (str) – If omitted defaults to “confluent-cloud-accounts”. Must be one of [“confluent-cloud-accounts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.confluent_account_update_request module¶

class ConfluentAccountUpdateRequest(arg: None)¶

class ConfluentAccountUpdateRequest(arg: ModelComposed)

class ConfluentAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The JSON:API request for updating a Confluent account.

Parameters:: data (ConfluentAccountUpdateRequestData) – Data object for updating a Confluent account.

datadog_api_client.v2.model.confluent_account_update_request_attributes module¶

class ConfluentAccountUpdateRequestAttributes(arg: None)¶

class ConfluentAccountUpdateRequestAttributes(arg: ModelComposed)

class ConfluentAccountUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for updating a Confluent account.

Parameters:

api_key (str) – The API key associated with your Confluent account.
api_secret (str) – The API secret associated with your Confluent account.
tags ([str], optional) – A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

datadog_api_client.v2.model.confluent_account_update_request_data module¶

class ConfluentAccountUpdateRequestData(arg: None)¶

class ConfluentAccountUpdateRequestData(arg: ModelComposed)

class ConfluentAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Confluent account.

Parameters:

attributes (ConfluentAccountUpdateRequestAttributes) – Attributes object for updating a Confluent account.
type (ConfluentAccountType) – The JSON:API type for this API. Should always be confluent-cloud-accounts.

datadog_api_client.v2.model.confluent_accounts_response module¶

class ConfluentAccountsResponse(arg: None)¶

class ConfluentAccountsResponse(arg: ModelComposed)

class ConfluentAccountsResponse(*args, **kwargs)

Bases: ModelNormal

Confluent account returned by the API.

Parameters:: data ([ConfluentAccountResponseData], optional) – The Confluent account.

datadog_api_client.v2.model.confluent_resource_request module¶

class ConfluentResourceRequest(arg: None)¶

class ConfluentResourceRequest(arg: ModelComposed)

class ConfluentResourceRequest(*args, **kwargs)

Bases: ModelNormal

The JSON:API request for updating a Confluent resource.

Parameters:: data (ConfluentResourceRequestData) – JSON:API request for updating a Confluent resource.

datadog_api_client.v2.model.confluent_resource_request_attributes module¶

class ConfluentResourceRequestAttributes(arg: None)¶

class ConfluentResourceRequestAttributes(arg: ModelComposed)

class ConfluentResourceRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for updating a Confluent resource.

Parameters:

enable_custom_metrics (bool, optional) – Enable the custom.consumer_lag_offset metric, which contains extra metric tags.
resource_type (str) – The resource type of the Resource. Can be kafka , connector , ksql , or schema_registry.
tags ([str], optional) – A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

datadog_api_client.v2.model.confluent_resource_request_data module¶

class ConfluentResourceRequestData(arg: None)¶

class ConfluentResourceRequestData(arg: ModelComposed)

class ConfluentResourceRequestData(*args, **kwargs)

Bases: ModelNormal

JSON:API request for updating a Confluent resource.

Parameters:

attributes (ConfluentResourceRequestAttributes) – Attributes object for updating a Confluent resource.
id (str) – The ID associated with a Confluent resource.
type (ConfluentResourceType) – The JSON:API type for this request.

datadog_api_client.v2.model.confluent_resource_response module¶

class ConfluentResourceResponse(arg: None)¶

class ConfluentResourceResponse(arg: ModelComposed)

class ConfluentResourceResponse(*args, **kwargs)

Bases: ModelNormal

Response schema when interacting with a Confluent resource.

Parameters:: data (ConfluentResourceResponseData, optional) – Confluent Cloud resource data.

datadog_api_client.v2.model.confluent_resource_response_attributes module¶

class ConfluentResourceResponseAttributes(arg: None)¶

class ConfluentResourceResponseAttributes(arg: ModelComposed)

class ConfluentResourceResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Model representation of a Confluent Cloud resource.

Parameters:

enable_custom_metrics (bool, optional) – Enable the custom.consumer_lag_offset metric, which contains extra metric tags.
id (str, optional) – The ID associated with the Confluent resource.
resource_type (str) – The resource type of the Resource. Can be kafka , connector , ksql , or schema_registry.
tags ([str], optional) – A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

datadog_api_client.v2.model.confluent_resource_response_data module¶

class ConfluentResourceResponseData(arg: None)¶

class ConfluentResourceResponseData(arg: ModelComposed)

class ConfluentResourceResponseData(*args, **kwargs)

Bases: ModelNormal

Confluent Cloud resource data.

Parameters:

attributes (ConfluentResourceResponseAttributes) – Model representation of a Confluent Cloud resource.
id (str) – The ID associated with the Confluent resource.
type (ConfluentResourceType) – The JSON:API type for this request.

datadog_api_client.v2.model.confluent_resource_type module¶

class ConfluentResourceType(arg: None)¶

class ConfluentResourceType(arg: ModelComposed)

class ConfluentResourceType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for this request.

Parameters:

value (str) – If omitted defaults to “confluent-cloud-resources”. Must be one of [“confluent-cloud-resources”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.confluent_resources_response module¶

class ConfluentResourcesResponse(arg: None)¶

class ConfluentResourcesResponse(arg: ModelComposed)

class ConfluentResourcesResponse(*args, **kwargs)

Bases: ModelNormal

Response schema when interacting with a list of Confluent resources.

Parameters:: data ([ConfluentResourceResponseData], optional) – The JSON:API data attribute.

datadog_api_client.v2.model.connected_team_ref module¶

class ConnectedTeamRef(arg: None)¶

class ConnectedTeamRef(arg: ModelComposed)

class ConnectedTeamRef(*args, **kwargs)

Bases: ModelNormal

Reference to a team from an external system.

Parameters:: data (ConnectedTeamRefData, optional) – Reference to connected external team.

datadog_api_client.v2.model.connected_team_ref_data module¶

class ConnectedTeamRefData(arg: None)¶

class ConnectedTeamRefData(arg: ModelComposed)

class ConnectedTeamRefData(*args, **kwargs)

Bases: ModelNormal

Reference to connected external team.

Parameters:

id (str) – The connected team ID as it is referenced throughout the Datadog ecosystem.
type (ConnectedTeamRefDataType) – External team resource type.

datadog_api_client.v2.model.connected_team_ref_data_type module¶

class ConnectedTeamRefDataType(arg: None)¶

class ConnectedTeamRefDataType(arg: ModelComposed)

class ConnectedTeamRefDataType(*args, **kwargs)

Bases: ModelSimple

External team resource type.

Parameters:

value (str) – If omitted defaults to “github_team”. Must be one of [“github_team”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.connection module¶

class Connection(arg: None)¶

class Connection(arg: ModelComposed)

class Connection(*args, **kwargs)

Bases: ModelNormal

The definition of Connection object.

Parameters:

connection_id (str) – The Connection connectionId.
label (str) – The Connection label.

datadog_api_client.v2.model.connection_env module¶

class ConnectionEnv(arg: None)¶

class ConnectionEnv(arg: ModelComposed)

class ConnectionEnv(*args, **kwargs)

Bases: ModelNormal

A list of connections or connection groups used in the workflow.

Parameters:

connection_groups ([ConnectionGroup], optional) – The ConnectionEnv connectionGroups.
connections ([Connection], optional) – The ConnectionEnv connections.
env (ConnectionEnvEnv) – The definition of ConnectionEnvEnv object.

datadog_api_client.v2.model.connection_env_env module¶

class ConnectionEnvEnv(arg: None)¶

class ConnectionEnvEnv(arg: ModelComposed)

class ConnectionEnvEnv(*args, **kwargs)

Bases: ModelSimple

The definition of ConnectionEnvEnv object.

Parameters:

value (str) – If omitted defaults to “default”. Must be one of [“default”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.connection_group module¶

class ConnectionGroup(arg: None)¶

class ConnectionGroup(arg: ModelComposed)

class ConnectionGroup(*args, **kwargs)

Bases: ModelNormal

The definition of ConnectionGroup object.

Parameters:

connection_group_id (str) – The ConnectionGroup connectionGroupId.
label (str) – The ConnectionGroup label.
tags ([str]) – The ConnectionGroup tags.

datadog_api_client.v2.model.connections_page_pagination module¶

class ConnectionsPagePagination(arg: None)¶

class ConnectionsPagePagination(arg: ModelComposed)

class ConnectionsPagePagination(*args, **kwargs)

Bases: ModelNormal

Page-based pagination metadata.

Parameters:

first_number (int, optional) – The first page number.
last_number (int, optional) – The last page number.
next_number (int, none_type, optional) – The next page number.
number (int, optional) – The current page number.
prev_number (int, none_type, optional) – The previous page number.
size (int, optional) – The page size.
total (int, optional) – Total connections matching request.
type (str, optional) – Pagination type.

datadog_api_client.v2.model.connections_response_meta module¶

class ConnectionsResponseMeta(arg: None)¶

class ConnectionsResponseMeta(arg: ModelComposed)

class ConnectionsResponseMeta(*args, **kwargs)

Bases: ModelNormal

Connections response metadata.

Parameters:: page (ConnectionsPagePagination, optional) – Page-based pagination metadata.

datadog_api_client.v2.model.container module¶

class Container(arg: None)¶

class Container(arg: ModelComposed)

class Container(*args, **kwargs)

Bases: ModelNormal

Container object.

Parameters:

attributes (ContainerAttributes, optional) – Attributes for a container.
id (str, optional) – Container ID.
type (ContainerType, optional) – Type of container.

datadog_api_client.v2.model.container_attributes module¶

class ContainerAttributes(arg: None)¶

class ContainerAttributes(arg: ModelComposed)

class ContainerAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a container.

Parameters:

container_id (str, optional) – The ID of the container.
created_at (str, optional) – Time the container was created.
host (str, optional) – Hostname of the host running the container.
image_digest (str, none_type, optional) – Digest of the compressed image manifest.
image_name (str, optional) – Name of the associated container image.
image_tags ([str], none_type, optional) – List of image tags associated with the container image.
name (str, optional) – Name of the container.
started_at (str, optional) – Time the container was started.
state (str, optional) – State of the container. This depends on the container runtime.
tags ([str], optional) – List of tags associated with the container.

datadog_api_client.v2.model.container_group module¶

class ContainerGroup(arg: None)¶

class ContainerGroup(arg: ModelComposed)

class ContainerGroup(*args, **kwargs)

Bases: ModelNormal

Container group object.

Parameters:

attributes (ContainerGroupAttributes, optional) – Attributes for a container group.
id (str, optional) – Container Group ID.
relationships (ContainerGroupRelationships, optional) – Relationships to containers inside a container group.
type (ContainerGroupType, optional) – Type of container group.

datadog_api_client.v2.model.container_group_attributes module¶

class ContainerGroupAttributes(arg: None)¶

class ContainerGroupAttributes(arg: ModelComposed)

class ContainerGroupAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a container group.

Parameters:

count (int, optional) – Number of containers in the group.
tags (dict, optional) – Tags from the group name parsed in key/value format.

datadog_api_client.v2.model.container_group_relationships module¶

class ContainerGroupRelationships(arg: None)¶

class ContainerGroupRelationships(arg: ModelComposed)

class ContainerGroupRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships to containers inside a container group.

Parameters:: containers (ContainerGroupRelationshipsLink, optional) – Relationships to Containers inside a Container Group.

datadog_api_client.v2.model.container_group_relationships_link module¶

class ContainerGroupRelationshipsLink(arg: None)¶

class ContainerGroupRelationshipsLink(arg: ModelComposed)

class ContainerGroupRelationshipsLink(*args, **kwargs)

Bases: ModelNormal

Relationships to Containers inside a Container Group.

Parameters:

data ([str], optional) – Links data.
links (ContainerGroupRelationshipsLinks, optional) – Links attributes.

datadog_api_client.v2.model.container_group_relationships_links module¶

class ContainerGroupRelationshipsLinks(arg: None)¶

class ContainerGroupRelationshipsLinks(arg: ModelComposed)

class ContainerGroupRelationshipsLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: related (str, optional) – Link to related containers.

datadog_api_client.v2.model.container_group_type module¶

class ContainerGroupType(arg: None)¶

class ContainerGroupType(arg: ModelComposed)

class ContainerGroupType(*args, **kwargs)

Bases: ModelSimple

Type of container group.

Parameters:

value (str) – If omitted defaults to “container_group”. Must be one of [“container_group”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.container_image module¶

class ContainerImage(arg: None)¶

class ContainerImage(arg: ModelComposed)

class ContainerImage(*args, **kwargs)

Bases: ModelNormal

Container Image object.

Parameters:

attributes (ContainerImageAttributes, optional) – Attributes for a Container Image.
id (str, optional) – Container Image ID.
type (ContainerImageType, optional) – Type of Container Image.

datadog_api_client.v2.model.container_image_attributes module¶

class ContainerImageAttributes(arg: None)¶

class ContainerImageAttributes(arg: ModelComposed)

class ContainerImageAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a Container Image.

Parameters:

container_count (int, optional) – Number of containers running the image.
image_flavors ([ContainerImageFlavor], optional) – List of platform-specific images associated with the image record. The list contains more than 1 entry for multi-architecture images.
image_tags ([str], optional) – List of image tags associated with the Container Image.
images_built_at ([str], optional) – List of build times associated with the Container Image. The list contains more than 1 entry for multi-architecture images.
name (str, optional) – Name of the Container Image.
os_architectures ([str], optional) – List of Operating System architectures supported by the Container Image.
os_names ([str], optional) – List of Operating System names supported by the Container Image.
os_versions ([str], optional) – List of Operating System versions supported by the Container Image.
published_at (str, optional) – Time the image was pushed to the container registry.
registry (str, optional) – Registry the Container Image was pushed to.
repo_digest (str, optional) – Digest of the compressed image manifest.
repository (str, optional) – Repository where the Container Image is stored in.
short_image (str, optional) – Short version of the Container Image name.
sizes ([int], optional) – List of size for each platform-specific image associated with the image record. The list contains more than 1 entry for multi-architecture images.
sources ([str], optional) – List of sources where the Container Image was collected from.
tags ([str], optional) – List of tags associated with the Container Image.
vulnerability_count (ContainerImageVulnerabilities, optional) – Vulnerability counts associated with the Container Image.

datadog_api_client.v2.model.container_image_flavor module¶

class ContainerImageFlavor(arg: None)¶

class ContainerImageFlavor(arg: ModelComposed)

class ContainerImageFlavor(*args, **kwargs)

Bases: ModelNormal

Container Image breakdown by supported platform.

Parameters:

built_at (str, optional) – Time the platform-specific Container Image was built.
os_architecture (str, optional) – Operating System architecture supported by the Container Image.
os_name (str, optional) – Operating System name supported by the Container Image.
os_version (str, optional) – Operating System version supported by the Container Image.
size (int, optional) – Size of the platform-specific Container Image.

datadog_api_client.v2.model.container_image_group module¶

class ContainerImageGroup(arg: None)¶

class ContainerImageGroup(arg: ModelComposed)

class ContainerImageGroup(*args, **kwargs)

Bases: ModelNormal

Container Image Group object.

Parameters:

attributes (ContainerImageGroupAttributes, optional) – Attributes for a Container Image Group.
id (str, optional) – Container Image Group ID.
relationships (ContainerImageGroupRelationships, optional) – Relationships inside a Container Image Group.
type (ContainerImageGroupType, optional) – Type of Container Image Group.

datadog_api_client.v2.model.container_image_group_attributes module¶

class ContainerImageGroupAttributes(arg: None)¶

class ContainerImageGroupAttributes(arg: ModelComposed)

class ContainerImageGroupAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a Container Image Group.

Parameters:

count (int, optional) – Number of Container Images in the group.
name (str, optional) – Name of the Container Image group.
tags (dict, optional) – Tags from the group name parsed in key/value format.

datadog_api_client.v2.model.container_image_group_images_relationships_link module¶

class ContainerImageGroupImagesRelationshipsLink(arg: None)¶

class ContainerImageGroupImagesRelationshipsLink(arg: ModelComposed)

class ContainerImageGroupImagesRelationshipsLink(*args, **kwargs)

Bases: ModelNormal

Relationships to Container Images inside a Container Image Group.

Parameters:

data ([str], optional) – Links data.
links (ContainerImageGroupRelationshipsLinks, optional) – Links attributes.

datadog_api_client.v2.model.container_image_group_relationships module¶

class ContainerImageGroupRelationships(arg: None)¶

class ContainerImageGroupRelationships(arg: ModelComposed)

class ContainerImageGroupRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships inside a Container Image Group.

Parameters:: container_images (ContainerImageGroupImagesRelationshipsLink, optional) – Relationships to Container Images inside a Container Image Group.

datadog_api_client.v2.model.container_image_group_relationships_links module¶

class ContainerImageGroupRelationshipsLinks(arg: None)¶

class ContainerImageGroupRelationshipsLinks(arg: ModelComposed)

class ContainerImageGroupRelationshipsLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: related (str, optional) – Link to related Container Images.

datadog_api_client.v2.model.container_image_group_type module¶

class ContainerImageGroupType(arg: None)¶

class ContainerImageGroupType(arg: ModelComposed)

class ContainerImageGroupType(*args, **kwargs)

Bases: ModelSimple

Type of Container Image Group.

Parameters:

value (str) – If omitted defaults to “container_image_group”. Must be one of [“container_image_group”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.container_image_item module¶

class ContainerImageItem(arg: None)¶

class ContainerImageItem(arg: ModelComposed)

class ContainerImageItem(*args, **kwargs)

Bases: ModelComposed

Possible Container Image models.

Parameters:

attributes (ContainerImageAttributes, optional) – Attributes for a Container Image.
id (str, optional) – Container Image ID.
type (ContainerImageType, optional) – Type of Container Image.
relationships (ContainerImageGroupRelationships, optional) – Relationships inside a Container Image Group.

datadog_api_client.v2.model.container_image_meta module¶

class ContainerImageMeta(arg: None)¶

class ContainerImageMeta(arg: ModelComposed)

class ContainerImageMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:: pagination (ContainerImageMetaPage, optional) – Paging attributes.

datadog_api_client.v2.model.container_image_meta_page module¶

class ContainerImageMetaPage(arg: None)¶

class ContainerImageMetaPage(arg: ModelComposed)

class ContainerImageMetaPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:

cursor (str, optional) – The cursor used to get the current results, if any.
limit (int, optional) – Number of results returned
next_cursor (str, optional) – The cursor used to get the next results, if any.
prev_cursor (str, none_type, optional) – The cursor used to get the previous results, if any.
total (int, optional) – Total number of records that match the query.
type (ContainerImageMetaPageType, optional) – Type of Container Image pagination.

datadog_api_client.v2.model.container_image_meta_page_type module¶

class ContainerImageMetaPageType(arg: None)¶

class ContainerImageMetaPageType(arg: ModelComposed)

class ContainerImageMetaPageType(*args, **kwargs)

Bases: ModelSimple

Type of Container Image pagination.

Parameters:

value (str) – If omitted defaults to “cursor_limit”. Must be one of [“cursor_limit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.container_image_type module¶

class ContainerImageType(arg: None)¶

class ContainerImageType(arg: ModelComposed)

class ContainerImageType(*args, **kwargs)

Bases: ModelSimple

Type of Container Image.

Parameters:

value (str) – If omitted defaults to “container_image”. Must be one of [“container_image”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.container_image_vulnerabilities module¶

class ContainerImageVulnerabilities(arg: None)¶

class ContainerImageVulnerabilities(arg: ModelComposed)

class ContainerImageVulnerabilities(*args, **kwargs)

Bases: ModelNormal

Vulnerability counts associated with the Container Image.

Parameters:

asset_id (str, optional) – ID of the Container Image.
critical (int, optional) – Number of vulnerabilities with CVSS Critical severity.
high (int, optional) – Number of vulnerabilities with CVSS High severity.
low (int, optional) – Number of vulnerabilities with CVSS Low severity.
medium (int, optional) – Number of vulnerabilities with CVSS Medium severity.
none (int, optional) – Number of vulnerabilities with CVSS None severity.
unknown (int, optional) – Number of vulnerabilities with an unknown CVSS severity.

datadog_api_client.v2.model.container_images_response module¶

class ContainerImagesResponse(arg: None)¶

class ContainerImagesResponse(arg: ModelComposed)

class ContainerImagesResponse(*args, **kwargs)

Bases: ModelNormal

List of Container Images.

Parameters:

data ([ContainerImageItem], optional) – Array of Container Image objects.
links (ContainerImagesResponseLinks, optional) – Pagination links.
meta (ContainerImageMeta, optional) – Response metadata object.

datadog_api_client.v2.model.container_images_response_links module¶

class ContainerImagesResponseLinks(arg: None)¶

class ContainerImagesResponseLinks(arg: ModelComposed)

class ContainerImagesResponseLinks(*args, **kwargs)

Bases: ModelNormal

Pagination links.

Parameters:

first (str, optional) – Link to the first page.
last (str, none_type, optional) – Link to the last page.
next (str, none_type, optional) – Link to the next page.
prev (str, none_type, optional) – Link to previous page.
self (str, optional) – Link to current page.

datadog_api_client.v2.model.container_item module¶

class ContainerItem(arg: None)¶

class ContainerItem(arg: ModelComposed)

class ContainerItem(*args, **kwargs)

Bases: ModelComposed

Possible Container models.

Parameters:

attributes (ContainerAttributes, optional) – Attributes for a container.
id (str, optional) – Container ID.
type (ContainerType, optional) – Type of container.
relationships (ContainerGroupRelationships, optional) – Relationships to containers inside a container group.

datadog_api_client.v2.model.container_meta module¶

class ContainerMeta(arg: None)¶

class ContainerMeta(arg: ModelComposed)

class ContainerMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:: pagination (ContainerMetaPage, optional) – Paging attributes.

datadog_api_client.v2.model.container_meta_page module¶

class ContainerMetaPage(arg: None)¶

class ContainerMetaPage(arg: ModelComposed)

class ContainerMetaPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:

cursor (str, optional) – The cursor used to get the current results, if any.
limit (int, optional) – Number of results returned
next_cursor (str, optional) – The cursor used to get the next results, if any.
prev_cursor (str, none_type, optional) – The cursor used to get the previous results, if any.
total (int, optional) – Total number of records that match the query.
type (ContainerMetaPageType, optional) – Type of Container pagination.

datadog_api_client.v2.model.container_meta_page_type module¶

class ContainerMetaPageType(arg: None)¶

class ContainerMetaPageType(arg: ModelComposed)

class ContainerMetaPageType(*args, **kwargs)

Bases: ModelSimple

Type of Container pagination.

Parameters:

value (str) – If omitted defaults to “cursor_limit”. Must be one of [“cursor_limit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.container_type module¶

class ContainerType(arg: None)¶

class ContainerType(arg: ModelComposed)

class ContainerType(*args, **kwargs)

Bases: ModelSimple

Type of container.

Parameters:

value (str) – If omitted defaults to “container”. Must be one of [“container”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.containers_response module¶

class ContainersResponse(arg: None)¶

class ContainersResponse(arg: ModelComposed)

class ContainersResponse(*args, **kwargs)

Bases: ModelNormal

List of containers.

Parameters:

data ([ContainerItem], optional) – Array of Container objects.
links (ContainersResponseLinks, optional) – Pagination links.
meta (ContainerMeta, optional) – Response metadata object.

datadog_api_client.v2.model.containers_response_links module¶

class ContainersResponseLinks(arg: None)¶

class ContainersResponseLinks(arg: ModelComposed)

class ContainersResponseLinks(*args, **kwargs)

Bases: ModelNormal

Pagination links.

Parameters:

first (str, optional) – Link to the first page.
last (str, none_type, optional) – Link to the last page.
next (str, none_type, optional) – Link to the next page.
prev (str, none_type, optional) – Link to previous page.
self (str, optional) – Link to current page.

datadog_api_client.v2.model.content_encoding module¶

class ContentEncoding(arg: None)¶

class ContentEncoding(arg: ModelComposed)

class ContentEncoding(*args, **kwargs)

Bases: ModelSimple

HTTP header used to compress the media-type.

Parameters:

value (str) – Must be one of [“identity”, “gzip”, “deflate”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.convert_job_results_to_signals_attributes module¶

class ConvertJobResultsToSignalsAttributes(arg: None)¶

class ConvertJobResultsToSignalsAttributes(arg: ModelComposed)

class ConvertJobResultsToSignalsAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for converting threat hunting job results to signals.

Parameters:

id (str, optional) – Request ID.
job_result_ids ([str]) – Job result IDs.
notifications ([str]) – Notifications sent.
signal_message (str) – Message of generated signals.
signal_severity (SecurityMonitoringRuleSeverity) – Severity of the Security Signal.

datadog_api_client.v2.model.convert_job_results_to_signals_data module¶

class ConvertJobResultsToSignalsData(arg: None)¶

class ConvertJobResultsToSignalsData(arg: ModelComposed)

class ConvertJobResultsToSignalsData(*args, **kwargs)

Bases: ModelNormal

Data for converting threat hunting job results to signals.

Parameters:

attributes (ConvertJobResultsToSignalsAttributes, optional) – Attributes for converting threat hunting job results to signals.
type (ConvertJobResultsToSignalsDataType, optional) – Type of payload.

datadog_api_client.v2.model.convert_job_results_to_signals_data_type module¶

class ConvertJobResultsToSignalsDataType(arg: None)¶

class ConvertJobResultsToSignalsDataType(arg: ModelComposed)

class ConvertJobResultsToSignalsDataType(*args, **kwargs)

Bases: ModelSimple

Type of payload.

Parameters:

value (str) – If omitted defaults to “historicalDetectionsJobResultSignalConversion”. Must be one of [“historicalDetectionsJobResultSignalConversion”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.convert_job_results_to_signals_request module¶

class ConvertJobResultsToSignalsRequest(arg: None)¶

class ConvertJobResultsToSignalsRequest(arg: ModelComposed)

class ConvertJobResultsToSignalsRequest(*args, **kwargs)

Bases: ModelNormal

Request for converting threat hunting job results to signals.

Parameters:: data (ConvertJobResultsToSignalsData, optional) – Data for converting threat hunting job results to signals.

datadog_api_client.v2.model.cost_attribution_aggregates_body module¶

class CostAttributionAggregatesBody(arg: None)¶

class CostAttributionAggregatesBody(arg: ModelComposed)

class CostAttributionAggregatesBody(*args, **kwargs)

Bases: ModelNormal

The object containing the aggregates.

Parameters:

agg_type (str, optional) – The aggregate type.
field (str, optional) – The field.
value (float, optional) – The value for a given field.

datadog_api_client.v2.model.cost_attribution_tag_names module¶

class CostAttributionTagNames(arg: None)¶

class CostAttributionTagNames(arg: ModelComposed)

class CostAttributionTagNames(*args, **kwargs)

Bases: ModelNormal

Tag keys and values. A null value here means that the requested tag breakdown cannot be applied because it does not match the tags configured for usage attribution. In this scenario the API returns the total cost, not broken down by tags.

datadog_api_client.v2.model.cost_attribution_type module¶

class CostAttributionType(arg: None)¶

class CostAttributionType(arg: ModelComposed)

class CostAttributionType(*args, **kwargs)

Bases: ModelSimple

Type of cost attribution data.

Parameters:

value (str) – If omitted defaults to “cost_by_tag”. Must be one of [“cost_by_tag”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cost_by_org module¶

class CostByOrg(arg: None)¶

class CostByOrg(arg: ModelComposed)

class CostByOrg(*args, **kwargs)

Bases: ModelNormal

Cost data.

Parameters:

attributes (CostByOrgAttributes, optional) – Cost attributes data.
id (str, optional) – Unique ID of the response.
type (CostByOrgType, optional) – Type of cost data.

datadog_api_client.v2.model.cost_by_org_attributes module¶

class CostByOrgAttributes(arg: None)¶

class CostByOrgAttributes(arg: ModelComposed)

class CostByOrgAttributes(*args, **kwargs)

Bases: ModelNormal

Cost attributes data.

Parameters:

account_name (str, optional) – The account name.
account_public_id (str, optional) – The account public ID.
charges ([ChargebackBreakdown], optional) – List of charges data reported for the requested month.
date (datetime, optional) – The month requested.
org_name (str, optional) – The organization name.
public_id (str, optional) – The organization public ID.
region (str, optional) – The region of the Datadog instance that the organization belongs to.
total_cost (float, optional) – The total cost of products for the month.

datadog_api_client.v2.model.cost_by_org_response module¶

class CostByOrgResponse(arg: None)¶

class CostByOrgResponse(arg: ModelComposed)

class CostByOrgResponse(*args, **kwargs)

Bases: ModelNormal

Chargeback Summary response.

Parameters:: data ([CostByOrg], optional) – Response containing Chargeback Summary.

datadog_api_client.v2.model.cost_by_org_type module¶

class CostByOrgType(arg: None)¶

class CostByOrgType(arg: ModelComposed)

class CostByOrgType(*args, **kwargs)

Bases: ModelSimple

Type of cost data.

Parameters:

value (str) – If omitted defaults to “cost_by_org”. Must be one of [“cost_by_org”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.cpu module¶

class Cpu(arg: None)¶

class Cpu(arg: ModelComposed)

class Cpu(*args, **kwargs)

Bases: ModelNormal

CPU usage statistics derived from historical Spark job metrics. Provides multiple estimates so users can choose between conservative and cost-saving risk profiles.

Parameters:

max (int, optional) – Maximum CPU usage observed for the job, expressed in millicores. This represents the upper bound of usage.
p75 (int, optional) – 75th percentile of CPU usage (millicores). Represents a cost-saving configuration while covering most workloads.
p95 (int, optional) – 95th percentile of CPU usage (millicores). Balances performance and cost, providing a safer margin than p75.

datadog_api_client.v2.model.create_action_connection_request module¶

class CreateActionConnectionRequest(arg: None)¶

class CreateActionConnectionRequest(arg: ModelComposed)

class CreateActionConnectionRequest(*args, **kwargs)

Bases: ModelNormal

Request used to create an action connection.

Parameters:: data (ActionConnectionData) – Data related to the connection.

datadog_api_client.v2.model.create_action_connection_response module¶

class CreateActionConnectionResponse(arg: None)¶

class CreateActionConnectionResponse(arg: ModelComposed)

class CreateActionConnectionResponse(*args, **kwargs)

Bases: ModelNormal

The response for a created connection

Parameters:: data (ActionConnectionData, optional) – Data related to the connection.

datadog_api_client.v2.model.create_app_request module¶

class CreateAppRequest(arg: None)¶

class CreateAppRequest(arg: ModelComposed)

class CreateAppRequest(*args, **kwargs)

Bases: ModelNormal

A request object for creating a new app.

Parameters:: data (CreateAppRequestData, optional) – The data object containing the app definition.

datadog_api_client.v2.model.create_app_request_data module¶

class CreateAppRequestData(arg: None)¶

class CreateAppRequestData(arg: ModelComposed)

class CreateAppRequestData(*args, **kwargs)

Bases: ModelNormal

The data object containing the app definition.

Parameters:

attributes (CreateAppRequestDataAttributes, optional) – App definition attributes such as name, description, and components.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.create_app_request_data_attributes module¶

class CreateAppRequestDataAttributes(arg: None)¶

class CreateAppRequestDataAttributes(arg: ModelComposed)

class CreateAppRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

App definition attributes such as name, description, and components.

Parameters:

components ([ComponentGrid], optional) – The UI components that make up the app.
description (str, optional) – A human-readable description for the app.
name (str, optional) – The name of the app.
queries ([Query], optional) – An array of queries, such as external actions and state variables, that the app uses.
root_instance_name (str, optional) – The name of the root component of the app. This must be a grid component that contains all other components.
tags ([str], optional) – A list of tags for the app, which can be used to filter apps.

datadog_api_client.v2.model.create_app_response module¶

class CreateAppResponse(arg: None)¶

class CreateAppResponse(arg: ModelComposed)

class CreateAppResponse(*args, **kwargs)

Bases: ModelNormal

The response object after a new app is successfully created, with the app ID.

Parameters:: data (CreateAppResponseData, optional) – The data object containing the app ID.

datadog_api_client.v2.model.create_app_response_data module¶

class CreateAppResponseData(arg: None)¶

class CreateAppResponseData(arg: ModelComposed)

class CreateAppResponseData(*args, **kwargs)

Bases: ModelNormal

The data object containing the app ID.

Parameters:

id (UUID) – The ID of the created app.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.create_apps_datastore_request module¶

class CreateAppsDatastoreRequest(arg: None)¶

class CreateAppsDatastoreRequest(arg: ModelComposed)

class CreateAppsDatastoreRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a new datastore with specified configuration and metadata.

Parameters:: data (CreateAppsDatastoreRequestData, optional) – Data wrapper containing the configuration needed to create a new datastore.

datadog_api_client.v2.model.create_apps_datastore_request_data module¶

class CreateAppsDatastoreRequestData(arg: None)¶

class CreateAppsDatastoreRequestData(arg: ModelComposed)

class CreateAppsDatastoreRequestData(*args, **kwargs)

Bases: ModelNormal

Data wrapper containing the configuration needed to create a new datastore.

Parameters:

attributes (CreateAppsDatastoreRequestDataAttributes, optional) – Configuration and metadata to create a new datastore.
id (str, optional) – Optional ID for the new datastore. If not provided, one will be generated automatically.
type (DatastoreDataType) – The resource type for datastores.

datadog_api_client.v2.model.create_apps_datastore_request_data_attributes module¶

class CreateAppsDatastoreRequestDataAttributes(arg: None)¶

class CreateAppsDatastoreRequestDataAttributes(arg: ModelComposed)

class CreateAppsDatastoreRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Configuration and metadata to create a new datastore.

Parameters:

description (str, optional) – A human-readable description about the datastore.
name (str) – The display name for the new datastore.
org_access (CreateAppsDatastoreRequestDataAttributesOrgAccess, optional) – The organization access level for the datastore. For example, ‘contributor’.
primary_column_name (str) –
The name of the primary key column for this datastore. Primary column names:
- Must abide by both PostgreSQL naming conventions
- Cannot exceed 63 characters
primary_key_generation_strategy (DatastorePrimaryKeyGenerationStrategy, optional) – Can be set to uuid to automatically generate primary keys when new items are added. Default value is none , which requires you to supply a primary key for each new item.

datadog_api_client.v2.model.create_apps_datastore_request_data_attributes_org_access module¶

class CreateAppsDatastoreRequestDataAttributesOrgAccess(arg: None)¶

class CreateAppsDatastoreRequestDataAttributesOrgAccess(arg: ModelComposed)

class CreateAppsDatastoreRequestDataAttributesOrgAccess(*args, **kwargs)

Bases: ModelSimple

The organization access level for the datastore. For example, ‘contributor’.

Parameters:

value (str) – Must be one of [“contributor”, “viewer”, “manager”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_apps_datastore_response module¶

class CreateAppsDatastoreResponse(arg: None)¶

class CreateAppsDatastoreResponse(arg: ModelComposed)

class CreateAppsDatastoreResponse(*args, **kwargs)

Bases: ModelNormal

Response after successfully creating a new datastore, containing the datastore’s assigned ID.

Parameters:: data (CreateAppsDatastoreResponseData, optional) – The newly created datastore’s data.

datadog_api_client.v2.model.create_apps_datastore_response_data module¶

class CreateAppsDatastoreResponseData(arg: None)¶

class CreateAppsDatastoreResponseData(arg: ModelComposed)

class CreateAppsDatastoreResponseData(*args, **kwargs)

Bases: ModelNormal

The newly created datastore’s data.

Parameters:

id (str, optional) – The unique identifier assigned to the newly created datastore.
type (DatastoreDataType) – The resource type for datastores.

datadog_api_client.v2.model.create_connection_request module¶

class CreateConnectionRequest(arg: None)¶

class CreateConnectionRequest(arg: ModelComposed)

class CreateConnectionRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (CreateConnectionRequestData, optional)

datadog_api_client.v2.model.create_connection_request_data module¶

class CreateConnectionRequestData(arg: None)¶

class CreateConnectionRequestData(arg: ModelComposed)

class CreateConnectionRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (CreateConnectionRequestDataAttributes, optional)
id (str, optional)
type (UpdateConnectionRequestDataType) – Connection id resource type.

datadog_api_client.v2.model.create_connection_request_data_attributes module¶

class CreateConnectionRequestDataAttributes(arg: None)¶

class CreateConnectionRequestDataAttributes(arg: ModelComposed)

class CreateConnectionRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

fields ([CreateConnectionRequestDataAttributesFieldsItems], optional)
join_attribute (str)
join_type (str)
metadata ({str: (str,)}, optional)
type (str)

datadog_api_client.v2.model.create_connection_request_data_attributes_fields_items module¶

class CreateConnectionRequestDataAttributesFieldsItems(arg: None)¶

class CreateConnectionRequestDataAttributesFieldsItems(arg: ModelComposed)

class CreateConnectionRequestDataAttributesFieldsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

description (str, optional)
display_name (str, optional)
groups ([str], optional)
id (str)
source_name (str)
type (str)

datadog_api_client.v2.model.create_custom_framework_request module¶

class CreateCustomFrameworkRequest(arg: None)¶

class CreateCustomFrameworkRequest(arg: ModelComposed)

class CreateCustomFrameworkRequest(*args, **kwargs)

Bases: ModelNormal

Request object to create a custom framework.

Parameters:: data (CustomFrameworkData) – Contains type and attributes for custom frameworks.

datadog_api_client.v2.model.create_custom_framework_response module¶

class CreateCustomFrameworkResponse(arg: None)¶

class CreateCustomFrameworkResponse(arg: ModelComposed)

class CreateCustomFrameworkResponse(*args, **kwargs)

Bases: ModelNormal

Response object to create a custom framework.

Parameters:: data (FrameworkHandleAndVersionResponseData) – Contains type and attributes for custom frameworks.

datadog_api_client.v2.model.create_data_deletion_request_body module¶

class CreateDataDeletionRequestBody(arg: None)¶

class CreateDataDeletionRequestBody(arg: ModelComposed)

class CreateDataDeletionRequestBody(*args, **kwargs)

Bases: ModelNormal

Object needed to create a data deletion request.

Parameters:: data (CreateDataDeletionRequestBodyData) – Data needed to create a data deletion request.

datadog_api_client.v2.model.create_data_deletion_request_body_attributes module¶

class CreateDataDeletionRequestBodyAttributes(arg: None)¶

class CreateDataDeletionRequestBodyAttributes(arg: ModelComposed)

class CreateDataDeletionRequestBodyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for creating a data deletion request.

Parameters:

_from (int) – Start of requested time window, milliseconds since Unix epoch.
indexes ([str], optional) – List of indexes for the search. If not provided, the search is performed in all indexes.
query ({str: (str,)}) – Query for creating a data deletion request.
to (int) – End of requested time window, milliseconds since Unix epoch.

datadog_api_client.v2.model.create_data_deletion_request_body_data module¶

class CreateDataDeletionRequestBodyData(arg: None)¶

class CreateDataDeletionRequestBodyData(arg: ModelComposed)

class CreateDataDeletionRequestBodyData(*args, **kwargs)

Bases: ModelNormal

Data needed to create a data deletion request.

Parameters:

attributes (CreateDataDeletionRequestBodyAttributes) – Attributes for creating a data deletion request.
type (CreateDataDeletionRequestBodyDataType) – The deletion request type.

datadog_api_client.v2.model.create_data_deletion_request_body_data_type module¶

class CreateDataDeletionRequestBodyDataType(arg: None)¶

class CreateDataDeletionRequestBodyDataType(arg: ModelComposed)

class CreateDataDeletionRequestBodyDataType(*args, **kwargs)

Bases: ModelSimple

The deletion request type.

Parameters:

value (str) – If omitted defaults to “create_deletion_req”. Must be one of [“create_deletion_req”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_data_deletion_response_body module¶

class CreateDataDeletionResponseBody(arg: None)¶

class CreateDataDeletionResponseBody(arg: ModelComposed)

class CreateDataDeletionResponseBody(*args, **kwargs)

Bases: ModelNormal

The response from the create data deletion request endpoint.

Parameters:

data (DataDeletionResponseItem, optional) – The created data deletion request information.
meta (DataDeletionResponseMeta, optional) – The metadata of the data deletion response.

datadog_api_client.v2.model.create_deployment_gate_params module¶

class CreateDeploymentGateParams(arg: None)¶

class CreateDeploymentGateParams(arg: ModelComposed)

class CreateDeploymentGateParams(*args, **kwargs)

Bases: ModelNormal

Parameters for creating a deployment gate.

Parameters:: data (CreateDeploymentGateParamsData) – Parameters for creating a deployment gate.

datadog_api_client.v2.model.create_deployment_gate_params_data module¶

class CreateDeploymentGateParamsData(arg: None)¶

class CreateDeploymentGateParamsData(arg: ModelComposed)

class CreateDeploymentGateParamsData(*args, **kwargs)

Bases: ModelNormal

Parameters for creating a deployment gate.

Parameters:

attributes (CreateDeploymentGateParamsDataAttributes) – Parameters for creating a deployment gate.
type (DeploymentGateDataType) – Deployment gate resource type.

datadog_api_client.v2.model.create_deployment_gate_params_data_attributes module¶

class CreateDeploymentGateParamsDataAttributes(arg: None)¶

class CreateDeploymentGateParamsDataAttributes(arg: ModelComposed)

class CreateDeploymentGateParamsDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters for creating a deployment gate.

Parameters:

dry_run (bool, optional) – Whether this gate is run in dry-run mode.
env (str) – The environment of the deployment gate.
identifier (str, optional) – The identifier of the deployment gate.
service (str) – The service of the deployment gate.

datadog_api_client.v2.model.create_deployment_rule_params module¶

class CreateDeploymentRuleParams(arg: None)¶

class CreateDeploymentRuleParams(arg: ModelComposed)

class CreateDeploymentRuleParams(*args, **kwargs)

Bases: ModelNormal

Parameters for creating a deployment rule.

Parameters:: data (CreateDeploymentRuleParamsData, optional) – Parameters for creating a deployment rule.

datadog_api_client.v2.model.create_deployment_rule_params_data module¶

class CreateDeploymentRuleParamsData(arg: None)¶

class CreateDeploymentRuleParamsData(arg: ModelComposed)

class CreateDeploymentRuleParamsData(*args, **kwargs)

Bases: ModelNormal

Parameters for creating a deployment rule.

Parameters:

attributes (CreateDeploymentRuleParamsDataAttributes) – Parameters for creating a deployment rule.
type (DeploymentRuleDataType) – Deployment rule resource type.

datadog_api_client.v2.model.create_deployment_rule_params_data_attributes module¶

class CreateDeploymentRuleParamsDataAttributes(arg: None)¶

class CreateDeploymentRuleParamsDataAttributes(arg: ModelComposed)

class CreateDeploymentRuleParamsDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters for creating a deployment rule.

Parameters:

dry_run (bool, optional) – Whether this rule is run in dry-run mode.
name (str) – The name of the deployment rule.
options (DeploymentRulesOptions) – Options for deployment rule response representing either faulty deployment detection or monitor options.
type (str) – The type of the deployment rule (faulty_deployment_detection or monitor).

datadog_api_client.v2.model.create_incident_notification_rule_request module¶

class CreateIncidentNotificationRuleRequest(arg: None)¶

class CreateIncidentNotificationRuleRequest(arg: ModelComposed)

class CreateIncidentNotificationRuleRequest(*args, **kwargs)

Bases: ModelNormal

Create request for a notification rule.

Parameters:: data (IncidentNotificationRuleCreateData) – Notification rule data for a create request.

datadog_api_client.v2.model.create_incident_notification_template_request module¶

class CreateIncidentNotificationTemplateRequest(arg: None)¶

class CreateIncidentNotificationTemplateRequest(arg: ModelComposed)

class CreateIncidentNotificationTemplateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for a notification template.

Parameters:: data (IncidentNotificationTemplateCreateData) – Notification template data for a create request.

datadog_api_client.v2.model.create_notification_rule_parameters module¶

class CreateNotificationRuleParameters(arg: None)¶

class CreateNotificationRuleParameters(arg: ModelComposed)

class CreateNotificationRuleParameters(*args, **kwargs)

Bases: ModelNormal

Body of the notification rule create request.

Parameters:: data (CreateNotificationRuleParametersData, optional) – Data of the notification rule create request: the rule type, and the rule attributes. All fields are required.

datadog_api_client.v2.model.create_notification_rule_parameters_data module¶

class CreateNotificationRuleParametersData(arg: None)¶

class CreateNotificationRuleParametersData(arg: ModelComposed)

class CreateNotificationRuleParametersData(*args, **kwargs)

Bases: ModelNormal

Data of the notification rule create request: the rule type, and the rule attributes. All fields are required.

Parameters:

attributes (CreateNotificationRuleParametersDataAttributes) – Attributes of the notification rule create request.
type (NotificationRulesType) – The rule type associated to notification rules.

datadog_api_client.v2.model.create_notification_rule_parameters_data_attributes module¶

class CreateNotificationRuleParametersDataAttributes(arg: None)¶

class CreateNotificationRuleParametersDataAttributes(arg: ModelComposed)

class CreateNotificationRuleParametersDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the notification rule create request.

Parameters:

enabled (bool, optional) – Field used to enable or disable the rule.
name (str) – Name of the notification rule.
selectors (Selectors) – Selectors are used to filter security issues for which notifications should be generated. Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source. Only the trigger_source field is required.
targets ([str]) – List of recipients to notify when a notification rule is triggered. Many different target types are supported, such as email addresses, Slack channels, and PagerDuty services. The appropriate integrations need to be properly configured to send notifications to the specified targets.
time_aggregation (int, optional) – Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation. Results are aggregated over a selected time frame using a rolling window, which updates with each new evaluation. Notifications are only sent for new issues discovered during the window. Time aggregation is only available for vulnerability-based notification rules. When omitted or set to 0, no aggregation is done.

datadog_api_client.v2.model.create_open_api_response module¶

class CreateOpenAPIResponse(arg: None)¶

class CreateOpenAPIResponse(arg: ModelComposed)

class CreateOpenAPIResponse(*args, **kwargs)

Bases: ModelNormal

Response for CreateOpenAPI operation.

Parameters:: data (CreateOpenAPIResponseData, optional) – Data envelope for CreateOpenAPIResponse.

datadog_api_client.v2.model.create_open_api_response_attributes module¶

class CreateOpenAPIResponseAttributes(arg: None)¶

class CreateOpenAPIResponseAttributes(arg: ModelComposed)

class CreateOpenAPIResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for CreateOpenAPI.

Parameters:: failed_endpoints ([OpenAPIEndpoint], optional) – List of endpoints which couldn’t be parsed.

datadog_api_client.v2.model.create_open_api_response_data module¶

class CreateOpenAPIResponseData(arg: None)¶

class CreateOpenAPIResponseData(arg: ModelComposed)

class CreateOpenAPIResponseData(*args, **kwargs)

Bases: ModelNormal

Data envelope for CreateOpenAPIResponse.

Parameters:

attributes (CreateOpenAPIResponseAttributes, optional) – Attributes for CreateOpenAPI.
id (UUID, optional) – API identifier.

datadog_api_client.v2.model.create_page_request module¶

class CreatePageRequest(arg: None)¶

class CreatePageRequest(arg: ModelComposed)

class CreatePageRequest(*args, **kwargs)

Bases: ModelNormal

Full request to trigger an On-Call Page.

Parameters:: data (CreatePageRequestData, optional) – The main request body, including attributes and resource type.

datadog_api_client.v2.model.create_page_request_data module¶

class CreatePageRequestData(arg: None)¶

class CreatePageRequestData(arg: ModelComposed)

class CreatePageRequestData(*args, **kwargs)

Bases: ModelNormal

The main request body, including attributes and resource type.

Parameters:

attributes (CreatePageRequestDataAttributes, optional) – Details about the On-Call Page you want to create.
type (CreatePageRequestDataType) – The type of resource used when creating an On-Call Page.

datadog_api_client.v2.model.create_page_request_data_attributes module¶

class CreatePageRequestDataAttributes(arg: None)¶

class CreatePageRequestDataAttributes(arg: ModelComposed)

class CreatePageRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Details about the On-Call Page you want to create.

Parameters:

description (str, optional) – A short summary of the issue or context.
tags ([str], optional) – Tags to help categorize or filter the page.
target (CreatePageRequestDataAttributesTarget) – Information about the target to notify (such as a team or user).
title (str) – The title of the page.
urgency (PageUrgency) – On-Call Page urgency level.

datadog_api_client.v2.model.create_page_request_data_attributes_target module¶

class CreatePageRequestDataAttributesTarget(arg: None)¶

class CreatePageRequestDataAttributesTarget(arg: ModelComposed)

class CreatePageRequestDataAttributesTarget(*args, **kwargs)

Bases: ModelNormal

Information about the target to notify (such as a team or user).

Parameters:

identifier (str, optional) – Identifier for the target (for example, team handle or user ID).
type (OnCallPageTargetType, optional) – The kind of target, team_id | team_handle | user_id.

datadog_api_client.v2.model.create_page_request_data_type module¶

class CreatePageRequestDataType(arg: None)¶

class CreatePageRequestDataType(arg: ModelComposed)

class CreatePageRequestDataType(*args, **kwargs)

Bases: ModelSimple

The type of resource used when creating an On-Call Page.

Parameters:

value (str) – If omitted defaults to “pages”. Must be one of [“pages”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_page_response module¶

class CreatePageResponse(arg: None)¶

class CreatePageResponse(arg: ModelComposed)

class CreatePageResponse(*args, **kwargs)

Bases: ModelNormal

The full response object after creating a new On-Call Page.

Parameters:: data (CreatePageResponseData, optional) – The information returned after successfully creating a page.

datadog_api_client.v2.model.create_page_response_data module¶

class CreatePageResponseData(arg: None)¶

class CreatePageResponseData(arg: ModelComposed)

class CreatePageResponseData(*args, **kwargs)

Bases: ModelNormal

The information returned after successfully creating a page.

Parameters:

id (str, optional) – The unique ID of the created page.
type (CreatePageResponseDataType) – The type of resource used when creating an On-Call Page.

datadog_api_client.v2.model.create_page_response_data_type module¶

class CreatePageResponseDataType(arg: None)¶

class CreatePageResponseDataType(arg: ModelComposed)

class CreatePageResponseDataType(*args, **kwargs)

Bases: ModelSimple

The type of resource used when creating an On-Call Page.

Parameters:

value (str) – If omitted defaults to “pages”. Must be one of [“pages”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_rule_request module¶

class CreateRuleRequest(arg: None)¶

class CreateRuleRequest(arg: ModelComposed)

class CreateRuleRequest(*args, **kwargs)

Bases: ModelNormal

Scorecard create rule request.

Parameters:: data (CreateRuleRequestData, optional) – Scorecard create rule request data.

datadog_api_client.v2.model.create_rule_request_data module¶

class CreateRuleRequestData(arg: None)¶

class CreateRuleRequestData(arg: ModelComposed)

class CreateRuleRequestData(*args, **kwargs)

Bases: ModelNormal

Scorecard create rule request data.

Parameters:

attributes (RuleAttributes, optional) – Details of a rule.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.create_rule_response module¶

class CreateRuleResponse(arg: None)¶

class CreateRuleResponse(arg: ModelComposed)

class CreateRuleResponse(*args, **kwargs)

Bases: ModelNormal

Created rule in response.

Parameters:: data (CreateRuleResponseData, optional) – Create rule response data.

datadog_api_client.v2.model.create_rule_response_data module¶

class CreateRuleResponseData(arg: None)¶

class CreateRuleResponseData(arg: ModelComposed)

class CreateRuleResponseData(*args, **kwargs)

Bases: ModelNormal

Create rule response data.

Parameters:

attributes (RuleAttributes, optional) – Details of a rule.
id (str, optional) – The unique ID for a scorecard rule.
relationships (RelationshipToRule, optional) – Scorecard create rule response relationship.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.create_ruleset_request module¶

class CreateRulesetRequest(arg: None)¶

class CreateRulesetRequest(arg: ModelComposed)

class CreateRulesetRequest(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequest object.

Parameters:: data (CreateRulesetRequestData, optional) – The definition of CreateRulesetRequestData object.

datadog_api_client.v2.model.create_ruleset_request_data module¶

class CreateRulesetRequestData(arg: None)¶

class CreateRulesetRequestData(arg: ModelComposed)

class CreateRulesetRequestData(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestData object.

Parameters:

attributes (CreateRulesetRequestDataAttributes, optional) – The definition of CreateRulesetRequestDataAttributes object.
id (str, optional) – The CreateRulesetRequestData id.
type (CreateRulesetRequestDataType) – Create ruleset resource type.

datadog_api_client.v2.model.create_ruleset_request_data_attributes module¶

class CreateRulesetRequestDataAttributes(arg: None)¶

class CreateRulesetRequestDataAttributes(arg: ModelComposed)

class CreateRulesetRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributes object.

Parameters:

enabled (bool, optional) – The attributes enabled.
rules ([CreateRulesetRequestDataAttributesRulesItems]) – The attributes rules.

datadog_api_client.v2.model.create_ruleset_request_data_attributes_rules_items module¶

class CreateRulesetRequestDataAttributesRulesItems(arg: None)¶

class CreateRulesetRequestDataAttributesRulesItems(arg: ModelComposed)

class CreateRulesetRequestDataAttributesRulesItems(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributesRulesItems object.

Parameters:

enabled (bool) – The items enabled.
mapping (CreateRulesetRequestDataAttributesRulesItemsMapping, none_type, optional) – The definition of CreateRulesetRequestDataAttributesRulesItemsMapping object.
metadata (RulesetItemMetadata, none_type, optional) – The items metadata.
name (str) – The items name.
query (CreateRulesetRequestDataAttributesRulesItemsQuery, none_type, optional) – The definition of CreateRulesetRequestDataAttributesRulesItemsQuery object.
reference_table (CreateRulesetRequestDataAttributesRulesItemsReferenceTable, none_type, optional) – The definition of CreateRulesetRequestDataAttributesRulesItemsReferenceTable object.

datadog_api_client.v2.model.create_ruleset_request_data_attributes_rules_items_mapping module¶

class CreateRulesetRequestDataAttributesRulesItemsMapping(arg: None)¶

class CreateRulesetRequestDataAttributesRulesItemsMapping(arg: ModelComposed)

class CreateRulesetRequestDataAttributesRulesItemsMapping(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributesRulesItemsMapping object.

Parameters:

destination_key (str) – The mapping destination_key.
if_not_exists (bool) – The mapping if_not_exists.
source_keys ([str]) – The mapping source_keys.

datadog_api_client.v2.model.create_ruleset_request_data_attributes_rules_items_query module¶

class CreateRulesetRequestDataAttributesRulesItemsQuery(arg: None)¶

class CreateRulesetRequestDataAttributesRulesItemsQuery(arg: ModelComposed)

class CreateRulesetRequestDataAttributesRulesItemsQuery(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributesRulesItemsQuery object.

Parameters:

addition (CreateRulesetRequestDataAttributesRulesItemsQueryAddition, none_type) – The definition of CreateRulesetRequestDataAttributesRulesItemsQueryAddition object.
case_insensitivity (bool, optional) – The query case_insensitivity.
if_not_exists (bool) – The query if_not_exists.
query (str) – The query query.

datadog_api_client.v2.model.create_ruleset_request_data_attributes_rules_items_query_addition module¶

class CreateRulesetRequestDataAttributesRulesItemsQueryAddition(arg: None)¶

class CreateRulesetRequestDataAttributesRulesItemsQueryAddition(arg: ModelComposed)

class CreateRulesetRequestDataAttributesRulesItemsQueryAddition(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributesRulesItemsQueryAddition object.

Parameters:

key (str) – The addition key.
value (str) – The addition value.

datadog_api_client.v2.model.create_ruleset_request_data_attributes_rules_items_reference_table module¶

class CreateRulesetRequestDataAttributesRulesItemsReferenceTable(arg: None)¶

class CreateRulesetRequestDataAttributesRulesItemsReferenceTable(arg: ModelComposed)

class CreateRulesetRequestDataAttributesRulesItemsReferenceTable(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributesRulesItemsReferenceTable object.

Parameters:

case_insensitivity (bool, optional) – The reference_table case_insensitivity.
field_pairs ([CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems]) – The reference_table field_pairs.
if_not_exists (bool, optional) – The reference_table if_not_exists.
source_keys ([str]) – The reference_table source_keys.
table_name (str) – The reference_table table_name.

datadog_api_client.v2.model.create_ruleset_request_data_attributes_rules_items_reference_table_field_pairs_items module¶

class CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems(arg: None)¶

class CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems(arg: ModelComposed)

class CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems(*args, **kwargs)

Bases: ModelNormal

The definition of CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems object.

Parameters:

input_column (str) – The items input_column.
output_key (str) – The items output_key.

datadog_api_client.v2.model.create_ruleset_request_data_type module¶

class CreateRulesetRequestDataType(arg: None)¶

class CreateRulesetRequestDataType(arg: ModelComposed)

class CreateRulesetRequestDataType(*args, **kwargs)

Bases: ModelSimple

Create ruleset resource type.

Parameters:

value (str) – If omitted defaults to “create_ruleset”. Must be one of [“create_ruleset”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_table_request module¶

class CreateTableRequest(arg: None)¶

class CreateTableRequest(arg: ModelComposed)

class CreateTableRequest(*args, **kwargs)

Bases: ModelNormal

Request body for creating a new reference table from a local file or cloud storage.

Parameters:: data (CreateTableRequestData, optional) – The data object containing the table definition.

datadog_api_client.v2.model.create_table_request_data module¶

class CreateTableRequestData(arg: None)¶

class CreateTableRequestData(arg: ModelComposed)

class CreateTableRequestData(*args, **kwargs)

Bases: ModelNormal

The data object containing the table definition.

Parameters:

attributes (CreateTableRequestDataAttributes, optional) – Attributes that define the reference table’s configuration and properties.
type (CreateTableRequestDataType) – Reference table resource type.

additional_properties_type = None¶

datadog_api_client.v2.model.create_table_request_data_attributes module¶

class CreateTableRequestDataAttributes(arg: None)¶

class CreateTableRequestDataAttributes(arg: ModelComposed)

class CreateTableRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes that define the reference table’s configuration and properties.

Parameters:

description (str, optional) – Optional text describing the purpose or contents of this reference table.
file_metadata (CreateTableRequestDataAttributesFileMetadata, optional) – Metadata specifying where and how to access the reference table’s data file.
schema (CreateTableRequestDataAttributesSchema) – Schema defining the structure and columns of the reference table.
source (ReferenceTableCreateSourceType) – The source type for creating reference table data. Only these source types can be created through this API.
table_name (str) – Name to identify this reference table.
tags ([str], optional) – Tags for organizing and filtering reference tables.

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata module¶

class CreateTableRequestDataAttributesFileMetadata(arg: None)¶

class CreateTableRequestDataAttributesFileMetadata(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadata(*args, **kwargs)

Bases: ModelComposed

Metadata specifying where and how to access the reference table’s data file.

Parameters:

access_details (CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails) – Cloud storage access configuration for the reference table data file.
sync_enabled (bool) – Whether this table is synced automatically.
upload_id (str) – The upload ID.

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_cloud_storage module¶

class CreateTableRequestDataAttributesFileMetadataCloudStorage(arg: None)¶

class CreateTableRequestDataAttributesFileMetadataCloudStorage(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadataCloudStorage(*args, **kwargs)

Bases: ModelNormal

Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.

Parameters:

access_details (CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails) – Cloud storage access configuration for the reference table data file.
sync_enabled (bool) – Whether this table is synced automatically.

additional_properties_type = None¶

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_local_file module¶

class CreateTableRequestDataAttributesFileMetadataLocalFile(arg: None)¶

class CreateTableRequestDataAttributesFileMetadataLocalFile(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadataLocalFile(*args, **kwargs)

Bases: ModelNormal

Local file metadata for create requests using the upload ID.

Parameters:: upload_id (str) – The upload ID.

additional_properties_type = None¶

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_one_of_access_details module¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails(arg: None)¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails(*args, **kwargs)

Bases: ModelNormal

Cloud storage access configuration for the reference table data file.

Parameters:

aws_detail (CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail, optional) – Amazon Web Services S3 storage access configuration.
azure_detail (CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail, optional) – Azure Blob Storage access configuration.
gcp_detail (CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail, optional) – Google Cloud Platform storage access configuration.

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail module¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(arg: None)¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(*args, **kwargs)

Bases: ModelNormal

Amazon Web Services S3 storage access configuration.

Parameters:

aws_account_id (str) – AWS account ID where the S3 bucket is located.
aws_bucket_name (str) – S3 bucket containing the CSV file.
file_path (str) – The relative file path from the S3 bucket root to the CSV file.

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail module¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail(arg: None)¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail(*args, **kwargs)

Bases: ModelNormal

Azure Blob Storage access configuration.

Parameters:

azure_client_id (str) – Azure service principal (application) client ID with permissions to read from the container.
azure_container_name (str) – Azure Blob Storage container containing the CSV file.
azure_storage_account_name (str) – Azure storage account where the container is located.
azure_tenant_id (str) – Azure Active Directory tenant ID.
file_path (str) – The relative file path from the Azure container root to the CSV file.

datadog_api_client.v2.model.create_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail module¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail(arg: None)¶

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail(arg: ModelComposed)

class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail(*args, **kwargs)

Bases: ModelNormal

Google Cloud Platform storage access configuration.

Parameters:

file_path (str) – The relative file path from the GCS bucket root to the CSV file.
gcp_bucket_name (str) – GCP bucket containing the CSV file.
gcp_project_id (str) – GCP project ID where the bucket is located.
gcp_service_account_email (str) – Service account email with read permissions for the GCS bucket.

datadog_api_client.v2.model.create_table_request_data_attributes_schema module¶

class CreateTableRequestDataAttributesSchema(arg: None)¶

class CreateTableRequestDataAttributesSchema(arg: ModelComposed)

class CreateTableRequestDataAttributesSchema(*args, **kwargs)

Bases: ModelNormal

Schema defining the structure and columns of the reference table.

Parameters:

fields ([CreateTableRequestDataAttributesSchemaFieldsItems]) – The schema fields.
primary_keys ([str]) – List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows.

datadog_api_client.v2.model.create_table_request_data_attributes_schema_fields_items module¶

class CreateTableRequestDataAttributesSchemaFieldsItems(arg: None)¶

class CreateTableRequestDataAttributesSchemaFieldsItems(arg: ModelComposed)

class CreateTableRequestDataAttributesSchemaFieldsItems(*args, **kwargs)

Bases: ModelNormal

A single field (column) in the reference table schema to be created.

Parameters:

name (str) – The field name.
type (ReferenceTableSchemaFieldType) – The field type for reference table schema fields.

datadog_api_client.v2.model.create_table_request_data_type module¶

class CreateTableRequestDataType(arg: None)¶

class CreateTableRequestDataType(arg: ModelComposed)

class CreateTableRequestDataType(*args, **kwargs)

Bases: ModelSimple

Reference table resource type.

Parameters:

value (str) – If omitted defaults to “reference_table”. Must be one of [“reference_table”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_upload_request module¶

class CreateUploadRequest(arg: None)¶

class CreateUploadRequest(arg: ModelComposed)

class CreateUploadRequest(*args, **kwargs)

Bases: ModelNormal

Request to create an upload for a file to be ingested into a reference table.

Parameters:: data (CreateUploadRequestData, optional) – Request data for creating an upload for a file to be ingested into a reference table.

datadog_api_client.v2.model.create_upload_request_data module¶

class CreateUploadRequestData(arg: None)¶

class CreateUploadRequestData(arg: ModelComposed)

class CreateUploadRequestData(*args, **kwargs)

Bases: ModelNormal

Request data for creating an upload for a file to be ingested into a reference table.

Parameters:

attributes (CreateUploadRequestDataAttributes, optional) – Upload configuration specifying how data is uploaded by the user, and properties of the table to associate the upload with.
type (CreateUploadRequestDataType) – Upload resource type.

additional_properties_type = None¶

datadog_api_client.v2.model.create_upload_request_data_attributes module¶

class CreateUploadRequestDataAttributes(arg: None)¶

class CreateUploadRequestDataAttributes(arg: ModelComposed)

class CreateUploadRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Upload configuration specifying how data is uploaded by the user, and properties of the table to associate the upload with.

Parameters:

headers ([str]) – The CSV file headers that define the schema fields, provided in the same order as the columns in the uploaded file.
part_count (int) – Number of parts to split the file into for multipart upload.
part_size (int) – The size of each part in the upload in bytes. All parts except the last one must be at least 5,000,000 bytes.
table_name (str) – Name of the table to associate with this upload.

datadog_api_client.v2.model.create_upload_request_data_type module¶

class CreateUploadRequestDataType(arg: None)¶

class CreateUploadRequestDataType(arg: ModelComposed)

class CreateUploadRequestDataType(*args, **kwargs)

Bases: ModelSimple

Upload resource type.

Parameters:

value (str) – If omitted defaults to “upload”. Must be one of [“upload”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_upload_response module¶

class CreateUploadResponse(arg: None)¶

class CreateUploadResponse(arg: ModelComposed)

class CreateUploadResponse(*args, **kwargs)

Bases: ModelNormal

Information about the upload created containing the upload ID and pre-signed URLs to PUT chunks of the CSV file to.

Parameters:: data (CreateUploadResponseData, optional) – Upload ID and attributes of the created upload.

datadog_api_client.v2.model.create_upload_response_data module¶

class CreateUploadResponseData(arg: None)¶

class CreateUploadResponseData(arg: ModelComposed)

class CreateUploadResponseData(*args, **kwargs)

Bases: ModelNormal

Upload ID and attributes of the created upload.

Parameters:

attributes (CreateUploadResponseDataAttributes, optional) – Pre-signed URLs for uploading parts of the file.
id (str, optional) – Unique identifier for this upload. Use this ID when creating the reference table.
type (CreateUploadResponseDataType) – Upload resource type.

additional_properties_type = None¶

datadog_api_client.v2.model.create_upload_response_data_attributes module¶

class CreateUploadResponseDataAttributes(arg: None)¶

class CreateUploadResponseDataAttributes(arg: ModelComposed)

class CreateUploadResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Pre-signed URLs for uploading parts of the file.

Parameters:: part_urls ([str], optional) – The pre-signed URLs for uploading parts. These URLs expire after 5 minutes.

datadog_api_client.v2.model.create_upload_response_data_type module¶

class CreateUploadResponseDataType(arg: None)¶

class CreateUploadResponseDataType(arg: ModelComposed)

class CreateUploadResponseDataType(*args, **kwargs)

Bases: ModelSimple

Upload resource type.

Parameters:

value (str) – If omitted defaults to “upload”. Must be one of [“upload”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.create_workflow_request module¶

class CreateWorkflowRequest(arg: None)¶

class CreateWorkflowRequest(arg: ModelComposed)

class CreateWorkflowRequest(*args, **kwargs)

Bases: ModelNormal

A request object for creating a new workflow.

Parameters:: data (WorkflowData) – Data related to the workflow.

datadog_api_client.v2.model.create_workflow_response module¶

class CreateWorkflowResponse(arg: None)¶

class CreateWorkflowResponse(arg: ModelComposed)

class CreateWorkflowResponse(*args, **kwargs)

Bases: ModelNormal

The response object after creating a new workflow.

Parameters:: data (WorkflowData) – Data related to the workflow.

datadog_api_client.v2.model.creator module¶

class Creator(arg: None)¶

class Creator(arg: ModelComposed)

class Creator(*args, **kwargs)

Bases: ModelNormal

Creator of the object.

Parameters:

email (str, optional) – Email of the creator.
handle (str, optional) – Handle of the creator.
name (str, none_type, optional) – Name of the creator.

datadog_api_client.v2.model.csm_agent_data module¶

class CsmAgentData(arg: None)¶

class CsmAgentData(arg: ModelComposed)

class CsmAgentData(*args, **kwargs)

Bases: ModelNormal

Single Agent Data.

Parameters:

attributes (CsmAgentsAttributes, optional) – A CSM Agent returned by the API.
id (str, optional) – The ID of the Agent.
type (CSMAgentsType, optional) – The type of the resource. The value should always be datadog_agent.

datadog_api_client.v2.model.csm_agents_attributes module¶

class CsmAgentsAttributes(arg: None)¶

class CsmAgentsAttributes(arg: ModelComposed)

class CsmAgentsAttributes(*args, **kwargs)

Bases: ModelNormal

A CSM Agent returned by the API.

Parameters:

agent_version (str, optional) – Version of the Datadog Agent.
aws_fargate (str, optional) – AWS Fargate details.
cluster_name ([str], optional) – List of cluster names associated with the Agent.
datadog_agent (str, optional) – Unique identifier for the Datadog Agent.
ecs_fargate_task_arn (str, optional) – ARN of the ECS Fargate task.
envs ([str], none_type, optional) – List of environments associated with the Agent.
host_id (int, optional) – ID of the host.
hostname (str, optional) – Name of the host.
install_method_installer_version (str, optional) – Version of the installer used for installing the Datadog Agent.
install_method_tool (str, optional) – Tool used for installing the Datadog Agent.
is_csm_vm_containers_enabled (bool, none_type, optional) – Indicates if CSM VM Containers is enabled.
is_csm_vm_hosts_enabled (bool, none_type, optional) – Indicates if CSM VM Hosts is enabled.
is_cspm_enabled (bool, none_type, optional) – Indicates if CSPM is enabled.
is_cws_enabled (bool, none_type, optional) – Indicates if CWS is enabled.
is_cws_remote_configuration_enabled (bool, none_type, optional) – Indicates if CWS Remote Configuration is enabled.
is_remote_configuration_enabled (bool, none_type, optional) – Indicates if Remote Configuration is enabled.
os (str, optional) – Operating system of the host.

datadog_api_client.v2.model.csm_agents_metadata module¶

class CSMAgentsMetadata(arg: None)¶

class CSMAgentsMetadata(arg: ModelComposed)

class CSMAgentsMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata related to the paginated response.

Parameters:

page_index (int, optional) – The index of the current page in the paginated results.
page_size (int, optional) – The number of items per page in the paginated results.
total_filtered (int, optional) – Total number of items that match the filter criteria.

datadog_api_client.v2.model.csm_agents_response module¶

class CsmAgentsResponse(arg: None)¶

class CsmAgentsResponse(arg: ModelComposed)

class CsmAgentsResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a list of CSM Agents.

Parameters:

data ([CsmAgentData], optional) – A list of Agents.
meta (CSMAgentsMetadata, optional) – Metadata related to the paginated response.

datadog_api_client.v2.model.csm_agents_type module¶

class CSMAgentsType(arg: None)¶

class CSMAgentsType(arg: ModelComposed)

class CSMAgentsType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be datadog_agent.

Parameters:

value (str) – If omitted defaults to “datadog_agent”. Must be one of [“datadog_agent”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_attributes module¶

class CsmCloudAccountsCoverageAnalysisAttributes(arg: None)¶

class CsmCloudAccountsCoverageAnalysisAttributes(arg: ModelComposed)

class CsmCloudAccountsCoverageAnalysisAttributes(*args, **kwargs)

Bases: ModelNormal

CSM Cloud Accounts Coverage Analysis attributes.

Parameters:

aws_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
azure_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
gcp_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
org_id (int, optional) – The ID of your organization.
total_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.

datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_data module¶

class CsmCloudAccountsCoverageAnalysisData(arg: None)¶

class CsmCloudAccountsCoverageAnalysisData(arg: ModelComposed)

class CsmCloudAccountsCoverageAnalysisData(*args, **kwargs)

Bases: ModelNormal

CSM Cloud Accounts Coverage Analysis data.

Parameters:

attributes (CsmCloudAccountsCoverageAnalysisAttributes, optional) – CSM Cloud Accounts Coverage Analysis attributes.
id (str, optional) – The ID of your organization.
type (str, optional) – The type of the resource. The value should always be get_cloud_accounts_coverage_analysis_response_public_v0.

datadog_api_client.v2.model.csm_cloud_accounts_coverage_analysis_response module¶

class CsmCloudAccountsCoverageAnalysisResponse(arg: None)¶

class CsmCloudAccountsCoverageAnalysisResponse(arg: ModelComposed)

class CsmCloudAccountsCoverageAnalysisResponse(*args, **kwargs)

Bases: ModelNormal

CSM Cloud Accounts Coverage Analysis response.

Parameters:: data (CsmCloudAccountsCoverageAnalysisData, optional) – CSM Cloud Accounts Coverage Analysis data.

datadog_api_client.v2.model.csm_coverage_analysis module¶

class CsmCoverageAnalysis(arg: None)¶

class CsmCoverageAnalysis(arg: ModelComposed)

class CsmCoverageAnalysis(*args, **kwargs)

Bases: ModelNormal

CSM Coverage Analysis.

Parameters:

configured_resources_count (int, optional) – The number of fully configured resources.
coverage (float, optional) – The coverage percentage.
partially_configured_resources_count (int, optional) – The number of partially configured resources.
total_resources_count (int, optional) – The total number of resources.

datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_attributes module¶

class CsmHostsAndContainersCoverageAnalysisAttributes(arg: None)¶

class CsmHostsAndContainersCoverageAnalysisAttributes(arg: ModelComposed)

class CsmHostsAndContainersCoverageAnalysisAttributes(*args, **kwargs)

Bases: ModelNormal

CSM Hosts and Containers Coverage Analysis attributes.

Parameters:

cspm_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
cws_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
org_id (int, optional) – The ID of your organization.
total_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
vm_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.

datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_data module¶

class CsmHostsAndContainersCoverageAnalysisData(arg: None)¶

class CsmHostsAndContainersCoverageAnalysisData(arg: ModelComposed)

class CsmHostsAndContainersCoverageAnalysisData(*args, **kwargs)

Bases: ModelNormal

CSM Hosts and Containers Coverage Analysis data.

Parameters:

attributes (CsmHostsAndContainersCoverageAnalysisAttributes, optional) – CSM Hosts and Containers Coverage Analysis attributes.
id (str, optional) – The ID of your organization.
type (str, optional) – The type of the resource. The value should always be get_hosts_and_containers_coverage_analysis_response_public_v0.

datadog_api_client.v2.model.csm_hosts_and_containers_coverage_analysis_response module¶

class CsmHostsAndContainersCoverageAnalysisResponse(arg: None)¶

class CsmHostsAndContainersCoverageAnalysisResponse(arg: ModelComposed)

class CsmHostsAndContainersCoverageAnalysisResponse(*args, **kwargs)

Bases: ModelNormal

CSM Hosts and Containers Coverage Analysis response.

Parameters:: data (CsmHostsAndContainersCoverageAnalysisData, optional) – CSM Hosts and Containers Coverage Analysis data.

datadog_api_client.v2.model.csm_serverless_coverage_analysis_attributes module¶

class CsmServerlessCoverageAnalysisAttributes(arg: None)¶

class CsmServerlessCoverageAnalysisAttributes(arg: ModelComposed)

class CsmServerlessCoverageAnalysisAttributes(*args, **kwargs)

Bases: ModelNormal

CSM Serverless Resources Coverage Analysis attributes.

Parameters:

cws_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.
org_id (int, optional) – The ID of your organization.
total_coverage (CsmCoverageAnalysis, optional) – CSM Coverage Analysis.

datadog_api_client.v2.model.csm_serverless_coverage_analysis_data module¶

class CsmServerlessCoverageAnalysisData(arg: None)¶

class CsmServerlessCoverageAnalysisData(arg: ModelComposed)

class CsmServerlessCoverageAnalysisData(*args, **kwargs)

Bases: ModelNormal

CSM Serverless Resources Coverage Analysis data.

Parameters:

attributes (CsmServerlessCoverageAnalysisAttributes, optional) – CSM Serverless Resources Coverage Analysis attributes.
id (str, optional) – The ID of your organization.
type (str, optional) – The type of the resource. The value should always be get_serverless_coverage_analysis_response_public_v0.

datadog_api_client.v2.model.csm_serverless_coverage_analysis_response module¶

class CsmServerlessCoverageAnalysisResponse(arg: None)¶

class CsmServerlessCoverageAnalysisResponse(arg: ModelComposed)

class CsmServerlessCoverageAnalysisResponse(*args, **kwargs)

Bases: ModelNormal

CSM Serverless Resources Coverage Analysis response.

Parameters:: data (CsmServerlessCoverageAnalysisData, optional) – CSM Serverless Resources Coverage Analysis data.

datadog_api_client.v2.model.custom_attribute_config module¶

class CustomAttributeConfig(arg: None)¶

class CustomAttributeConfig(arg: ModelComposed)

class CustomAttributeConfig(*args, **kwargs)

Bases: ModelNormal

The definition of CustomAttributeConfig object.

Parameters:

attributes (CustomAttributeConfigResourceAttributes, optional) – Custom attribute resource attributes
id (str, optional) – Custom attribute configs identifier
type (CustomAttributeConfigResourceType, optional) – Custom attributes config JSON:API resource type

datadog_api_client.v2.model.custom_attribute_config_attributes_create module¶

class CustomAttributeConfigAttributesCreate(arg: None)¶

class CustomAttributeConfigAttributesCreate(arg: ModelComposed)

class CustomAttributeConfigAttributesCreate(*args, **kwargs)

Bases: ModelNormal

Custom attribute config resource attributes

Parameters:

description (str, optional) – Custom attribute description.
display_name (str) – Custom attribute name.
is_multi (bool) – Whether multiple values can be set
key (str) – Custom attribute key. This will be the value use to search on this custom attribute
type (CustomAttributeType) – Custom attributes type

datadog_api_client.v2.model.custom_attribute_config_create module¶

class CustomAttributeConfigCreate(arg: None)¶

class CustomAttributeConfigCreate(arg: ModelComposed)

class CustomAttributeConfigCreate(*args, **kwargs)

Bases: ModelNormal

Custom attribute config

Parameters:

attributes (CustomAttributeConfigAttributesCreate) – Custom attribute config resource attributes
type (CustomAttributeConfigResourceType) – Custom attributes config JSON:API resource type

datadog_api_client.v2.model.custom_attribute_config_create_request module¶

class CustomAttributeConfigCreateRequest(arg: None)¶

class CustomAttributeConfigCreateRequest(arg: ModelComposed)

class CustomAttributeConfigCreateRequest(*args, **kwargs)

Bases: ModelNormal

Custom attribute config create request

Parameters:: data (CustomAttributeConfigCreate) – Custom attribute config

datadog_api_client.v2.model.custom_attribute_config_resource_attributes module¶

class CustomAttributeConfigResourceAttributes(arg: None)¶

class CustomAttributeConfigResourceAttributes(arg: ModelComposed)

class CustomAttributeConfigResourceAttributes(*args, **kwargs)

Bases: ModelNormal

Custom attribute resource attributes

Parameters:

case_type_id (str) – Custom attribute config identifier.
description (str, optional) – Custom attribute description.
display_name (str) – Custom attribute name.
is_multi (bool) – Whether multiple values can be set
key (str) – Custom attribute key. This will be the value use to search on this custom attribute
type (CustomAttributeType) – Custom attributes type

datadog_api_client.v2.model.custom_attribute_config_resource_type module¶

class CustomAttributeConfigResourceType(arg: None)¶

class CustomAttributeConfigResourceType(arg: ModelComposed)

class CustomAttributeConfigResourceType(*args, **kwargs)

Bases: ModelSimple

Custom attributes config JSON:API resource type

Parameters:

value (str) – If omitted defaults to “custom_attribute”. Must be one of [“custom_attribute”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_attribute_config_response module¶

class CustomAttributeConfigResponse(arg: None)¶

class CustomAttributeConfigResponse(arg: ModelComposed)

class CustomAttributeConfigResponse(*args, **kwargs)

Bases: ModelNormal

Custom attribute config response.

Parameters:: data (CustomAttributeConfig, optional) – The definition of CustomAttributeConfig object.

datadog_api_client.v2.model.custom_attribute_configs_response module¶

class CustomAttributeConfigsResponse(arg: None)¶

class CustomAttributeConfigsResponse(arg: ModelComposed)

class CustomAttributeConfigsResponse(*args, **kwargs)

Bases: ModelNormal

Custom attribute configs response.

Parameters:: data ([CustomAttributeConfig], optional) – List of custom attribute configs of case type

datadog_api_client.v2.model.custom_attribute_type module¶

class CustomAttributeType(arg: None)¶

class CustomAttributeType(arg: ModelComposed)

class CustomAttributeType(*args, **kwargs)

Bases: ModelSimple

Custom attributes type

Parameters:

value (str) – Must be one of [“URL”, “TEXT”, “NUMBER”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_attribute_value module¶

class CustomAttributeValue(arg: None)¶

class CustomAttributeValue(arg: ModelComposed)

class CustomAttributeValue(*args, **kwargs)

Bases: ModelNormal

Custom attribute values

Parameters:

is_multi (bool) – If true, value must be an array
type (CustomAttributeType) – Custom attributes type
value (CustomAttributeValuesUnion) – Union of supported value for a custom attribute

datadog_api_client.v2.model.custom_attribute_values_union module¶

class CustomAttributeValuesUnion(arg: None)¶

class CustomAttributeValuesUnion(arg: ModelComposed)

class CustomAttributeValuesUnion(*args, **kwargs)

Bases: ModelComposed

Union of supported value for a custom attribute

datadog_api_client.v2.model.custom_connection module¶

class CustomConnection(arg: None)¶

class CustomConnection(arg: ModelComposed)

class CustomConnection(*args, **kwargs)

Bases: ModelNormal

A custom connection used by an app.

Parameters:

attributes (CustomConnectionAttributes, optional) – The custom connection attributes.
id (UUID, optional) – The ID of the custom connection.
type (CustomConnectionType, optional) – The custom connection type.

datadog_api_client.v2.model.custom_connection_attributes module¶

class CustomConnectionAttributes(arg: None)¶

class CustomConnectionAttributes(arg: ModelComposed)

class CustomConnectionAttributes(*args, **kwargs)

Bases: ModelNormal

The custom connection attributes.

Parameters:

name (str, optional) – The name of the custom connection.
on_prem_runner (CustomConnectionAttributesOnPremRunner, optional) – Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.

datadog_api_client.v2.model.custom_connection_attributes_on_prem_runner module¶

class CustomConnectionAttributesOnPremRunner(arg: None)¶

class CustomConnectionAttributesOnPremRunner(arg: ModelComposed)

class CustomConnectionAttributesOnPremRunner(*args, **kwargs)

Bases: ModelNormal

Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.

Parameters:

id (str, optional) – The Private Action Runner ID.
url (str, optional) – The URL of the Private Action Runner.

datadog_api_client.v2.model.custom_connection_type module¶

class CustomConnectionType(arg: None)¶

class CustomConnectionType(arg: ModelComposed)

class CustomConnectionType(*args, **kwargs)

Bases: ModelSimple

The custom connection type.

Parameters:

value (str) – If omitted defaults to “custom_connections”. Must be one of [“custom_connections”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_cost_get_response_meta module¶

class CustomCostGetResponseMeta(arg: None)¶

class CustomCostGetResponseMeta(arg: ModelComposed)

class CustomCostGetResponseMeta(*args, **kwargs)

Bases: ModelNormal

Meta for the response from the Get Custom Costs endpoints.

Parameters:: version (str, optional) – Version of Custom Costs file

datadog_api_client.v2.model.custom_cost_list_response_meta module¶

class CustomCostListResponseMeta(arg: None)¶

class CustomCostListResponseMeta(arg: ModelComposed)

class CustomCostListResponseMeta(*args, **kwargs)

Bases: ModelNormal

Meta for the response from the List Custom Costs endpoints.

Parameters:

total_filtered_count (int, optional) – Number of Custom Costs files returned by the List Custom Costs endpoint
version (str, optional) – Version of Custom Costs file

datadog_api_client.v2.model.custom_cost_upload_response_meta module¶

class CustomCostUploadResponseMeta(arg: None)¶

class CustomCostUploadResponseMeta(arg: ModelComposed)

class CustomCostUploadResponseMeta(*args, **kwargs)

Bases: ModelNormal

Meta for the response from the Upload Custom Costs endpoints.

Parameters:: version (str, optional) – Version of Custom Costs file

datadog_api_client.v2.model.custom_costs_file_get_response module¶

class CustomCostsFileGetResponse(arg: None)¶

class CustomCostsFileGetResponse(arg: ModelComposed)

class CustomCostsFileGetResponse(*args, **kwargs)

Bases: ModelNormal

Response for Get Custom Costs files.

Parameters:

data (CustomCostsFileMetadataWithContentHighLevel, optional) – JSON API format of for a Custom Costs file with content.
meta (CustomCostGetResponseMeta, optional) – Meta for the response from the Get Custom Costs endpoints.

datadog_api_client.v2.model.custom_costs_file_line_item module¶

class CustomCostsFileLineItem(arg: None)¶

class CustomCostsFileLineItem(arg: ModelComposed)

class CustomCostsFileLineItem(*args, **kwargs)

Bases: ModelNormal

Line item details from a Custom Costs file.

Parameters:

billed_cost (float, optional) – Total cost in the cost file.
billing_currency (str, optional) – Currency used in the Custom Costs file.
charge_description (str, optional) – Description for the line item cost.
charge_period_end (str, optional) – End date of the usage charge.
charge_period_start (str, optional) – Start date of the usage charge.
provider_name (str, optional) – Name of the provider for the line item.
tags ({str: (str,)}, optional) – Additional tags for the line item.

datadog_api_client.v2.model.custom_costs_file_list_response module¶

class CustomCostsFileListResponse(arg: None)¶

class CustomCostsFileListResponse(arg: ModelComposed)

class CustomCostsFileListResponse(*args, **kwargs)

Bases: ModelNormal

Response for List Custom Costs files.

Parameters:

data ([CustomCostsFileMetadataHighLevel], optional) – List of Custom Costs files.
meta (CustomCostListResponseMeta, optional) – Meta for the response from the List Custom Costs endpoints.

datadog_api_client.v2.model.custom_costs_file_metadata module¶

class CustomCostsFileMetadata(arg: None)¶

class CustomCostsFileMetadata(arg: ModelComposed)

class CustomCostsFileMetadata(*args, **kwargs)

Bases: ModelNormal

Schema of a Custom Costs metadata.

Parameters:

billed_cost (float, optional) – Total cost in the cost file.
billing_currency (str, optional) – Currency used in the Custom Costs file.
charge_period (CustomCostsFileUsageChargePeriod, optional) – Usage charge period of a Custom Costs file.
name (str, optional) – Name of the Custom Costs file.
provider_names ([str], optional) – Providers contained in the Custom Costs file.
status (str, optional) – Status of the Custom Costs file.
uploaded_at (float, optional) – Timestamp, in millisecond, of the upload time of the Custom Costs file.
uploaded_by (CustomCostsUser, optional) – Metadata of the user that has uploaded the Custom Costs file.

datadog_api_client.v2.model.custom_costs_file_metadata_high_level module¶

class CustomCostsFileMetadataHighLevel(arg: None)¶

class CustomCostsFileMetadataHighLevel(arg: ModelComposed)

class CustomCostsFileMetadataHighLevel(*args, **kwargs)

Bases: ModelNormal

JSON API format for a Custom Costs file.

Parameters:

attributes (CustomCostsFileMetadata, optional) – Schema of a Custom Costs metadata.
id (str, optional) – ID of the Custom Costs metadata.
type (str, optional) – Type of the Custom Costs file metadata.

datadog_api_client.v2.model.custom_costs_file_metadata_with_content module¶

class CustomCostsFileMetadataWithContent(arg: None)¶

class CustomCostsFileMetadataWithContent(arg: ModelComposed)

class CustomCostsFileMetadataWithContent(*args, **kwargs)

Bases: ModelNormal

Schema of a cost file’s metadata.

Parameters:

billed_cost (float, optional) – Total cost in the cost file.
billing_currency (str, optional) – Currency used in the Custom Costs file.
charge_period (CustomCostsFileUsageChargePeriod, optional) – Usage charge period of a Custom Costs file.
content ([CustomCostsFileLineItem], optional) – Detail of the line items from the Custom Costs file.
name (str, optional) – Name of the Custom Costs file.
provider_names ([str], optional) – Providers contained in the Custom Costs file.
status (str, optional) – Status of the Custom Costs file.
uploaded_at (float, optional) – Timestamp in millisecond of the upload time of the Custom Costs file.
uploaded_by (CustomCostsUser, optional) – Metadata of the user that has uploaded the Custom Costs file.

datadog_api_client.v2.model.custom_costs_file_metadata_with_content_high_level module¶

class CustomCostsFileMetadataWithContentHighLevel(arg: None)¶

class CustomCostsFileMetadataWithContentHighLevel(arg: ModelComposed)

class CustomCostsFileMetadataWithContentHighLevel(*args, **kwargs)

Bases: ModelNormal

JSON API format of for a Custom Costs file with content.

Parameters:

attributes (CustomCostsFileMetadataWithContent, optional) – Schema of a cost file’s metadata.
id (str, optional) – ID of the Custom Costs metadata.
type (str, optional) – Type of the Custom Costs file metadata.

datadog_api_client.v2.model.custom_costs_file_upload_response module¶

class CustomCostsFileUploadResponse(arg: None)¶

class CustomCostsFileUploadResponse(arg: ModelComposed)

class CustomCostsFileUploadResponse(*args, **kwargs)

Bases: ModelNormal

Response for Uploaded Custom Costs files.

Parameters:

data (CustomCostsFileMetadataHighLevel, optional) – JSON API format for a Custom Costs file.
meta (CustomCostUploadResponseMeta, optional) – Meta for the response from the Upload Custom Costs endpoints.

datadog_api_client.v2.model.custom_costs_file_usage_charge_period module¶

class CustomCostsFileUsageChargePeriod(arg: None)¶

class CustomCostsFileUsageChargePeriod(arg: ModelComposed)

class CustomCostsFileUsageChargePeriod(*args, **kwargs)

Bases: ModelNormal

Usage charge period of a Custom Costs file.

Parameters:

end (float, optional) – End of the usage of the Custom Costs file.
start (float, optional) – Start of the usage of the Custom Costs file.

datadog_api_client.v2.model.custom_costs_user module¶

class CustomCostsUser(arg: None)¶

class CustomCostsUser(arg: ModelComposed)

class CustomCostsUser(*args, **kwargs)

Bases: ModelNormal

Metadata of the user that has uploaded the Custom Costs file.

Parameters:

email (str, optional) – The name of the Custom Costs file.
icon (str, optional) – The name of the Custom Costs file.
name (str, optional) – Name of the user.

datadog_api_client.v2.model.custom_destination_attribute_tags_restriction_list_type module¶

class CustomDestinationAttributeTagsRestrictionListType(arg: None)¶

class CustomDestinationAttributeTagsRestrictionListType(arg: ModelComposed)

class CustomDestinationAttributeTagsRestrictionListType(*args, **kwargs)

Bases: ModelSimple

How forward_tags_restriction_list parameter should be interpreted.

If ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list are forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list.

Parameters:

value (str) – If omitted defaults to “ALLOW_LIST”. Must be one of [“ALLOW_LIST”, “BLOCK_LIST”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_create_request module¶

class CustomDestinationCreateRequest(arg: None)¶

class CustomDestinationCreateRequest(arg: ModelComposed)

class CustomDestinationCreateRequest(*args, **kwargs)

Bases: ModelNormal

The custom destination.

Parameters:: data (CustomDestinationCreateRequestDefinition, optional) – The definition of a custom destination.

datadog_api_client.v2.model.custom_destination_create_request_attributes module¶

class CustomDestinationCreateRequestAttributes(arg: None)¶

class CustomDestinationCreateRequestAttributes(arg: ModelComposed)

class CustomDestinationCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes associated with the custom destination.

Parameters:

enabled (bool, optional) – Whether logs matching this custom destination should be forwarded or not.
forward_tags (bool, optional) – Whether tags from the forwarded logs should be forwarded or not.
forward_tags_restriction_list ([str], optional) –
List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be forwarded depending on forward_tags_restriction_list_type parameter.
forward_tags_restriction_list_type (CustomDestinationAttributeTagsRestrictionListType, optional) –
How forward_tags_restriction_list parameter should be interpreted. If ALLOW_LIST , then only tags whose keys on the forwarded logs match the ones on the restriction list are forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list.
forwarder_destination (CustomDestinationForwardDestination) – A custom destination’s location to forward logs.
name (str) – The custom destination name.
query (str, optional) – The custom destination query and filter. Logs matching this query are forwarded to the destination.

datadog_api_client.v2.model.custom_destination_create_request_definition module¶

class CustomDestinationCreateRequestDefinition(arg: None)¶

class CustomDestinationCreateRequestDefinition(arg: ModelComposed)

class CustomDestinationCreateRequestDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of a custom destination.

Parameters:

attributes (CustomDestinationCreateRequestAttributes) – The attributes associated with the custom destination.
type (CustomDestinationType) – The type of the resource. The value should always be custom_destination.

datadog_api_client.v2.model.custom_destination_elasticsearch_destination_auth module¶

class CustomDestinationElasticsearchDestinationAuth(arg: None)¶

class CustomDestinationElasticsearchDestinationAuth(arg: ModelComposed)

class CustomDestinationElasticsearchDestinationAuth(*args, **kwargs)

Bases: ModelNormal

Basic access authentication.

Parameters:

password (str) – The password of the authentication. This field is not returned by the API.
username (str) – The username of the authentication. This field is not returned by the API.

datadog_api_client.v2.model.custom_destination_forward_destination module¶

class CustomDestinationForwardDestination(arg: None)¶

class CustomDestinationForwardDestination(arg: ModelComposed)

class CustomDestinationForwardDestination(*args, **kwargs)

Bases: ModelComposed

A custom destination’s location to forward logs.

Parameters:

auth (CustomDestinationHttpDestinationAuth) – Authentication method of the HTTP requests.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type (CustomDestinationForwardDestinationHttpType) – Type of the HTTP destination.
access_token (str) – Access token of the Splunk HTTP Event Collector. This field is not returned by the API.
index_name (str) – Name of the Elasticsearch index (must follow [Elasticsearch’s criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
index_rotation (str, optional) –
Date pattern with US locale and UTC timezone to be appended to the index name after adding - (that is, ${index_name}-${indexPattern}). You can customize the index rotation naming pattern by choosing one of these options: - Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09) - Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19) - Weekly: yyyy-‘W’ww (as an example, it would render: 2022-W42) - Monthly: yyyy-MM (as an example, it would render: 2022-10)

If this field is missing or is blank, it means that the index name will always be the same (that is, no rotation).
client_id (str) – Client ID from the Datadog Azure integration.
data_collection_endpoint (str) – Azure data collection endpoint.
data_collection_rule_id (str) – Azure data collection rule ID.
stream_name (str) – Azure stream name.
tenant_id (str) – Tenant ID from the Datadog Azure integration.

datadog_api_client.v2.model.custom_destination_forward_destination_elasticsearch module¶

class CustomDestinationForwardDestinationElasticsearch(arg: None)¶

class CustomDestinationForwardDestinationElasticsearch(arg: ModelComposed)

class CustomDestinationForwardDestinationElasticsearch(*args, **kwargs)

Bases: ModelNormal

The Elasticsearch destination.

Parameters:

auth (CustomDestinationElasticsearchDestinationAuth) – Basic access authentication.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
index_name (str) – Name of the Elasticsearch index (must follow Elasticsearch’s criteria ).
index_rotation (str, optional) –
Date pattern with US locale and UTC timezone to be appended to the index name after adding - (that is, ${index_name}-${indexPattern} ). You can customize the index rotation naming pattern by choosing one of these options:
- Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09 )
- Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19 )
- Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42 )
- Monthly: yyyy-MM (as an example, it would render: 2022-10 )
If this field is missing or is blank, it means that the index name will always be the same (that is, no rotation).
type (CustomDestinationForwardDestinationElasticsearchType) – Type of the Elasticsearch destination.

datadog_api_client.v2.model.custom_destination_forward_destination_elasticsearch_type module¶

class CustomDestinationForwardDestinationElasticsearchType(arg: None)¶

class CustomDestinationForwardDestinationElasticsearchType(arg: ModelComposed)

class CustomDestinationForwardDestinationElasticsearchType(*args, **kwargs)

Bases: ModelSimple

Type of the Elasticsearch destination.

Parameters:

value (str) – If omitted defaults to “elasticsearch”. Must be one of [“elasticsearch”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_forward_destination_http module¶

class CustomDestinationForwardDestinationHttp(arg: None)¶

class CustomDestinationForwardDestinationHttp(arg: ModelComposed)

class CustomDestinationForwardDestinationHttp(*args, **kwargs)

Bases: ModelNormal

The HTTP destination.

Parameters:

auth (CustomDestinationHttpDestinationAuth) – Authentication method of the HTTP requests.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type (CustomDestinationForwardDestinationHttpType) – Type of the HTTP destination.

datadog_api_client.v2.model.custom_destination_forward_destination_http_type module¶

class CustomDestinationForwardDestinationHttpType(arg: None)¶

class CustomDestinationForwardDestinationHttpType(arg: ModelComposed)

class CustomDestinationForwardDestinationHttpType(*args, **kwargs)

Bases: ModelSimple

Type of the HTTP destination.

Parameters:

value (str) – If omitted defaults to “http”. Must be one of [“http”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_forward_destination_microsoft_sentinel module¶

class CustomDestinationForwardDestinationMicrosoftSentinel(arg: None)¶

class CustomDestinationForwardDestinationMicrosoftSentinel(arg: ModelComposed)

class CustomDestinationForwardDestinationMicrosoftSentinel(*args, **kwargs)

Bases: ModelNormal

The Microsoft Sentinel destination.

Parameters:

client_id (str) – Client ID from the Datadog Azure integration.
data_collection_endpoint (str) – Azure data collection endpoint.
data_collection_rule_id (str) – Azure data collection rule ID.
stream_name (str) – Azure stream name.
tenant_id (str) – Tenant ID from the Datadog Azure integration.
type (CustomDestinationForwardDestinationMicrosoftSentinelType) – Type of the Microsoft Sentinel destination.

datadog_api_client.v2.model.custom_destination_forward_destination_microsoft_sentinel_type module¶

class CustomDestinationForwardDestinationMicrosoftSentinelType(arg: None)¶

class CustomDestinationForwardDestinationMicrosoftSentinelType(arg: ModelComposed)

class CustomDestinationForwardDestinationMicrosoftSentinelType(*args, **kwargs)

Bases: ModelSimple

Type of the Microsoft Sentinel destination.

Parameters:

value (str) – If omitted defaults to “microsoft_sentinel”. Must be one of [“microsoft_sentinel”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_forward_destination_splunk module¶

class CustomDestinationForwardDestinationSplunk(arg: None)¶

class CustomDestinationForwardDestinationSplunk(arg: ModelComposed)

class CustomDestinationForwardDestinationSplunk(*args, **kwargs)

Bases: ModelNormal

The Splunk HTTP Event Collector (HEC) destination.

Parameters:

access_token (str) – Access token of the Splunk HTTP Event Collector. This field is not returned by the API.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type (CustomDestinationForwardDestinationSplunkType) – Type of the Splunk HTTP Event Collector (HEC) destination.

datadog_api_client.v2.model.custom_destination_forward_destination_splunk_type module¶

class CustomDestinationForwardDestinationSplunkType(arg: None)¶

class CustomDestinationForwardDestinationSplunkType(arg: ModelComposed)

class CustomDestinationForwardDestinationSplunkType(*args, **kwargs)

Bases: ModelSimple

Type of the Splunk HTTP Event Collector (HEC) destination.

Parameters:

value (str) – If omitted defaults to “splunk_hec”. Must be one of [“splunk_hec”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_http_destination_auth module¶

class CustomDestinationHttpDestinationAuth(arg: None)¶

class CustomDestinationHttpDestinationAuth(arg: ModelComposed)

class CustomDestinationHttpDestinationAuth(*args, **kwargs)

Bases: ModelComposed

Authentication method of the HTTP requests.

Parameters:

password (str) – The password of the authentication. This field is not returned by the API.
type (CustomDestinationHttpDestinationAuthBasicType) – Type of the basic access authentication.
username (str) – The username of the authentication. This field is not returned by the API.
header_name (str) – The header name of the authentication.
header_value (str) – The header value of the authentication. This field is not returned by the API.

datadog_api_client.v2.model.custom_destination_http_destination_auth_basic module¶

class CustomDestinationHttpDestinationAuthBasic(arg: None)¶

class CustomDestinationHttpDestinationAuthBasic(arg: ModelComposed)

class CustomDestinationHttpDestinationAuthBasic(*args, **kwargs)

Bases: ModelNormal

Basic access authentication.

Parameters:

password (str) – The password of the authentication. This field is not returned by the API.
type (CustomDestinationHttpDestinationAuthBasicType) – Type of the basic access authentication.
username (str) – The username of the authentication. This field is not returned by the API.

datadog_api_client.v2.model.custom_destination_http_destination_auth_basic_type module¶

class CustomDestinationHttpDestinationAuthBasicType(arg: None)¶

class CustomDestinationHttpDestinationAuthBasicType(arg: ModelComposed)

class CustomDestinationHttpDestinationAuthBasicType(*args, **kwargs)

Bases: ModelSimple

Type of the basic access authentication.

Parameters:

value (str) – If omitted defaults to “basic”. Must be one of [“basic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_http_destination_auth_custom_header module¶

class CustomDestinationHttpDestinationAuthCustomHeader(arg: None)¶

class CustomDestinationHttpDestinationAuthCustomHeader(arg: ModelComposed)

class CustomDestinationHttpDestinationAuthCustomHeader(*args, **kwargs)

Bases: ModelNormal

Custom header access authentication.

Parameters:

header_name (str) – The header name of the authentication.
header_value (str) – The header value of the authentication. This field is not returned by the API.
type (CustomDestinationHttpDestinationAuthCustomHeaderType) – Type of the custom header access authentication.

datadog_api_client.v2.model.custom_destination_http_destination_auth_custom_header_type module¶

class CustomDestinationHttpDestinationAuthCustomHeaderType(arg: None)¶

class CustomDestinationHttpDestinationAuthCustomHeaderType(arg: ModelComposed)

class CustomDestinationHttpDestinationAuthCustomHeaderType(*args, **kwargs)

Bases: ModelSimple

Type of the custom header access authentication.

Parameters:

value (str) – If omitted defaults to “custom_header”. Must be one of [“custom_header”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_response module¶

class CustomDestinationResponse(arg: None)¶

class CustomDestinationResponse(arg: ModelComposed)

class CustomDestinationResponse(*args, **kwargs)

Bases: ModelNormal

The custom destination.

Parameters:: data (CustomDestinationResponseDefinition, optional) – The definition of a custom destination.

datadog_api_client.v2.model.custom_destination_response_attributes module¶

class CustomDestinationResponseAttributes(arg: None)¶

class CustomDestinationResponseAttributes(arg: ModelComposed)

class CustomDestinationResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes associated with the custom destination.

Parameters:

enabled (bool, optional) – Whether logs matching this custom destination should be forwarded or not.
forward_tags (bool, optional) – Whether tags from the forwarded logs should be forwarded or not.
forward_tags_restriction_list ([str], optional) –
List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be forwarded depending on forward_tags_restriction_list_type parameter.
forward_tags_restriction_list_type (CustomDestinationAttributeTagsRestrictionListType, optional) –
How forward_tags_restriction_list parameter should be interpreted. If ALLOW_LIST , then only tags whose keys on the forwarded logs match the ones on the restriction list are forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list.
forwarder_destination (CustomDestinationResponseForwardDestination, optional) – A custom destination’s location to forward logs.
name (str, optional) – The custom destination name.
query (str, optional) – The custom destination query filter. Logs matching this query are forwarded to the destination.

datadog_api_client.v2.model.custom_destination_response_definition module¶

class CustomDestinationResponseDefinition(arg: None)¶

class CustomDestinationResponseDefinition(arg: ModelComposed)

class CustomDestinationResponseDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of a custom destination.

Parameters:

attributes (CustomDestinationResponseAttributes, optional) – The attributes associated with the custom destination.
id (str, optional) – The custom destination ID.
type (CustomDestinationType, optional) – The type of the resource. The value should always be custom_destination.

datadog_api_client.v2.model.custom_destination_response_elasticsearch_destination_auth module¶

class CustomDestinationResponseElasticsearchDestinationAuth(arg: None)¶

class CustomDestinationResponseElasticsearchDestinationAuth(arg: ModelComposed)

class CustomDestinationResponseElasticsearchDestinationAuth(*args, **kwargs)

Bases: ModelNormal

Basic access authentication.

datadog_api_client.v2.model.custom_destination_response_forward_destination module¶

class CustomDestinationResponseForwardDestination(arg: None)¶

class CustomDestinationResponseForwardDestination(arg: ModelComposed)

class CustomDestinationResponseForwardDestination(*args, **kwargs)

Bases: ModelComposed

A custom destination’s location to forward logs.

Parameters:

auth (CustomDestinationResponseHttpDestinationAuth) – Authentication method of the HTTP requests.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type (CustomDestinationResponseForwardDestinationHttpType) – Type of the HTTP destination.
index_name (str) – Name of the Elasticsearch index (must follow [Elasticsearch’s criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)).
index_rotation (str, optional) –
Date pattern with US locale and UTC timezone to be appended to the index name after adding - (that is, ${index_name}-${indexPattern}). You can customize the index rotation naming pattern by choosing one of these options: - Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09) - Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19) - Weekly: yyyy-‘W’ww (as an example, it would render: 2022-W42) - Monthly: yyyy-MM (as an example, it would render: 2022-10)

If this field is missing or is blank, it means that the index name will always be the same (that is, no rotation).
client_id (str) – Client ID from the Datadog Azure integration.
data_collection_endpoint (str) – Azure data collection endpoint.
data_collection_rule_id (str) – Azure data collection rule ID.
stream_name (str) – Azure stream name.
tenant_id (str) – Tenant ID from the Datadog Azure integration.

datadog_api_client.v2.model.custom_destination_response_forward_destination_elasticsearch module¶

class CustomDestinationResponseForwardDestinationElasticsearch(arg: None)¶

class CustomDestinationResponseForwardDestinationElasticsearch(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationElasticsearch(*args, **kwargs)

Bases: ModelNormal

The Elasticsearch destination.

Parameters:

auth (CustomDestinationResponseElasticsearchDestinationAuth) – Basic access authentication.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
index_name (str) –
Name of the Elasticsearch index (must follow Elasticsearch’s criteria ).
index_rotation (str, optional) –
Date pattern with US locale and UTC timezone to be appended to the index name after adding - (that is, ${index_name}-${indexPattern} ). You can customize the index rotation naming pattern by choosing one of these options:
- Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09 )
- Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19 )
- Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42 )
- Monthly: yyyy-MM (as an example, it would render: 2022-10 )
If this field is missing or is blank, it means that the index name will always be the same (that is, no rotation).
type (CustomDestinationResponseForwardDestinationElasticsearchType) – Type of the Elasticsearch destination.

datadog_api_client.v2.model.custom_destination_response_forward_destination_elasticsearch_type module¶

class CustomDestinationResponseForwardDestinationElasticsearchType(arg: None)¶

class CustomDestinationResponseForwardDestinationElasticsearchType(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationElasticsearchType(*args, **kwargs)

Bases: ModelSimple

Type of the Elasticsearch destination.

Parameters:

value (str) – If omitted defaults to “elasticsearch”. Must be one of [“elasticsearch”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_response_forward_destination_http module¶

class CustomDestinationResponseForwardDestinationHttp(arg: None)¶

class CustomDestinationResponseForwardDestinationHttp(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationHttp(*args, **kwargs)

Bases: ModelNormal

The HTTP destination.

Parameters:

auth (CustomDestinationResponseHttpDestinationAuth) – Authentication method of the HTTP requests.
endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type (CustomDestinationResponseForwardDestinationHttpType) – Type of the HTTP destination.

datadog_api_client.v2.model.custom_destination_response_forward_destination_http_type module¶

class CustomDestinationResponseForwardDestinationHttpType(arg: None)¶

class CustomDestinationResponseForwardDestinationHttpType(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationHttpType(*args, **kwargs)

Bases: ModelSimple

Type of the HTTP destination.

Parameters:

value (str) – If omitted defaults to “http”. Must be one of [“http”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_response_forward_destination_microsoft_sentinel module¶

class CustomDestinationResponseForwardDestinationMicrosoftSentinel(arg: None)¶

class CustomDestinationResponseForwardDestinationMicrosoftSentinel(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationMicrosoftSentinel(*args, **kwargs)

Bases: ModelNormal

The Microsoft Sentinel destination.

Parameters:

client_id (str) – Client ID from the Datadog Azure integration.
data_collection_endpoint (str) – Azure data collection endpoint.
data_collection_rule_id (str) – Azure data collection rule ID.
stream_name (str) – Azure stream name.
tenant_id (str) – Tenant ID from the Datadog Azure integration.
type (CustomDestinationResponseForwardDestinationMicrosoftSentinelType) – Type of the Microsoft Sentinel destination.

datadog_api_client.v2.model.custom_destination_response_forward_destination_microsoft_sentinel_type module¶

class CustomDestinationResponseForwardDestinationMicrosoftSentinelType(arg: None)¶

class CustomDestinationResponseForwardDestinationMicrosoftSentinelType(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationMicrosoftSentinelType(*args, **kwargs)

Bases: ModelSimple

Type of the Microsoft Sentinel destination.

Parameters:

value (str) – If omitted defaults to “microsoft_sentinel”. Must be one of [“microsoft_sentinel”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_response_forward_destination_splunk module¶

class CustomDestinationResponseForwardDestinationSplunk(arg: None)¶

class CustomDestinationResponseForwardDestinationSplunk(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationSplunk(*args, **kwargs)

Bases: ModelNormal

The Splunk HTTP Event Collector (HEC) destination.

Parameters:

endpoint (str) – The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.
type (CustomDestinationResponseForwardDestinationSplunkType) – Type of the Splunk HTTP Event Collector (HEC) destination.

datadog_api_client.v2.model.custom_destination_response_forward_destination_splunk_type module¶

class CustomDestinationResponseForwardDestinationSplunkType(arg: None)¶

class CustomDestinationResponseForwardDestinationSplunkType(arg: ModelComposed)

class CustomDestinationResponseForwardDestinationSplunkType(*args, **kwargs)

Bases: ModelSimple

Type of the Splunk HTTP Event Collector (HEC) destination.

Parameters:

value (str) – If omitted defaults to “splunk_hec”. Must be one of [“splunk_hec”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_response_http_destination_auth module¶

class CustomDestinationResponseHttpDestinationAuth(arg: None)¶

class CustomDestinationResponseHttpDestinationAuth(arg: ModelComposed)

class CustomDestinationResponseHttpDestinationAuth(*args, **kwargs)

Bases: ModelComposed

Authentication method of the HTTP requests.

Parameters:

type (CustomDestinationResponseHttpDestinationAuthBasicType) – Type of the basic access authentication.
header_name (str) – The header name of the authentication.

datadog_api_client.v2.model.custom_destination_response_http_destination_auth_basic module¶

class CustomDestinationResponseHttpDestinationAuthBasic(arg: None)¶

class CustomDestinationResponseHttpDestinationAuthBasic(arg: ModelComposed)

class CustomDestinationResponseHttpDestinationAuthBasic(*args, **kwargs)

Bases: ModelNormal

Basic access authentication.

Parameters:: type (CustomDestinationResponseHttpDestinationAuthBasicType) – Type of the basic access authentication.

datadog_api_client.v2.model.custom_destination_response_http_destination_auth_basic_type module¶

class CustomDestinationResponseHttpDestinationAuthBasicType(arg: None)¶

class CustomDestinationResponseHttpDestinationAuthBasicType(arg: ModelComposed)

class CustomDestinationResponseHttpDestinationAuthBasicType(*args, **kwargs)

Bases: ModelSimple

Type of the basic access authentication.

Parameters:

value (str) – If omitted defaults to “basic”. Must be one of [“basic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_response_http_destination_auth_custom_header module¶

class CustomDestinationResponseHttpDestinationAuthCustomHeader(arg: None)¶

class CustomDestinationResponseHttpDestinationAuthCustomHeader(arg: ModelComposed)

class CustomDestinationResponseHttpDestinationAuthCustomHeader(*args, **kwargs)

Bases: ModelNormal

Custom header access authentication.

Parameters:

header_name (str) – The header name of the authentication.
type (CustomDestinationResponseHttpDestinationAuthCustomHeaderType) – Type of the custom header access authentication.

datadog_api_client.v2.model.custom_destination_response_http_destination_auth_custom_header_type module¶

class CustomDestinationResponseHttpDestinationAuthCustomHeaderType(arg: None)¶

class CustomDestinationResponseHttpDestinationAuthCustomHeaderType(arg: ModelComposed)

class CustomDestinationResponseHttpDestinationAuthCustomHeaderType(*args, **kwargs)

Bases: ModelSimple

Type of the custom header access authentication.

Parameters:

value (str) – If omitted defaults to “custom_header”. Must be one of [“custom_header”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_type module¶

class CustomDestinationType(arg: None)¶

class CustomDestinationType(arg: ModelComposed)

class CustomDestinationType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be custom_destination.

Parameters:

value (str) – If omitted defaults to “custom_destination”. Must be one of [“custom_destination”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_destination_update_request module¶

class CustomDestinationUpdateRequest(arg: None)¶

class CustomDestinationUpdateRequest(arg: ModelComposed)

class CustomDestinationUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The custom destination.

Parameters:: data (CustomDestinationUpdateRequestDefinition, optional) – The definition of a custom destination.

datadog_api_client.v2.model.custom_destination_update_request_attributes module¶

class CustomDestinationUpdateRequestAttributes(arg: None)¶

class CustomDestinationUpdateRequestAttributes(arg: ModelComposed)

class CustomDestinationUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes associated with the custom destination.

Parameters:

enabled (bool, optional) – Whether logs matching this custom destination should be forwarded or not.
forward_tags (bool, optional) – Whether tags from the forwarded logs should be forwarded or not.
forward_tags_restriction_list ([str], optional) –
List of keys of tags to be restricted from being forwarded. An empty list represents no restriction is in place and either all or no tags will be forwarded depending on forward_tags_restriction_list_type parameter.
forward_tags_restriction_list_type (CustomDestinationAttributeTagsRestrictionListType, optional) –
How forward_tags_restriction_list parameter should be interpreted. If ALLOW_LIST , then only tags whose keys on the forwarded logs match the ones on the restriction list are forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list.
forwarder_destination (CustomDestinationForwardDestination, optional) – A custom destination’s location to forward logs.
name (str, optional) – The custom destination name.
query (str, optional) – The custom destination query and filter. Logs matching this query are forwarded to the destination.

datadog_api_client.v2.model.custom_destination_update_request_definition module¶

class CustomDestinationUpdateRequestDefinition(arg: None)¶

class CustomDestinationUpdateRequestDefinition(arg: ModelComposed)

class CustomDestinationUpdateRequestDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of a custom destination.

Parameters:

attributes (CustomDestinationUpdateRequestAttributes, optional) – The attributes associated with the custom destination.
id (str) – The custom destination ID.
type (CustomDestinationType) – The type of the resource. The value should always be custom_destination.

datadog_api_client.v2.model.custom_destinations_response module¶

class CustomDestinationsResponse(arg: None)¶

class CustomDestinationsResponse(arg: ModelComposed)

class CustomDestinationsResponse(*args, **kwargs)

Bases: ModelNormal

The available custom destinations.

Parameters:: data ([CustomDestinationResponseDefinition], optional) – A list of custom destinations.

datadog_api_client.v2.model.custom_framework_control module¶

class CustomFrameworkControl(arg: None)¶

class CustomFrameworkControl(arg: ModelComposed)

class CustomFrameworkControl(*args, **kwargs)

Bases: ModelNormal

Framework Control.

Parameters:

name (str) – Control Name.
rules_id ([str]) – Rule IDs.

datadog_api_client.v2.model.custom_framework_data module¶

class CustomFrameworkData(arg: None)¶

class CustomFrameworkData(arg: ModelComposed)

class CustomFrameworkData(*args, **kwargs)

Bases: ModelNormal

Contains type and attributes for custom frameworks.

Parameters:

attributes (CustomFrameworkDataAttributes) – Framework Data Attributes.
type (CustomFrameworkType) – The type of the resource. The value must be custom_framework.

datadog_api_client.v2.model.custom_framework_data_attributes module¶

class CustomFrameworkDataAttributes(arg: None)¶

class CustomFrameworkDataAttributes(arg: ModelComposed)

class CustomFrameworkDataAttributes(*args, **kwargs)

Bases: ModelNormal

Framework Data Attributes.

Parameters:

description (str, optional) – Framework Description
handle (str) – Framework Handle
icon_url (str, optional) – Framework Icon URL
name (str) – Framework Name
requirements ([CustomFrameworkRequirement]) – Framework Requirements
version (str) – Framework Version

datadog_api_client.v2.model.custom_framework_metadata module¶

class CustomFrameworkMetadata(arg: None)¶

class CustomFrameworkMetadata(arg: ModelComposed)

class CustomFrameworkMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata for custom frameworks.

Parameters:

attributes (CustomFrameworkWithoutRequirements, optional) – Framework without requirements.
id (str, optional) – The ID of the custom framework.
type (CustomFrameworkType, optional) – The type of the resource. The value must be custom_framework.

datadog_api_client.v2.model.custom_framework_requirement module¶

class CustomFrameworkRequirement(arg: None)¶

class CustomFrameworkRequirement(arg: ModelComposed)

class CustomFrameworkRequirement(*args, **kwargs)

Bases: ModelNormal

Framework Requirement.

Parameters:

controls ([CustomFrameworkControl]) – Requirement Controls.
name (str) – Requirement Name.

datadog_api_client.v2.model.custom_framework_type module¶

class CustomFrameworkType(arg: None)¶

class CustomFrameworkType(arg: ModelComposed)

class CustomFrameworkType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value must be custom_framework.

Parameters:

value (str) – If omitted defaults to “custom_framework”. Must be one of [“custom_framework”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.custom_framework_without_requirements module¶

class CustomFrameworkWithoutRequirements(arg: None)¶

class CustomFrameworkWithoutRequirements(arg: ModelComposed)

class CustomFrameworkWithoutRequirements(*args, **kwargs)

Bases: ModelNormal

Framework without requirements.

Parameters:

description (str, optional) – Framework Description
handle (str) – Framework Handle
icon_url (str, optional) – Framework Icon URL
name (str) – Framework Name
version (str) – Framework Version

datadog_api_client.v2.model.cvss module¶

class CVSS(arg: None)¶

class CVSS(arg: ModelComposed)

class CVSS(*args, **kwargs)

Bases: ModelNormal

Vulnerability severity.

Parameters:

score (float) – Vulnerability severity score.
severity (VulnerabilitySeverity) – The vulnerability severity.
vector (str) – Vulnerability CVSS vector.

datadog_api_client.v2.model.dashboard_list_add_items_request module¶

class DashboardListAddItemsRequest(arg: None)¶

class DashboardListAddItemsRequest(arg: ModelComposed)

class DashboardListAddItemsRequest(*args, **kwargs)

Bases: ModelNormal

Request containing a list of dashboards to add.

Parameters:: dashboards ([DashboardListItemRequest], optional) – List of dashboards to add the dashboard list.

datadog_api_client.v2.model.dashboard_list_add_items_response module¶

class DashboardListAddItemsResponse(arg: None)¶

class DashboardListAddItemsResponse(arg: ModelComposed)

class DashboardListAddItemsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of added dashboards.

Parameters:: added_dashboards_to_list ([DashboardListItemResponse], optional) – List of dashboards added to the dashboard list.

datadog_api_client.v2.model.dashboard_list_delete_items_request module¶

class DashboardListDeleteItemsRequest(arg: None)¶

class DashboardListDeleteItemsRequest(arg: ModelComposed)

class DashboardListDeleteItemsRequest(*args, **kwargs)

Bases: ModelNormal

Request containing a list of dashboards to delete.

Parameters:: dashboards ([DashboardListItemRequest], optional) – List of dashboards to delete from the dashboard list.

datadog_api_client.v2.model.dashboard_list_delete_items_response module¶

class DashboardListDeleteItemsResponse(arg: None)¶

class DashboardListDeleteItemsResponse(arg: ModelComposed)

class DashboardListDeleteItemsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of deleted dashboards.

Parameters:: deleted_dashboards_from_list ([DashboardListItemResponse], optional) – List of dashboards deleted from the dashboard list.

datadog_api_client.v2.model.dashboard_list_item module¶

class DashboardListItem(arg: None)¶

class DashboardListItem(arg: ModelComposed)

class DashboardListItem(*args, **kwargs)

Bases: ModelNormal

A dashboard within a list.

Parameters:

author (Creator, optional) – Creator of the object.
created (datetime, optional) – Date of creation of the dashboard.
icon (str, none_type, optional) – URL to the icon of the dashboard.
id (str) – ID of the dashboard.
integration_id (str, none_type, optional) – The short name of the integration.
is_favorite (bool, optional) – Whether or not the dashboard is in the favorites.
is_read_only (bool, optional) – Whether or not the dashboard is read only.
is_shared (bool, optional) – Whether the dashboard is publicly shared or not.
modified (datetime, optional) – Date of last edition of the dashboard.
popularity (int, optional) – Popularity of the dashboard.
tags ([str], none_type, optional) – List of team names representing ownership of a dashboard.
title (str, optional) – Title of the dashboard.
type (DashboardType) – The type of the dashboard.
url (str, optional) – URL path to the dashboard.

datadog_api_client.v2.model.dashboard_list_item_request module¶

class DashboardListItemRequest(arg: None)¶

class DashboardListItemRequest(arg: ModelComposed)

class DashboardListItemRequest(*args, **kwargs)

Bases: ModelNormal

A dashboard within a list.

Parameters:

id (str) – ID of the dashboard.
type (DashboardType) – The type of the dashboard.

datadog_api_client.v2.model.dashboard_list_item_response module¶

class DashboardListItemResponse(arg: None)¶

class DashboardListItemResponse(arg: ModelComposed)

class DashboardListItemResponse(*args, **kwargs)

Bases: ModelNormal

A dashboard within a list.

Parameters:

id (str) – ID of the dashboard.
type (DashboardType) – The type of the dashboard.

datadog_api_client.v2.model.dashboard_list_items module¶

class DashboardListItems(arg: None)¶

class DashboardListItems(arg: ModelComposed)

class DashboardListItems(*args, **kwargs)

Bases: ModelNormal

Dashboards within a list.

Parameters:

dashboards ([DashboardListItem]) – List of dashboards in the dashboard list.
total (int, optional) – Number of dashboards in the dashboard list.

datadog_api_client.v2.model.dashboard_list_update_items_request module¶

class DashboardListUpdateItemsRequest(arg: None)¶

class DashboardListUpdateItemsRequest(arg: ModelComposed)

class DashboardListUpdateItemsRequest(*args, **kwargs)

Bases: ModelNormal

Request containing the list of dashboards to update to.

Parameters:: dashboards ([DashboardListItemRequest], optional) – List of dashboards to update the dashboard list to.

datadog_api_client.v2.model.dashboard_list_update_items_response module¶

class DashboardListUpdateItemsResponse(arg: None)¶

class DashboardListUpdateItemsResponse(arg: ModelComposed)

class DashboardListUpdateItemsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of updated dashboards.

Parameters:: dashboards ([DashboardListItemResponse], optional) – List of dashboards in the dashboard list.

datadog_api_client.v2.model.dashboard_trigger_wrapper module¶

class DashboardTriggerWrapper(arg: None)¶

class DashboardTriggerWrapper(arg: ModelComposed)

class DashboardTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Dashboard-based trigger.

Parameters:

dashboard_trigger (dict) – Trigger a workflow from a Dashboard.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.dashboard_type module¶

class DashboardType(arg: None)¶

class DashboardType(arg: ModelComposed)

class DashboardType(*args, **kwargs)

Bases: ModelSimple

The type of the dashboard.

Parameters:

value (str) – Must be one of [“custom_timeboard”, “custom_screenboard”, “integration_screenboard”, “integration_timeboard”, “host_timeboard”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.data_deletion_response_item module¶

class DataDeletionResponseItem(arg: None)¶

class DataDeletionResponseItem(arg: ModelComposed)

class DataDeletionResponseItem(*args, **kwargs)

Bases: ModelNormal

The created data deletion request information.

Parameters:

attributes (DataDeletionResponseItemAttributes) – Deletion attribute for data deletion response.
id (str) – The ID of the created data deletion request.
type (str) – The type of the request created.

datadog_api_client.v2.model.data_deletion_response_item_attributes module¶

class DataDeletionResponseItemAttributes(arg: None)¶

class DataDeletionResponseItemAttributes(arg: ModelComposed)

class DataDeletionResponseItemAttributes(*args, **kwargs)

Bases: ModelNormal

Deletion attribute for data deletion response.

Parameters:

created_at (str) – Creation time of the deletion request.
created_by (str) – User who created the deletion request.
from_time (int) – Start of requested time window, milliseconds since Unix epoch.
indexes ([str], optional) – List of indexes for the search. If not provided, the search is performed in all indexes.
is_created (bool) – Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.
org_id (int) – Organization ID.
product (str) – Product name.
query (str) – Query for creating a data deletion request.
starting_at (str) – Starting time of the process to delete the requested data.
status (str) – Status of the deletion request.
to_time (int) – End of requested time window, milliseconds since Unix epoch.
total_unrestricted (int) – Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.
updated_at (str) – Update time of the deletion request.

datadog_api_client.v2.model.data_deletion_response_meta module¶

class DataDeletionResponseMeta(arg: None)¶

class DataDeletionResponseMeta(arg: ModelComposed)

class DataDeletionResponseMeta(*args, **kwargs)

Bases: ModelNormal

The metadata of the data deletion response.

Parameters:

count_product ({str: (int,)}, optional) – The total deletion requests created by product.
count_status ({str: (int,)}, optional) – The total deletion requests created by status.
next_page (str, optional) – The next page when searching deletion requests created in the current organization.
product (str, optional) – The product of the deletion request.
request_status (str, optional) – The status of the executed request.

datadog_api_client.v2.model.data_relationships_teams module¶

class DataRelationshipsTeams(arg: None)¶

class DataRelationshipsTeams(arg: ModelComposed)

class DataRelationshipsTeams(*args, **kwargs)

Bases: ModelNormal

Associates teams with this schedule in a data structure.

Parameters:: data ([DataRelationshipsTeamsDataItems], optional) – An array of team references for this schedule.

datadog_api_client.v2.model.data_relationships_teams_data_items module¶

class DataRelationshipsTeamsDataItems(arg: None)¶

class DataRelationshipsTeamsDataItems(arg: ModelComposed)

class DataRelationshipsTeamsDataItems(*args, **kwargs)

Bases: ModelNormal

Relates a team to this schedule, identified by id and type (must be teams ).

Parameters:

id (str) – The unique identifier of the team in this relationship.
type (DataRelationshipsTeamsDataItemsType) – Teams resource type.

datadog_api_client.v2.model.data_relationships_teams_data_items_type module¶

class DataRelationshipsTeamsDataItemsType(arg: None)¶

class DataRelationshipsTeamsDataItemsType(arg: ModelComposed)

class DataRelationshipsTeamsDataItemsType(*args, **kwargs)

Bases: ModelSimple

Teams resource type.

Parameters:

value (str) – If omitted defaults to “teams”. Must be one of [“teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.data_scalar_column module¶

class DataScalarColumn(arg: None)¶

class DataScalarColumn(arg: ModelComposed)

class DataScalarColumn(*args, **kwargs)

Bases: ModelNormal

A column containing the numerical results for a formula or query.

Parameters:

meta (ScalarMeta, optional) – Metadata for the resulting numerical values.
name (str, optional) – The name referencing the formula or query for this column.
type (ScalarColumnTypeNumber, optional) – The type of column present for numbers.
values ([float, none_type], optional) – The array of numerical values for one formula or query.

datadog_api_client.v2.model.data_transform module¶

class DataTransform(arg: None)¶

class DataTransform(arg: ModelComposed)

class DataTransform(*args, **kwargs)

Bases: ModelNormal

A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change.

Parameters:

id (UUID) – The ID of the data transformer.
name (str) – A unique identifier for this data transformer. This name is also used to access the transformer’s result throughout the app.
properties (DataTransformProperties) – The properties of the data transformer.
type (DataTransformType) – The data transform type.

datadog_api_client.v2.model.data_transform_properties module¶

class DataTransformProperties(arg: None)¶

class DataTransformProperties(arg: ModelComposed)

class DataTransformProperties(*args, **kwargs)

Bases: ModelNormal

The properties of the data transformer.

Parameters:: outputs (str, optional) – A JavaScript function that returns the transformed data.

datadog_api_client.v2.model.data_transform_type module¶

class DataTransformType(arg: None)¶

class DataTransformType(arg: ModelComposed)

class DataTransformType(*args, **kwargs)

Bases: ModelSimple

The data transform type.

Parameters:

value (str) – If omitted defaults to “dataTransform”. Must be one of [“dataTransform”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.database_monitoring_trigger_wrapper module¶

class DatabaseMonitoringTriggerWrapper(arg: None)¶

class DatabaseMonitoringTriggerWrapper(arg: ModelComposed)

class DatabaseMonitoringTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Database Monitoring-based trigger.

Parameters:

database_monitoring_trigger (dict) – Trigger a workflow from Database Monitoring.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.datadog_api_key module¶

class DatadogAPIKey(arg: None)¶

class DatadogAPIKey(arg: ModelComposed)

class DatadogAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the DatadogAPIKey object.

Parameters:

api_key (str) – The DatadogAPIKey api_key.
app_key (str) – The DatadogAPIKey app_key.
datacenter (str) – The DatadogAPIKey datacenter.
subdomain (str, optional) – Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses https://acme.datadoghq.com to access Datadog, set this field to acme. If this field is omitted, generated URLs will use the default site URL for its datacenter (see https://docs.datadoghq.com/getting_started/site ).
type (DatadogAPIKeyType) – The definition of the DatadogAPIKey object.

datadog_api_client.v2.model.datadog_api_key_type module¶

class DatadogAPIKeyType(arg: None)¶

class DatadogAPIKeyType(arg: ModelComposed)

class DatadogAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the DatadogAPIKey object.

Parameters:

value (str) – If omitted defaults to “DatadogAPIKey”. Must be one of [“DatadogAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.datadog_api_key_update module¶

class DatadogAPIKeyUpdate(arg: None)¶

class DatadogAPIKeyUpdate(arg: ModelComposed)

class DatadogAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the DatadogAPIKey object.

Parameters:

api_key (str, optional) – The DatadogAPIKeyUpdate api_key.
app_key (str, optional) – The DatadogAPIKeyUpdate app_key.
datacenter (str, optional) – The DatadogAPIKeyUpdate datacenter.
subdomain (str, optional) –
Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses https://acme.datadoghq.com to access Datadog, set this field to acme. If this field is omitted, generated URLs will use the default site URL for its datacenter (see https://docs.datadoghq.com/getting_started/site ).
type (DatadogAPIKeyType) – The definition of the DatadogAPIKey object.

datadog_api_client.v2.model.datadog_credentials module¶

class DatadogCredentials(arg: None)¶

class DatadogCredentials(arg: ModelComposed)

class DatadogCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the DatadogCredentials object.

Parameters:

api_key (str) – The DatadogAPIKey api_key.
app_key (str) – The DatadogAPIKey app_key.
datacenter (str) – The DatadogAPIKey datacenter.
subdomain (str, optional) – Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses https://acme.datadoghq.com to access Datadog, set this field to acme. If this field is omitted, generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)).
type (DatadogAPIKeyType) – The definition of the DatadogAPIKey object.

datadog_api_client.v2.model.datadog_credentials_update module¶

class DatadogCredentialsUpdate(arg: None)¶

class DatadogCredentialsUpdate(arg: ModelComposed)

class DatadogCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the DatadogCredentialsUpdate object.

Parameters:

api_key (str, optional) – The DatadogAPIKeyUpdate api_key.
app_key (str, optional) – The DatadogAPIKeyUpdate app_key.
datacenter (str, optional) – The DatadogAPIKeyUpdate datacenter.
subdomain (str, optional) – Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses https://acme.datadoghq.com to access Datadog, set this field to acme. If this field is omitted, generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)).
type (DatadogAPIKeyType) – The definition of the DatadogAPIKey object.

datadog_api_client.v2.model.datadog_integration module¶

class DatadogIntegration(arg: None)¶

class DatadogIntegration(arg: ModelComposed)

class DatadogIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the DatadogIntegration object.

Parameters:

credentials (DatadogCredentials) – The definition of the DatadogCredentials object.
type (DatadogIntegrationType) – The definition of the DatadogIntegrationType object.

datadog_api_client.v2.model.datadog_integration_type module¶

class DatadogIntegrationType(arg: None)¶

class DatadogIntegrationType(arg: ModelComposed)

class DatadogIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the DatadogIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Datadog”. Must be one of [“Datadog”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.datadog_integration_update module¶

class DatadogIntegrationUpdate(arg: None)¶

class DatadogIntegrationUpdate(arg: ModelComposed)

class DatadogIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the DatadogIntegrationUpdate object.

Parameters:

credentials (DatadogCredentialsUpdate, optional) – The definition of the DatadogCredentialsUpdate object.
type (DatadogIntegrationType) – The definition of the DatadogIntegrationType object.

datadog_api_client.v2.model.dataset_attributes_request module¶

class DatasetAttributesRequest(arg: None)¶

class DatasetAttributesRequest(arg: ModelComposed)

class DatasetAttributesRequest(*args, **kwargs)

Bases: ModelNormal

Dataset metadata and configurations.

Parameters:

name (str) – Name of the dataset.
principals ([str]) – List of access principals, formatted as principal_type:id. Principal can be ‘team’ or ‘role’.
product_filters ([FiltersPerProduct]) – List of product-specific filters.

datadog_api_client.v2.model.dataset_attributes_response module¶

class DatasetAttributesResponse(arg: None)¶

class DatasetAttributesResponse(arg: ModelComposed)

class DatasetAttributesResponse(*args, **kwargs)

Bases: ModelNormal

Dataset metadata and configuration(s).

Parameters:

created_at (datetime, none_type, optional) – Timestamp when the dataset was created.
created_by (UUID, optional) – Unique ID of the user who created the dataset.
name (str, optional) – Name of the dataset.
principals ([str], optional) – List of access principals, formatted as principal_type:id. Principal can be ‘team’ or ‘role’.
product_filters ([FiltersPerProduct], optional) – List of product-specific filters.

datadog_api_client.v2.model.dataset_create_request module¶

class DatasetCreateRequest(arg: None)¶

class DatasetCreateRequest(arg: ModelComposed)

class DatasetCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for a dataset.

Parameters:

data (DatasetRequest) –

Datasets Object Constraints

Tag limit per dataset :
- Each restricted dataset supports a maximum of 10 key:value pairs per product.
Tag key rules per telemetry type :
- Only one tag key or attribute may be used to define access within a single telemetry type.
- The same or different tag key may be used across different telemetry types.
Tag value uniqueness :
- Tag values must be unique within a single dataset.
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.

datadog_api_client.v2.model.dataset_request module¶

class DatasetRequest(arg: None)¶

class DatasetRequest(arg: ModelComposed)

class DatasetRequest(*args, **kwargs)

Bases: ModelNormal

Datasets Object Constraints

Tag limit per dataset :
- Each restricted dataset supports a maximum of 10 key:value pairs per product.
Tag key rules per telemetry type :
- Only one tag key or attribute may be used to define access within a single telemetry type.
- The same or different tag key may be used across different telemetry types.
Tag value uniqueness :
- Tag values must be unique within a single dataset.
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.

Parameters:

attributes (DatasetAttributesRequest) – Dataset metadata and configurations.
type (DatasetType) – Resource type, always set to dataset.

datadog_api_client.v2.model.dataset_response module¶

class DatasetResponse(arg: None)¶

class DatasetResponse(arg: ModelComposed)

class DatasetResponse(*args, **kwargs)

Bases: ModelNormal

Datasets Object Constraints

Tag Limit per Dataset :
- Each restricted dataset supports a maximum of 10 key:value pairs per product.
Tag Key Rules per Telemetry Type :
- Only one tag key or attribute may be used to define access within a single telemetry type.
- The same or different tag key may be used across different telemetry types.
Tag Value Uniqueness :
- Tag values must be unique within a single dataset.
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.

Parameters:

attributes (DatasetAttributesResponse, optional) – Dataset metadata and configuration(s).
id (str, optional) – Unique identifier for the dataset.
type (DatasetType, optional) – Resource type, always set to dataset.

datadog_api_client.v2.model.dataset_response_multi module¶

class DatasetResponseMulti(arg: None)¶

class DatasetResponseMulti(arg: ModelComposed)

class DatasetResponseMulti(*args, **kwargs)

Bases: ModelNormal

Response containing a list of datasets.

Parameters:: data ([DatasetResponse], optional) – The list of datasets returned in response.

datadog_api_client.v2.model.dataset_response_single module¶

class DatasetResponseSingle(arg: None)¶

class DatasetResponseSingle(arg: ModelComposed)

class DatasetResponseSingle(*args, **kwargs)

Bases: ModelNormal

Response containing a single dataset object.

Parameters:

data (DatasetResponse, optional) –

Datasets Object Constraints

Tag Limit per Dataset :
- Each restricted dataset supports a maximum of 10 key:value pairs per product.
Tag Key Rules per Telemetry Type :
- Only one tag key or attribute may be used to define access within a single telemetry type.
- The same or different tag key may be used across different telemetry types.
Tag Value Uniqueness :
- Tag values must be unique within a single dataset.
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.

datadog_api_client.v2.model.dataset_type module¶

class DatasetType(arg: None)¶

class DatasetType(arg: ModelComposed)

class DatasetType(*args, **kwargs)

Bases: ModelSimple

Resource type, always set to dataset.

Parameters:

value (str) – If omitted defaults to “dataset”. Must be one of [“dataset”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.dataset_update_request module¶

class DatasetUpdateRequest(arg: None)¶

class DatasetUpdateRequest(arg: ModelComposed)

class DatasetUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Edit request for a dataset.

Parameters:

data (DatasetRequest) –

Datasets Object Constraints

Tag limit per dataset :
- Each restricted dataset supports a maximum of 10 key:value pairs per product.
Tag key rules per telemetry type :
- Only one tag key or attribute may be used to define access within a single telemetry type.
- The same or different tag key may be used across different telemetry types.
Tag value uniqueness :
- Tag values must be unique within a single dataset.
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.

datadog_api_client.v2.model.datastore module¶

class Datastore(arg: None)¶

class Datastore(arg: ModelComposed)

class Datastore(*args, **kwargs)

Bases: ModelNormal

A datastore’s complete configuration and metadata.

Parameters:: data (DatastoreData, optional) – Core information about a datastore, including its unique identifier and attributes.

datadog_api_client.v2.model.datastore_array module¶

class DatastoreArray(arg: None)¶

class DatastoreArray(arg: ModelComposed)

class DatastoreArray(*args, **kwargs)

Bases: ModelNormal

A collection of datastores returned by list operations.

Parameters:: data ([DatastoreData]) – An array of datastore objects containing their configurations and metadata.

datadog_api_client.v2.model.datastore_data module¶

class DatastoreData(arg: None)¶

class DatastoreData(arg: ModelComposed)

class DatastoreData(*args, **kwargs)

Bases: ModelNormal

Core information about a datastore, including its unique identifier and attributes.

Parameters:

attributes (DatastoreDataAttributes, optional) – Detailed information about a datastore.
id (str, optional) – The unique identifier of the datastore.
type (DatastoreDataType) – The resource type for datastores.

datadog_api_client.v2.model.datastore_data_attributes module¶

class DatastoreDataAttributes(arg: None)¶

class DatastoreDataAttributes(arg: ModelComposed)

class DatastoreDataAttributes(*args, **kwargs)

Bases: ModelNormal

Detailed information about a datastore.

Parameters:

created_at (datetime, optional) – Timestamp when the datastore was created.
creator_user_id (int, optional) – The numeric ID of the user who created the datastore.
creator_user_uuid (str, optional) – The UUID of the user who created the datastore.
description (str, optional) – A human-readable description about the datastore.
modified_at (datetime, optional) – Timestamp when the datastore was last modified.
name (str, optional) – The display name of the datastore.
org_id (int, optional) – The ID of the organization that owns this datastore.
primary_column_name (str, optional) –
The name of the primary key column for this datastore. Primary column names:
- Must abide by both PostgreSQL naming conventions
- Cannot exceed 63 characters
primary_key_generation_strategy (DatastorePrimaryKeyGenerationStrategy, optional) – Can be set to uuid to automatically generate primary keys when new items are added. Default value is none , which requires you to supply a primary key for each new item.

datadog_api_client.v2.model.datastore_data_type module¶

class DatastoreDataType(arg: None)¶

class DatastoreDataType(arg: ModelComposed)

class DatastoreDataType(*args, **kwargs)

Bases: ModelSimple

The resource type for datastores.

Parameters:

value (str) – If omitted defaults to “datastores”. Must be one of [“datastores”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.datastore_item_conflict_mode module¶

class DatastoreItemConflictMode(arg: None)¶

class DatastoreItemConflictMode(arg: ModelComposed)

class DatastoreItemConflictMode(*args, **kwargs)

Bases: ModelSimple

How to handle conflicts when inserting items that already exist in the datastore.

Parameters:

value (str) – Must be one of [“fail_on_conflict”, “overwrite_on_conflict”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.datastore_items_data_type module¶

class DatastoreItemsDataType(arg: None)¶

class DatastoreItemsDataType(arg: ModelComposed)

class DatastoreItemsDataType(*args, **kwargs)

Bases: ModelSimple

The resource type for datastore items.

Parameters:

value (str) – If omitted defaults to “items”. Must be one of [“items”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.datastore_primary_key_generation_strategy module¶

class DatastorePrimaryKeyGenerationStrategy(arg: None)¶

class DatastorePrimaryKeyGenerationStrategy(arg: ModelComposed)

class DatastorePrimaryKeyGenerationStrategy(*args, **kwargs)

Bases: ModelSimple

Can be set to uuid to automatically generate primary keys when new items are added. Default value is none, which requires you to supply a primary key for each new item.

Parameters:

value (str) – Must be one of [“none”, “uuid”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.datastore_trigger module¶

class DatastoreTrigger(arg: None)¶

class DatastoreTrigger(arg: ModelComposed)

class DatastoreTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.datastore_trigger_wrapper module¶

class DatastoreTriggerWrapper(arg: None)¶

class DatastoreTriggerWrapper(arg: ModelComposed)

class DatastoreTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Datastore-based trigger.

Parameters:

datastore_trigger (DatastoreTrigger) – Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.delete_app_response module¶

class DeleteAppResponse(arg: None)¶

class DeleteAppResponse(arg: ModelComposed)

class DeleteAppResponse(*args, **kwargs)

Bases: ModelNormal

The response object after an app is successfully deleted.

Parameters:: data (DeleteAppResponseData, optional) – The definition of DeleteAppResponseData object.

datadog_api_client.v2.model.delete_app_response_data module¶

class DeleteAppResponseData(arg: None)¶

class DeleteAppResponseData(arg: ModelComposed)

class DeleteAppResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of DeleteAppResponseData object.

Parameters:

id (UUID) – The ID of the deleted app.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.delete_apps_datastore_item_request module¶

class DeleteAppsDatastoreItemRequest(arg: None)¶

class DeleteAppsDatastoreItemRequest(arg: ModelComposed)

class DeleteAppsDatastoreItemRequest(*args, **kwargs)

Bases: ModelNormal

Request to delete a specific item from a datastore by its primary key.

Parameters:: data (DeleteAppsDatastoreItemRequestData, optional) – Data wrapper containing the information needed to identify and delete a specific datastore item.

datadog_api_client.v2.model.delete_apps_datastore_item_request_data module¶

class DeleteAppsDatastoreItemRequestData(arg: None)¶

class DeleteAppsDatastoreItemRequestData(arg: ModelComposed)

class DeleteAppsDatastoreItemRequestData(*args, **kwargs)

Bases: ModelNormal

Data wrapper containing the information needed to identify and delete a specific datastore item.

Parameters:

attributes (DeleteAppsDatastoreItemRequestDataAttributes, optional) – Attributes specifying which datastore item to delete by its primary key.
type (DatastoreItemsDataType) – The resource type for datastore items.

datadog_api_client.v2.model.delete_apps_datastore_item_request_data_attributes module¶

class DeleteAppsDatastoreItemRequestDataAttributes(arg: None)¶

class DeleteAppsDatastoreItemRequestDataAttributes(arg: ModelComposed)

class DeleteAppsDatastoreItemRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes specifying which datastore item to delete by its primary key.

Parameters:

id (str, optional) – Optional unique identifier of the item to delete.
item_key (str) – The primary key value that identifies the item to delete. Cannot exceed 256 characters.

datadog_api_client.v2.model.delete_apps_datastore_item_response module¶

class DeleteAppsDatastoreItemResponse(arg: None)¶

class DeleteAppsDatastoreItemResponse(arg: ModelComposed)

class DeleteAppsDatastoreItemResponse(*args, **kwargs)

Bases: ModelNormal

Response from successfully deleting a datastore item.

Parameters:: data (DeleteAppsDatastoreItemResponseData, optional) – Data containing the identifier of the datastore item that was successfully deleted.

datadog_api_client.v2.model.delete_apps_datastore_item_response_array module¶

class DeleteAppsDatastoreItemResponseArray(arg: None)¶

class DeleteAppsDatastoreItemResponseArray(arg: ModelComposed)

class DeleteAppsDatastoreItemResponseArray(*args, **kwargs)

Bases: ModelNormal

The definition of DeleteAppsDatastoreItemResponseArray object.

Parameters:: data ([DeleteAppsDatastoreItemResponseData]) – The DeleteAppsDatastoreItemResponseArray data.

datadog_api_client.v2.model.delete_apps_datastore_item_response_data module¶

class DeleteAppsDatastoreItemResponseData(arg: None)¶

class DeleteAppsDatastoreItemResponseData(arg: ModelComposed)

class DeleteAppsDatastoreItemResponseData(*args, **kwargs)

Bases: ModelNormal

Data containing the identifier of the datastore item that was successfully deleted.

Parameters:

id (str, optional) – The unique identifier of the item that was deleted.
type (DatastoreItemsDataType) – The resource type for datastore items.

datadog_api_client.v2.model.delete_apps_request module¶

class DeleteAppsRequest(arg: None)¶

class DeleteAppsRequest(arg: ModelComposed)

class DeleteAppsRequest(*args, **kwargs)

Bases: ModelNormal

A request object for deleting multiple apps by ID.

Parameters:: data ([DeleteAppsRequestDataItems], optional) – An array of objects containing the IDs of the apps to delete.

datadog_api_client.v2.model.delete_apps_request_data_items module¶

class DeleteAppsRequestDataItems(arg: None)¶

class DeleteAppsRequestDataItems(arg: ModelComposed)

class DeleteAppsRequestDataItems(*args, **kwargs)

Bases: ModelNormal

An object containing the ID of an app to delete.

Parameters:

id (UUID) – The ID of the app to delete.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.delete_apps_response module¶

class DeleteAppsResponse(arg: None)¶

class DeleteAppsResponse(arg: ModelComposed)

class DeleteAppsResponse(*args, **kwargs)

Bases: ModelNormal

The response object after multiple apps are successfully deleted.

Parameters:: data ([DeleteAppsResponseDataItems], optional) – An array of objects containing the IDs of the deleted apps.

datadog_api_client.v2.model.delete_apps_response_data_items module¶

class DeleteAppsResponseDataItems(arg: None)¶

class DeleteAppsResponseDataItems(arg: ModelComposed)

class DeleteAppsResponseDataItems(*args, **kwargs)

Bases: ModelNormal

An object containing the ID of a deleted app.

Parameters:

id (UUID) – The ID of the deleted app.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.delete_custom_framework_response module¶

class DeleteCustomFrameworkResponse(arg: None)¶

class DeleteCustomFrameworkResponse(arg: ModelComposed)

class DeleteCustomFrameworkResponse(*args, **kwargs)

Bases: ModelNormal

Response object to delete a custom framework.

Parameters:: data (CustomFrameworkMetadata) – Metadata for custom frameworks.

datadog_api_client.v2.model.dependency_location module¶

class DependencyLocation(arg: None)¶

class DependencyLocation(arg: ModelComposed)

class DependencyLocation(*args, **kwargs)

Bases: ModelNormal

Static library vulnerability location.

Parameters:

column_end (int) – Location column end.
column_start (int) – Location column start.
file_name (str) – Location file name.
line_end (int) – Location line end.
line_start (int) – Location line start.

datadog_api_client.v2.model.deployment module¶

class Deployment(arg: None)¶

class Deployment(arg: ModelComposed)

class Deployment(*args, **kwargs)

Bases: ModelNormal

The version of the app that was published.

Parameters:

attributes (DeploymentAttributes, optional) – The attributes object containing the version ID of the published app.
id (UUID, optional) – The deployment ID.
meta (DeploymentMetadata, optional) – Metadata object containing the publication creation information.
type (AppDeploymentType, optional) – The deployment type.

datadog_api_client.v2.model.deployment_attributes module¶

class DeploymentAttributes(arg: None)¶

class DeploymentAttributes(arg: ModelComposed)

class DeploymentAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes object containing the version ID of the published app.

Parameters:: app_version_id (UUID, optional) – The version ID of the app that was published. For an unpublished app, this is always the nil UUID ( 00000000-0000-0000-0000-000000000000 ).

datadog_api_client.v2.model.deployment_gate_data_type module¶

class DeploymentGateDataType(arg: None)¶

class DeploymentGateDataType(arg: ModelComposed)

class DeploymentGateDataType(*args, **kwargs)

Bases: ModelSimple

Deployment gate resource type.

Parameters:

value (str) – If omitted defaults to “deployment_gate”. Must be one of [“deployment_gate”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.deployment_gate_response module¶

class DeploymentGateResponse(arg: None)¶

class DeploymentGateResponse(arg: ModelComposed)

class DeploymentGateResponse(*args, **kwargs)

Bases: ModelNormal

Response for a deployment gate.

Parameters:: data (DeploymentGateResponseData, optional) – Data for a deployment gate.

datadog_api_client.v2.model.deployment_gate_response_data module¶

class DeploymentGateResponseData(arg: None)¶

class DeploymentGateResponseData(arg: ModelComposed)

class DeploymentGateResponseData(*args, **kwargs)

Bases: ModelNormal

Data for a deployment gate.

Parameters:

attributes (DeploymentGateResponseDataAttributes) – Basic information about a deployment gate.
id (str) – Unique identifier of the deployment gate.
type (DeploymentGateDataType) – Deployment gate resource type.

datadog_api_client.v2.model.deployment_gate_response_data_attributes module¶

class DeploymentGateResponseDataAttributes(arg: None)¶

class DeploymentGateResponseDataAttributes(arg: ModelComposed)

class DeploymentGateResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Basic information about a deployment gate.

Parameters:

created_at (datetime) – The timestamp when the deployment gate was created.
created_by (DeploymentGateResponseDataAttributesCreatedBy) – Information about the user who created the deployment gate.
dry_run (bool) – Whether this gate is run in dry-run mode.
env (str) – The environment of the deployment gate.
identifier (str) – The identifier of the deployment gate.
service (str) – The service of the deployment gate.
updated_at (datetime, optional) – The timestamp when the deployment gate was last updated.
updated_by (DeploymentGateResponseDataAttributesUpdatedBy, optional) – Information about the user who updated the deployment gate.

datadog_api_client.v2.model.deployment_gate_response_data_attributes_created_by module¶

class DeploymentGateResponseDataAttributesCreatedBy(arg: None)¶

class DeploymentGateResponseDataAttributesCreatedBy(arg: ModelComposed)

class DeploymentGateResponseDataAttributesCreatedBy(*args, **kwargs)

Bases: ModelNormal

Information about the user who created the deployment gate.

Parameters:

handle (str, optional) – The handle of the user who created the deployment rule.
id (str) – The ID of the user who created the deployment rule.
name (str, optional) – The name of the user who created the deployment rule.

datadog_api_client.v2.model.deployment_gate_response_data_attributes_updated_by module¶

class DeploymentGateResponseDataAttributesUpdatedBy(arg: None)¶

class DeploymentGateResponseDataAttributesUpdatedBy(arg: ModelComposed)

class DeploymentGateResponseDataAttributesUpdatedBy(*args, **kwargs)

Bases: ModelNormal

Information about the user who updated the deployment gate.

Parameters:

handle (str, optional) – The handle of the user who updated the deployment rule.
id (str) – The ID of the user who updated the deployment rule.
name (str, optional) – The name of the user who updated the deployment rule.

datadog_api_client.v2.model.deployment_metadata module¶

class DeploymentMetadata(arg: None)¶

class DeploymentMetadata(arg: ModelComposed)

class DeploymentMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata object containing the publication creation information.

Parameters:

created_at (datetime, optional) – Timestamp of when the app was published.
user_id (int, optional) – The ID of the user who published the app.
user_name (str, optional) – The name (or email address) of the user who published the app.
user_uuid (UUID, optional) – The UUID of the user who published the app.

datadog_api_client.v2.model.deployment_relationship module¶

class DeploymentRelationship(arg: None)¶

class DeploymentRelationship(arg: ModelComposed)

class DeploymentRelationship(*args, **kwargs)

Bases: ModelNormal

Information pointing to the app’s publication status.

Parameters:

data (DeploymentRelationshipData, optional) – Data object containing the deployment ID.
meta (DeploymentMetadata, optional) – Metadata object containing the publication creation information.

datadog_api_client.v2.model.deployment_relationship_data module¶

class DeploymentRelationshipData(arg: None)¶

class DeploymentRelationshipData(arg: ModelComposed)

class DeploymentRelationshipData(*args, **kwargs)

Bases: ModelNormal

Data object containing the deployment ID.

Parameters:

id (UUID, optional) – The deployment ID.
type (AppDeploymentType, optional) – The deployment type.

datadog_api_client.v2.model.deployment_rule_data_type module¶

class DeploymentRuleDataType(arg: None)¶

class DeploymentRuleDataType(arg: ModelComposed)

class DeploymentRuleDataType(*args, **kwargs)

Bases: ModelSimple

Deployment rule resource type.

Parameters:

value (str) – If omitted defaults to “deployment_rule”. Must be one of [“deployment_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.deployment_rule_options_faulty_deployment_detection module¶

class DeploymentRuleOptionsFaultyDeploymentDetection(arg: None)¶

class DeploymentRuleOptionsFaultyDeploymentDetection(arg: ModelComposed)

class DeploymentRuleOptionsFaultyDeploymentDetection(*args, **kwargs)

Bases: ModelNormal

Faulty deployment detection options for deployment rules.

Parameters:

duration (int, optional) – The duration for faulty deployment detection.
excluded_resources ([str], optional) – Resources to exclude from faulty deployment detection.

additional_properties_type = None¶

datadog_api_client.v2.model.deployment_rule_options_monitor module¶

class DeploymentRuleOptionsMonitor(arg: None)¶

class DeploymentRuleOptionsMonitor(arg: ModelComposed)

class DeploymentRuleOptionsMonitor(*args, **kwargs)

Bases: ModelNormal

Monitor options for deployment rules.

Parameters:

duration (int, optional) – Seconds the monitor needs to stay in OK status for the rule to pass.
query (str) – Monitors that match this query are evaluated.

additional_properties_type = None¶

datadog_api_client.v2.model.deployment_rule_response module¶

class DeploymentRuleResponse(arg: None)¶

class DeploymentRuleResponse(arg: ModelComposed)

class DeploymentRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response for a deployment rule.

Parameters:: data (DeploymentRuleResponseData, optional) – Data for a deployment rule.

datadog_api_client.v2.model.deployment_rule_response_data module¶

class DeploymentRuleResponseData(arg: None)¶

class DeploymentRuleResponseData(arg: ModelComposed)

class DeploymentRuleResponseData(*args, **kwargs)

Bases: ModelNormal

Data for a deployment rule.

Parameters:

attributes (DeploymentRuleResponseDataAttributes) – Basic information about a deployment rule.
id (str) – Unique identifier of the deployment rule.
type (DeploymentRuleDataType) – Deployment rule resource type.

datadog_api_client.v2.model.deployment_rule_response_data_attributes module¶

class DeploymentRuleResponseDataAttributes(arg: None)¶

class DeploymentRuleResponseDataAttributes(arg: ModelComposed)

class DeploymentRuleResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Basic information about a deployment rule.

Parameters:

created_at (datetime) – The timestamp when the deployment rule was created.
created_by (DeploymentRuleResponseDataAttributesCreatedBy) – Information about the user who created the deployment rule.
dry_run (bool) – Whether this rule is run in dry-run mode.
gate_id (str) – The ID of the deployment gate.
name (str) – The name of the deployment rule.
options (DeploymentRulesOptions) – Options for deployment rule response representing either faulty deployment detection or monitor options.
type (DeploymentRuleResponseDataAttributesType) – The type of the deployment rule.
updated_at (datetime, optional) – The timestamp when the deployment rule was last updated.
updated_by (DeploymentRuleResponseDataAttributesUpdatedBy, optional) – Information about the user who updated the deployment rule.

datadog_api_client.v2.model.deployment_rule_response_data_attributes_created_by module¶

class DeploymentRuleResponseDataAttributesCreatedBy(arg: None)¶

class DeploymentRuleResponseDataAttributesCreatedBy(arg: ModelComposed)

class DeploymentRuleResponseDataAttributesCreatedBy(*args, **kwargs)

Bases: ModelNormal

Information about the user who created the deployment rule.

Parameters:

handle (str, optional) – The handle of the user who created the deployment rule.
id (str) – The ID of the user who created the deployment rule.
name (str, optional) – The name of the user who created the deployment rule.

datadog_api_client.v2.model.deployment_rule_response_data_attributes_type module¶

class DeploymentRuleResponseDataAttributesType(arg: None)¶

class DeploymentRuleResponseDataAttributesType(arg: ModelComposed)

class DeploymentRuleResponseDataAttributesType(*args, **kwargs)

Bases: ModelSimple

The type of the deployment rule.

Parameters:

value (str) – Must be one of [“faulty_deployment_detection”, “monitor”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.deployment_rule_response_data_attributes_updated_by module¶

class DeploymentRuleResponseDataAttributesUpdatedBy(arg: None)¶

class DeploymentRuleResponseDataAttributesUpdatedBy(arg: ModelComposed)

class DeploymentRuleResponseDataAttributesUpdatedBy(*args, **kwargs)

Bases: ModelNormal

Information about the user who updated the deployment rule.

Parameters:

handle (str, optional) – The handle of the user who updated the deployment rule.
id (str) – The ID of the user who updated the deployment rule.
name (str, optional) – The name of the user who updated the deployment rule.

datadog_api_client.v2.model.deployment_rules_options module¶

class DeploymentRulesOptions(arg: None)¶

class DeploymentRulesOptions(arg: ModelComposed)

class DeploymentRulesOptions(*args, **kwargs)

Bases: ModelComposed

Options for deployment rule response representing either faulty deployment detection or monitor options.

Parameters:

duration (int, optional) – The duration for faulty deployment detection.
excluded_resources ([str], optional) – Resources to exclude from faulty deployment detection.
query (str) – Monitors that match this query are evaluated.

datadog_api_client.v2.model.detailed_finding module¶

class DetailedFinding(arg: None)¶

class DetailedFinding(arg: ModelComposed)

class DetailedFinding(*args, **kwargs)

Bases: ModelNormal

A single finding with with message and resource configuration.

Parameters:

attributes (DetailedFindingAttributes, optional) – The JSON:API attributes of the detailed finding.
id (str, optional) – The unique ID for this finding.
type (DetailedFindingType, optional) – The JSON:API type for findings that have the message and resource configuration.

datadog_api_client.v2.model.detailed_finding_attributes module¶

class DetailedFindingAttributes(arg: None)¶

class DetailedFindingAttributes(arg: ModelComposed)

class DetailedFindingAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes of the detailed finding.

Parameters:

evaluation (FindingEvaluation, optional) – The evaluation of the finding.
evaluation_changed_at (int, optional) – The date on which the evaluation for this finding changed (Unix ms).
message (str, optional) – The remediation message for this finding.
mute (FindingMute, optional) – Information about the mute status of this finding.
resource (str, optional) – The resource name of this finding.
resource_configuration (dict, optional) – The resource configuration for this finding.
resource_discovery_date (int, optional) – The date on which the resource was discovered (Unix ms).
resource_type (str, optional) – The resource type of this finding.
rule (FindingRule, optional) – The rule that triggered this finding.
status (FindingStatus, optional) – The status of the finding.
tags ([str], optional) – The tags associated with this finding.

datadog_api_client.v2.model.detailed_finding_type module¶

class DetailedFindingType(arg: None)¶

class DetailedFindingType(arg: ModelComposed)

class DetailedFindingType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for findings that have the message and resource configuration.

Parameters:

value (str) – If omitted defaults to “detailed_finding”. Must be one of [“detailed_finding”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.device_attributes module¶

class DeviceAttributes(arg: None)¶

class DeviceAttributes(arg: ModelComposed)

class DeviceAttributes(*args, **kwargs)

Bases: ModelNormal

The device attributes

Parameters:

description (str, optional) – The device description
device_type (str, optional) – The device type
integration (str, optional) – The device integration
interface_statuses (DeviceAttributesInterfaceStatuses, optional) – Count of the device interfaces by status
ip_address (str, optional) – The device IP address
location (str, optional) – The device location
model (str, optional) – The device model
name (str, optional) – The device name
os_hostname (str, optional) – The device OS hostname
os_name (str, optional) – The device OS name
os_version (str, optional) – The device OS version
ping_status (str, optional) – The device ping status
product_name (str, optional) – The device product name
serial_number (str, optional) – The device serial number
status (str, optional) – The device SNMP status
subnet (str, optional) – The device subnet
sys_object_id (str, optional) – The device sys_object_id
tags ([str], optional) – The list of device tags
vendor (str, optional) – The device vendor
version (str, optional) – The device version

datadog_api_client.v2.model.device_attributes_interface_statuses module¶

class DeviceAttributesInterfaceStatuses(arg: None)¶

class DeviceAttributesInterfaceStatuses(arg: ModelComposed)

class DeviceAttributesInterfaceStatuses(*args, **kwargs)

Bases: ModelNormal

Count of the device interfaces by status

Parameters:

down (int, optional) – The number of interfaces that are down
off (int, optional) – The number of interfaces that are off
up (int, optional) – The number of interfaces that are up
warning (int, optional) – The number of interfaces that are in a warning state

datadog_api_client.v2.model.devices_list_data module¶

class DevicesListData(arg: None)¶

class DevicesListData(arg: ModelComposed)

class DevicesListData(*args, **kwargs)

Bases: ModelNormal

The devices list data

Parameters:

attributes (DeviceAttributes, optional) – The device attributes
id (str, optional) – The device ID
type (str, optional) – The type of the resource. The value should always be device.

datadog_api_client.v2.model.dns_metric_key module¶

class DnsMetricKey(arg: None)¶

class DnsMetricKey(arg: ModelComposed)

class DnsMetricKey(*args, **kwargs)

Bases: ModelSimple

The metric key for DNS metrics.

Parameters:

value (str) – Must be one of [“dns_total_requests”, “dns_failures”, “dns_successful_responses”, “dns_failed_responses”, “dns_timeouts”, “dns_responses.nxdomain”, “dns_responses.servfail”, “dns_responses.other”, “dns_success_latency_percentile”, “dns_failure_latency_percentile”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.domain_allowlist module¶

class DomainAllowlist(arg: None)¶

class DomainAllowlist(arg: ModelComposed)

class DomainAllowlist(*args, **kwargs)

Bases: ModelNormal

The email domain allowlist for an org.

Parameters:

attributes (DomainAllowlistAttributes, optional) – The details of the email domain allowlist.
id (str, none_type, optional) – The unique identifier of the org.
type (DomainAllowlistType) – Email domain allowlist allowlist type.

datadog_api_client.v2.model.domain_allowlist_attributes module¶

class DomainAllowlistAttributes(arg: None)¶

class DomainAllowlistAttributes(arg: ModelComposed)

class DomainAllowlistAttributes(*args, **kwargs)

Bases: ModelNormal

The details of the email domain allowlist.

Parameters:

domains ([str], optional) – The list of domains in the email domain allowlist.
enabled (bool, optional) – Whether the email domain allowlist is enabled for the org.

datadog_api_client.v2.model.domain_allowlist_request module¶

class DomainAllowlistRequest(arg: None)¶

class DomainAllowlistRequest(arg: ModelComposed)

class DomainAllowlistRequest(*args, **kwargs)

Bases: ModelNormal

Request containing the desired email domain allowlist configuration.

Parameters:: data (DomainAllowlist) – The email domain allowlist for an org.

datadog_api_client.v2.model.domain_allowlist_response module¶

class DomainAllowlistResponse(arg: None)¶

class DomainAllowlistResponse(arg: ModelComposed)

class DomainAllowlistResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about the email domain allowlist.

Parameters:: data (DomainAllowlistResponseData, optional) – The email domain allowlist response for an org.

datadog_api_client.v2.model.domain_allowlist_response_data module¶

class DomainAllowlistResponseData(arg: None)¶

class DomainAllowlistResponseData(arg: ModelComposed)

class DomainAllowlistResponseData(*args, **kwargs)

Bases: ModelNormal

The email domain allowlist response for an org.

Parameters:

attributes (DomainAllowlistResponseDataAttributes, optional) – The details of the email domain allowlist.
id (str, none_type, optional) – The unique identifier of the org.
type (DomainAllowlistType) – Email domain allowlist allowlist type.

datadog_api_client.v2.model.domain_allowlist_response_data_attributes module¶

class DomainAllowlistResponseDataAttributes(arg: None)¶

class DomainAllowlistResponseDataAttributes(arg: ModelComposed)

class DomainAllowlistResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The details of the email domain allowlist.

Parameters:

domains ([str], optional) – The list of domains in the email domain allowlist.
enabled (bool, optional) – Whether the email domain allowlist is enabled for the org.

datadog_api_client.v2.model.domain_allowlist_type module¶

class DomainAllowlistType(arg: None)¶

class DomainAllowlistType(arg: ModelComposed)

class DomainAllowlistType(*args, **kwargs)

Bases: ModelSimple

Email domain allowlist allowlist type.

Parameters:

value (str) – If omitted defaults to “domain_allowlist”. Must be one of [“domain_allowlist”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.dora_deployment_request module¶

class DORADeploymentRequest(arg: None)¶

class DORADeploymentRequest(arg: ModelComposed)

class DORADeploymentRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a DORA deployment event.

Parameters:: data (DORADeploymentRequestData) – The JSON:API data.

datadog_api_client.v2.model.dora_deployment_request_attributes module¶

class DORADeploymentRequestAttributes(arg: None)¶

class DORADeploymentRequestAttributes(arg: ModelComposed)

class DORADeploymentRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes to create a DORA deployment event.

Parameters:

custom_tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env (str, optional) – Environment name to where the service was deployed.
finished_at (int) – Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds.
git (DORAGitInfo, optional) – Git info for DORA Metrics events.
id (str, optional) – Deployment ID.
service (str) – Service name.
started_at (int) – Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.
team (str, optional) – Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.
version (str, optional) – Version to correlate with APM Deployment Tracking.

datadog_api_client.v2.model.dora_deployment_request_data module¶

class DORADeploymentRequestData(arg: None)¶

class DORADeploymentRequestData(arg: ModelComposed)

class DORADeploymentRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:: attributes (DORADeploymentRequestAttributes) – Attributes to create a DORA deployment event.

datadog_api_client.v2.model.dora_deployment_response module¶

class DORADeploymentResponse(arg: None)¶

class DORADeploymentResponse(arg: ModelComposed)

class DORADeploymentResponse(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA deployment event.

Parameters:: data (DORADeploymentResponseData) – The JSON:API data.

datadog_api_client.v2.model.dora_deployment_response_data module¶

class DORADeploymentResponseData(arg: None)¶

class DORADeploymentResponseData(arg: ModelComposed)

class DORADeploymentResponseData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:

id (str) – The ID of the received DORA deployment event.
type (DORADeploymentType, optional) – JSON:API type for DORA deployment events.

datadog_api_client.v2.model.dora_deployment_type module¶

class DORADeploymentType(arg: None)¶

class DORADeploymentType(arg: ModelComposed)

class DORADeploymentType(*args, **kwargs)

Bases: ModelSimple

JSON:API type for DORA deployment events.

Parameters:

value (str) – If omitted defaults to “dora_deployment”. Must be one of [“dora_deployment”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.dora_event module¶

class DORAEvent(arg: None)¶

class DORAEvent(arg: ModelComposed)

class DORAEvent(*args, **kwargs)

Bases: ModelNormal

A DORA event.

Parameters:

attributes (dict, optional) – The attributes of the event.
id (str, optional) – The ID of the event.
type (str, optional) – The type of the event.

datadog_api_client.v2.model.dora_failure_request module¶

class DORAFailureRequest(arg: None)¶

class DORAFailureRequest(arg: ModelComposed)

class DORAFailureRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a DORA failure event.

Parameters:: data (DORAFailureRequestData) – The JSON:API data.

datadog_api_client.v2.model.dora_failure_request_attributes module¶

class DORAFailureRequestAttributes(arg: None)¶

class DORAFailureRequestAttributes(arg: ModelComposed)

class DORAFailureRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes to create a DORA failure event.

Parameters:

custom_tags ([str], none_type, optional) – A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env (str, optional) – Environment name that was impacted by the failure.
finished_at (int, optional) – Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds.
git (DORAGitInfo, optional) – Git info for DORA Metrics events.
id (str, optional) – Failure ID. Must have at least 16 characters. Required to update a previously sent failure.
name (str, optional) – Failure name.
services ([str], optional) – Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.
severity (str, optional) – Failure severity.
started_at (int) – Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.
team (str, optional) – Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.
version (str, optional) –
Version to correlate with APM Deployment Tracking.

datadog_api_client.v2.model.dora_failure_request_data module¶

class DORAFailureRequestData(arg: None)¶

class DORAFailureRequestData(arg: ModelComposed)

class DORAFailureRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:: attributes (DORAFailureRequestAttributes) – Attributes to create a DORA failure event.

datadog_api_client.v2.model.dora_failure_response module¶

class DORAFailureResponse(arg: None)¶

class DORAFailureResponse(arg: ModelComposed)

class DORAFailureResponse(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA failure event.

Parameters:: data (DORAFailureResponseData) – Response after receiving a DORA failure event.

datadog_api_client.v2.model.dora_failure_response_data module¶

class DORAFailureResponseData(arg: None)¶

class DORAFailureResponseData(arg: ModelComposed)

class DORAFailureResponseData(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA failure event.

Parameters:

id (str) – The ID of the received DORA failure event.
type (DORAFailureType, optional) – JSON:API type for DORA failure events.

datadog_api_client.v2.model.dora_failure_type module¶

class DORAFailureType(arg: None)¶

class DORAFailureType(arg: ModelComposed)

class DORAFailureType(*args, **kwargs)

Bases: ModelSimple

JSON:API type for DORA failure events.

Parameters:

value (str) – If omitted defaults to “dora_failure”. Must be one of [“dora_failure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.dora_fetch_response module¶

class DORAFetchResponse(arg: None)¶

class DORAFetchResponse(arg: ModelComposed)

class DORAFetchResponse(*args, **kwargs)

Bases: ModelNormal

Response for the DORA fetch endpoints.

Parameters:: data (DORAEvent, optional) – A DORA event.

datadog_api_client.v2.model.dora_git_info module¶

class DORAGitInfo(arg: None)¶

class DORAGitInfo(arg: ModelComposed)

class DORAGitInfo(*args, **kwargs)

Bases: ModelNormal

Git info for DORA Metrics events.

Parameters:

commit_sha (str) – Git Commit SHA.
repository_url (str) – Git Repository URL

datadog_api_client.v2.model.dora_list_deployments_request module¶

class DORAListDeploymentsRequest(arg: None)¶

class DORAListDeploymentsRequest(arg: ModelComposed)

class DORAListDeploymentsRequest(*args, **kwargs)

Bases: ModelNormal

Request to get a list of deployments.

Parameters:: data (DORAListDeploymentsRequestData) – The JSON:API data.

datadog_api_client.v2.model.dora_list_deployments_request_attributes module¶

class DORAListDeploymentsRequestAttributes(arg: None)¶

class DORAListDeploymentsRequestAttributes(arg: ModelComposed)

class DORAListDeploymentsRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes to get a list of deployments.

Parameters:

_from (datetime, optional) – Minimum timestamp for requested events.
limit (int, optional) – Maximum number of events in the response.
query (str, optional) – Search query with event platform syntax.
sort (str, optional) – Sort order (prefixed with - for descending).
to (datetime, optional) – Maximum timestamp for requested events.

datadog_api_client.v2.model.dora_list_deployments_request_data module¶

class DORAListDeploymentsRequestData(arg: None)¶

class DORAListDeploymentsRequestData(arg: ModelComposed)

class DORAListDeploymentsRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:

attributes (DORAListDeploymentsRequestAttributes) – Attributes to get a list of deployments.
type (DORAListDeploymentsRequestDataType, optional) – The definition of DORAListDeploymentsRequestDataType object.

datadog_api_client.v2.model.dora_list_deployments_request_data_type module¶

class DORAListDeploymentsRequestDataType(arg: None)¶

class DORAListDeploymentsRequestDataType(arg: ModelComposed)

class DORAListDeploymentsRequestDataType(*args, **kwargs)

Bases: ModelSimple

The definition of DORAListDeploymentsRequestDataType object.

Parameters:

value (str) – If omitted defaults to “dora_deployments_list_request”. Must be one of [“dora_deployments_list_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.dora_list_failures_request module¶

class DORAListFailuresRequest(arg: None)¶

class DORAListFailuresRequest(arg: ModelComposed)

class DORAListFailuresRequest(*args, **kwargs)

Bases: ModelNormal

Request to get a list of failures.

Parameters:: data (DORAListFailuresRequestData) – The JSON:API data.

datadog_api_client.v2.model.dora_list_failures_request_attributes module¶

class DORAListFailuresRequestAttributes(arg: None)¶

class DORAListFailuresRequestAttributes(arg: ModelComposed)

class DORAListFailuresRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes to get a list of failures.

Parameters:

_from (datetime, optional) – Minimum timestamp for requested events.
limit (int, optional) – Maximum number of events in the response.
query (str, optional) – Search query with event platform syntax.
sort (str, optional) – Sort order (prefixed with - for descending).
to (datetime, optional) – Maximum timestamp for requested events.

datadog_api_client.v2.model.dora_list_failures_request_data module¶

class DORAListFailuresRequestData(arg: None)¶

class DORAListFailuresRequestData(arg: ModelComposed)

class DORAListFailuresRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:

attributes (DORAListFailuresRequestAttributes) – Attributes to get a list of failures.
type (DORAListFailuresRequestDataType, optional) – The definition of DORAListFailuresRequestDataType object.

datadog_api_client.v2.model.dora_list_failures_request_data_type module¶

class DORAListFailuresRequestDataType(arg: None)¶

class DORAListFailuresRequestDataType(arg: ModelComposed)

class DORAListFailuresRequestDataType(*args, **kwargs)

Bases: ModelSimple

The definition of DORAListFailuresRequestDataType object.

Parameters:

value (str) – If omitted defaults to “dora_failures_list_request”. Must be one of [“dora_failures_list_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.dora_list_response module¶

class DORAListResponse(arg: None)¶

class DORAListResponse(arg: ModelComposed)

class DORAListResponse(*args, **kwargs)

Bases: ModelNormal

Response for the DORA list endpoints.

Parameters:: data ([DORAEvent], optional) – The list of DORA events.

datadog_api_client.v2.model.downtime_create_request module¶

class DowntimeCreateRequest(arg: None)¶

class DowntimeCreateRequest(arg: ModelComposed)

class DowntimeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a downtime.

Parameters:: data (DowntimeCreateRequestData) – Object to create a downtime.

datadog_api_client.v2.model.downtime_create_request_attributes module¶

class DowntimeCreateRequestAttributes(arg: None)¶

class DowntimeCreateRequestAttributes(arg: ModelComposed)

class DowntimeCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Downtime details.

Parameters:

display_timezone (str, none_type, optional) – The timezone in which to display the downtime’s start and end times in Datadog applications. This is not used as an offset for scheduling.
message (str, none_type, optional) – A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.
monitor_identifier (DowntimeMonitorIdentifier) – Monitor identifier for the downtime.
mute_first_recovery_notification (bool, optional) – If the first recovery notification during a downtime should be muted.
notify_end_states ([DowntimeNotifyEndStateTypes], optional) – States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types ([DowntimeNotifyEndStateActions], optional) – Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule (DowntimeScheduleCreateRequest, optional) – Schedule for the downtime.
scope (str) – The scope to which the downtime applies. Must follow the common search syntax.

datadog_api_client.v2.model.downtime_create_request_data module¶

class DowntimeCreateRequestData(arg: None)¶

class DowntimeCreateRequestData(arg: ModelComposed)

class DowntimeCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Object to create a downtime.

Parameters:

attributes (DowntimeCreateRequestAttributes) – Downtime details.
type (DowntimeResourceType) – Downtime resource type.

datadog_api_client.v2.model.downtime_included_monitor_type module¶

class DowntimeIncludedMonitorType(arg: None)¶

class DowntimeIncludedMonitorType(arg: ModelComposed)

class DowntimeIncludedMonitorType(*args, **kwargs)

Bases: ModelSimple

Monitor resource type.

Parameters:

value (str) – If omitted defaults to “monitors”. Must be one of [“monitors”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.downtime_meta module¶

class DowntimeMeta(arg: None)¶

class DowntimeMeta(arg: ModelComposed)

class DowntimeMeta(*args, **kwargs)

Bases: ModelNormal

Pagination metadata returned by the API.

Parameters:: page (DowntimeMetaPage, optional) – Object containing the total filtered count.

datadog_api_client.v2.model.downtime_meta_page module¶

class DowntimeMetaPage(arg: None)¶

class DowntimeMetaPage(arg: ModelComposed)

class DowntimeMetaPage(*args, **kwargs)

Bases: ModelNormal

Object containing the total filtered count.

Parameters:: total_filtered_count (int, optional) – Total count of elements matched by the filter.

datadog_api_client.v2.model.downtime_monitor_identifier module¶

class DowntimeMonitorIdentifier(arg: None)¶

class DowntimeMonitorIdentifier(arg: ModelComposed)

class DowntimeMonitorIdentifier(*args, **kwargs)

Bases: ModelComposed

Monitor identifier for the downtime.

Parameters:

monitor_id (int) – ID of the monitor to prevent notifications.
monitor_tags ([str]) – A list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags to [*] configures the downtime to mute all monitors for the given scope.

datadog_api_client.v2.model.downtime_monitor_identifier_id module¶

class DowntimeMonitorIdentifierId(arg: None)¶

class DowntimeMonitorIdentifierId(arg: ModelComposed)

class DowntimeMonitorIdentifierId(*args, **kwargs)

Bases: ModelNormal

Object of the monitor identifier.

Parameters:: monitor_id (int) – ID of the monitor to prevent notifications.

datadog_api_client.v2.model.downtime_monitor_identifier_tags module¶

class DowntimeMonitorIdentifierTags(arg: None)¶

class DowntimeMonitorIdentifierTags(arg: ModelComposed)

class DowntimeMonitorIdentifierTags(*args, **kwargs)

Bases: ModelNormal

Object of the monitor tags.

Parameters:: monitor_tags ([str]) – A list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags to [*] configures the downtime to mute all monitors for the given scope.

datadog_api_client.v2.model.downtime_monitor_included_attributes module¶

class DowntimeMonitorIncludedAttributes(arg: None)¶

class DowntimeMonitorIncludedAttributes(arg: ModelComposed)

class DowntimeMonitorIncludedAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the monitor identified by the downtime.

Parameters:: name (str, optional) – The name of the monitor identified by the downtime.

datadog_api_client.v2.model.downtime_monitor_included_item module¶

class DowntimeMonitorIncludedItem(arg: None)¶

class DowntimeMonitorIncludedItem(arg: ModelComposed)

class DowntimeMonitorIncludedItem(*args, **kwargs)

Bases: ModelNormal

Information about the monitor identified by the downtime.

Parameters:

attributes (DowntimeMonitorIncludedAttributes, optional) – Attributes of the monitor identified by the downtime.
id (int, optional) – ID of the monitor identified by the downtime.
type (DowntimeIncludedMonitorType, optional) – Monitor resource type.

datadog_api_client.v2.model.downtime_notify_end_state_actions module¶

class DowntimeNotifyEndStateActions(arg: None)¶

class DowntimeNotifyEndStateActions(arg: ModelComposed)

class DowntimeNotifyEndStateActions(*args, **kwargs)

Bases: ModelSimple

Action that will trigger a monitor notification if the downtime is in the notify_end_types state.

Parameters:

value (str) – Must be one of [“canceled”, “expired”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.downtime_notify_end_state_types module¶

class DowntimeNotifyEndStateTypes(arg: None)¶

class DowntimeNotifyEndStateTypes(arg: ModelComposed)

class DowntimeNotifyEndStateTypes(*args, **kwargs)

Bases: ModelSimple

State that will trigger a monitor notification when the notify_end_types action occurs.

Parameters:

value (str) – Must be one of [“alert”, “no data”, “warn”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.downtime_relationships module¶

class DowntimeRelationships(arg: None)¶

class DowntimeRelationships(arg: ModelComposed)

class DowntimeRelationships(*args, **kwargs)

Bases: ModelNormal

All relationships associated with downtime.

Parameters:

created_by (DowntimeRelationshipsCreatedBy, optional) – The user who created the downtime.
monitor (DowntimeRelationshipsMonitor, optional) – The monitor identified by the downtime.

datadog_api_client.v2.model.downtime_relationships_created_by module¶

class DowntimeRelationshipsCreatedBy(arg: None)¶

class DowntimeRelationshipsCreatedBy(arg: ModelComposed)

class DowntimeRelationshipsCreatedBy(*args, **kwargs)

Bases: ModelNormal

The user who created the downtime.

Parameters:: data (DowntimeRelationshipsCreatedByData, none_type, optional) – Data for the user who created the downtime.

datadog_api_client.v2.model.downtime_relationships_created_by_data module¶

class DowntimeRelationshipsCreatedByData(arg: None)¶

class DowntimeRelationshipsCreatedByData(arg: ModelComposed)

class DowntimeRelationshipsCreatedByData(*args, **kwargs)

Bases: ModelNormal

Data for the user who created the downtime.

Parameters:

id (str, optional) – User ID of the downtime creator.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.downtime_relationships_monitor module¶

class DowntimeRelationshipsMonitor(arg: None)¶

class DowntimeRelationshipsMonitor(arg: ModelComposed)

class DowntimeRelationshipsMonitor(*args, **kwargs)

Bases: ModelNormal

The monitor identified by the downtime.

Parameters:: data (DowntimeRelationshipsMonitorData, none_type, optional) – Data for the monitor.

datadog_api_client.v2.model.downtime_relationships_monitor_data module¶

class DowntimeRelationshipsMonitorData(arg: None)¶

class DowntimeRelationshipsMonitorData(arg: ModelComposed)

class DowntimeRelationshipsMonitorData(*args, **kwargs)

Bases: ModelNormal

Data for the monitor.

Parameters:

id (str, optional) – Monitor ID of the downtime.
type (DowntimeIncludedMonitorType, optional) – Monitor resource type.

datadog_api_client.v2.model.downtime_resource_type module¶

class DowntimeResourceType(arg: None)¶

class DowntimeResourceType(arg: ModelComposed)

class DowntimeResourceType(*args, **kwargs)

Bases: ModelSimple

Downtime resource type.

Parameters:

value (str) – If omitted defaults to “downtime”. Must be one of [“downtime”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.downtime_response module¶

class DowntimeResponse(arg: None)¶

class DowntimeResponse(arg: ModelComposed)

class DowntimeResponse(*args, **kwargs)

Bases: ModelNormal

Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.

Parameters:

data (DowntimeResponseData, optional) – Downtime data.
included ([DowntimeResponseIncludedItem], optional) – Array of objects related to the downtime that the user requested.

datadog_api_client.v2.model.downtime_response_attributes module¶

class DowntimeResponseAttributes(arg: None)¶

class DowntimeResponseAttributes(arg: ModelComposed)

class DowntimeResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Downtime details.

Parameters:

canceled (datetime, none_type, optional) – Time that the downtime was canceled.
created (datetime, optional) – Creation time of the downtime.
display_timezone (str, none_type, optional) – The timezone in which to display the downtime’s start and end times in Datadog applications. This is not used as an offset for scheduling.
message (str, none_type, optional) – A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.
modified (datetime, optional) – Time that the downtime was last modified.
monitor_identifier (DowntimeMonitorIdentifier, optional) – Monitor identifier for the downtime.
mute_first_recovery_notification (bool, optional) – If the first recovery notification during a downtime should be muted.
notify_end_states ([DowntimeNotifyEndStateTypes], optional) – States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types ([DowntimeNotifyEndStateActions], optional) – Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule (DowntimeScheduleResponse, optional) – The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules: one-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are provided, the downtime will begin immediately and never end.
scope (str, optional) –
The scope to which the downtime applies. Must follow the common search syntax.
status (DowntimeStatus, optional) – The current status of the downtime.

datadog_api_client.v2.model.downtime_response_data module¶

class DowntimeResponseData(arg: None)¶

class DowntimeResponseData(arg: ModelComposed)

class DowntimeResponseData(*args, **kwargs)

Bases: ModelNormal

Downtime data.

Parameters:

attributes (DowntimeResponseAttributes, optional) – Downtime details.
id (str, optional) – The downtime ID.
relationships (DowntimeRelationships, optional) – All relationships associated with downtime.
type (DowntimeResourceType, optional) – Downtime resource type.

datadog_api_client.v2.model.downtime_response_included_item module¶

class DowntimeResponseIncludedItem(arg: None)¶

class DowntimeResponseIncludedItem(arg: ModelComposed)

class DowntimeResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to a downtime.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.downtime_schedule_create_request module¶

class DowntimeScheduleCreateRequest(arg: None)¶

class DowntimeScheduleCreateRequest(arg: ModelComposed)

class DowntimeScheduleCreateRequest(*args, **kwargs)

Bases: ModelComposed

Schedule for the downtime.

Parameters:

recurrences ([DowntimeScheduleRecurrenceCreateUpdateRequest]) – A list of downtime recurrences.
timezone (str, optional) – The timezone in which to schedule the downtime.
end (datetime, none_type, optional) – ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the downtime continues forever.
start (datetime, none_type, optional) – ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the downtime starts the moment it is created.

datadog_api_client.v2.model.downtime_schedule_current_downtime_response module¶

class DowntimeScheduleCurrentDowntimeResponse(arg: None)¶

class DowntimeScheduleCurrentDowntimeResponse(arg: ModelComposed)

class DowntimeScheduleCurrentDowntimeResponse(*args, **kwargs)

Bases: ModelNormal

The most recent actual start and end dates for a recurring downtime. For a canceled downtime, this is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled downtimes it is the upcoming downtime.

Parameters:

end (datetime, none_type, optional) – The end of the current downtime.
start (datetime, optional) – The start of the current downtime.

datadog_api_client.v2.model.downtime_schedule_one_time_create_update_request module¶

class DowntimeScheduleOneTimeCreateUpdateRequest(arg: None)¶

class DowntimeScheduleOneTimeCreateUpdateRequest(arg: ModelComposed)

class DowntimeScheduleOneTimeCreateUpdateRequest(*args, **kwargs)

Bases: ModelNormal

A one-time downtime definition.

Parameters:

end (datetime, none_type, optional) – ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the downtime continues forever.
start (datetime, none_type, optional) – ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the downtime starts the moment it is created.

additional_properties_type = None¶

datadog_api_client.v2.model.downtime_schedule_one_time_response module¶

class DowntimeScheduleOneTimeResponse(arg: None)¶

class DowntimeScheduleOneTimeResponse(arg: ModelComposed)

class DowntimeScheduleOneTimeResponse(*args, **kwargs)

Bases: ModelNormal

A one-time downtime definition.

Parameters:

end (datetime, none_type, optional) – ISO-8601 Datetime to end the downtime.
start (datetime) – ISO-8601 Datetime to start the downtime.

datadog_api_client.v2.model.downtime_schedule_recurrence_create_update_request module¶

class DowntimeScheduleRecurrenceCreateUpdateRequest(arg: None)¶

class DowntimeScheduleRecurrenceCreateUpdateRequest(arg: ModelComposed)

class DowntimeScheduleRecurrenceCreateUpdateRequest(*args, **kwargs)

Bases: ModelNormal

An object defining the recurrence of the downtime.

Parameters:

duration (str) – The length of the downtime. Must begin with an integer and end with one of ‘m’, ‘h’, d’, or ‘w’.
rrule (str) –
The RRULE standard for defining recurring events. For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1. Most common rrule options from the iCalendar Spec are supported.

Note : Attributes specifying the duration in RRULE are not supported (for example, DTSTART , DTEND , DURATION ). More examples available in this downtime guide.
start (str, none_type, optional) – ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the downtime starts the moment it is created.

datadog_api_client.v2.model.downtime_schedule_recurrence_response module¶

class DowntimeScheduleRecurrenceResponse(arg: None)¶

class DowntimeScheduleRecurrenceResponse(arg: ModelComposed)

class DowntimeScheduleRecurrenceResponse(*args, **kwargs)

Bases: ModelNormal

An RRULE-based recurring downtime.

Parameters:

duration (str, optional) – The length of the downtime. Must begin with an integer and end with one of ‘m’, ‘h’, d’, or ‘w’.
rrule (str, optional) –
The RRULE standard for defining recurring events. For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1. Most common rrule options from the iCalendar Spec are supported.

Note : Attributes specifying the duration in RRULE are not supported (for example, DTSTART , DTEND , DURATION ). More examples available in this downtime guide.
start (str, optional) – ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the downtime starts the moment it is created.

datadog_api_client.v2.model.downtime_schedule_recurrences_create_request module¶

class DowntimeScheduleRecurrencesCreateRequest(arg: None)¶

class DowntimeScheduleRecurrencesCreateRequest(arg: ModelComposed)

class DowntimeScheduleRecurrencesCreateRequest(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:

recurrences ([DowntimeScheduleRecurrenceCreateUpdateRequest]) – A list of downtime recurrences.
timezone (str, optional) – The timezone in which to schedule the downtime.

datadog_api_client.v2.model.downtime_schedule_recurrences_response module¶

class DowntimeScheduleRecurrencesResponse(arg: None)¶

class DowntimeScheduleRecurrencesResponse(arg: ModelComposed)

class DowntimeScheduleRecurrencesResponse(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:

current_downtime (DowntimeScheduleCurrentDowntimeResponse, optional) – The most recent actual start and end dates for a recurring downtime. For a canceled downtime, this is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled downtimes it is the upcoming downtime.
recurrences ([DowntimeScheduleRecurrenceResponse]) – A list of downtime recurrences.
timezone (str, optional) – The timezone in which to schedule the downtime. This affects recurring start and end dates. Must match display_timezone.

datadog_api_client.v2.model.downtime_schedule_recurrences_update_request module¶

class DowntimeScheduleRecurrencesUpdateRequest(arg: None)¶

class DowntimeScheduleRecurrencesUpdateRequest(arg: ModelComposed)

class DowntimeScheduleRecurrencesUpdateRequest(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:

recurrences ([DowntimeScheduleRecurrenceCreateUpdateRequest], optional) – A list of downtime recurrences.
timezone (str, optional) – The timezone in which to schedule the downtime.

additional_properties_type = None¶

datadog_api_client.v2.model.downtime_schedule_response module¶

class DowntimeScheduleResponse(arg: None)¶

class DowntimeScheduleResponse(arg: ModelComposed)

class DowntimeScheduleResponse(*args, **kwargs)

Bases: ModelComposed

The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules: one-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are provided, the downtime will begin immediately and never end.

Parameters:

current_downtime (DowntimeScheduleCurrentDowntimeResponse, optional) – The most recent actual start and end dates for a recurring downtime. For a canceled downtime, this is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled downtimes it is the upcoming downtime.
recurrences ([DowntimeScheduleRecurrenceResponse]) – A list of downtime recurrences.
timezone (str, optional) – The timezone in which to schedule the downtime. This affects recurring start and end dates. Must match display_timezone.
end (datetime, none_type, optional) – ISO-8601 Datetime to end the downtime.
start (datetime) – ISO-8601 Datetime to start the downtime.

datadog_api_client.v2.model.downtime_schedule_update_request module¶

class DowntimeScheduleUpdateRequest(arg: None)¶

class DowntimeScheduleUpdateRequest(arg: ModelComposed)

class DowntimeScheduleUpdateRequest(*args, **kwargs)

Bases: ModelComposed

Schedule for the downtime.

Parameters:

recurrences ([DowntimeScheduleRecurrenceCreateUpdateRequest], optional) – A list of downtime recurrences.
timezone (str, optional) – The timezone in which to schedule the downtime.
end (datetime, none_type, optional) – ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the downtime continues forever.
start (datetime, none_type, optional) – ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the downtime starts the moment it is created.

datadog_api_client.v2.model.downtime_status module¶

class DowntimeStatus(arg: None)¶

class DowntimeStatus(arg: ModelComposed)

class DowntimeStatus(*args, **kwargs)

Bases: ModelSimple

The current status of the downtime.

Parameters:

value (str) – Must be one of [“active”, “canceled”, “ended”, “scheduled”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.downtime_update_request module¶

class DowntimeUpdateRequest(arg: None)¶

class DowntimeUpdateRequest(arg: ModelComposed)

class DowntimeUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request for editing a downtime.

Parameters:: data (DowntimeUpdateRequestData) – Object to update a downtime.

datadog_api_client.v2.model.downtime_update_request_attributes module¶

class DowntimeUpdateRequestAttributes(arg: None)¶

class DowntimeUpdateRequestAttributes(arg: ModelComposed)

class DowntimeUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the downtime to update.

Parameters:

display_timezone (str, none_type, optional) – The timezone in which to display the downtime’s start and end times in Datadog applications. This is not used as an offset for scheduling.
message (str, none_type, optional) – A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same @username notation as events.
monitor_identifier (DowntimeMonitorIdentifier, optional) – Monitor identifier for the downtime.
mute_first_recovery_notification (bool, optional) – If the first recovery notification during a downtime should be muted.
notify_end_states ([DowntimeNotifyEndStateTypes], optional) – States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types ([DowntimeNotifyEndStateActions], optional) – Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule (DowntimeScheduleUpdateRequest, optional) – Schedule for the downtime.
scope (str, optional) –
The scope to which the downtime applies. Must follow the common search syntax.

datadog_api_client.v2.model.downtime_update_request_data module¶

class DowntimeUpdateRequestData(arg: None)¶

class DowntimeUpdateRequestData(arg: ModelComposed)

class DowntimeUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Object to update a downtime.

Parameters:

attributes (DowntimeUpdateRequestAttributes) – Attributes of the downtime to update.
id (str) – ID of this downtime.
type (DowntimeResourceType) – Downtime resource type.

datadog_api_client.v2.model.entity_attributes module¶

class EntityAttributes(arg: None)¶

class EntityAttributes(arg: ModelComposed)

class EntityAttributes(*args, **kwargs)

Bases: ModelNormal

Entity attributes.

Parameters:

api_version (str, optional) – The API version.
description (str, optional) – The description.
display_name (str, optional) – The display name.
kind (str, optional) – The kind.
name (str, optional) – The name.
namespace (str, optional) – The namespace.
owner (str, optional) – The owner.
tags ([str], optional) – The tags.

datadog_api_client.v2.model.entity_data module¶

class EntityData(arg: None)¶

class EntityData(arg: ModelComposed)

class EntityData(*args, **kwargs)

Bases: ModelNormal

Entity data.

Parameters:

attributes (EntityAttributes, optional) – Entity attributes.
id (str, optional) – Entity ID.
meta (EntityMeta, optional) – Entity metadata.
relationships (EntityRelationships, optional) – Entity relationships.
type (str, optional) – Entity.

datadog_api_client.v2.model.entity_meta module¶

class EntityMeta(arg: None)¶

class EntityMeta(arg: ModelComposed)

class EntityMeta(*args, **kwargs)

Bases: ModelNormal

Entity metadata.

Parameters:

created_at (str, optional) – The creation time.
ingestion_source (str, optional) – The ingestion source.
modified_at (str, optional) – The modification time.
origin (str, optional) – The origin.

datadog_api_client.v2.model.entity_relationships module¶

class EntityRelationships(arg: None)¶

class EntityRelationships(arg: ModelComposed)

class EntityRelationships(*args, **kwargs)

Bases: ModelNormal

Entity relationships.

Parameters:

incidents (EntityToIncidents, optional) – Entity to incidents relationship.
oncall (EntityToOncalls, optional) – Entity to oncalls relationship.
raw_schema (EntityToRawSchema, optional) – Entity to raw schema relationship.
related_entities (EntityToRelatedEntities, optional) – Entity to related entities relationship.
schema (EntityToSchema, optional) – Entity to detail schema relationship.

datadog_api_client.v2.model.entity_response_array module¶

class EntityResponseArray(arg: None)¶

class EntityResponseArray(arg: ModelComposed)

class EntityResponseArray(*args, **kwargs)

Bases: ModelNormal

Parameters:: data ([PreviewEntityResponseData])

datadog_api_client.v2.model.entity_response_data_attributes module¶

class EntityResponseDataAttributes(arg: None)¶

class EntityResponseDataAttributes(arg: ModelComposed)

class EntityResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

api_version (str, optional)
description (str, optional)
display_name (str, optional)
kind (str, optional)
name (str, optional)
namespace (str, optional)
owner (str, optional)
properties ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional)
tags ([str], optional)

datadog_api_client.v2.model.entity_response_data_relationships module¶

class EntityResponseDataRelationships(arg: None)¶

class EntityResponseDataRelationships(arg: ModelComposed)

class EntityResponseDataRelationships(*args, **kwargs)

Bases: ModelNormal

Parameters:

incidents (EntityResponseDataRelationshipsIncidents, optional)
oncalls (EntityResponseDataRelationshipsOncalls, optional)
raw_schema (EntityResponseDataRelationshipsRawSchema, optional)
related_entities (EntityResponseDataRelationshipsRelatedEntities, optional)
schema (EntityResponseDataRelationshipsSchema, optional)

datadog_api_client.v2.model.entity_response_data_relationships_incidents module¶

class EntityResponseDataRelationshipsIncidents(arg: None)¶

class EntityResponseDataRelationshipsIncidents(arg: ModelComposed)

class EntityResponseDataRelationshipsIncidents(*args, **kwargs)

Bases: ModelNormal

Parameters:: data ([EntityResponseDataRelationshipsIncidentsDataItems], optional)

datadog_api_client.v2.model.entity_response_data_relationships_incidents_data_items module¶

class EntityResponseDataRelationshipsIncidentsDataItems(arg: None)¶

class EntityResponseDataRelationshipsIncidentsDataItems(arg: ModelComposed)

class EntityResponseDataRelationshipsIncidentsDataItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str)
type (EntityResponseDataRelationshipsIncidentsDataItemsType) – Incident resource type.

datadog_api_client.v2.model.entity_response_data_relationships_incidents_data_items_type module¶

class EntityResponseDataRelationshipsIncidentsDataItemsType(arg: None)¶

class EntityResponseDataRelationshipsIncidentsDataItemsType(arg: ModelComposed)

class EntityResponseDataRelationshipsIncidentsDataItemsType(*args, **kwargs)

Bases: ModelSimple

Incident resource type.

Parameters:

value (str) – If omitted defaults to “incident”. Must be one of [“incident”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_data_relationships_oncalls module¶

class EntityResponseDataRelationshipsOncalls(arg: None)¶

class EntityResponseDataRelationshipsOncalls(arg: ModelComposed)

class EntityResponseDataRelationshipsOncalls(*args, **kwargs)

Bases: ModelNormal

Parameters:: data ([EntityResponseDataRelationshipsOncallsDataItems], optional)

datadog_api_client.v2.model.entity_response_data_relationships_oncalls_data_items module¶

class EntityResponseDataRelationshipsOncallsDataItems(arg: None)¶

class EntityResponseDataRelationshipsOncallsDataItems(arg: ModelComposed)

class EntityResponseDataRelationshipsOncallsDataItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str)
type (EntityResponseDataRelationshipsOncallsDataItemsType) – Oncall resource type.

datadog_api_client.v2.model.entity_response_data_relationships_oncalls_data_items_type module¶

class EntityResponseDataRelationshipsOncallsDataItemsType(arg: None)¶

class EntityResponseDataRelationshipsOncallsDataItemsType(arg: ModelComposed)

class EntityResponseDataRelationshipsOncallsDataItemsType(*args, **kwargs)

Bases: ModelSimple

Oncall resource type.

Parameters:

value (str) – If omitted defaults to “oncall”. Must be one of [“oncall”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_data_relationships_raw_schema module¶

class EntityResponseDataRelationshipsRawSchema(arg: None)¶

class EntityResponseDataRelationshipsRawSchema(arg: ModelComposed)

class EntityResponseDataRelationshipsRawSchema(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (EntityResponseDataRelationshipsRawSchemaData)

datadog_api_client.v2.model.entity_response_data_relationships_raw_schema_data module¶

class EntityResponseDataRelationshipsRawSchemaData(arg: None)¶

class EntityResponseDataRelationshipsRawSchemaData(arg: ModelComposed)

class EntityResponseDataRelationshipsRawSchemaData(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str)
type (EntityResponseDataRelationshipsRawSchemaDataType) – Raw schema resource type.

datadog_api_client.v2.model.entity_response_data_relationships_raw_schema_data_type module¶

class EntityResponseDataRelationshipsRawSchemaDataType(arg: None)¶

class EntityResponseDataRelationshipsRawSchemaDataType(arg: ModelComposed)

class EntityResponseDataRelationshipsRawSchemaDataType(*args, **kwargs)

Bases: ModelSimple

Raw schema resource type.

Parameters:

value (str) – If omitted defaults to “rawSchema”. Must be one of [“rawSchema”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_data_relationships_related_entities module¶

class EntityResponseDataRelationshipsRelatedEntities(arg: None)¶

class EntityResponseDataRelationshipsRelatedEntities(arg: ModelComposed)

class EntityResponseDataRelationshipsRelatedEntities(*args, **kwargs)

Bases: ModelNormal

Parameters:: data ([EntityResponseDataRelationshipsRelatedEntitiesDataItems], optional)

datadog_api_client.v2.model.entity_response_data_relationships_related_entities_data_items module¶

class EntityResponseDataRelationshipsRelatedEntitiesDataItems(arg: None)¶

class EntityResponseDataRelationshipsRelatedEntitiesDataItems(arg: ModelComposed)

class EntityResponseDataRelationshipsRelatedEntitiesDataItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str)
type (EntityResponseDataRelationshipsRelatedEntitiesDataItemsType) – Related entity resource type.

datadog_api_client.v2.model.entity_response_data_relationships_related_entities_data_items_type module¶

class EntityResponseDataRelationshipsRelatedEntitiesDataItemsType(arg: None)¶

class EntityResponseDataRelationshipsRelatedEntitiesDataItemsType(arg: ModelComposed)

class EntityResponseDataRelationshipsRelatedEntitiesDataItemsType(*args, **kwargs)

Bases: ModelSimple

Related entity resource type.

Parameters:

value (str) – If omitted defaults to “relatedEntity”. Must be one of [“relatedEntity”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_data_relationships_schema module¶

class EntityResponseDataRelationshipsSchema(arg: None)¶

class EntityResponseDataRelationshipsSchema(arg: ModelComposed)

class EntityResponseDataRelationshipsSchema(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (EntityResponseDataRelationshipsSchemaData)

datadog_api_client.v2.model.entity_response_data_relationships_schema_data module¶

class EntityResponseDataRelationshipsSchemaData(arg: None)¶

class EntityResponseDataRelationshipsSchemaData(arg: ModelComposed)

class EntityResponseDataRelationshipsSchemaData(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str)
type (EntityResponseDataRelationshipsSchemaDataType) – Schema resource type.

datadog_api_client.v2.model.entity_response_data_relationships_schema_data_type module¶

class EntityResponseDataRelationshipsSchemaDataType(arg: None)¶

class EntityResponseDataRelationshipsSchemaDataType(arg: ModelComposed)

class EntityResponseDataRelationshipsSchemaDataType(*args, **kwargs)

Bases: ModelSimple

Schema resource type.

Parameters:

value (str) – If omitted defaults to “schema”. Must be one of [“schema”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_data_type module¶

class EntityResponseDataType(arg: None)¶

class EntityResponseDataType(arg: ModelComposed)

class EntityResponseDataType(*args, **kwargs)

Bases: ModelSimple

Entity resource type.

Parameters:

value (str) – If omitted defaults to “entity”. Must be one of [“entity”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_included_incident module¶

class EntityResponseIncludedIncident(arg: None)¶

class EntityResponseIncludedIncident(arg: ModelComposed)

class EntityResponseIncludedIncident(*args, **kwargs)

Bases: ModelNormal

Included incident.

Parameters:

attributes (EntityResponseIncludedRelatedIncidentAttributes, optional) – Incident attributes.
id (str, optional) – Incident ID.
type (EntityResponseIncludedIncidentType, optional) – Incident description.

datadog_api_client.v2.model.entity_response_included_incident_type module¶

class EntityResponseIncludedIncidentType(arg: None)¶

class EntityResponseIncludedIncidentType(arg: ModelComposed)

class EntityResponseIncludedIncidentType(*args, **kwargs)

Bases: ModelSimple

Incident description.

Parameters:

value (str) – If omitted defaults to “incident”. Must be one of [“incident”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_included_oncall module¶

class EntityResponseIncludedOncall(arg: None)¶

class EntityResponseIncludedOncall(arg: ModelComposed)

class EntityResponseIncludedOncall(*args, **kwargs)

Bases: ModelNormal

Included oncall.

Parameters:

attributes (EntityResponseIncludedRelatedOncallAttributes, optional) – Included related oncall attributes.
id (str, optional) – Oncall ID.
type (EntityResponseIncludedOncallType, optional) – Oncall type.

datadog_api_client.v2.model.entity_response_included_oncall_type module¶

class EntityResponseIncludedOncallType(arg: None)¶

class EntityResponseIncludedOncallType(arg: ModelComposed)

class EntityResponseIncludedOncallType(*args, **kwargs)

Bases: ModelSimple

Oncall type.

Parameters:

value (str) – If omitted defaults to “oncall”. Must be one of [“oncall”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_included_raw_schema module¶

class EntityResponseIncludedRawSchema(arg: None)¶

class EntityResponseIncludedRawSchema(arg: ModelComposed)

class EntityResponseIncludedRawSchema(*args, **kwargs)

Bases: ModelNormal

Included raw schema.

Parameters:

attributes (EntityResponseIncludedRawSchemaAttributes, optional) – Included raw schema attributes.
id (str, optional) – Raw schema ID.
type (EntityResponseIncludedRawSchemaType, optional) – Raw schema type.

datadog_api_client.v2.model.entity_response_included_raw_schema_attributes module¶

class EntityResponseIncludedRawSchemaAttributes(arg: None)¶

class EntityResponseIncludedRawSchemaAttributes(arg: ModelComposed)

class EntityResponseIncludedRawSchemaAttributes(*args, **kwargs)

Bases: ModelNormal

Included raw schema attributes.

Parameters:: raw_schema (str, optional) – Schema from user input in base64 encoding.

datadog_api_client.v2.model.entity_response_included_raw_schema_type module¶

class EntityResponseIncludedRawSchemaType(arg: None)¶

class EntityResponseIncludedRawSchemaType(arg: ModelComposed)

class EntityResponseIncludedRawSchemaType(*args, **kwargs)

Bases: ModelSimple

Raw schema type.

Parameters:

value (str) – If omitted defaults to “rawSchema”. Must be one of [“rawSchema”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_included_related_entity module¶

class EntityResponseIncludedRelatedEntity(arg: None)¶

class EntityResponseIncludedRelatedEntity(arg: ModelComposed)

class EntityResponseIncludedRelatedEntity(*args, **kwargs)

Bases: ModelNormal

Included related entity.

Parameters:

attributes (EntityResponseIncludedRelatedEntityAttributes, optional) – Related entity attributes.
id (str, optional) – Entity UUID.
meta (EntityResponseIncludedRelatedEntityMeta, optional) – Included related entity meta.
type (EntityResponseIncludedRelatedEntityType, optional) – Related entity.

datadog_api_client.v2.model.entity_response_included_related_entity_attributes module¶

class EntityResponseIncludedRelatedEntityAttributes(arg: None)¶

class EntityResponseIncludedRelatedEntityAttributes(arg: ModelComposed)

class EntityResponseIncludedRelatedEntityAttributes(*args, **kwargs)

Bases: ModelNormal

Related entity attributes.

Parameters:

kind (str, optional) – Entity kind.
name (str, optional) – Entity name.
namespace (str, optional) – Entity namespace.
type (str, optional) – Entity relation type to the associated entity.

datadog_api_client.v2.model.entity_response_included_related_entity_meta module¶

class EntityResponseIncludedRelatedEntityMeta(arg: None)¶

class EntityResponseIncludedRelatedEntityMeta(arg: ModelComposed)

class EntityResponseIncludedRelatedEntityMeta(*args, **kwargs)

Bases: ModelNormal

Included related entity meta.

Parameters:

created_at (datetime, optional) – Entity creation time.
defined_by (str, optional) – Entity relation defined by.
modified_at (datetime, optional) – Entity modification time.
source (str, optional) – Entity relation source.

datadog_api_client.v2.model.entity_response_included_related_entity_type module¶

class EntityResponseIncludedRelatedEntityType(arg: None)¶

class EntityResponseIncludedRelatedEntityType(arg: ModelComposed)

class EntityResponseIncludedRelatedEntityType(*args, **kwargs)

Bases: ModelSimple

Related entity.

Parameters:

value (str) – If omitted defaults to “relatedEntity”. Must be one of [“relatedEntity”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_included_related_incident_attributes module¶

class EntityResponseIncludedRelatedIncidentAttributes(arg: None)¶

class EntityResponseIncludedRelatedIncidentAttributes(arg: ModelComposed)

class EntityResponseIncludedRelatedIncidentAttributes(*args, **kwargs)

Bases: ModelNormal

Incident attributes.

Parameters:

created_at (datetime, optional) – Incident creation time.
html_url (str, optional) – Incident URL.
provider (str, optional) – Incident provider.
status (str, optional) – Incident status.
title (str, optional) – Incident title.

datadog_api_client.v2.model.entity_response_included_related_oncall_attributes module¶

class EntityResponseIncludedRelatedOncallAttributes(arg: None)¶

class EntityResponseIncludedRelatedOncallAttributes(arg: ModelComposed)

class EntityResponseIncludedRelatedOncallAttributes(*args, **kwargs)

Bases: ModelNormal

Included related oncall attributes.

Parameters:

escalations ([EntityResponseIncludedRelatedOncallEscalationItem], optional) – Oncall escalations.
provider (str, optional) – Oncall provider.

datadog_api_client.v2.model.entity_response_included_related_oncall_escalation_item module¶

class EntityResponseIncludedRelatedOncallEscalationItem(arg: None)¶

class EntityResponseIncludedRelatedOncallEscalationItem(arg: ModelComposed)

class EntityResponseIncludedRelatedOncallEscalationItem(*args, **kwargs)

Bases: ModelNormal

Oncall escalation.

Parameters:

email (str, optional) – Oncall email.
escalation_level (int, optional) – Oncall level.
name (str, optional) – Oncall name.

datadog_api_client.v2.model.entity_response_included_schema module¶

class EntityResponseIncludedSchema(arg: None)¶

class EntityResponseIncludedSchema(arg: ModelComposed)

class EntityResponseIncludedSchema(*args, **kwargs)

Bases: ModelNormal

Included detail entity schema.

Parameters:

attributes (EntityResponseIncludedSchemaAttributes, optional) – Included schema.
id (str, optional) – Entity ID.
type (EntityResponseIncludedSchemaType, optional) – Schema type.

datadog_api_client.v2.model.entity_response_included_schema_attributes module¶

class EntityResponseIncludedSchemaAttributes(arg: None)¶

class EntityResponseIncludedSchemaAttributes(arg: ModelComposed)

class EntityResponseIncludedSchemaAttributes(*args, **kwargs)

Bases: ModelNormal

Included schema.

Parameters:: schema (EntityV3, optional) – Entity schema v3.

datadog_api_client.v2.model.entity_response_included_schema_type module¶

class EntityResponseIncludedSchemaType(arg: None)¶

class EntityResponseIncludedSchemaType(arg: ModelComposed)

class EntityResponseIncludedSchemaType(*args, **kwargs)

Bases: ModelSimple

Schema type.

Parameters:

value (str) – If omitted defaults to “schema”. Must be one of [“schema”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_response_meta module¶

class EntityResponseMeta(arg: None)¶

class EntityResponseMeta(arg: ModelComposed)

class EntityResponseMeta(*args, **kwargs)

Bases: ModelNormal

Entity metadata.

Parameters:

count (int, optional) – Total entities count.
include_count (int, optional) – Total included data count.

datadog_api_client.v2.model.entity_to_incidents module¶

class EntityToIncidents(arg: None)¶

class EntityToIncidents(arg: ModelComposed)

class EntityToIncidents(*args, **kwargs)

Bases: ModelNormal

Entity to incidents relationship.

Parameters:: data ([RelationshipItem], optional) – Relationships.

datadog_api_client.v2.model.entity_to_oncalls module¶

class EntityToOncalls(arg: None)¶

class EntityToOncalls(arg: ModelComposed)

class EntityToOncalls(*args, **kwargs)

Bases: ModelNormal

Entity to oncalls relationship.

Parameters:: data ([RelationshipItem], optional) – Relationships.

datadog_api_client.v2.model.entity_to_raw_schema module¶

class EntityToRawSchema(arg: None)¶

class EntityToRawSchema(arg: ModelComposed)

class EntityToRawSchema(*args, **kwargs)

Bases: ModelNormal

Entity to raw schema relationship.

Parameters:: data (RelationshipItem, optional) – Relationship entry.

datadog_api_client.v2.model.entity_to_related_entities module¶

class EntityToRelatedEntities(arg: None)¶

class EntityToRelatedEntities(arg: ModelComposed)

class EntityToRelatedEntities(*args, **kwargs)

Bases: ModelNormal

Entity to related entities relationship.

Parameters:: data ([RelationshipItem], optional) – Relationships.

datadog_api_client.v2.model.entity_to_schema module¶

class EntityToSchema(arg: None)¶

class EntityToSchema(arg: ModelComposed)

class EntityToSchema(*args, **kwargs)

Bases: ModelNormal

Entity to detail schema relationship.

Parameters:: data (RelationshipItem, optional) – Relationship entry.

datadog_api_client.v2.model.entity_v3 module¶

class EntityV3(arg: None)¶

class EntityV3(arg: ModelComposed)

class EntityV3(*args, **kwargs)

Bases: ModelComposed

Entity schema v3.

Parameters:

api_version (EntityV3APIVersion) – The version of the schema data that was used to populate this entity’s data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
datadog (EntityV3ServiceDatadog, optional) – Datadog product integrations for the service entity.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
integrations (EntityV3Integrations, optional) – A base schema for defining third-party integrations.
kind (EntityV3ServiceKind) – The definition of Entity V3 Service Kind object.
metadata (EntityV3Metadata) – The definition of Entity V3 Metadata object.
spec (EntityV3ServiceSpec, optional) – The definition of Entity V3 Service Spec object.

datadog_api_client.v2.model.entity_v3_api module¶

class EntityV3API(arg: None)¶

class EntityV3API(arg: ModelComposed)

class EntityV3API(*args, **kwargs)

Bases: ModelNormal

Schema for API entities.

Parameters:

api_version (EntityV3APIVersion) – The version of the schema data that was used to populate this entity’s data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
datadog (EntityV3APIDatadog, optional) – Datadog product integrations for the API entity.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
integrations (EntityV3Integrations, optional) – A base schema for defining third-party integrations.
kind (EntityV3APIKind) – The definition of Entity V3 API Kind object.
metadata (EntityV3Metadata) – The definition of Entity V3 Metadata object.
spec (EntityV3APISpec, optional) – The definition of Entity V3 API Spec object.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_api_datadog module¶

class EntityV3APIDatadog(arg: None)¶

class EntityV3APIDatadog(arg: ModelComposed)

class EntityV3APIDatadog(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the API entity.

Parameters:

code_locations ([EntityV3DatadogCodeLocationItem], optional) – Schema for mapping source code locations to an entity.
events ([EntityV3DatadogEventItem], optional) – Events associations.
logs ([EntityV3DatadogLogItem], optional) – Logs association.
performance_data (EntityV3DatadogPerformance, optional) – Performance stats association.
pipelines (EntityV3DatadogPipelines, optional) – CI Pipelines association.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_api_kind module¶

class EntityV3APIKind(arg: None)¶

class EntityV3APIKind(arg: ModelComposed)

class EntityV3APIKind(*args, **kwargs)

Bases: ModelSimple

The definition of Entity V3 API Kind object.

Parameters:

value (str) – If omitted defaults to “api”. Must be one of [“api”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_v3_api_spec module¶

class EntityV3APISpec(arg: None)¶

class EntityV3APISpec(arg: ModelComposed)

class EntityV3APISpec(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 API Spec object.

Parameters:

implemented_by ([str], optional) – Services which implemented the API.
interface (EntityV3APISpecInterface, optional) – The API definition.
lifecycle (str, optional) – The lifecycle state of the component.
tier (str, optional) – The importance of the component.
type (str, optional) – The type of API.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_api_spec_interface module¶

class EntityV3APISpecInterface(arg: None)¶

class EntityV3APISpecInterface(arg: ModelComposed)

class EntityV3APISpecInterface(*args, **kwargs)

Bases: ModelComposed

The API definition.

Parameters:

file_ref (str, optional) – The reference to the API definition file.
definition (dict, optional) – The API definition.

datadog_api_client.v2.model.entity_v3_api_spec_interface_definition module¶

class EntityV3APISpecInterfaceDefinition(arg: None)¶

class EntityV3APISpecInterfaceDefinition(arg: ModelComposed)

class EntityV3APISpecInterfaceDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of EntityV3APISpecInterfaceDefinition object.

Parameters:: definition (dict, optional) – The API definition.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_api_spec_interface_file_ref module¶

class EntityV3APISpecInterfaceFileRef(arg: None)¶

class EntityV3APISpecInterfaceFileRef(arg: ModelComposed)

class EntityV3APISpecInterfaceFileRef(*args, **kwargs)

Bases: ModelNormal

The definition of EntityV3APISpecInterfaceFileRef object.

Parameters:: file_ref (str, optional) – The reference to the API definition file.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_code_location_item module¶

class EntityV3DatadogCodeLocationItem(arg: None)¶

class EntityV3DatadogCodeLocationItem(arg: ModelComposed)

class EntityV3DatadogCodeLocationItem(*args, **kwargs)

Bases: ModelNormal

Code location item.

Parameters:

paths ([str], optional) – The paths (glob) to the source code of the service.
repository_url (str, optional) – The repository path of the source code of the entity.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_event_item module¶

class EntityV3DatadogEventItem(arg: None)¶

class EntityV3DatadogEventItem(arg: ModelComposed)

class EntityV3DatadogEventItem(*args, **kwargs)

Bases: ModelNormal

Events association item.

Parameters:

name (str, optional) – The name of the query.
query (str, optional) – The query to run.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_integration_opsgenie module¶

class EntityV3DatadogIntegrationOpsgenie(arg: None)¶

class EntityV3DatadogIntegrationOpsgenie(arg: ModelComposed)

class EntityV3DatadogIntegrationOpsgenie(*args, **kwargs)

Bases: ModelNormal

An Opsgenie integration schema.

Parameters:

region (str, optional) – The region for the Opsgenie integration.
service_url (str) – The service URL for the Opsgenie integration.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_integration_pagerduty module¶

class EntityV3DatadogIntegrationPagerduty(arg: None)¶

class EntityV3DatadogIntegrationPagerduty(arg: ModelComposed)

class EntityV3DatadogIntegrationPagerduty(*args, **kwargs)

Bases: ModelNormal

A PagerDuty integration schema.

Parameters:: service_url (str) – The service URL for the PagerDuty integration.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_log_item module¶

class EntityV3DatadogLogItem(arg: None)¶

class EntityV3DatadogLogItem(arg: ModelComposed)

class EntityV3DatadogLogItem(*args, **kwargs)

Bases: ModelNormal

Log association item.

Parameters:

name (str, optional) – The name of the query.
query (str, optional) – The query to run.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_performance module¶

class EntityV3DatadogPerformance(arg: None)¶

class EntityV3DatadogPerformance(arg: ModelComposed)

class EntityV3DatadogPerformance(*args, **kwargs)

Bases: ModelNormal

Performance stats association.

Parameters:: tags ([str], optional) – A list of APM entity tags that associates the APM Stats data with the entity.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datadog_pipelines module¶

class EntityV3DatadogPipelines(arg: None)¶

class EntityV3DatadogPipelines(arg: ModelComposed)

class EntityV3DatadogPipelines(*args, **kwargs)

Bases: ModelNormal

CI Pipelines association.

Parameters:: fingerprints ([str], optional) – A list of CI Fingerprints that associate CI Pipelines with the entity.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datastore module¶

class EntityV3Datastore(arg: None)¶

class EntityV3Datastore(arg: ModelComposed)

class EntityV3Datastore(*args, **kwargs)

Bases: ModelNormal

Schema for datastore entities.

Parameters:

api_version (EntityV3APIVersion) – The version of the schema data that was used to populate this entity’s data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
datadog (EntityV3DatastoreDatadog, optional) – Datadog product integrations for the datastore entity.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations (EntityV3Integrations, optional) – A base schema for defining third-party integrations.
kind (EntityV3DatastoreKind) – The definition of Entity V3 Datastore Kind object.
metadata (EntityV3Metadata) – The definition of Entity V3 Metadata object.
spec (EntityV3DatastoreSpec, optional) – The definition of Entity V3 Datastore Spec object.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datastore_datadog module¶

class EntityV3DatastoreDatadog(arg: None)¶

class EntityV3DatastoreDatadog(arg: ModelComposed)

class EntityV3DatastoreDatadog(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the datastore entity.

Parameters:

events ([EntityV3DatadogEventItem], optional) – Events associations.
logs ([EntityV3DatadogLogItem], optional) – Logs association.
performance_data (EntityV3DatadogPerformance, optional) – Performance stats association.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_datastore_kind module¶

class EntityV3DatastoreKind(arg: None)¶

class EntityV3DatastoreKind(arg: ModelComposed)

class EntityV3DatastoreKind(*args, **kwargs)

Bases: ModelSimple

The definition of Entity V3 Datastore Kind object.

Parameters:

value (str) – If omitted defaults to “datastore”. Must be one of [“datastore”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_v3_datastore_spec module¶

class EntityV3DatastoreSpec(arg: None)¶

class EntityV3DatastoreSpec(arg: ModelComposed)

class EntityV3DatastoreSpec(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Datastore Spec object.

Parameters:

component_of ([str], optional) – A list of components the datastore is a part of
lifecycle (str, optional) – The lifecycle state of the datastore.
tier (str, optional) – The importance of the datastore.
type (str, optional) – The type of datastore.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_integrations module¶

class EntityV3Integrations(arg: None)¶

class EntityV3Integrations(arg: ModelComposed)

class EntityV3Integrations(*args, **kwargs)

Bases: ModelNormal

A base schema for defining third-party integrations.

Parameters:

opsgenie (EntityV3DatadogIntegrationOpsgenie, optional) – An Opsgenie integration schema.
pagerduty (EntityV3DatadogIntegrationPagerduty, optional) – A PagerDuty integration schema.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_metadata module¶

class EntityV3Metadata(arg: None)¶

class EntityV3Metadata(arg: ModelComposed)

class EntityV3Metadata(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Metadata object.

Parameters:

additional_owners ([EntityV3MetadataAdditionalOwnersItems], optional) – The additional owners of the entity, usually a team.
contacts ([EntityV3MetadataContactsItems], optional) – A list of contacts for the entity.
description (str, optional) – Short description of the entity. The UI can leverage the description for display.
display_name (str, optional) – User friendly name of the entity. The UI can leverage the display name for display.
id (str, optional) – A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inherit_from (str, optional) – The entity reference from which to inherit metadata
links ([EntityV3MetadataLinksItems], optional) – A list of links for the entity.
managed ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name (str) – Unique name given to an entity under the kind/namespace.
namespace (str, optional) – Namespace is a part of unique identifier. It has a default value of ‘default’.
owner (str, optional) – The owner of the entity, usually a team.
tags ([str], optional) – A set of custom tags.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_metadata_additional_owners_items module¶

class EntityV3MetadataAdditionalOwnersItems(arg: None)¶

class EntityV3MetadataAdditionalOwnersItems(arg: ModelComposed)

class EntityV3MetadataAdditionalOwnersItems(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Metadata Additional Owners Items object.

Parameters:

name (str) – Team name.
type (str, optional) – Team type.

datadog_api_client.v2.model.entity_v3_metadata_contacts_items module¶

class EntityV3MetadataContactsItems(arg: None)¶

class EntityV3MetadataContactsItems(arg: ModelComposed)

class EntityV3MetadataContactsItems(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Metadata Contacts Items object.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact name.
type (str) – Contact type.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_metadata_links_items module¶

class EntityV3MetadataLinksItems(arg: None)¶

class EntityV3MetadataLinksItems(arg: ModelComposed)

class EntityV3MetadataLinksItems(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Metadata Links Items object.

Parameters:

name (str) – Link name.
provider (str, optional) – Link provider.
type (str) – Link type.
url (str) – Link URL.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_queue module¶

class EntityV3Queue(arg: None)¶

class EntityV3Queue(arg: ModelComposed)

class EntityV3Queue(*args, **kwargs)

Bases: ModelNormal

Schema for queue entities.

Parameters:

api_version (EntityV3APIVersion) – The version of the schema data that was used to populate this entity’s data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
datadog (EntityV3QueueDatadog, optional) – Datadog product integrations for the datastore entity.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
integrations (EntityV3Integrations, optional) – A base schema for defining third-party integrations.
kind (EntityV3QueueKind) – The definition of Entity V3 Queue Kind object.
metadata (EntityV3Metadata) – The definition of Entity V3 Metadata object.
spec (EntityV3QueueSpec, optional) – The definition of Entity V3 Queue Spec object.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_queue_datadog module¶

class EntityV3QueueDatadog(arg: None)¶

class EntityV3QueueDatadog(arg: ModelComposed)

class EntityV3QueueDatadog(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the datastore entity.

Parameters:

events ([EntityV3DatadogEventItem], optional) – Events associations.
logs ([EntityV3DatadogLogItem], optional) – Logs association.
performance_data (EntityV3DatadogPerformance, optional) – Performance stats association.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_queue_kind module¶

class EntityV3QueueKind(arg: None)¶

class EntityV3QueueKind(arg: ModelComposed)

class EntityV3QueueKind(*args, **kwargs)

Bases: ModelSimple

The definition of Entity V3 Queue Kind object.

Parameters:

value (str) – If omitted defaults to “queue”. Must be one of [“queue”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_v3_queue_spec module¶

class EntityV3QueueSpec(arg: None)¶

class EntityV3QueueSpec(arg: ModelComposed)

class EntityV3QueueSpec(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Queue Spec object.

Parameters:

component_of ([str], optional) – A list of components the queue is a part of
lifecycle (str, optional) – The lifecycle state of the queue.
tier (str, optional) – The importance of the queue.
type (str, optional) – The type of queue.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_service module¶

class EntityV3Service(arg: None)¶

class EntityV3Service(arg: ModelComposed)

class EntityV3Service(*args, **kwargs)

Bases: ModelNormal

Schema for service entities.

Parameters:

api_version (EntityV3APIVersion) – The version of the schema data that was used to populate this entity’s data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
datadog (EntityV3ServiceDatadog, optional) – Datadog product integrations for the service entity.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
integrations (EntityV3Integrations, optional) – A base schema for defining third-party integrations.
kind (EntityV3ServiceKind) – The definition of Entity V3 Service Kind object.
metadata (EntityV3Metadata) – The definition of Entity V3 Metadata object.
spec (EntityV3ServiceSpec, optional) – The definition of Entity V3 Service Spec object.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_service_datadog module¶

class EntityV3ServiceDatadog(arg: None)¶

class EntityV3ServiceDatadog(arg: ModelComposed)

class EntityV3ServiceDatadog(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the service entity.

Parameters:

code_locations ([EntityV3DatadogCodeLocationItem], optional) – Schema for mapping source code locations to an entity.
events ([EntityV3DatadogEventItem], optional) – Events associations.
logs ([EntityV3DatadogLogItem], optional) – Logs association.
performance_data (EntityV3DatadogPerformance, optional) – Performance stats association.
pipelines (EntityV3DatadogPipelines, optional) – CI Pipelines association.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_service_kind module¶

class EntityV3ServiceKind(arg: None)¶

class EntityV3ServiceKind(arg: ModelComposed)

class EntityV3ServiceKind(*args, **kwargs)

Bases: ModelSimple

The definition of Entity V3 Service Kind object.

Parameters:

value (str) – If omitted defaults to “service”. Must be one of [“service”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_v3_service_spec module¶

class EntityV3ServiceSpec(arg: None)¶

class EntityV3ServiceSpec(arg: ModelComposed)

class EntityV3ServiceSpec(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Service Spec object.

Parameters:

component_of ([str], optional) – A list of components the service is a part of
depends_on ([str], optional) – A list of components the service depends on.
languages ([str], optional) – The service’s programming language.
lifecycle (str, optional) – The lifecycle state of the component.
tier (str, optional) – The importance of the component.
type (str, optional) – The type of service.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_system module¶

class EntityV3System(arg: None)¶

class EntityV3System(arg: ModelComposed)

class EntityV3System(*args, **kwargs)

Bases: ModelNormal

Schema for system entities.

Parameters:

api_version (EntityV3APIVersion) – The version of the schema data that was used to populate this entity’s data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version.
datadog (EntityV3SystemDatadog, optional) – Datadog product integrations for the service entity.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
integrations (EntityV3Integrations, optional) – A base schema for defining third-party integrations.
kind (EntityV3SystemKind) – The definition of Entity V3 System Kind object.
metadata (EntityV3Metadata) – The definition of Entity V3 Metadata object.
spec (EntityV3SystemSpec, optional) – The definition of Entity V3 System Spec object.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_system_datadog module¶

class EntityV3SystemDatadog(arg: None)¶

class EntityV3SystemDatadog(arg: ModelComposed)

class EntityV3SystemDatadog(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the service entity.

Parameters:

events ([EntityV3DatadogEventItem], optional) – Events associations.
logs ([EntityV3DatadogLogItem], optional) – Logs association.
performance_data (EntityV3DatadogPerformance, optional) – Performance stats association.
pipelines (EntityV3DatadogPipelines, optional) – CI Pipelines association.

additional_properties_type = None¶

datadog_api_client.v2.model.entity_v3_system_kind module¶

class EntityV3SystemKind(arg: None)¶

class EntityV3SystemKind(arg: ModelComposed)

class EntityV3SystemKind(*args, **kwargs)

Bases: ModelSimple

The definition of Entity V3 System Kind object.

Parameters:

value (str) – If omitted defaults to “system”. Must be one of [“system”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.entity_v3_system_spec module¶

class EntityV3SystemSpec(arg: None)¶

class EntityV3SystemSpec(arg: ModelComposed)

class EntityV3SystemSpec(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 System Spec object.

Parameters:

components ([str], optional) – A list of components belongs to the system.
lifecycle (str, optional) – The lifecycle state of the component.
tier (str, optional) – An entity reference to the owner of the component.

additional_properties_type = None¶

datadog_api_client.v2.model.epss module¶

class EPSS(arg: None)¶

class EPSS(arg: ModelComposed)

class EPSS(*args, **kwargs)

Bases: ModelNormal

Vulnerability EPSS severity.

Parameters:

score (float) – Vulnerability EPSS severity score.
severity (VulnerabilitySeverity) – The vulnerability severity.

datadog_api_client.v2.model.error_handler module¶

class ErrorHandler(arg: None)¶

class ErrorHandler(arg: ModelComposed)

class ErrorHandler(*args, **kwargs)

Bases: ModelNormal

Used to handle errors in an action.

Parameters:

fallback_step_name (str) – The ErrorHandler fallbackStepName.
retry_strategy (RetryStrategy) – The definition of RetryStrategy object.

datadog_api_client.v2.model.escalation module¶

class Escalation(arg: None)¶

class Escalation(arg: ModelComposed)

class Escalation(*args, **kwargs)

Bases: ModelNormal

Represents an escalation policy step.

Parameters:

id (str, optional) – Unique identifier of the escalation step.
relationships (EscalationRelationships, optional) – Contains the relationships of an escalation object, including its responders.
type (EscalationType) – Represents the resource type for individual steps in an escalation policy used during incident response.

datadog_api_client.v2.model.escalation_policy module¶

class EscalationPolicy(arg: None)¶

class EscalationPolicy(arg: ModelComposed)

class EscalationPolicy(*args, **kwargs)

Bases: ModelNormal

Represents a complete escalation policy response, including policy data and optionally included related resources.

Parameters:

data (EscalationPolicyData, optional) – Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
included ([EscalationPolicyIncluded], optional) – Provides any included related resources, such as steps or targets, returned with the policy.

datadog_api_client.v2.model.escalation_policy_create_request module¶

class EscalationPolicyCreateRequest(arg: None)¶

class EscalationPolicyCreateRequest(arg: ModelComposed)

class EscalationPolicyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Represents a request to create a new escalation policy, including the policy data.

Parameters:: data (EscalationPolicyCreateRequestData) – Represents the data for creating an escalation policy, including its attributes, relationships, and resource type.

datadog_api_client.v2.model.escalation_policy_create_request_data module¶

class EscalationPolicyCreateRequestData(arg: None)¶

class EscalationPolicyCreateRequestData(arg: ModelComposed)

class EscalationPolicyCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Represents the data for creating an escalation policy, including its attributes, relationships, and resource type.

Parameters:

attributes (EscalationPolicyCreateRequestDataAttributes) – Defines the attributes for creating an escalation policy, including its description, name, resolution behavior, retries, and steps.
relationships (EscalationPolicyCreateRequestDataRelationships, optional) – Represents relationships in an escalation policy creation request, including references to teams.
type (EscalationPolicyCreateRequestDataType) – Indicates that the resource is of type policies.

datadog_api_client.v2.model.escalation_policy_create_request_data_attributes module¶

class EscalationPolicyCreateRequestDataAttributes(arg: None)¶

class EscalationPolicyCreateRequestDataAttributes(arg: ModelComposed)

class EscalationPolicyCreateRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Defines the attributes for creating an escalation policy, including its description, name, resolution behavior, retries, and steps.

Parameters:

name (str) – Specifies the name for the new escalation policy.
resolve_page_on_policy_end (bool, optional) – Indicates whether the page is automatically resolved when the policy ends.
retries (int, optional) – Specifies how many times the escalation sequence is retried if there is no response.
steps ([EscalationPolicyCreateRequestDataAttributesStepsItems]) – A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy.

datadog_api_client.v2.model.escalation_policy_create_request_data_attributes_steps_items module¶

class EscalationPolicyCreateRequestDataAttributesStepsItems(arg: None)¶

class EscalationPolicyCreateRequestDataAttributesStepsItems(arg: ModelComposed)

class EscalationPolicyCreateRequestDataAttributesStepsItems(*args, **kwargs)

Bases: ModelNormal

Defines a single escalation step within an escalation policy creation request. Contains assignment strategy, escalation timeout, and a list of targets.

Parameters:

assignment (EscalationPolicyStepAttributesAssignment, optional) – Specifies how this escalation step will assign targets (example default or round-robin ).
escalate_after_seconds (int, optional) – Defines how many seconds to wait before escalating to the next step.
targets ([EscalationPolicyStepTarget]) – Specifies the collection of escalation targets for this step.

datadog_api_client.v2.model.escalation_policy_create_request_data_relationships module¶

class EscalationPolicyCreateRequestDataRelationships(arg: None)¶

class EscalationPolicyCreateRequestDataRelationships(arg: ModelComposed)

class EscalationPolicyCreateRequestDataRelationships(*args, **kwargs)

Bases: ModelNormal

Represents relationships in an escalation policy creation request, including references to teams.

Parameters:: teams (DataRelationshipsTeams, optional) – Associates teams with this schedule in a data structure.

datadog_api_client.v2.model.escalation_policy_create_request_data_type module¶

class EscalationPolicyCreateRequestDataType(arg: None)¶

class EscalationPolicyCreateRequestDataType(arg: ModelComposed)

class EscalationPolicyCreateRequestDataType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type policies.

Parameters:

value (str) – If omitted defaults to “policies”. Must be one of [“policies”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_data module¶

class EscalationPolicyData(arg: None)¶

class EscalationPolicyData(arg: ModelComposed)

class EscalationPolicyData(*args, **kwargs)

Bases: ModelNormal

Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.

Parameters:

attributes (EscalationPolicyDataAttributes, optional) – Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
id (str, optional) – Specifies the unique identifier of the escalation policy.
relationships (EscalationPolicyDataRelationships, optional) – Represents the relationships for an escalation policy, including references to steps and teams.
type (EscalationPolicyDataType) – Indicates that the resource is of type policies.

datadog_api_client.v2.model.escalation_policy_data_attributes module¶

class EscalationPolicyDataAttributes(arg: None)¶

class EscalationPolicyDataAttributes(arg: ModelComposed)

class EscalationPolicyDataAttributes(*args, **kwargs)

Bases: ModelNormal

Defines the main attributes of an escalation policy, such as its name and behavior on policy end.

Parameters:

name (str) – Specifies the name of the escalation policy.
resolve_page_on_policy_end (bool, optional) – Indicates whether the page is automatically resolved when the policy ends.
retries (int, optional) – Specifies how many times the escalation sequence is retried if there is no response.

datadog_api_client.v2.model.escalation_policy_data_relationships module¶

class EscalationPolicyDataRelationships(arg: None)¶

class EscalationPolicyDataRelationships(arg: ModelComposed)

class EscalationPolicyDataRelationships(*args, **kwargs)

Bases: ModelNormal

Represents the relationships for an escalation policy, including references to steps and teams.

Parameters:

steps (EscalationPolicyDataRelationshipsSteps) – Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
teams (DataRelationshipsTeams, optional) – Associates teams with this schedule in a data structure.

datadog_api_client.v2.model.escalation_policy_data_relationships_steps module¶

class EscalationPolicyDataRelationshipsSteps(arg: None)¶

class EscalationPolicyDataRelationshipsSteps(arg: ModelComposed)

class EscalationPolicyDataRelationshipsSteps(*args, **kwargs)

Bases: ModelNormal

Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.

Parameters:: data ([EscalationPolicyDataRelationshipsStepsDataItems], optional) – An array of references to the steps defined in this escalation policy.

datadog_api_client.v2.model.escalation_policy_data_relationships_steps_data_items module¶

class EscalationPolicyDataRelationshipsStepsDataItems(arg: None)¶

class EscalationPolicyDataRelationshipsStepsDataItems(arg: ModelComposed)

class EscalationPolicyDataRelationshipsStepsDataItems(*args, **kwargs)

Bases: ModelNormal

Defines a relationship to a single step within an escalation policy. Contains the step’s id and type.

Parameters:

id (str) – Specifies the unique identifier for the step resource.
type (EscalationPolicyDataRelationshipsStepsDataItemsType) – Indicates that the resource is of type steps.

datadog_api_client.v2.model.escalation_policy_data_relationships_steps_data_items_type module¶

class EscalationPolicyDataRelationshipsStepsDataItemsType(arg: None)¶

class EscalationPolicyDataRelationshipsStepsDataItemsType(arg: ModelComposed)

class EscalationPolicyDataRelationshipsStepsDataItemsType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type steps.

Parameters:

value (str) – If omitted defaults to “steps”. Must be one of [“steps”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_data_type module¶

class EscalationPolicyDataType(arg: None)¶

class EscalationPolicyDataType(arg: ModelComposed)

class EscalationPolicyDataType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type policies.

Parameters:

value (str) – If omitted defaults to “policies”. Must be one of [“policies”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_included module¶

class EscalationPolicyIncluded(arg: None)¶

class EscalationPolicyIncluded(arg: ModelComposed)

class EscalationPolicyIncluded(*args, **kwargs)

Bases: ModelComposed

Represents included related resources when retrieving an escalation policy, such as teams, steps, or targets.

Parameters:

attributes (TeamReferenceAttributes, optional) – Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
id (str, optional) – The team’s unique identifier.
type (TeamReferenceType) – Teams resource type.
relationships (EscalationPolicyStepRelationships, optional) – Represents the relationship of an escalation policy step to its targets.

datadog_api_client.v2.model.escalation_policy_step module¶

class EscalationPolicyStep(arg: None)¶

class EscalationPolicyStep(arg: ModelComposed)

class EscalationPolicyStep(*args, **kwargs)

Bases: ModelNormal

Represents a single step in an escalation policy, including its attributes, relationships, and resource type.

Parameters:

attributes (EscalationPolicyStepAttributes, optional) – Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
id (str, optional) – Specifies the unique identifier of this escalation policy step.
relationships (EscalationPolicyStepRelationships, optional) – Represents the relationship of an escalation policy step to its targets.
type (EscalationPolicyStepType) – Indicates that the resource is of type steps.

datadog_api_client.v2.model.escalation_policy_step_attributes module¶

class EscalationPolicyStepAttributes(arg: None)¶

class EscalationPolicyStepAttributes(arg: ModelComposed)

class EscalationPolicyStepAttributes(*args, **kwargs)

Bases: ModelNormal

Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.

Parameters:

assignment (EscalationPolicyStepAttributesAssignment, optional) – Specifies how this escalation step will assign targets (example default or round-robin ).
escalate_after_seconds (int, optional) – Specifies how many seconds to wait before escalating to the next step.

datadog_api_client.v2.model.escalation_policy_step_attributes_assignment module¶

class EscalationPolicyStepAttributesAssignment(arg: None)¶

class EscalationPolicyStepAttributesAssignment(arg: ModelComposed)

class EscalationPolicyStepAttributesAssignment(*args, **kwargs)

Bases: ModelSimple

Specifies how this escalation step will assign targets (example default or round-robin).

Parameters:

value (str) – Must be one of [“default”, “round-robin”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_step_relationships module¶

class EscalationPolicyStepRelationships(arg: None)¶

class EscalationPolicyStepRelationships(arg: ModelComposed)

class EscalationPolicyStepRelationships(*args, **kwargs)

Bases: ModelNormal

Represents the relationship of an escalation policy step to its targets.

Parameters:: targets (EscalationTargets, optional) – A list of escalation targets for a step

datadog_api_client.v2.model.escalation_policy_step_target module¶

class EscalationPolicyStepTarget(arg: None)¶

class EscalationPolicyStepTarget(arg: ModelComposed)

class EscalationPolicyStepTarget(*args, **kwargs)

Bases: ModelNormal

Defines a single escalation target within a step for an escalation policy creation request. Contains id and type.

Parameters:

id (str, optional) – Specifies the unique identifier for this target.
type (EscalationPolicyStepTargetType, optional) – Specifies the type of escalation target (example users , schedules , or teams ).

datadog_api_client.v2.model.escalation_policy_step_target_type module¶

class EscalationPolicyStepTargetType(arg: None)¶

class EscalationPolicyStepTargetType(arg: ModelComposed)

class EscalationPolicyStepTargetType(*args, **kwargs)

Bases: ModelSimple

Specifies the type of escalation target (example users, schedules, or teams).

Parameters:

value (str) – Must be one of [“users”, “schedules”, “teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_step_type module¶

class EscalationPolicyStepType(arg: None)¶

class EscalationPolicyStepType(arg: ModelComposed)

class EscalationPolicyStepType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type steps.

Parameters:

value (str) – If omitted defaults to “steps”. Must be one of [“steps”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_update_request module¶

class EscalationPolicyUpdateRequest(arg: None)¶

class EscalationPolicyUpdateRequest(arg: ModelComposed)

class EscalationPolicyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Represents a request to update an existing escalation policy, including the updated policy data.

Parameters:: data (EscalationPolicyUpdateRequestData) – Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type.

datadog_api_client.v2.model.escalation_policy_update_request_data module¶

class EscalationPolicyUpdateRequestData(arg: None)¶

class EscalationPolicyUpdateRequestData(arg: ModelComposed)

class EscalationPolicyUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type.

Parameters:

attributes (EscalationPolicyUpdateRequestDataAttributes) – Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps.
id (str) – Specifies the unique identifier of the escalation policy being updated.
relationships (EscalationPolicyUpdateRequestDataRelationships, optional) – Represents relationships in an escalation policy update request, including references to teams.
type (EscalationPolicyUpdateRequestDataType) – Indicates that the resource is of type policies.

datadog_api_client.v2.model.escalation_policy_update_request_data_attributes module¶

class EscalationPolicyUpdateRequestDataAttributes(arg: None)¶

class EscalationPolicyUpdateRequestDataAttributes(arg: ModelComposed)

class EscalationPolicyUpdateRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps.

Parameters:

name (str) – Specifies the name of the escalation policy.
resolve_page_on_policy_end (bool, optional) – Indicates whether the page is automatically resolved when the policy ends.
retries (int, optional) – Specifies how many times the escalation sequence is retried if there is no response.
steps ([EscalationPolicyUpdateRequestDataAttributesStepsItems]) – A list of escalation steps, each defining assignment, escalation timeout, and targets.

datadog_api_client.v2.model.escalation_policy_update_request_data_attributes_steps_items module¶

class EscalationPolicyUpdateRequestDataAttributesStepsItems(arg: None)¶

class EscalationPolicyUpdateRequestDataAttributesStepsItems(arg: ModelComposed)

class EscalationPolicyUpdateRequestDataAttributesStepsItems(*args, **kwargs)

Bases: ModelNormal

Defines a single escalation step within an escalation policy update request. Contains assignment strategy, escalation timeout, an optional step ID, and a list of targets.

Parameters:

assignment (EscalationPolicyStepAttributesAssignment, optional) – Specifies how this escalation step will assign targets (example default or round-robin ).
escalate_after_seconds (int, optional) – Defines how many seconds to wait before escalating to the next step.
id (str, optional) – Specifies the unique identifier of this step.
targets ([EscalationPolicyStepTarget]) – Specifies the collection of escalation targets for this step.

datadog_api_client.v2.model.escalation_policy_update_request_data_relationships module¶

class EscalationPolicyUpdateRequestDataRelationships(arg: None)¶

class EscalationPolicyUpdateRequestDataRelationships(arg: ModelComposed)

class EscalationPolicyUpdateRequestDataRelationships(*args, **kwargs)

Bases: ModelNormal

Represents relationships in an escalation policy update request, including references to teams.

Parameters:: teams (DataRelationshipsTeams, optional) – Associates teams with this schedule in a data structure.

datadog_api_client.v2.model.escalation_policy_update_request_data_type module¶

class EscalationPolicyUpdateRequestDataType(arg: None)¶

class EscalationPolicyUpdateRequestDataType(arg: ModelComposed)

class EscalationPolicyUpdateRequestDataType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type policies.

Parameters:

value (str) – If omitted defaults to “policies”. Must be one of [“policies”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_policy_user module¶

class EscalationPolicyUser(arg: None)¶

class EscalationPolicyUser(arg: ModelComposed)

class EscalationPolicyUser(*args, **kwargs)

Bases: ModelNormal

Represents a user object in the context of an escalation policy, including their id , type, and basic attributes.

Parameters:

attributes (EscalationPolicyUserAttributes, optional) – Provides basic user information for an escalation policy, including a name and email address.
id (str, optional) – The unique user identifier.
type (EscalationPolicyUserType) – Users resource type.

datadog_api_client.v2.model.escalation_policy_user_attributes module¶

class EscalationPolicyUserAttributes(arg: None)¶

class EscalationPolicyUserAttributes(arg: ModelComposed)

class EscalationPolicyUserAttributes(*args, **kwargs)

Bases: ModelNormal

Provides basic user information for an escalation policy, including a name and email address.

Parameters:

email (str, optional) – The user’s email address.
name (str, optional) – The user’s name.
status (UserAttributesStatus, optional) – The user’s status.

datadog_api_client.v2.model.escalation_policy_user_type module¶

class EscalationPolicyUserType(arg: None)¶

class EscalationPolicyUserType(arg: ModelComposed)

class EscalationPolicyUserType(*args, **kwargs)

Bases: ModelSimple

Users resource type.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_relationships module¶

class EscalationRelationships(arg: None)¶

class EscalationRelationships(arg: ModelComposed)

class EscalationRelationships(*args, **kwargs)

Bases: ModelNormal

Contains the relationships of an escalation object, including its responders.

Parameters:: responders (EscalationRelationshipsResponders, optional) – Lists the users involved in a specific step of the escalation policy.

datadog_api_client.v2.model.escalation_relationships_responders module¶

class EscalationRelationshipsResponders(arg: None)¶

class EscalationRelationshipsResponders(arg: ModelComposed)

class EscalationRelationshipsResponders(*args, **kwargs)

Bases: ModelNormal

Lists the users involved in a specific step of the escalation policy.

Parameters:: data ([EscalationRelationshipsRespondersDataItems], optional) – Array of user references assigned as responders for this escalation step.

datadog_api_client.v2.model.escalation_relationships_responders_data_items module¶

class EscalationRelationshipsRespondersDataItems(arg: None)¶

class EscalationRelationshipsRespondersDataItems(arg: ModelComposed)

class EscalationRelationshipsRespondersDataItems(*args, **kwargs)

Bases: ModelNormal

Represents a user assigned to an escalation step.

Parameters:

id (str) – Unique identifier of the user assigned to the escalation step.
type (EscalationRelationshipsRespondersDataItemsType) – Represents the resource type for users assigned as responders in an escalation step.

datadog_api_client.v2.model.escalation_relationships_responders_data_items_type module¶

class EscalationRelationshipsRespondersDataItemsType(arg: None)¶

class EscalationRelationshipsRespondersDataItemsType(arg: ModelComposed)

class EscalationRelationshipsRespondersDataItemsType(*args, **kwargs)

Bases: ModelSimple

Represents the resource type for users assigned as responders in an escalation step.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.escalation_target module¶

class EscalationTarget(arg: None)¶

class EscalationTarget(arg: ModelComposed)

class EscalationTarget(*args, **kwargs)

Bases: ModelComposed

Represents an escalation target, which can be a team, user, or schedule.

Parameters:

id (str) – Specifies the unique identifier of the team resource.
type (TeamTargetType) – Indicates that the resource is of type teams.

datadog_api_client.v2.model.escalation_targets module¶

class EscalationTargets(arg: None)¶

class EscalationTargets(arg: ModelComposed)

class EscalationTargets(*args, **kwargs)

Bases: ModelNormal

A list of escalation targets for a step

Parameters:: data ([EscalationTarget], optional) – The EscalationTargets data.

datadog_api_client.v2.model.escalation_type module¶

class EscalationType(arg: None)¶

class EscalationType(arg: ModelComposed)

class EscalationType(*args, **kwargs)

Bases: ModelSimple

Represents the resource type for individual steps in an escalation policy used during incident response.

Parameters:

value (str) – If omitted defaults to “escalation_policy_steps”. Must be one of [“escalation_policy_steps”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.estimation module¶

class Estimation(arg: None)¶

class Estimation(arg: ModelComposed)

class Estimation(*args, **kwargs)

Bases: ModelNormal

Recommended resource values for a Spark driver or executor, derived from recent real usage metrics. Used by SPA to propose more efficient pod sizing.

Parameters:

cpu (Cpu, optional) – CPU usage statistics derived from historical Spark job metrics. Provides multiple estimates so users can choose between conservative and cost-saving risk profiles.
ephemeral_storage (int, optional) – Recommended ephemeral storage allocation (in MiB). Derived from job temporary storage patterns.
heap (int, optional) – Recommended JVM heap size (in MiB).
memory (int, optional) – Recommended total memory allocation (in MiB). Includes both heap and overhead.
overhead (int, optional) – Recommended JVM overhead (in MiB). Computed as total memory - heap.

datadog_api_client.v2.model.event module¶

class Event(arg: None)¶

class Event(arg: ModelComposed)

class Event(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

id (str, optional) – Event ID.
name (str, optional) – The event name.
source_id (int, optional) – Event source ID.
type (str, optional) – Event type.

datadog_api_client.v2.model.event_attributes module¶

class EventAttributes(arg: None)¶

class EventAttributes(arg: ModelComposed)

class EventAttributes(*args, **kwargs)

Bases: ModelNormal

Object description of attributes from your event.

Parameters:

aggregation_key (str, optional) – Aggregation key of the event.
date_happened (int, optional) – POSIX timestamp of the event. Must be sent as an integer (no quotation marks). Limited to events no older than 18 hours.
device_name (str, optional) – A device name.
duration (int, optional) – The duration between the triggering of the event and its recovery in nanoseconds.
event_object (str, optional) – The event title.
evt (Event, optional) – The metadata associated with a request.
hostname (str, optional) – Host name to associate with the event. Any tags associated with the host are also applied to this event.
monitor (MonitorType, none_type, optional) – Attributes from the monitor that triggered the event.
monitor_groups ([str], none_type, optional) – List of groups referred to in the event.
monitor_id (int, none_type, optional) – ID of the monitor that triggered the event. When an event isn’t related to a monitor, this field is empty.
priority (EventPriority, none_type, optional) – The priority of the event’s monitor. For example, normal or low.
related_event_id (int, optional) – Related event ID.
service (str, optional) – Service that triggered the event.
source_type_name (str, optional) – The type of event being posted. For example, nagios , hudson , jenkins , my_apps , chef , puppet , git or bitbucket. The list of standard source attribute values is available here.
sourcecategory (str, optional) – Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.
status (EventStatusType, optional) – If an alert event is enabled, its status is one of the following: failure , error , warning , info , success , user_update , recommendation , or snapshot.
tags ([str], optional) – A list of tags to apply to the event.
timestamp (int, optional) – POSIX timestamp of your event in milliseconds.
title (str, optional) – The event title.

datadog_api_client.v2.model.event_category module¶

class EventCategory(arg: None)¶

class EventCategory(arg: ModelComposed)

class EventCategory(*args, **kwargs)

Bases: ModelSimple

Event category identifying the type of event.

Parameters:

value (str) – Must be one of [“change”, “alert”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_create_request module¶

class EventCreateRequest(arg: None)¶

class EventCreateRequest(arg: ModelComposed)

class EventCreateRequest(*args, **kwargs)

Bases: ModelNormal

An event object.

Parameters:

attributes (EventPayload) – Event attributes.
type (EventCreateRequestType) – Entity type.

datadog_api_client.v2.model.event_create_request_payload module¶

class EventCreateRequestPayload(arg: None)¶

class EventCreateRequestPayload(arg: ModelComposed)

class EventCreateRequestPayload(*args, **kwargs)

Bases: ModelNormal

Payload for creating an event.

Parameters:: data (EventCreateRequest) – An event object.

datadog_api_client.v2.model.event_create_request_type module¶

class EventCreateRequestType(arg: None)¶

class EventCreateRequestType(arg: ModelComposed)

class EventCreateRequestType(*args, **kwargs)

Bases: ModelSimple

Entity type.

Parameters:

value (str) – If omitted defaults to “event”. Must be one of [“event”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_create_response module¶

class EventCreateResponse(arg: None)¶

class EventCreateResponse(arg: ModelComposed)

class EventCreateResponse(*args, **kwargs)

Bases: ModelNormal

Event object.

Parameters:

attributes (EventCreateResponseAttributes, optional) – Event attributes.
type (str, optional) – Entity type.

datadog_api_client.v2.model.event_create_response_attributes module¶

class EventCreateResponseAttributes(arg: None)¶

class EventCreateResponseAttributes(arg: ModelComposed)

class EventCreateResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Event attributes.

Parameters:: attributes (EventCreateResponseAttributesAttributes, optional) – JSON object for category-specific attributes.

datadog_api_client.v2.model.event_create_response_attributes_attributes module¶

class EventCreateResponseAttributesAttributes(arg: None)¶

class EventCreateResponseAttributesAttributes(arg: ModelComposed)

class EventCreateResponseAttributesAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object for category-specific attributes.

Parameters:: evt (EventCreateResponseAttributesAttributesEvt, optional) – JSON object of event system attributes.

datadog_api_client.v2.model.event_create_response_attributes_attributes_evt module¶

class EventCreateResponseAttributesAttributesEvt(arg: None)¶

class EventCreateResponseAttributesAttributesEvt(arg: ModelComposed)

class EventCreateResponseAttributesAttributesEvt(*args, **kwargs)

Bases: ModelNormal

JSON object of event system attributes.

Parameters:

id (str, optional) – Event identifier. This field is deprecated and will be removed in a future version. Use the uid field instead. Deprecated.
uid (str, optional) – A unique identifier for the event. You can use this identifier to query or reference the event.

datadog_api_client.v2.model.event_create_response_payload module¶

class EventCreateResponsePayload(arg: None)¶

class EventCreateResponsePayload(arg: ModelComposed)

class EventCreateResponsePayload(*args, **kwargs)

Bases: ModelNormal

Event creation response.

Parameters:

data (EventCreateResponse, optional) – Event object.
links (EventCreateResponsePayloadLinks, optional) – Links to the event.

datadog_api_client.v2.model.event_create_response_payload_links module¶

class EventCreateResponsePayloadLinks(arg: None)¶

class EventCreateResponsePayloadLinks(arg: ModelComposed)

class EventCreateResponsePayloadLinks(*args, **kwargs)

Bases: ModelNormal

Links to the event.

Parameters:: self (str, optional) – The URL of the event. This link is only functional when using the default subdomain.

datadog_api_client.v2.model.event_payload module¶

class EventPayload(arg: None)¶

class EventPayload(arg: ModelComposed)

class EventPayload(*args, **kwargs)

Bases: ModelNormal

Event attributes.

Parameters:

aggregation_key (str, optional) – A string used for aggregation when correlating events. If you specify a key, events are deduplicated to alerts based on this key. Limited to 100 characters.
attributes (EventPayloadAttributes) – JSON object for category-specific attributes. Schema is different per event category.
category (EventCategory) – Event category identifying the type of event.
integration_id (EventPayloadIntegrationId, optional) – Integration ID sourced from integration manifests.
message (str, optional) – Free formed text associated with the event. It’s suggested to use data.attributes.attributes.custom for well-structured attributes. Limited to 4000 characters.
tags ([str], optional) – A list of tags associated with the event. Maximum of 100 tags allowed. Refer to Tags docs.
timestamp (str, optional) – Timestamp when the event occurred. Must follow ISO 8601 format. For example "2017-01-15T01:30:15.010000Z". Defaults to the timestamp of receipt. Limited to values no older than 18 hours.
title (str) – The title of the event. Limited to 500 characters.

additional_properties_type = None¶

datadog_api_client.v2.model.event_payload_attributes module¶

class EventPayloadAttributes(arg: None)¶

class EventPayloadAttributes(arg: ModelComposed)

class EventPayloadAttributes(*args, **kwargs)

Bases: ModelComposed

JSON object for category-specific attributes. Schema is different per event category.

Parameters:

author (ChangeEventCustomAttributesAuthor, optional) – The entity that made the change. Optional, if provided it must include type and name.
change_metadata ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form JSON object with information related to the change event. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.
changed_resource (ChangeEventCustomAttributesChangedResource) – A uniquely identified resource.
impacted_resources ([ChangeEventCustomAttributesImpactedResourcesItems], optional) – A list of resources impacted by this change. It is recommended to provide an impacted resource to display the change event at the correct location. Only resources of type service are supported. Maximum of 100 impacted resources allowed.
new_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form JSON object representing the new state of the changed resource.
prev_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form JSON object representing the previous state of the changed resource.
custom (AlertEventCustomAttributesCustom, optional) – Free form JSON object for arbitrary data. Supports up to 100 properties per object and a maximum nesting depth of 10 levels.
links ([AlertEventCustomAttributesLinksItems], optional) – The links related to the event. Maximum of 20 links allowed.
priority (AlertEventCustomAttributesPriority, optional) – The priority of the alert.
status (AlertEventCustomAttributesStatus) – The status of the alert.

datadog_api_client.v2.model.event_payload_integration_id module¶

class EventPayloadIntegrationId(arg: None)¶

class EventPayloadIntegrationId(arg: ModelComposed)

class EventPayloadIntegrationId(*args, **kwargs)

Bases: ModelSimple

Integration ID sourced from integration manifests.

Parameters:

value (str) – If omitted defaults to “custom-events”. Must be one of [“custom-events”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_priority module¶

class EventPriority(arg: None)¶

class EventPriority(arg: ModelComposed)

class EventPriority(*args, **kwargs)

Bases: ModelSimple

The priority of the event’s monitor. For example, normal or low.

Parameters:

value (str) – Must be one of [“normal”, “low”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_response module¶

class EventResponse(arg: None)¶

class EventResponse(arg: ModelComposed)

class EventResponse(*args, **kwargs)

Bases: ModelNormal

The object description of an event after being processed and stored by Datadog.

Parameters:

attributes (EventResponseAttributes, optional) – The object description of an event response attribute.
id (str, optional) – the unique ID of the event.
type (EventType, optional) – Type of the event.

datadog_api_client.v2.model.event_response_attributes module¶

class EventResponseAttributes(arg: None)¶

class EventResponseAttributes(arg: ModelComposed)

class EventResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object description of an event response attribute.

Parameters:

attributes (EventAttributes, optional) – Object description of attributes from your event.
message (str, optional) – The message of the event.
tags ([str], optional) – An array of tags associated with the event.
timestamp (datetime, optional) – The timestamp of the event.

datadog_api_client.v2.model.event_status_type module¶

class EventStatusType(arg: None)¶

class EventStatusType(arg: ModelComposed)

class EventStatusType(*args, **kwargs)

Bases: ModelSimple

If an alert event is enabled, its status is one of the following:: failure, error, warning, info, success, user_update, recommendation, or snapshot.

Parameters:

value (str) – Must be one of [“failure”, “error”, “warning”, “info”, “success”, “user_update”, “recommendation”, “snapshot”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_system_attributes module¶

class EventSystemAttributes(arg: None)¶

class EventSystemAttributes(arg: ModelComposed)

class EventSystemAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object of event system attributes.

Parameters:

category (EventSystemAttributesCategory, optional) – Event category identifying the type of event.
id (str, optional) – Event identifier. This field is deprecated and will be removed in a future version. Use the uid field instead.
integration_id (EventSystemAttributesIntegrationId, optional) – Integration ID sourced from integration manifests.
source_id (int, optional) – The source type ID of the event.
uid (str, optional) – A unique identifier for the event. You can use this identifier to query or reference the event.

datadog_api_client.v2.model.event_system_attributes_category module¶

class EventSystemAttributesCategory(arg: None)¶

class EventSystemAttributesCategory(arg: ModelComposed)

class EventSystemAttributesCategory(*args, **kwargs)

Bases: ModelSimple

Event category identifying the type of event.

Parameters:

value (str) – Must be one of [“change”, “alert”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_system_attributes_integration_id module¶

class EventSystemAttributesIntegrationId(arg: None)¶

class EventSystemAttributesIntegrationId(arg: ModelComposed)

class EventSystemAttributesIntegrationId(*args, **kwargs)

Bases: ModelSimple

Integration ID sourced from integration manifests.

Parameters:

value (str) – If omitted defaults to “custom-events”. Must be one of [“custom-events”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.event_type module¶

class EventType(arg: None)¶

class EventType(arg: ModelComposed)

class EventType(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “event”. Must be one of [“event”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.events_aggregation module¶

class EventsAggregation(arg: None)¶

class EventsAggregation(arg: ModelComposed)

class EventsAggregation(*args, **kwargs)

Bases: ModelSimple

The type of aggregation that can be performed on events-based queries.

Parameters:

value (str) – If omitted defaults to “count”. Must be one of [“count”, “cardinality”, “pc75”, “pc90”, “pc95”, “pc98”, “pc99”, “sum”, “min”, “max”, “avg”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.events_compute module¶

class EventsCompute(arg: None)¶

class EventsCompute(arg: ModelComposed)

class EventsCompute(*args, **kwargs)

Bases: ModelNormal

The instructions for what to compute for this query.

Parameters:

aggregation (EventsAggregation) – The type of aggregation that can be performed on events-based queries.
interval (int, optional) – Interval for compute in milliseconds.
metric (str, optional) – The “measure” attribute on which to perform the computation.

datadog_api_client.v2.model.events_data_source module¶

class EventsDataSource(arg: None)¶

class EventsDataSource(arg: ModelComposed)

class EventsDataSource(*args, **kwargs)

Bases: ModelSimple

A data source that is powered by the Events Platform.

Parameters:

value (str) – If omitted defaults to “logs”. Must be one of [“logs”, “rum”, “dora”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.events_group_by module¶

class EventsGroupBy(arg: None)¶

class EventsGroupBy(arg: ModelComposed)

class EventsGroupBy(*args, **kwargs)

Bases: ModelNormal

A dimension on which to split a query’s results.

Parameters:

facet (str) – The facet by which to split groups.
limit (int, optional) – The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. If grouping by multiple facets, the product of limits must not exceed 10000.
sort (EventsGroupBySort, optional) – The dimension by which to sort a query’s results.

datadog_api_client.v2.model.events_group_by_sort module¶

class EventsGroupBySort(arg: None)¶

class EventsGroupBySort(arg: ModelComposed)

class EventsGroupBySort(*args, **kwargs)

Bases: ModelNormal

The dimension by which to sort a query’s results.

Parameters:

aggregation (EventsAggregation) – The type of aggregation that can be performed on events-based queries.
metric (str, optional) – The metric’s calculated value which should be used to define the sort order of a query’s results.
order (QuerySortOrder, optional) – Direction of sort.
type (EventsSortType, optional) – The type of sort to use on the calculated value.

datadog_api_client.v2.model.events_list_request module¶

class EventsListRequest(arg: None)¶

class EventsListRequest(arg: ModelComposed)

class EventsListRequest(*args, **kwargs)

Bases: ModelNormal

The object sent with the request to retrieve a list of events from your organization.

Parameters:

filter (EventsQueryFilter, optional) – The search and filter query settings.
options (EventsQueryOptions, optional) – The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.
page (EventsRequestPage, optional) – Pagination settings.
sort (EventsSort, optional) – The sort parameters when querying events.

datadog_api_client.v2.model.events_list_response module¶

class EventsListResponse(arg: None)¶

class EventsListResponse(arg: ModelComposed)

class EventsListResponse(*args, **kwargs)

Bases: ModelNormal

The response object with all events matching the request and pagination information.

Parameters:

data ([EventResponse], optional) – An array of events matching the request.
links (EventsListResponseLinks, optional) – Links attributes.
meta (EventsResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.events_list_response_links module¶

class EventsListResponseLinks(arg: None)¶

class EventsListResponseLinks(arg: ModelComposed)

class EventsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. Note that the request can also be made using the POST endpoint.

datadog_api_client.v2.model.events_query_filter module¶

class EventsQueryFilter(arg: None)¶

class EventsQueryFilter(arg: ModelComposed)

class EventsQueryFilter(*args, **kwargs)

Bases: ModelNormal

The search and filter query settings.

Parameters:

_from (str, optional) – The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.
query (str, optional) – The search query following the event search syntax.
to (str, optional) – The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.

datadog_api_client.v2.model.events_query_group_bys module¶

class EventsQueryGroupBys(arg: None)¶

class EventsQueryGroupBys(arg: ModelComposed)

class EventsQueryGroupBys(*args, **kwargs)

Bases: ModelSimple

The list of facets on which to split results.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.events_query_options module¶

class EventsQueryOptions(arg: None)¶

class EventsQueryOptions(arg: ModelComposed)

class EventsQueryOptions(*args, **kwargs)

Bases: ModelNormal

The global query options that are used. Either provide a timezone or a time offset but not both, otherwise the query fails.

Parameters:

time_offset (int, optional) – The time offset to apply to the query in seconds.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

datadog_api_client.v2.model.events_request_page module¶

class EventsRequestPage(arg: None)¶

class EventsRequestPage(arg: ModelComposed)

class EventsRequestPage(*args, **kwargs)

Bases: ModelNormal

Pagination settings.

Parameters:

cursor (str, optional) – The returned paging point to use to get the next results.
limit (int, optional) – The maximum number of logs in the response.

datadog_api_client.v2.model.events_response_metadata module¶

class EventsResponseMetadata(arg: None)¶

class EventsResponseMetadata(arg: ModelComposed)

class EventsResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds.
page (EventsResponseMetadataPage, optional) – Pagination attributes.
request_id (str, optional) – The identifier of the request.
status (str, optional) – The request status.
warnings ([EventsWarning], optional) – A list of warnings (non-fatal errors) encountered. Partial results might be returned if warnings are present in the response.

datadog_api_client.v2.model.events_response_metadata_page module¶

class EventsResponseMetadataPage(arg: None)¶

class EventsResponseMetadataPage(arg: ModelComposed)

class EventsResponseMetadataPage(*args, **kwargs)

Bases: ModelNormal

Pagination attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

datadog_api_client.v2.model.events_scalar_query module¶

class EventsScalarQuery(arg: None)¶

class EventsScalarQuery(arg: ModelComposed)

class EventsScalarQuery(*args, **kwargs)

Bases: ModelNormal

An individual scalar events query.

Parameters:

compute (EventsCompute) – The instructions for what to compute for this query.
data_source (EventsDataSource) – A data source that is powered by the Events Platform.
group_by (EventsQueryGroupBys, optional) – The list of facets on which to split results.
indexes ([str], optional) – The indexes in which to search.
name (str, optional) – The variable name for use in formulas.
search (EventsSearch, optional) – Configuration of the search/filter for an events query.

datadog_api_client.v2.model.events_search module¶

class EventsSearch(arg: None)¶

class EventsSearch(arg: ModelComposed)

class EventsSearch(*args, **kwargs)

Bases: ModelNormal

Configuration of the search/filter for an events query.

Parameters:: query (str, optional) – The search/filter string for an events query.

datadog_api_client.v2.model.events_sort module¶

class EventsSort(arg: None)¶

class EventsSort(arg: ModelComposed)

class EventsSort(*args, **kwargs)

Bases: ModelSimple

The sort parameters when querying events.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.events_sort_type module¶

class EventsSortType(arg: None)¶

class EventsSortType(arg: ModelComposed)

class EventsSortType(*args, **kwargs)

Bases: ModelSimple

The type of sort to use on the calculated value.

Parameters:

value (str) – Must be one of [“alphabetical”, “measure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.events_timeseries_query module¶

class EventsTimeseriesQuery(arg: None)¶

class EventsTimeseriesQuery(arg: ModelComposed)

class EventsTimeseriesQuery(*args, **kwargs)

Bases: ModelNormal

An individual timeseries events query.

Parameters:

compute (EventsCompute) – The instructions for what to compute for this query.
data_source (EventsDataSource) – A data source that is powered by the Events Platform.
group_by (EventsQueryGroupBys, optional) – The list of facets on which to split results.
indexes ([str], optional) – The indexes in which to search.
name (str, optional) – The variable name for use in formulas.
search (EventsSearch, optional) – Configuration of the search/filter for an events query.

datadog_api_client.v2.model.events_warning module¶

class EventsWarning(arg: None)¶

class EventsWarning(arg: ModelComposed)

class EventsWarning(*args, **kwargs)

Bases: ModelNormal

A warning message indicating something is wrong with the query.

Parameters:

code (str, optional) – A unique code for this type of warning.
detail (str, optional) – A detailed explanation of this specific warning.
title (str, optional) – A short human-readable summary of the warning.

datadog_api_client.v2.model.fastly_accoun_response_attributes module¶

class FastlyAccounResponseAttributes(arg: None)¶

class FastlyAccounResponseAttributes(arg: ModelComposed)

class FastlyAccounResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object of a Fastly account.

Parameters:

name (str) – The name of the Fastly account.
services ([FastlyService], optional) – A list of services belonging to the parent account.

datadog_api_client.v2.model.fastly_account_create_request module¶

class FastlyAccountCreateRequest(arg: None)¶

class FastlyAccountCreateRequest(arg: ModelComposed)

class FastlyAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when adding a Fastly account.

Parameters:: data (FastlyAccountCreateRequestData) – Data object for creating a Fastly account.

datadog_api_client.v2.model.fastly_account_create_request_attributes module¶

class FastlyAccountCreateRequestAttributes(arg: None)¶

class FastlyAccountCreateRequestAttributes(arg: ModelComposed)

class FastlyAccountCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for creating a Fastly account.

Parameters:

api_key (str) – The API key for the Fastly account.
name (str) – The name of the Fastly account.
services ([FastlyService], optional) – A list of services belonging to the parent account.

datadog_api_client.v2.model.fastly_account_create_request_data module¶

class FastlyAccountCreateRequestData(arg: None)¶

class FastlyAccountCreateRequestData(arg: ModelComposed)

class FastlyAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for creating a Fastly account.

Parameters:

attributes (FastlyAccountCreateRequestAttributes) – Attributes object for creating a Fastly account.
type (FastlyAccountType) – The JSON:API type for this API. Should always be fastly-accounts.

datadog_api_client.v2.model.fastly_account_response module¶

class FastlyAccountResponse(arg: None)¶

class FastlyAccountResponse(arg: ModelComposed)

class FastlyAccountResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting a Fastly account.

Parameters:: data (FastlyAccountResponseData, optional) – Data object of a Fastly account.

datadog_api_client.v2.model.fastly_account_response_data module¶

class FastlyAccountResponseData(arg: None)¶

class FastlyAccountResponseData(arg: ModelComposed)

class FastlyAccountResponseData(*args, **kwargs)

Bases: ModelNormal

Data object of a Fastly account.

Parameters:

attributes (FastlyAccounResponseAttributes) – Attributes object of a Fastly account.
id (str) – The ID of the Fastly account, a hash of the account name.
type (FastlyAccountType) – The JSON:API type for this API. Should always be fastly-accounts.

datadog_api_client.v2.model.fastly_account_type module¶

class FastlyAccountType(arg: None)¶

class FastlyAccountType(arg: ModelComposed)

class FastlyAccountType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for this API. Should always be fastly-accounts.

Parameters:

value (str) – If omitted defaults to “fastly-accounts”. Must be one of [“fastly-accounts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fastly_account_update_request module¶

class FastlyAccountUpdateRequest(arg: None)¶

class FastlyAccountUpdateRequest(arg: ModelComposed)

class FastlyAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when updating a Fastly account.

Parameters:: data (FastlyAccountUpdateRequestData) – Data object for updating a Fastly account.

datadog_api_client.v2.model.fastly_account_update_request_attributes module¶

class FastlyAccountUpdateRequestAttributes(arg: None)¶

class FastlyAccountUpdateRequestAttributes(arg: ModelComposed)

class FastlyAccountUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for updating a Fastly account.

Parameters:

api_key (str, optional) – The API key of the Fastly account.
name (str, optional) – The name of the Fastly account.

datadog_api_client.v2.model.fastly_account_update_request_data module¶

class FastlyAccountUpdateRequestData(arg: None)¶

class FastlyAccountUpdateRequestData(arg: ModelComposed)

class FastlyAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Fastly account.

Parameters:

attributes (FastlyAccountUpdateRequestAttributes, optional) – Attributes object for updating a Fastly account.
type (FastlyAccountType, optional) – The JSON:API type for this API. Should always be fastly-accounts.

datadog_api_client.v2.model.fastly_accounts_response module¶

class FastlyAccountsResponse(arg: None)¶

class FastlyAccountsResponse(arg: ModelComposed)

class FastlyAccountsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Fastly accounts.

Parameters:: data ([FastlyAccountResponseData], optional) – The JSON:API data schema.

datadog_api_client.v2.model.fastly_api_key module¶

class FastlyAPIKey(arg: None)¶

class FastlyAPIKey(arg: ModelComposed)

class FastlyAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the FastlyAPIKey object.

Parameters:

api_key (str) – The FastlyAPIKey api_key.
type (FastlyAPIKeyType) – The definition of the FastlyAPIKey object.

datadog_api_client.v2.model.fastly_api_key_type module¶

class FastlyAPIKeyType(arg: None)¶

class FastlyAPIKeyType(arg: ModelComposed)

class FastlyAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the FastlyAPIKey object.

Parameters:

value (str) – If omitted defaults to “FastlyAPIKey”. Must be one of [“FastlyAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fastly_api_key_update module¶

class FastlyAPIKeyUpdate(arg: None)¶

class FastlyAPIKeyUpdate(arg: ModelComposed)

class FastlyAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the FastlyAPIKey object.

Parameters:

api_key (str, optional) – The FastlyAPIKeyUpdate api_key.
type (FastlyAPIKeyType) – The definition of the FastlyAPIKey object.

datadog_api_client.v2.model.fastly_credentials module¶

class FastlyCredentials(arg: None)¶

class FastlyCredentials(arg: ModelComposed)

class FastlyCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the FastlyCredentials object.

Parameters:

api_key (str) – The FastlyAPIKey api_key.
type (FastlyAPIKeyType) – The definition of the FastlyAPIKey object.

datadog_api_client.v2.model.fastly_credentials_update module¶

class FastlyCredentialsUpdate(arg: None)¶

class FastlyCredentialsUpdate(arg: ModelComposed)

class FastlyCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the FastlyCredentialsUpdate object.

Parameters:

api_key (str, optional) – The FastlyAPIKeyUpdate api_key.
type (FastlyAPIKeyType) – The definition of the FastlyAPIKey object.

datadog_api_client.v2.model.fastly_integration module¶

class FastlyIntegration(arg: None)¶

class FastlyIntegration(arg: ModelComposed)

class FastlyIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the FastlyIntegration object.

Parameters:

credentials (FastlyCredentials) – The definition of the FastlyCredentials object.
type (FastlyIntegrationType) – The definition of the FastlyIntegrationType object.

datadog_api_client.v2.model.fastly_integration_type module¶

class FastlyIntegrationType(arg: None)¶

class FastlyIntegrationType(arg: ModelComposed)

class FastlyIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the FastlyIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Fastly”. Must be one of [“Fastly”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fastly_integration_update module¶

class FastlyIntegrationUpdate(arg: None)¶

class FastlyIntegrationUpdate(arg: ModelComposed)

class FastlyIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the FastlyIntegrationUpdate object.

Parameters:

credentials (FastlyCredentialsUpdate, optional) – The definition of the FastlyCredentialsUpdate object.
type (FastlyIntegrationType) – The definition of the FastlyIntegrationType object.

datadog_api_client.v2.model.fastly_service module¶

class FastlyService(arg: None)¶

class FastlyService(arg: ModelComposed)

class FastlyService(*args, **kwargs)

Bases: ModelNormal

The schema representation of a Fastly service.

Parameters:

id (str) – The ID of the Fastly service
tags ([str], optional) – A list of tags for the Fastly service.

datadog_api_client.v2.model.fastly_service_attributes module¶

class FastlyServiceAttributes(arg: None)¶

class FastlyServiceAttributes(arg: ModelComposed)

class FastlyServiceAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for Fastly service requests.

Parameters:: tags ([str], optional) – A list of tags for the Fastly service.

datadog_api_client.v2.model.fastly_service_data module¶

class FastlyServiceData(arg: None)¶

class FastlyServiceData(arg: ModelComposed)

class FastlyServiceData(*args, **kwargs)

Bases: ModelNormal

Data object for Fastly service requests.

Parameters:

attributes (FastlyServiceAttributes, optional) – Attributes object for Fastly service requests.
id (str) – The ID of the Fastly service.
type (FastlyServiceType) – The JSON:API type for this API. Should always be fastly-services.

datadog_api_client.v2.model.fastly_service_request module¶

class FastlyServiceRequest(arg: None)¶

class FastlyServiceRequest(arg: ModelComposed)

class FastlyServiceRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema for Fastly service requests.

Parameters:: data (FastlyServiceData) – Data object for Fastly service requests.

datadog_api_client.v2.model.fastly_service_response module¶

class FastlyServiceResponse(arg: None)¶

class FastlyServiceResponse(arg: ModelComposed)

class FastlyServiceResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting a Fastly service.

Parameters:: data (FastlyServiceData, optional) – Data object for Fastly service requests.

datadog_api_client.v2.model.fastly_service_type module¶

class FastlyServiceType(arg: None)¶

class FastlyServiceType(arg: ModelComposed)

class FastlyServiceType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for this API. Should always be fastly-services.

Parameters:

value (str) – If omitted defaults to “fastly-services”. Must be one of [“fastly-services”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fastly_services_response module¶

class FastlyServicesResponse(arg: None)¶

class FastlyServicesResponse(arg: ModelComposed)

class FastlyServicesResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Fastly services.

Parameters:: data ([FastlyServiceData], optional) – The JSON:API data schema.

datadog_api_client.v2.model.filters_per_product module¶

class FiltersPerProduct(arg: None)¶

class FiltersPerProduct(arg: ModelComposed)

class FiltersPerProduct(*args, **kwargs)

Bases: ModelNormal

Product-specific filters for the dataset.

Parameters:

filters ([str]) – Defines the list of tag-based filters used to restrict access to telemetry data for a specific product. These filters act as access control rules. Each filter must follow the tag query syntax used by Datadog (such as @tag.key:value ), and only one tag or attribute may be used to define the access strategy per telemetry type.
product (str) – Name of the product the dataset is for. Possible values are ‘apm’, ‘rum’, ‘metrics’, ‘logs’, ‘error_tracking’, and ‘cloud_cost’.

datadog_api_client.v2.model.finding module¶

class Finding(arg: None)¶

class Finding(arg: ModelComposed)

class Finding(*args, **kwargs)

Bases: ModelNormal

A single finding without the message and resource configuration.

Parameters:

attributes (FindingAttributes, optional) – The JSON:API attributes of the finding.
id (str, optional) – The unique ID for this finding.
type (FindingType, optional) – The JSON:API type for findings.

datadog_api_client.v2.model.finding_attributes module¶

class FindingAttributes(arg: None)¶

class FindingAttributes(arg: ModelComposed)

class FindingAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes of the finding.

Parameters:

datadog_link (str, optional) – The Datadog relative link for this finding.
description (str, optional) – The description and remediation steps for this finding.
evaluation (FindingEvaluation, optional) – The evaluation of the finding.
evaluation_changed_at (int, optional) – The date on which the evaluation for this finding changed (Unix ms).
external_id (str, optional) – The cloud-based ID for the resource related to the finding.
mute (FindingMute, optional) – Information about the mute status of this finding.
resource (str, optional) – The resource name of this finding.
resource_discovery_date (int, optional) – The date on which the resource was discovered (Unix ms).
resource_type (str, optional) – The resource type of this finding.
rule (FindingRule, optional) – The rule that triggered this finding.
status (FindingStatus, optional) – The status of the finding.
tags ([str], optional) – The tags associated with this finding.
vulnerability_type (FindingVulnerabilityType, optional) – The vulnerability type of the finding.

datadog_api_client.v2.model.finding_evaluation module¶

class FindingEvaluation(arg: None)¶

class FindingEvaluation(arg: ModelComposed)

class FindingEvaluation(*args, **kwargs)

Bases: ModelSimple

The evaluation of the finding.

Parameters:

value (str) – Must be one of [“pass”, “fail”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.finding_mute module¶

class FindingMute(arg: None)¶

class FindingMute(arg: ModelComposed)

class FindingMute(*args, **kwargs)

Bases: ModelNormal

Information about the mute status of this finding.

Parameters:

description (str, optional) – Additional information about the reason why this finding is muted or unmuted.
expiration_date (int, optional) – The expiration date of the mute or unmute action (Unix ms).
muted (bool, optional) – Whether this finding is muted or unmuted.
reason (FindingMuteReason, optional) – The reason why this finding is muted or unmuted.
start_date (int, optional) – The start of the mute period.
uuid (str, optional) – The ID of the user who muted or unmuted this finding.

additional_properties_type = None¶

datadog_api_client.v2.model.finding_mute_reason module¶

class FindingMuteReason(arg: None)¶

class FindingMuteReason(arg: ModelComposed)

class FindingMuteReason(*args, **kwargs)

Bases: ModelSimple

The reason why this finding is muted or unmuted.

Parameters:

value (str) – Must be one of [“PENDING_FIX”, “FALSE_POSITIVE”, “ACCEPTED_RISK”, “NO_PENDING_FIX”, “HUMAN_ERROR”, “NO_LONGER_ACCEPTED_RISK”, “OTHER”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.finding_rule module¶

class FindingRule(arg: None)¶

class FindingRule(arg: ModelComposed)

class FindingRule(*args, **kwargs)

Bases: ModelNormal

The rule that triggered this finding.

Parameters:

id (str, optional) – The ID of the rule that triggered this finding.
name (str, optional) – The name of the rule that triggered this finding.

additional_properties_type = None¶

datadog_api_client.v2.model.finding_status module¶

class FindingStatus(arg: None)¶

class FindingStatus(arg: ModelComposed)

class FindingStatus(*args, **kwargs)

Bases: ModelSimple

The status of the finding.

Parameters:

value (str) – Must be one of [“critical”, “high”, “medium”, “low”, “info”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.finding_type module¶

class FindingType(arg: None)¶

class FindingType(arg: ModelComposed)

class FindingType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for findings.

Parameters:

value (str) – If omitted defaults to “finding”. Must be one of [“finding”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.finding_vulnerability_type module¶

class FindingVulnerabilityType(arg: None)¶

class FindingVulnerabilityType(arg: ModelComposed)

class FindingVulnerabilityType(*args, **kwargs)

Bases: ModelSimple

The vulnerability type of the finding.

Parameters:

value (str) – Must be one of [“misconfiguration”, “attack_path”, “identity_risk”, “api_security”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.flaky_test module¶

class FlakyTest(arg: None)¶

class FlakyTest(arg: ModelComposed)

class FlakyTest(*args, **kwargs)

Bases: ModelNormal

A flaky test object.

Parameters:

attributes (FlakyTestAttributes, optional) – Attributes of a flaky test.
id (str, optional) – Test’s ID. This ID is the hash of the test’s Fully Qualified Name and Git repository ID. On the Test Runs UI it is the same as the test_fingerprint_fqn tag.
type (FlakyTestType, optional) – The type of the flaky test from Flaky Test Management.

datadog_api_client.v2.model.flaky_test_attributes module¶

class FlakyTestAttributes(arg: None)¶

class FlakyTestAttributes(arg: ModelComposed)

class FlakyTestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a flaky test.

Parameters:

attempt_to_fix_id (str, optional) –
Unique identifier for the attempt to fix this flaky test. Use this ID in the Git commit message in order to trigger the attempt to fix workflow.

When the workflow is triggered the test is automatically retried by the tracer a certain number of configurable times. When all retries pass, the test is automatically marked as fixed in Flaky Test Management. Test runs are tagged with @test.test_management.attempt_to_fix_passed and @test.test_management.is_attempt_to_fix when the attempt to fix workflow is triggered.
codeowners ([str], optional) – The name of the test’s code owners as inferred from the repository configuration.
envs ([str], optional) – List of environments where this test has been flaky.
first_flaked_branch (str, optional) – The branch name where the test exhibited flakiness for the first time.
first_flaked_sha (str, optional) – The commit SHA where the test exhibited flakiness for the first time.
first_flaked_ts (int, optional) – Unix timestamp when the test exhibited flakiness for the first time.
flaky_category (str, none_type, optional) – The category of a flaky test.
flaky_state (FlakyTestAttributesFlakyState, optional) – The current state of the flaky test.
last_flaked_branch (str, optional) – The branch name where the test exhibited flakiness for the last time.
last_flaked_sha (str, optional) – The commit SHA where the test exhibited flakiness for the last time.
last_flaked_ts (int, optional) – Unix timestamp when the test exhibited flakiness for the last time.
module (str, none_type, optional) –
The name of the test module. The definition of module changes slightly per language:
- In .NET, a test module groups every test that is run under the same unit test project.
- In Swift, a test module groups every test that is run for a given bundle.
- In JavaScript, the test modules map one-to-one to test sessions.
- In Java, a test module groups every test that is run by the same Maven Surefire/Failsafe or Gradle Test task execution.
- In Python, a test module groups every test that is run under the same .py file as part of a test suite, which is typically managed by a framework like unittest or pytest.
- In Ruby, a test module groups every test that is run within the same test file, which is typically managed by a framework like RSpec or Minitest.
name (str, optional) – The test name. A concise name for a test case. Defined in the test itself.
pipeline_stats (FlakyTestPipelineStats, optional) – CI pipeline related statistics for the flaky test. This information is only available if test runs are associated with CI pipeline events from CI Visibility.
services ([str], optional) –
List of test service names where this test has been flaky.

A test service is a group of tests associated with a project or repository. It contains all the individual tests for your code, optionally organized into test suites, which are like folders for your tests.
suite (str, optional) – The name of the test suite. A group of tests exercising the same unit of code depending on your language and testing framework.
test_run_metadata (FlakyTestRunMetadata, optional) – Metadata about the latest failed test run of the flaky test.
test_stats (FlakyTestStats, optional) – Test statistics for the flaky test.

datadog_api_client.v2.model.flaky_test_attributes_flaky_state module¶

class FlakyTestAttributesFlakyState(arg: None)¶

class FlakyTestAttributesFlakyState(arg: ModelComposed)

class FlakyTestAttributesFlakyState(*args, **kwargs)

Bases: ModelSimple

The current state of the flaky test.

Parameters:

value (str) – Must be one of [“active”, “fixed”, “quarantined”, “disabled”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.flaky_test_pipeline_stats module¶

class FlakyTestPipelineStats(arg: None)¶

class FlakyTestPipelineStats(arg: ModelComposed)

class FlakyTestPipelineStats(*args, **kwargs)

Bases: ModelNormal

CI pipeline related statistics for the flaky test. This information is only available if test runs are associated with CI pipeline events from CI Visibility.

Parameters:

failed_pipelines (int, none_type, optional) – The number of pipelines that failed due to this test for the past 7 days. This is computed as the sum of failed CI pipeline events associated with test runs where the flaky test failed.
total_lost_time_ms (int, none_type, optional) – The total time lost by CI pipelines due to this flaky test in milliseconds. This is computed as the sum of the duration of failed CI pipeline events associated with test runs where the flaky test failed.

datadog_api_client.v2.model.flaky_test_run_metadata module¶

class FlakyTestRunMetadata(arg: None)¶

class FlakyTestRunMetadata(arg: ModelComposed)

class FlakyTestRunMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata about the latest failed test run of the flaky test.

Parameters:

duration_ms (int, none_type, optional) – The duration of the test run in milliseconds.
error_message (str, none_type, optional) – The error message from the test failure.
error_stack (str, none_type, optional) – The stack trace from the test failure.
source_end (int, none_type, optional) – The line number where the test ends in the source file.
source_file (str, none_type, optional) – The source file where the test is defined.
source_start (int, none_type, optional) – The line number where the test starts in the source file.

datadog_api_client.v2.model.flaky_test_stats module¶

class FlakyTestStats(arg: None)¶

class FlakyTestStats(arg: ModelComposed)

class FlakyTestStats(*args, **kwargs)

Bases: ModelNormal

Test statistics for the flaky test.

Parameters:: failure_rate_pct (float, none_type, optional) – The failure rate percentage of the test for the past 7 days. This is the number of failed test runs divided by the total number of test runs (excluding skipped test runs).

datadog_api_client.v2.model.flaky_test_type module¶

class FlakyTestType(arg: None)¶

class FlakyTestType(arg: ModelComposed)

class FlakyTestType(*args, **kwargs)

Bases: ModelSimple

The type of the flaky test from Flaky Test Management.

Parameters:

value (str) – If omitted defaults to “flaky_test”. Must be one of [“flaky_test”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.flaky_tests_pagination module¶

class FlakyTestsPagination(arg: None)¶

class FlakyTestsPagination(arg: ModelComposed)

class FlakyTestsPagination(*args, **kwargs)

Bases: ModelNormal

Pagination metadata for flaky tests.

Parameters:: next_page (str, none_type, optional) – Cursor for the next page of results.

datadog_api_client.v2.model.flaky_tests_search_filter module¶

class FlakyTestsSearchFilter(arg: None)¶

class FlakyTestsSearchFilter(arg: ModelComposed)

class FlakyTestsSearchFilter(*args, **kwargs)

Bases: ModelNormal

Search filter settings.

Parameters:

query (str, optional) –

Search query following log syntax used to filter flaky tests, same as on Flaky Tests Management UI. The supported search keys are:

flaky_test_state
flaky_test_category
@test.name
@test.suite
@test.module
@test.service
@git.repository.id_v2
@git.branch
@test.codeowners
env

datadog_api_client.v2.model.flaky_tests_search_page_options module¶

class FlakyTestsSearchPageOptions(arg: None)¶

class FlakyTestsSearchPageOptions(arg: ModelComposed)

class FlakyTestsSearchPageOptions(*args, **kwargs)

Bases: ModelNormal

Pagination attributes for listing flaky tests.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous request.
limit (int, optional) – Maximum number of flaky tests in the response.

datadog_api_client.v2.model.flaky_tests_search_request module¶

class FlakyTestsSearchRequest(arg: None)¶

class FlakyTestsSearchRequest(arg: ModelComposed)

class FlakyTestsSearchRequest(*args, **kwargs)

Bases: ModelNormal

The request for a flaky tests search.

Parameters:: data (FlakyTestsSearchRequestData, optional) – The JSON:API data for flaky tests search request.

datadog_api_client.v2.model.flaky_tests_search_request_attributes module¶

class FlakyTestsSearchRequestAttributes(arg: None)¶

class FlakyTestsSearchRequestAttributes(arg: ModelComposed)

class FlakyTestsSearchRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for the flaky tests search request.

Parameters:

filter (FlakyTestsSearchFilter, optional) – Search filter settings.
page (FlakyTestsSearchPageOptions, optional) – Pagination attributes for listing flaky tests.
sort (FlakyTestsSearchSort, optional) – Parameter for sorting flaky test results. The default sort is by ascending Fully Qualified Name (FQN). The FQN is the concatenation of the test module, suite, and name.

datadog_api_client.v2.model.flaky_tests_search_request_data module¶

class FlakyTestsSearchRequestData(arg: None)¶

class FlakyTestsSearchRequestData(arg: ModelComposed)

class FlakyTestsSearchRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data for flaky tests search request.

Parameters:

attributes (FlakyTestsSearchRequestAttributes, optional) – Attributes for the flaky tests search request.
type (FlakyTestsSearchRequestDataType, optional) – The definition of FlakyTestsSearchRequestDataType object.

datadog_api_client.v2.model.flaky_tests_search_request_data_type module¶

class FlakyTestsSearchRequestDataType(arg: None)¶

class FlakyTestsSearchRequestDataType(arg: ModelComposed)

class FlakyTestsSearchRequestDataType(*args, **kwargs)

Bases: ModelSimple

The definition of FlakyTestsSearchRequestDataType object.

Parameters:

value (str) – If omitted defaults to “search_flaky_tests_request”. Must be one of [“search_flaky_tests_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.flaky_tests_search_response module¶

class FlakyTestsSearchResponse(arg: None)¶

class FlakyTestsSearchResponse(arg: ModelComposed)

class FlakyTestsSearchResponse(*args, **kwargs)

Bases: ModelNormal

Response object with flaky tests matching the search request.

Parameters:

data ([FlakyTest], optional) – Array of flaky tests matching the request.
meta (FlakyTestsSearchResponseMeta, optional) – Metadata for the flaky tests search response.

datadog_api_client.v2.model.flaky_tests_search_response_meta module¶

class FlakyTestsSearchResponseMeta(arg: None)¶

class FlakyTestsSearchResponseMeta(arg: ModelComposed)

class FlakyTestsSearchResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata for the flaky tests search response.

Parameters:: pagination (FlakyTestsPagination, optional) – Pagination metadata for flaky tests.

datadog_api_client.v2.model.flaky_tests_search_sort module¶

class FlakyTestsSearchSort(arg: None)¶

class FlakyTestsSearchSort(arg: ModelComposed)

class FlakyTestsSearchSort(*args, **kwargs)

Bases: ModelSimple

Parameter for sorting flaky test results. The default sort is by ascending Fully Qualified Name (FQN). The FQN is the concatenation of the test module, suite, and name.

Parameters:

value (str) – Must be one of [“fqn”, “-fqn”, “first_flaked”, “-first_flaked”, “last_flaked”, “-last_flaked”, “failure_rate”, “-failure_rate”, “pipelines_failed”, “-pipelines_failed”, “pipelines_duration_lost”, “-pipelines_duration_lost”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fleet_agent_version_attributes module¶

class FleetAgentVersionAttributes(arg: None)¶

class FleetAgentVersionAttributes(arg: ModelComposed)

class FleetAgentVersionAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:: version (str, optional) – The Agent version string.

datadog_api_client.v2.model.fleet_agent_version_resource_type module¶

class FleetAgentVersionResourceType(arg: None)¶

class FleetAgentVersionResourceType(arg: ModelComposed)

class FleetAgentVersionResourceType(*args, **kwargs)

Bases: ModelSimple

The type of Agent version resource.

Parameters:

value (str) – If omitted defaults to “agent_version”. Must be one of [“agent_version”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fleet_agent_versions_response module¶

class FleetAgentVersionsResponse(arg: None)¶

class FleetAgentVersionsResponse(arg: ModelComposed)

class FleetAgentVersionsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of available Agent versions.

Parameters:: data ([FleetAgentVersion]) – Array of available Agent versions.

datadog_api_client.v2.model.fleet_deployment module¶

class FleetDeployment(arg: None)¶

class FleetDeployment(arg: ModelComposed)

class FleetDeployment(*args, **kwargs)

Bases: ModelNormal

A deployment that defines automated configuration changes for a fleet of hosts.

Parameters:

attributes (FleetDeploymentAttributes) – Attributes of a deployment in the response.
id (str) – Unique identifier for the deployment.
type (FleetDeploymentResourceType) – The type of deployment resource.

datadog_api_client.v2.model.fleet_deployment_attributes module¶

class FleetDeploymentAttributes(arg: None)¶

class FleetDeploymentAttributes(arg: ModelComposed)

class FleetDeploymentAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a deployment in the response.

Parameters:

config_operations ([FleetDeploymentOperation], optional) – Ordered list of configuration file operations to perform on the target hosts.
estimated_end_time_unix (int, optional) – Estimated completion time of the deployment as a Unix timestamp (seconds since epoch).
filter_query (str, optional) – Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax.
high_level_status (str, optional) – Current high-level status of the deployment (for example, “pending”, “running”, “completed”, “failed”).
hosts ([FleetDeploymentHost], optional) – Paginated list of hosts in this deployment with their individual statuses. Only included when fetching a single deployment by ID. Use the limit and page query parameters to navigate through pages. Pagination metadata is included in the response meta.hosts field.
packages ([FleetDeploymentPackage], optional) – List of packages to deploy to target hosts. Present only for package upgrade deployments.
total_hosts (int, optional) – Total number of hosts targeted by this deployment.

datadog_api_client.v2.model.fleet_deployment_configure_attributes module¶

class FleetDeploymentConfigureAttributes(arg: None)¶

class FleetDeploymentConfigureAttributes(arg: ModelComposed)

class FleetDeploymentConfigureAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for creating a new configuration deployment.

Parameters:

config_operations ([FleetDeploymentOperation]) – Ordered list of configuration file operations to perform on the target hosts.
filter_query (str, optional) – Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax.

datadog_api_client.v2.model.fleet_deployment_configure_create module¶

class FleetDeploymentConfigureCreate(arg: None)¶

class FleetDeploymentConfigureCreate(arg: ModelComposed)

class FleetDeploymentConfigureCreate(*args, **kwargs)

Bases: ModelNormal

Data for creating a new configuration deployment.

Parameters:

attributes (FleetDeploymentConfigureAttributes) – Attributes for creating a new configuration deployment.
type (FleetDeploymentResourceType) – The type of deployment resource.

datadog_api_client.v2.model.fleet_deployment_configure_create_request module¶

class FleetDeploymentConfigureCreateRequest(arg: None)¶

class FleetDeploymentConfigureCreateRequest(arg: ModelComposed)

class FleetDeploymentConfigureCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request payload for creating a new configuration deployment.

Parameters:: data (FleetDeploymentConfigureCreate) – Data for creating a new configuration deployment.

datadog_api_client.v2.model.fleet_deployment_file_op module¶

class FleetDeploymentFileOp(arg: None)¶

class FleetDeploymentFileOp(arg: ModelComposed)

class FleetDeploymentFileOp(*args, **kwargs)

Bases: ModelSimple

Type of file operation to perform on the target configuration file.

merge-patch: Merges the provided patch data with the existing configuration file. Creates the file if it doesn’t exist.
delete: Removes the specified configuration file from the target hosts.

Parameters:

value (str) – Must be one of [“merge-patch”, “delete”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fleet_deployment_host module¶

class FleetDeploymentHost(arg: None)¶

class FleetDeploymentHost(arg: ModelComposed)

class FleetDeploymentHost(*args, **kwargs)

Bases: ModelNormal

A host that is part of a deployment with its current status.

Parameters:

error (str, optional) – Error message if the deployment failed on this host.
hostname (str, optional) – The hostname of the agent.
status (str, optional) – Current deployment status for this specific host.
versions ([FleetDeploymentHostPackage], optional) – List of packages and their versions currently installed on this host.

datadog_api_client.v2.model.fleet_deployment_host_package module¶

class FleetDeploymentHostPackage(arg: None)¶

class FleetDeploymentHostPackage(arg: ModelComposed)

class FleetDeploymentHostPackage(*args, **kwargs)

Bases: ModelNormal

Package version information for a host, showing the initial version before deployment, the target version to deploy, and the current version on the host.

Parameters:

current_version (str, optional) – The current version of the package on the host.
initial_version (str, optional) – The initial version of the package on the host before the deployment started.
package_name (str, optional) – The name of the package.
target_version (str, optional) – The target version that the deployment is attempting to install.

datadog_api_client.v2.model.fleet_deployment_hosts_page module¶

class FleetDeploymentHostsPage(arg: None)¶

class FleetDeploymentHostsPage(arg: ModelComposed)

class FleetDeploymentHostsPage(*args, **kwargs)

Bases: ModelNormal

Pagination details for the list of hosts in a deployment.

Parameters:

current_page (int, optional) – Current page index (zero-based).
page_size (int, optional) – Number of hosts returned per page.
total_hosts (int, optional) – Total number of hosts in this deployment.
total_pages (int, optional) – Total number of pages available.

datadog_api_client.v2.model.fleet_deployment_operation module¶

class FleetDeploymentOperation(arg: None)¶

class FleetDeploymentOperation(arg: ModelComposed)

class FleetDeploymentOperation(*args, **kwargs)

Bases: ModelNormal

A single configuration file operation to perform on the target hosts.

Parameters:

file_op (FleetDeploymentFileOp) –
Type of file operation to perform on the target configuration file.
- merge-patch : Merges the provided patch data with the existing configuration file. Creates the file if it doesn’t exist.
- delete : Removes the specified configuration file from the target hosts.
file_path (str) – Absolute path to the target configuration file on the host.
patch ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Patch data in JSON format to apply to the configuration file. When using merge-patch , this object is merged with the existing configuration, allowing you to add, update, or override specific fields without replacing the entire file. The structure must match the target configuration file format (for example, YAML structure for Datadog Agent config). Not applicable when using the delete operation.

datadog_api_client.v2.model.fleet_deployment_package module¶

class FleetDeploymentPackage(arg: None)¶

class FleetDeploymentPackage(arg: ModelComposed)

class FleetDeploymentPackage(*args, **kwargs)

Bases: ModelNormal

A package and its target version for deployment.

Parameters:

name (str) – The name of the package to deploy.
version (str) – The target version of the package to deploy.

datadog_api_client.v2.model.fleet_deployment_package_upgrade_attributes module¶

class FleetDeploymentPackageUpgradeAttributes(arg: None)¶

class FleetDeploymentPackageUpgradeAttributes(arg: ModelComposed)

class FleetDeploymentPackageUpgradeAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for creating a new package upgrade deployment.

Parameters:

filter_query (str, optional) – Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax.
target_packages ([FleetDeploymentPackage]) – List of packages and their target versions to deploy to the selected hosts.

datadog_api_client.v2.model.fleet_deployment_package_upgrade_create module¶

class FleetDeploymentPackageUpgradeCreate(arg: None)¶

class FleetDeploymentPackageUpgradeCreate(arg: ModelComposed)

class FleetDeploymentPackageUpgradeCreate(*args, **kwargs)

Bases: ModelNormal

Data for creating a new package upgrade deployment.

Parameters:

attributes (FleetDeploymentPackageUpgradeAttributes) – Attributes for creating a new package upgrade deployment.
type (FleetDeploymentResourceType) – The type of deployment resource.

datadog_api_client.v2.model.fleet_deployment_package_upgrade_create_request module¶

class FleetDeploymentPackageUpgradeCreateRequest(arg: None)¶

class FleetDeploymentPackageUpgradeCreateRequest(arg: ModelComposed)

class FleetDeploymentPackageUpgradeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request payload for creating a new package upgrade deployment.

Parameters:: data (FleetDeploymentPackageUpgradeCreate) – Data for creating a new package upgrade deployment.

datadog_api_client.v2.model.fleet_deployment_resource_type module¶

class FleetDeploymentResourceType(arg: None)¶

class FleetDeploymentResourceType(arg: ModelComposed)

class FleetDeploymentResourceType(*args, **kwargs)

Bases: ModelSimple

The type of deployment resource.

Parameters:

value (str) – If omitted defaults to “deployment”. Must be one of [“deployment”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fleet_deployment_response module¶

class FleetDeploymentResponse(arg: None)¶

class FleetDeploymentResponse(arg: ModelComposed)

class FleetDeploymentResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a single deployment.

Parameters:

data (FleetDeployment, optional) – A deployment that defines automated configuration changes for a fleet of hosts.
meta (FleetDeploymentResponseMeta, optional) – Metadata for a single deployment response, including pagination information for hosts.

datadog_api_client.v2.model.fleet_deployment_response_meta module¶

class FleetDeploymentResponseMeta(arg: None)¶

class FleetDeploymentResponseMeta(arg: ModelComposed)

class FleetDeploymentResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata for a single deployment response, including pagination information for hosts.

Parameters:: hosts (FleetDeploymentHostsPage, optional) – Pagination details for the list of hosts in a deployment.

datadog_api_client.v2.model.fleet_deployments_page module¶

class FleetDeploymentsPage(arg: None)¶

class FleetDeploymentsPage(arg: ModelComposed)

class FleetDeploymentsPage(*args, **kwargs)

Bases: ModelNormal

Pagination details for the list of deployments.

Parameters:: total_count (int, optional) – Total number of deployments available across all pages.

datadog_api_client.v2.model.fleet_deployments_response module¶

class FleetDeploymentsResponse(arg: None)¶

class FleetDeploymentsResponse(arg: ModelComposed)

class FleetDeploymentsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a paginated list of deployments.

Parameters:

data ([FleetDeployment]) – Array of deployments matching the query criteria.
meta (FleetDeploymentsResponseMeta, optional) – Metadata for the list of deployments, including pagination information.

datadog_api_client.v2.model.fleet_deployments_response_meta module¶

class FleetDeploymentsResponseMeta(arg: None)¶

class FleetDeploymentsResponseMeta(arg: ModelComposed)

class FleetDeploymentsResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata for the list of deployments, including pagination information.

Parameters:: page (FleetDeploymentsPage, optional) – Pagination details for the list of deployments.

datadog_api_client.v2.model.fleet_schedule module¶

class FleetSchedule(arg: None)¶

class FleetSchedule(arg: ModelComposed)

class FleetSchedule(*args, **kwargs)

Bases: ModelNormal

A schedule that automatically creates deployments based on a recurrence rule.

Parameters:

attributes (FleetScheduleAttributes) – Attributes of a schedule in the response.
id (str) – Unique identifier for the schedule.
type (FleetScheduleResourceType) – The type of schedule resource.

datadog_api_client.v2.model.fleet_schedule_attributes module¶

class FleetScheduleAttributes(arg: None)¶

class FleetScheduleAttributes(arg: ModelComposed)

class FleetScheduleAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a schedule in the response.

Parameters:

created_at_unix (int, optional) – Unix timestamp (seconds since epoch) when the schedule was created.
created_by (str, optional) – User handle of the person who created the schedule.
name (str, optional) – Human-readable name for the schedule.
query (str, optional) – Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax.
rule (FleetScheduleRecurrenceRule, optional) – Defines the recurrence pattern for the schedule. Specifies when deployments should be automatically triggered based on maintenance windows.
status (FleetScheduleStatus, optional) –
The status of the schedule.
- active : The schedule is active and will create deployments according to its recurrence rule.
- inactive : The schedule is inactive and will not create any deployments.
updated_at_unix (int, optional) – Unix timestamp (seconds since epoch) when the schedule was last updated.
updated_by (str, optional) – User handle of the person who last updated the schedule.
version_to_latest (int, optional) –
Number of major versions behind the latest to target for upgrades.
- 0: Always upgrade to the latest version
- 1: Upgrade to latest minus 1 major version
- 2: Upgrade to latest minus 2 major versions Maximum value is 2.

datadog_api_client.v2.model.fleet_schedule_create module¶

class FleetScheduleCreate(arg: None)¶

class FleetScheduleCreate(arg: ModelComposed)

class FleetScheduleCreate(*args, **kwargs)

Bases: ModelNormal

Data for creating a new schedule.

Parameters:

attributes (FleetScheduleCreateAttributes) – Attributes for creating a new schedule.
type (FleetScheduleResourceType) – The type of schedule resource.

datadog_api_client.v2.model.fleet_schedule_create_attributes module¶

class FleetScheduleCreateAttributes(arg: None)¶

class FleetScheduleCreateAttributes(arg: ModelComposed)

class FleetScheduleCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for creating a new schedule.

Parameters:

name (str) – Human-readable name for the schedule.
query (str) – Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax.
rule (FleetScheduleRecurrenceRule) – Defines the recurrence pattern for the schedule. Specifies when deployments should be automatically triggered based on maintenance windows.
status (FleetScheduleStatus, optional) –
The status of the schedule.
- active : The schedule is active and will create deployments according to its recurrence rule.
- inactive : The schedule is inactive and will not create any deployments.
version_to_latest (int, optional) –
Number of major versions behind the latest to target for upgrades.
- 0: Always upgrade to the latest version (default)
- 1: Upgrade to latest minus 1 major version
- 2: Upgrade to latest minus 2 major versions Maximum value is 2.

datadog_api_client.v2.model.fleet_schedule_create_request module¶

class FleetScheduleCreateRequest(arg: None)¶

class FleetScheduleCreateRequest(arg: ModelComposed)

class FleetScheduleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request payload for creating a new schedule.

Parameters:: data (FleetScheduleCreate) – Data for creating a new schedule.

datadog_api_client.v2.model.fleet_schedule_patch module¶

class FleetSchedulePatch(arg: None)¶

class FleetSchedulePatch(arg: ModelComposed)

class FleetSchedulePatch(*args, **kwargs)

Bases: ModelNormal

Data for partially updating a schedule.

Parameters:

attributes (FleetSchedulePatchAttributes, optional) – Attributes for partially updating a schedule. All fields are optional.
type (FleetScheduleResourceType) – The type of schedule resource.

datadog_api_client.v2.model.fleet_schedule_patch_attributes module¶

class FleetSchedulePatchAttributes(arg: None)¶

class FleetSchedulePatchAttributes(arg: ModelComposed)

class FleetSchedulePatchAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for partially updating a schedule. All fields are optional.

Parameters:

name (str, optional) – Human-readable name for the schedule.
query (str, optional) – Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax.
rule (FleetScheduleRecurrenceRule, optional) – Defines the recurrence pattern for the schedule. Specifies when deployments should be automatically triggered based on maintenance windows.
status (FleetScheduleStatus, optional) –
The status of the schedule.
- active : The schedule is active and will create deployments according to its recurrence rule.
- inactive : The schedule is inactive and will not create any deployments.
version_to_latest (int, optional) –
Number of major versions behind the latest to target for upgrades.
- 0: Always upgrade to the latest version
- 1: Upgrade to latest minus 1 major version
- 2: Upgrade to latest minus 2 major versions Maximum value is 2.

datadog_api_client.v2.model.fleet_schedule_patch_request module¶

class FleetSchedulePatchRequest(arg: None)¶

class FleetSchedulePatchRequest(arg: ModelComposed)

class FleetSchedulePatchRequest(*args, **kwargs)

Bases: ModelNormal

Request payload for partially updating a schedule.

Parameters:: data (FleetSchedulePatch) – Data for partially updating a schedule.

datadog_api_client.v2.model.fleet_schedule_recurrence_rule module¶

class FleetScheduleRecurrenceRule(arg: None)¶

class FleetScheduleRecurrenceRule(arg: ModelComposed)

class FleetScheduleRecurrenceRule(*args, **kwargs)

Bases: ModelNormal

Defines the recurrence pattern for the schedule. Specifies when deployments should be automatically triggered based on maintenance windows.

Parameters:

days_of_week ([str]) – List of days of the week when the schedule should trigger. Valid values are: “Mon”, “Tue”, “Wed”, “Thu”, “Fri”, “Sat”, “Sun”.
maintenance_window_duration (int) – Duration of the maintenance window in minutes.
start_maintenance_window (str) – Start time of the maintenance window in 24-hour clock format (HH:MM). Deployments will be triggered at this time on the specified days.
timezone (str) – Timezone for the schedule in IANA Time Zone Database format (e.g., “America/New_York”, “UTC”).

datadog_api_client.v2.model.fleet_schedule_resource_type module¶

class FleetScheduleResourceType(arg: None)¶

class FleetScheduleResourceType(arg: ModelComposed)

class FleetScheduleResourceType(*args, **kwargs)

Bases: ModelSimple

The type of schedule resource.

Parameters:

value (str) – If omitted defaults to “schedule”. Must be one of [“schedule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fleet_schedule_response module¶

class FleetScheduleResponse(arg: None)¶

class FleetScheduleResponse(arg: ModelComposed)

class FleetScheduleResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a single schedule.

Parameters:: data (FleetSchedule, optional) – A schedule that automatically creates deployments based on a recurrence rule.

datadog_api_client.v2.model.fleet_schedule_status module¶

class FleetScheduleStatus(arg: None)¶

class FleetScheduleStatus(arg: ModelComposed)

class FleetScheduleStatus(*args, **kwargs)

Bases: ModelSimple

The status of the schedule.

active: The schedule is active and will create deployments according to its recurrence rule.
inactive: The schedule is inactive and will not create any deployments.

Parameters:

value (str) – Must be one of [“active”, “inactive”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.fleet_schedules_response module¶

class FleetSchedulesResponse(arg: None)¶

class FleetSchedulesResponse(arg: ModelComposed)

class FleetSchedulesResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of schedules.

Parameters:: data ([FleetSchedule]) – Array of schedules.

datadog_api_client.v2.model.formula_limit module¶

class FormulaLimit(arg: None)¶

class FormulaLimit(arg: ModelComposed)

class FormulaLimit(*args, **kwargs)

Bases: ModelNormal

Message for specifying limits to the number of values returned by a query. This limit is only for scalar queries and has no effect on timeseries queries.

Parameters:

count (int, optional) – The number of results to which to limit.
order (QuerySortOrder, optional) – Direction of sort.

datadog_api_client.v2.model.framework_handle_and_version_response_data module¶

class FrameworkHandleAndVersionResponseData(arg: None)¶

class FrameworkHandleAndVersionResponseData(arg: ModelComposed)

class FrameworkHandleAndVersionResponseData(*args, **kwargs)

Bases: ModelNormal

Contains type and attributes for custom frameworks.

Parameters:

attributes (CustomFrameworkDataHandleAndVersion) – Framework Handle and Version.
id (str) – The ID of the custom framework.
type (CustomFrameworkType) – The type of the resource. The value must be custom_framework.

datadog_api_client.v2.model.freshservice_api_key module¶

class FreshserviceAPIKey(arg: None)¶

class FreshserviceAPIKey(arg: ModelComposed)

class FreshserviceAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the FreshserviceAPIKey object.

Parameters:

api_key (str) – The FreshserviceAPIKey api_key.
domain (str) – The FreshserviceAPIKey domain.
type (FreshserviceAPIKeyType) – The definition of the FreshserviceAPIKey object.

datadog_api_client.v2.model.freshservice_api_key_type module¶

class FreshserviceAPIKeyType(arg: None)¶

class FreshserviceAPIKeyType(arg: ModelComposed)

class FreshserviceAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the FreshserviceAPIKey object.

Parameters:

value (str) – If omitted defaults to “FreshserviceAPIKey”. Must be one of [“FreshserviceAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.freshservice_api_key_update module¶

class FreshserviceAPIKeyUpdate(arg: None)¶

class FreshserviceAPIKeyUpdate(arg: ModelComposed)

class FreshserviceAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the FreshserviceAPIKey object.

Parameters:

api_key (str, optional) – The FreshserviceAPIKeyUpdate api_key.
domain (str, optional) – The FreshserviceAPIKeyUpdate domain.
type (FreshserviceAPIKeyType) – The definition of the FreshserviceAPIKey object.

datadog_api_client.v2.model.freshservice_credentials module¶

class FreshserviceCredentials(arg: None)¶

class FreshserviceCredentials(arg: ModelComposed)

class FreshserviceCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the FreshserviceCredentials object.

Parameters:

api_key (str) – The FreshserviceAPIKey api_key.
domain (str) – The FreshserviceAPIKey domain.
type (FreshserviceAPIKeyType) – The definition of the FreshserviceAPIKey object.

datadog_api_client.v2.model.freshservice_credentials_update module¶

class FreshserviceCredentialsUpdate(arg: None)¶

class FreshserviceCredentialsUpdate(arg: ModelComposed)

class FreshserviceCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the FreshserviceCredentialsUpdate object.

Parameters:

api_key (str, optional) – The FreshserviceAPIKeyUpdate api_key.
domain (str, optional) – The FreshserviceAPIKeyUpdate domain.
type (FreshserviceAPIKeyType) – The definition of the FreshserviceAPIKey object.

datadog_api_client.v2.model.freshservice_integration module¶

class FreshserviceIntegration(arg: None)¶

class FreshserviceIntegration(arg: ModelComposed)

class FreshserviceIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the FreshserviceIntegration object.

Parameters:

credentials (FreshserviceCredentials) – The definition of the FreshserviceCredentials object.
type (FreshserviceIntegrationType) – The definition of the FreshserviceIntegrationType object.

datadog_api_client.v2.model.freshservice_integration_type module¶

class FreshserviceIntegrationType(arg: None)¶

class FreshserviceIntegrationType(arg: ModelComposed)

class FreshserviceIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the FreshserviceIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Freshservice”. Must be one of [“Freshservice”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.freshservice_integration_update module¶

class FreshserviceIntegrationUpdate(arg: None)¶

class FreshserviceIntegrationUpdate(arg: ModelComposed)

class FreshserviceIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the FreshserviceIntegrationUpdate object.

Parameters:

credentials (FreshserviceCredentialsUpdate, optional) – The definition of the FreshserviceCredentialsUpdate object.
type (FreshserviceIntegrationType) – The definition of the FreshserviceIntegrationType object.

datadog_api_client.v2.model.full_api_key module¶

class FullAPIKey(arg: None)¶

class FullAPIKey(arg: ModelComposed)

class FullAPIKey(*args, **kwargs)

Bases: ModelNormal

Datadog API key.

Parameters:

attributes (FullAPIKeyAttributes, optional) – Attributes of a full API key.
id (str, optional) – ID of the API key.
relationships (APIKeyRelationships, optional) – Resources related to the API key.
type (APIKeysType, optional) – API Keys resource type.

datadog_api_client.v2.model.full_api_key_attributes module¶

class FullAPIKeyAttributes(arg: None)¶

class FullAPIKeyAttributes(arg: ModelComposed)

class FullAPIKeyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a full API key.

Parameters:

category (str, optional) – The category of the API key.
created_at (datetime, optional) – Creation date of the API key.
date_last_used (datetime, none_type, optional) – Date the API Key was last used
key (str, optional) – The API key.
last4 (str, optional) – The last four characters of the API key.
modified_at (datetime, optional) – Date the API key was last modified.
name (str, optional) – Name of the API key.
remote_config_read_enabled (bool, optional) – The remote config read enabled status.

datadog_api_client.v2.model.full_application_key module¶

class FullApplicationKey(arg: None)¶

class FullApplicationKey(arg: ModelComposed)

class FullApplicationKey(*args, **kwargs)

Bases: ModelNormal

Datadog application key.

Parameters:

attributes (FullApplicationKeyAttributes, optional) – Attributes of a full application key.
id (str, optional) – ID of the application key.
relationships (ApplicationKeyRelationships, optional) – Resources related to the application key.
type (ApplicationKeysType, optional) – Application Keys resource type.

datadog_api_client.v2.model.full_application_key_attributes module¶

class FullApplicationKeyAttributes(arg: None)¶

class FullApplicationKeyAttributes(arg: ModelComposed)

class FullApplicationKeyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a full application key.

Parameters:

created_at (datetime, optional) – Creation date of the application key.
key (str, optional) – The application key.
last4 (str, optional) – The last four characters of the application key.
last_used_at (datetime, none_type, optional) – Last usage timestamp of the application key.
name (str, optional) – Name of the application key.
scopes ([str], none_type, optional) – Array of scopes to grant the application key.

datadog_api_client.v2.model.full_custom_framework_data module¶

class FullCustomFrameworkData(arg: None)¶

class FullCustomFrameworkData(arg: ModelComposed)

class FullCustomFrameworkData(*args, **kwargs)

Bases: ModelNormal

Contains type and attributes for custom frameworks.

Parameters:

attributes (FullCustomFrameworkDataAttributes) – Full Framework Data Attributes.
id (str) – The ID of the custom framework.
type (CustomFrameworkType) – The type of the resource. The value must be custom_framework.

datadog_api_client.v2.model.full_custom_framework_data_attributes module¶

class FullCustomFrameworkDataAttributes(arg: None)¶

class FullCustomFrameworkDataAttributes(arg: ModelComposed)

class FullCustomFrameworkDataAttributes(*args, **kwargs)

Bases: ModelNormal

Full Framework Data Attributes.

Parameters:

handle (str) – Framework Handle
icon_url (str, optional) – Framework Icon URL
name (str) – Framework Name
requirements ([CustomFrameworkRequirement]) – Framework Requirements
version (str) – Framework Version

datadog_api_client.v2.model.gcp_credentials module¶

class GCPCredentials(arg: None)¶

class GCPCredentials(arg: ModelComposed)

class GCPCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the GCPCredentials object.

Parameters:

private_key (str) – The GCPServiceAccount private_key.
service_account_email (str) – The GCPServiceAccount service_account_email.
type (GCPServiceAccountCredentialType) – The definition of the GCPServiceAccount object.

datadog_api_client.v2.model.gcp_credentials_update module¶

class GCPCredentialsUpdate(arg: None)¶

class GCPCredentialsUpdate(arg: ModelComposed)

class GCPCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the GCPCredentialsUpdate object.

Parameters:

private_key (str, optional) – The GCPServiceAccountUpdate private_key.
service_account_email (str, optional) – The GCPServiceAccountUpdate service_account_email.
type (GCPServiceAccountCredentialType) – The definition of the GCPServiceAccount object.

datadog_api_client.v2.model.gcp_integration module¶

class GCPIntegration(arg: None)¶

class GCPIntegration(arg: ModelComposed)

class GCPIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the GCPIntegration object.

Parameters:

credentials (GCPCredentials) – The definition of the GCPCredentials object.
type (GCPIntegrationType) – The definition of the GCPIntegrationType object.

datadog_api_client.v2.model.gcp_integration_type module¶

class GCPIntegrationType(arg: None)¶

class GCPIntegrationType(arg: ModelComposed)

class GCPIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the GCPIntegrationType object.

Parameters:

value (str) – If omitted defaults to “GCP”. Must be one of [“GCP”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_integration_update module¶

class GCPIntegrationUpdate(arg: None)¶

class GCPIntegrationUpdate(arg: ModelComposed)

class GCPIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GCPIntegrationUpdate object.

Parameters:

credentials (GCPCredentialsUpdate, optional) – The definition of the GCPCredentialsUpdate object.
type (GCPIntegrationType) – The definition of the GCPIntegrationType object.

datadog_api_client.v2.model.gcp_metric_namespace_config module¶

class GCPMetricNamespaceConfig(arg: None)¶

class GCPMetricNamespaceConfig(arg: ModelComposed)

class GCPMetricNamespaceConfig(*args, **kwargs)

Bases: ModelNormal

Configuration for a GCP metric namespace.

Parameters:

disabled (bool, optional) – When disabled, Datadog does not collect metrics that are related to this GCP metric namespace.
filters ([str], optional) – When enabled, Datadog applies these additional filters to limit metric collection. A metric is collected only if it does not match all exclusion filters and matches at least one allow filter.
id (str, optional) – The id of the GCP metric namespace.

datadog_api_client.v2.model.gcp_monitored_resource_config module¶

class GCPMonitoredResourceConfig(arg: None)¶

class GCPMonitoredResourceConfig(arg: ModelComposed)

class GCPMonitoredResourceConfig(*args, **kwargs)

Bases: ModelNormal

Configuration for a GCP monitored resource.

Parameters:

filters ([str], optional) – List of filters to limit the monitored resources that are pulled into Datadog by using tags. Only monitored resources that apply to specified filters are imported into Datadog.
type (GCPMonitoredResourceConfigType, optional) – The GCP monitored resource type. Only a subset of resource types are supported.

datadog_api_client.v2.model.gcp_monitored_resource_config_type module¶

class GCPMonitoredResourceConfigType(arg: None)¶

class GCPMonitoredResourceConfigType(arg: ModelComposed)

class GCPMonitoredResourceConfigType(*args, **kwargs)

Bases: ModelSimple

The GCP monitored resource type. Only a subset of resource types are supported.

Parameters:

value (str) – Must be one of [“cloud_function”, “cloud_run_revision”, “gce_instance”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_scan_options module¶

class GcpScanOptions(arg: None)¶

class GcpScanOptions(arg: ModelComposed)

class GcpScanOptions(*args, **kwargs)

Bases: ModelNormal

Response object containing GCP scan options for a single project.

Parameters:: data (GcpScanOptionsData, optional) – Single GCP scan options entry.

datadog_api_client.v2.model.gcp_scan_options_array module¶

class GcpScanOptionsArray(arg: None)¶

class GcpScanOptionsArray(arg: ModelComposed)

class GcpScanOptionsArray(*args, **kwargs)

Bases: ModelNormal

Response object containing a list of GCP scan options.

Parameters:: data ([GcpScanOptionsData]) – A list of GCP scan options.

datadog_api_client.v2.model.gcp_scan_options_data module¶

class GcpScanOptionsData(arg: None)¶

class GcpScanOptionsData(arg: ModelComposed)

class GcpScanOptionsData(*args, **kwargs)

Bases: ModelNormal

Single GCP scan options entry.

Parameters:

attributes (GcpScanOptionsDataAttributes, optional) – Attributes for GCP scan options configuration.
id (str) – The GCP project ID.
type (GcpScanOptionsDataType) – GCP scan options resource type.

datadog_api_client.v2.model.gcp_scan_options_data_attributes module¶

class GcpScanOptionsDataAttributes(arg: None)¶

class GcpScanOptionsDataAttributes(arg: ModelComposed)

class GcpScanOptionsDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for GCP scan options configuration.

Parameters:

vuln_containers_os (bool, optional) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool, optional) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.gcp_scan_options_data_type module¶

class GcpScanOptionsDataType(arg: None)¶

class GcpScanOptionsDataType(arg: ModelComposed)

class GcpScanOptionsDataType(*args, **kwargs)

Bases: ModelSimple

GCP scan options resource type.

Parameters:

value (str) – If omitted defaults to “gcp_scan_options”. Must be one of [“gcp_scan_options”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_scan_options_input_update module¶

class GcpScanOptionsInputUpdate(arg: None)¶

class GcpScanOptionsInputUpdate(arg: ModelComposed)

class GcpScanOptionsInputUpdate(*args, **kwargs)

Bases: ModelNormal

Request object for updating GCP scan options.

Parameters:: data (GcpScanOptionsInputUpdateData, optional) – Data object for updating the scan options of a single GCP project.

datadog_api_client.v2.model.gcp_scan_options_input_update_data module¶

class GcpScanOptionsInputUpdateData(arg: None)¶

class GcpScanOptionsInputUpdateData(arg: ModelComposed)

class GcpScanOptionsInputUpdateData(*args, **kwargs)

Bases: ModelNormal

Data object for updating the scan options of a single GCP project.

Parameters:

attributes (GcpScanOptionsInputUpdateDataAttributes, optional) – Attributes for updating GCP scan options configuration.
id (str) – The GCP project ID.
type (GcpScanOptionsInputUpdateDataType) – GCP scan options resource type.

datadog_api_client.v2.model.gcp_scan_options_input_update_data_attributes module¶

class GcpScanOptionsInputUpdateDataAttributes(arg: None)¶

class GcpScanOptionsInputUpdateDataAttributes(arg: ModelComposed)

class GcpScanOptionsInputUpdateDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for updating GCP scan options configuration.

Parameters:

vuln_containers_os (bool, optional) – Indicates if scanning for vulnerabilities in containers is enabled.
vuln_host_os (bool, optional) – Indicates if scanning for vulnerabilities in hosts is enabled.

datadog_api_client.v2.model.gcp_scan_options_input_update_data_type module¶

class GcpScanOptionsInputUpdateDataType(arg: None)¶

class GcpScanOptionsInputUpdateDataType(arg: ModelComposed)

class GcpScanOptionsInputUpdateDataType(*args, **kwargs)

Bases: ModelSimple

GCP scan options resource type.

Parameters:

value (str) – If omitted defaults to “gcp_scan_options”. Must be one of [“gcp_scan_options”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_service_account module¶

class GCPServiceAccount(arg: None)¶

class GCPServiceAccount(arg: ModelComposed)

class GCPServiceAccount(*args, **kwargs)

Bases: ModelNormal

The definition of the GCPServiceAccount object.

Parameters:

private_key (str) – The GCPServiceAccount private_key.
service_account_email (str) – The GCPServiceAccount service_account_email.
type (GCPServiceAccountCredentialType) – The definition of the GCPServiceAccount object.

datadog_api_client.v2.model.gcp_service_account_credential_type module¶

class GCPServiceAccountCredentialType(arg: None)¶

class GCPServiceAccountCredentialType(arg: ModelComposed)

class GCPServiceAccountCredentialType(*args, **kwargs)

Bases: ModelSimple

The definition of the GCPServiceAccount object.

Parameters:

value (str) – If omitted defaults to “GCPServiceAccount”. Must be one of [“GCPServiceAccount”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_service_account_meta module¶

class GCPServiceAccountMeta(arg: None)¶

class GCPServiceAccountMeta(arg: ModelComposed)

class GCPServiceAccountMeta(*args, **kwargs)

Bases: ModelNormal

Additional information related to your service account.

Parameters:: accessible_projects ([str], optional) – The current list of projects accessible from your service account.

datadog_api_client.v2.model.gcp_service_account_type module¶

class GCPServiceAccountType(arg: None)¶

class GCPServiceAccountType(arg: ModelComposed)

class GCPServiceAccountType(*args, **kwargs)

Bases: ModelSimple

The type of account.

Parameters:

value (str) – If omitted defaults to “gcp_service_account”. Must be one of [“gcp_service_account”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_service_account_update module¶

class GCPServiceAccountUpdate(arg: None)¶

class GCPServiceAccountUpdate(arg: ModelComposed)

class GCPServiceAccountUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GCPServiceAccount object.

Parameters:

private_key (str, optional) – The GCPServiceAccountUpdate private_key.
service_account_email (str, optional) – The GCPServiceAccountUpdate service_account_email.
type (GCPServiceAccountCredentialType) – The definition of the GCPServiceAccount object.

datadog_api_client.v2.model.gcp_uc_config_response module¶

class GcpUcConfigResponse(arg: None)¶

class GcpUcConfigResponse(arg: ModelComposed)

class GcpUcConfigResponse(*args, **kwargs)

Bases: ModelNormal

The definition of GcpUcConfigResponse object.

Parameters:: data (GcpUcConfigResponseData, optional) – The definition of GcpUcConfigResponseData object.

datadog_api_client.v2.model.gcp_uc_config_response_data module¶

class GcpUcConfigResponseData(arg: None)¶

class GcpUcConfigResponseData(arg: ModelComposed)

class GcpUcConfigResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of GcpUcConfigResponseData object.

Parameters:

attributes (GcpUcConfigResponseDataAttributes, optional) – The definition of GcpUcConfigResponseDataAttributes object.
id (str, optional) – The GcpUcConfigResponseData id.
type (GcpUcConfigResponseDataType) – Google Cloud Usage Cost config resource type.

datadog_api_client.v2.model.gcp_uc_config_response_data_attributes module¶

class GcpUcConfigResponseDataAttributes(arg: None)¶

class GcpUcConfigResponseDataAttributes(arg: ModelComposed)

class GcpUcConfigResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of GcpUcConfigResponseDataAttributes object.

Parameters:

account_id (str, optional) – The attributes account_id.
bucket_name (str, optional) – The attributes bucket_name.
created_at (str, optional) – The attributes created_at.
dataset (str, optional) – The attributes dataset.
error_messages ([str], none_type, optional) – The attributes error_messages.
export_prefix (str, optional) – The attributes export_prefix.
export_project_name (str, optional) – The attributes export_project_name.
months (int, optional) – The attributes months.
project_id (str, optional) – The attributes project_id.
service_account (str, optional) – The attributes service_account.
status (str, optional) – The attributes status.
status_updated_at (str, optional) – The attributes status_updated_at.
updated_at (str, optional) – The attributes updated_at.

datadog_api_client.v2.model.gcp_uc_config_response_data_type module¶

class GcpUcConfigResponseDataType(arg: None)¶

class GcpUcConfigResponseDataType(arg: ModelComposed)

class GcpUcConfigResponseDataType(*args, **kwargs)

Bases: ModelSimple

Google Cloud Usage Cost config resource type.

Parameters:

value (str) – If omitted defaults to “gcp_uc_config”. Must be one of [“gcp_uc_config”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_usage_cost_config module¶

class GCPUsageCostConfig(arg: None)¶

class GCPUsageCostConfig(arg: ModelComposed)

class GCPUsageCostConfig(*args, **kwargs)

Bases: ModelNormal

Google Cloud Usage Cost config.

Parameters:

attributes (GCPUsageCostConfigAttributes) – Attributes for a Google Cloud Usage Cost config.
id (str, optional) – The ID of the Google Cloud Usage Cost config.
type (GCPUsageCostConfigType) – Type of Google Cloud Usage Cost config.

datadog_api_client.v2.model.gcp_usage_cost_config_attributes module¶

class GCPUsageCostConfigAttributes(arg: None)¶

class GCPUsageCostConfigAttributes(arg: ModelComposed)

class GCPUsageCostConfigAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a Google Cloud Usage Cost config.

Parameters:

account_id (str) – The Google Cloud account ID.
bucket_name (str) – The Google Cloud bucket name used to store the Usage Cost export.
created_at (str, optional) – The timestamp when the Google Cloud Usage Cost config was created.
dataset (str) – The export dataset name used for the Google Cloud Usage Cost Report.
error_messages ([str], none_type, optional) – The error messages for the Google Cloud Usage Cost config.
export_prefix (str) – The export prefix used for the Google Cloud Usage Cost Report.
export_project_name (str) – The name of the Google Cloud Usage Cost Report.
months (int, optional) – The number of months the report has been backfilled. Deprecated.
project_id (str, optional) – The project_id of the Google Cloud Usage Cost report.
service_account (str) – The unique Google Cloud service account email.
status (str) – The status of the Google Cloud Usage Cost config.
status_updated_at (str, optional) – The timestamp when the Google Cloud Usage Cost config status was updated.
updated_at (str, optional) – The timestamp when the Google Cloud Usage Cost config status was updated.

datadog_api_client.v2.model.gcp_usage_cost_config_patch_data module¶

class GCPUsageCostConfigPatchData(arg: None)¶

class GCPUsageCostConfigPatchData(arg: ModelComposed)

class GCPUsageCostConfigPatchData(*args, **kwargs)

Bases: ModelNormal

Google Cloud Usage Cost config patch data.

Parameters:

attributes (GCPUsageCostConfigPatchRequestAttributes) – Attributes for Google Cloud Usage Cost config patch request.
type (GCPUsageCostConfigPatchRequestType) – Type of Google Cloud Usage Cost config patch request.

datadog_api_client.v2.model.gcp_usage_cost_config_patch_request module¶

class GCPUsageCostConfigPatchRequest(arg: None)¶

class GCPUsageCostConfigPatchRequest(arg: ModelComposed)

class GCPUsageCostConfigPatchRequest(*args, **kwargs)

Bases: ModelNormal

Google Cloud Usage Cost config patch request.

Parameters:: data (GCPUsageCostConfigPatchData) – Google Cloud Usage Cost config patch data.

datadog_api_client.v2.model.gcp_usage_cost_config_patch_request_attributes module¶

class GCPUsageCostConfigPatchRequestAttributes(arg: None)¶

class GCPUsageCostConfigPatchRequestAttributes(arg: ModelComposed)

class GCPUsageCostConfigPatchRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Google Cloud Usage Cost config patch request.

Parameters:: is_enabled (bool) – Whether or not the Cloud Cost Management account is enabled.

datadog_api_client.v2.model.gcp_usage_cost_config_patch_request_type module¶

class GCPUsageCostConfigPatchRequestType(arg: None)¶

class GCPUsageCostConfigPatchRequestType(arg: ModelComposed)

class GCPUsageCostConfigPatchRequestType(*args, **kwargs)

Bases: ModelSimple

Type of Google Cloud Usage Cost config patch request.

Parameters:

value (str) – If omitted defaults to “gcp_uc_config_patch_request”. Must be one of [“gcp_uc_config_patch_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_usage_cost_config_post_data module¶

class GCPUsageCostConfigPostData(arg: None)¶

class GCPUsageCostConfigPostData(arg: ModelComposed)

class GCPUsageCostConfigPostData(*args, **kwargs)

Bases: ModelNormal

Google Cloud Usage Cost config post data.

Parameters:

attributes (GCPUsageCostConfigPostRequestAttributes, optional) – Attributes for Google Cloud Usage Cost config post request.
type (GCPUsageCostConfigPostRequestType) – Type of Google Cloud Usage Cost config post request.

datadog_api_client.v2.model.gcp_usage_cost_config_post_request module¶

class GCPUsageCostConfigPostRequest(arg: None)¶

class GCPUsageCostConfigPostRequest(arg: ModelComposed)

class GCPUsageCostConfigPostRequest(*args, **kwargs)

Bases: ModelNormal

Google Cloud Usage Cost config post request.

Parameters:: data (GCPUsageCostConfigPostData) – Google Cloud Usage Cost config post data.

datadog_api_client.v2.model.gcp_usage_cost_config_post_request_attributes module¶

class GCPUsageCostConfigPostRequestAttributes(arg: None)¶

class GCPUsageCostConfigPostRequestAttributes(arg: ModelComposed)

class GCPUsageCostConfigPostRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Google Cloud Usage Cost config post request.

Parameters:

billing_account_id (str) – The Google Cloud account ID.
bucket_name (str) – The Google Cloud bucket name used to store the Usage Cost export.
export_dataset_name (str) – The export dataset name used for the Google Cloud Usage Cost report.
export_prefix (str, optional) – The export prefix used for the Google Cloud Usage Cost report.
export_project_name (str) – The name of the Google Cloud Usage Cost report.
service_account (str) – The unique Google Cloud service account email.

datadog_api_client.v2.model.gcp_usage_cost_config_post_request_type module¶

class GCPUsageCostConfigPostRequestType(arg: None)¶

class GCPUsageCostConfigPostRequestType(arg: ModelComposed)

class GCPUsageCostConfigPostRequestType(*args, **kwargs)

Bases: ModelSimple

Type of Google Cloud Usage Cost config post request.

Parameters:

value (str) – If omitted defaults to “gcp_uc_config_post_request”. Must be one of [“gcp_uc_config_post_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_usage_cost_config_response module¶

class GCPUsageCostConfigResponse(arg: None)¶

class GCPUsageCostConfigResponse(arg: ModelComposed)

class GCPUsageCostConfigResponse(*args, **kwargs)

Bases: ModelNormal

Response of Google Cloud Usage Cost config.

Parameters:: data (GCPUsageCostConfig, optional) – Google Cloud Usage Cost config.

datadog_api_client.v2.model.gcp_usage_cost_config_type module¶

class GCPUsageCostConfigType(arg: None)¶

class GCPUsageCostConfigType(arg: ModelComposed)

class GCPUsageCostConfigType(*args, **kwargs)

Bases: ModelSimple

Type of Google Cloud Usage Cost config.

Parameters:

value (str) – If omitted defaults to “gcp_uc_config”. Must be one of [“gcp_uc_config”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcp_usage_cost_configs_response module¶

class GCPUsageCostConfigsResponse(arg: None)¶

class GCPUsageCostConfigsResponse(arg: ModelComposed)

class GCPUsageCostConfigsResponse(*args, **kwargs)

Bases: ModelNormal

List of Google Cloud Usage Cost configs.

Parameters:: data ([GCPUsageCostConfig]) – A Google Cloud Usage Cost config.

datadog_api_client.v2.model.gcpsts_delegate_account module¶

class GCPSTSDelegateAccount(arg: None)¶

class GCPSTSDelegateAccount(arg: ModelComposed)

class GCPSTSDelegateAccount(*args, **kwargs)

Bases: ModelNormal

Datadog principal service account info.

Parameters:

attributes (GCPSTSDelegateAccountAttributes, optional) – Your delegate account attributes.
id (str, optional) – The ID of the delegate service account.
type (GCPSTSDelegateAccountType, optional) – The type of account.

datadog_api_client.v2.model.gcpsts_delegate_account_attributes module¶

class GCPSTSDelegateAccountAttributes(arg: None)¶

class GCPSTSDelegateAccountAttributes(arg: ModelComposed)

class GCPSTSDelegateAccountAttributes(*args, **kwargs)

Bases: ModelNormal

Your delegate account attributes.

Parameters:: delegate_account_email (str, optional) – Your organization’s Datadog principal email address.

datadog_api_client.v2.model.gcpsts_delegate_account_response module¶

class GCPSTSDelegateAccountResponse(arg: None)¶

class GCPSTSDelegateAccountResponse(arg: ModelComposed)

class GCPSTSDelegateAccountResponse(*args, **kwargs)

Bases: ModelNormal

Your delegate service account response data.

Parameters:: data (GCPSTSDelegateAccount, optional) – Datadog principal service account info.

datadog_api_client.v2.model.gcpsts_delegate_account_type module¶

class GCPSTSDelegateAccountType(arg: None)¶

class GCPSTSDelegateAccountType(arg: ModelComposed)

class GCPSTSDelegateAccountType(*args, **kwargs)

Bases: ModelSimple

The type of account.

Parameters:

value (str) – If omitted defaults to “gcp_sts_delegate”. Must be one of [“gcp_sts_delegate”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gcpsts_service_account module¶

class GCPSTSServiceAccount(arg: None)¶

class GCPSTSServiceAccount(arg: ModelComposed)

class GCPSTSServiceAccount(*args, **kwargs)

Bases: ModelNormal

Info on your service account.

Parameters:

attributes (GCPSTSServiceAccountAttributes, optional) – Attributes associated with your service account.
id (str, optional) – Your service account’s unique ID.
meta (GCPServiceAccountMeta, optional) – Additional information related to your service account.
type (GCPServiceAccountType, optional) – The type of account.

datadog_api_client.v2.model.gcpsts_service_account_attributes module¶

class GCPSTSServiceAccountAttributes(arg: None)¶

class GCPSTSServiceAccountAttributes(arg: ModelComposed)

class GCPSTSServiceAccountAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes associated with your service account.

Parameters:

account_tags ([str], optional) – Tags to be associated with GCP metrics and service checks from your account.
automute (bool, optional) – Silence monitors for expected GCE instance shutdowns.
client_email (str, optional) – Your service account email address.
cloud_run_revision_filters ([str], optional) – List of filters to limit the Cloud Run revisions that are pulled into Datadog by using tags. Only Cloud Run revision resources that apply to specified filters are imported into Datadog. Note: This field is deprecated. Instead, use monitored_resource_configs with type=cloud_run_revision Deprecated.
host_filters ([str], optional) – List of filters to limit the VM instances that are pulled into Datadog by using tags. Only VM instance resources that apply to specified filters are imported into Datadog. Note: This field is deprecated. Instead, use monitored_resource_configs with type=gce_instance Deprecated.
is_cspm_enabled (bool, optional) – When enabled, Datadog will activate the Cloud Security Monitoring product for this service account. Note: This requires resource_collection_enabled to be set to true.
is_per_project_quota_enabled (bool, optional) – When enabled, Datadog applies the X-Goog-User-Project header, attributing Google Cloud billing and quota usage to the project being monitored rather than the default service account project.
is_resource_change_collection_enabled (bool, optional) – When enabled, Datadog scans for all resource change data in your Google Cloud environment.
is_security_command_center_enabled (bool, optional) – When enabled, Datadog will attempt to collect Security Command Center Findings. Note: This requires additional permissions on the service account.
metric_namespace_configs ([GCPMetricNamespaceConfig], optional) – Configurations for GCP metric namespaces.
monitored_resource_configs ([GCPMonitoredResourceConfig], optional) – Configurations for GCP monitored resources.
resource_collection_enabled (bool, optional) – When enabled, Datadog scans for all resources in your GCP environment.

datadog_api_client.v2.model.gcpsts_service_account_create_request module¶

class GCPSTSServiceAccountCreateRequest(arg: None)¶

class GCPSTSServiceAccountCreateRequest(arg: ModelComposed)

class GCPSTSServiceAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Data on your newly generated service account.

Parameters:: data (GCPSTSServiceAccountData, optional) – Additional metadata on your generated service account.

datadog_api_client.v2.model.gcpsts_service_account_data module¶

class GCPSTSServiceAccountData(arg: None)¶

class GCPSTSServiceAccountData(arg: ModelComposed)

class GCPSTSServiceAccountData(*args, **kwargs)

Bases: ModelNormal

Additional metadata on your generated service account.

Parameters:

attributes (GCPSTSServiceAccountAttributes, optional) – Attributes associated with your service account.
type (GCPServiceAccountType, optional) – The type of account.

datadog_api_client.v2.model.gcpsts_service_account_response module¶

class GCPSTSServiceAccountResponse(arg: None)¶

class GCPSTSServiceAccountResponse(arg: ModelComposed)

class GCPSTSServiceAccountResponse(*args, **kwargs)

Bases: ModelNormal

The account creation response.

Parameters:: data (GCPSTSServiceAccount, optional) – Info on your service account.

datadog_api_client.v2.model.gcpsts_service_account_update_request module¶

class GCPSTSServiceAccountUpdateRequest(arg: None)¶

class GCPSTSServiceAccountUpdateRequest(arg: ModelComposed)

class GCPSTSServiceAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Service account info.

Parameters:: data (GCPSTSServiceAccountUpdateRequestData, optional) – Data on your service account.

datadog_api_client.v2.model.gcpsts_service_account_update_request_data module¶

class GCPSTSServiceAccountUpdateRequestData(arg: None)¶

class GCPSTSServiceAccountUpdateRequestData(arg: ModelComposed)

class GCPSTSServiceAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data on your service account.

Parameters:

attributes (GCPSTSServiceAccountAttributes, optional) – Attributes associated with your service account.
id (str, optional) – Your service account’s unique ID.
type (GCPServiceAccountType, optional) – The type of account.

datadog_api_client.v2.model.gcpsts_service_accounts_response module¶

class GCPSTSServiceAccountsResponse(arg: None)¶

class GCPSTSServiceAccountsResponse(arg: ModelComposed)

class GCPSTSServiceAccountsResponse(*args, **kwargs)

Bases: ModelNormal

Object containing all your STS enabled accounts.

Parameters:: data ([GCPSTSServiceAccount], optional) – Array of GCP STS enabled service accounts.

datadog_api_client.v2.model.gemini_api_key module¶

class GeminiAPIKey(arg: None)¶

class GeminiAPIKey(arg: ModelComposed)

class GeminiAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the GeminiAPIKey object.

Parameters:

api_key (str) – The GeminiAPIKey api_key.
type (GeminiAPIKeyType) – The definition of the GeminiAPIKey object.

datadog_api_client.v2.model.gemini_api_key_type module¶

class GeminiAPIKeyType(arg: None)¶

class GeminiAPIKeyType(arg: ModelComposed)

class GeminiAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the GeminiAPIKey object.

Parameters:

value (str) – If omitted defaults to “GeminiAPIKey”. Must be one of [“GeminiAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gemini_api_key_update module¶

class GeminiAPIKeyUpdate(arg: None)¶

class GeminiAPIKeyUpdate(arg: ModelComposed)

class GeminiAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GeminiAPIKey object.

Parameters:

api_key (str, optional) – The GeminiAPIKeyUpdate api_key.
type (GeminiAPIKeyType) – The definition of the GeminiAPIKey object.

datadog_api_client.v2.model.gemini_credentials module¶

class GeminiCredentials(arg: None)¶

class GeminiCredentials(arg: ModelComposed)

class GeminiCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the GeminiCredentials object.

Parameters:

api_key (str) – The GeminiAPIKey api_key.
type (GeminiAPIKeyType) – The definition of the GeminiAPIKey object.

datadog_api_client.v2.model.gemini_credentials_update module¶

class GeminiCredentialsUpdate(arg: None)¶

class GeminiCredentialsUpdate(arg: ModelComposed)

class GeminiCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the GeminiCredentialsUpdate object.

Parameters:

api_key (str, optional) – The GeminiAPIKeyUpdate api_key.
type (GeminiAPIKeyType) – The definition of the GeminiAPIKey object.

datadog_api_client.v2.model.gemini_integration module¶

class GeminiIntegration(arg: None)¶

class GeminiIntegration(arg: ModelComposed)

class GeminiIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the GeminiIntegration object.

Parameters:

credentials (GeminiCredentials) – The definition of the GeminiCredentials object.
type (GeminiIntegrationType) – The definition of the GeminiIntegrationType object.

datadog_api_client.v2.model.gemini_integration_type module¶

class GeminiIntegrationType(arg: None)¶

class GeminiIntegrationType(arg: ModelComposed)

class GeminiIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the GeminiIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Gemini”. Must be one of [“Gemini”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gemini_integration_update module¶

class GeminiIntegrationUpdate(arg: None)¶

class GeminiIntegrationUpdate(arg: ModelComposed)

class GeminiIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GeminiIntegrationUpdate object.

Parameters:

credentials (GeminiCredentialsUpdate, optional) – The definition of the GeminiCredentialsUpdate object.
type (GeminiIntegrationType) – The definition of the GeminiIntegrationType object.

datadog_api_client.v2.model.get_action_connection_response module¶

class GetActionConnectionResponse(arg: None)¶

class GetActionConnectionResponse(arg: ModelComposed)

class GetActionConnectionResponse(*args, **kwargs)

Bases: ModelNormal

The response for found connection

Parameters:: data (ActionConnectionData, optional) – Data related to the connection.

datadog_api_client.v2.model.get_app_key_registration_response module¶

class GetAppKeyRegistrationResponse(arg: None)¶

class GetAppKeyRegistrationResponse(arg: ModelComposed)

class GetAppKeyRegistrationResponse(*args, **kwargs)

Bases: ModelNormal

The response object after getting an app key registration.

Parameters:: data (AppKeyRegistrationData, optional) – Data related to the app key registration.

datadog_api_client.v2.model.get_app_response module¶

class GetAppResponse(arg: None)¶

class GetAppResponse(arg: ModelComposed)

class GetAppResponse(*args, **kwargs)

Bases: ModelNormal

The full app definition response object.

Parameters:

data (GetAppResponseData, optional) – The data object containing the app definition.
included ([Deployment], optional) – Data on the version of the app that was published.
meta (AppMeta, optional) – Metadata of an app.
relationship (AppRelationship, optional) – The app’s publication relationship and custom connections.

datadog_api_client.v2.model.get_app_response_data module¶

class GetAppResponseData(arg: None)¶

class GetAppResponseData(arg: ModelComposed)

class GetAppResponseData(*args, **kwargs)

Bases: ModelNormal

The data object containing the app definition.

Parameters:

attributes (GetAppResponseDataAttributes) – The app definition attributes, such as name, description, and components.
id (UUID) – The ID of the app.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.get_app_response_data_attributes module¶

class GetAppResponseDataAttributes(arg: None)¶

class GetAppResponseDataAttributes(arg: ModelComposed)

class GetAppResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The app definition attributes, such as name, description, and components.

Parameters:

components ([ComponentGrid], optional) – The UI components that make up the app.
description (str, optional) – A human-readable description for the app.
favorite (bool, optional) – Whether the app is marked as a favorite by the current user.
name (str, optional) – The name of the app.
queries ([Query], optional) – An array of queries, such as external actions and state variables, that the app uses.
root_instance_name (str, optional) – The name of the root component of the app. This must be a grid component that contains all other components.
tags ([str], optional) – A list of tags for the app, which can be used to filter apps.

datadog_api_client.v2.model.get_custom_framework_response module¶

class GetCustomFrameworkResponse(arg: None)¶

class GetCustomFrameworkResponse(arg: ModelComposed)

class GetCustomFrameworkResponse(*args, **kwargs)

Bases: ModelNormal

Response object to get a custom framework.

Parameters:: data (FullCustomFrameworkData) – Contains type and attributes for custom frameworks.

datadog_api_client.v2.model.get_data_deletions_response_body module¶

class GetDataDeletionsResponseBody(arg: None)¶

class GetDataDeletionsResponseBody(arg: ModelComposed)

class GetDataDeletionsResponseBody(*args, **kwargs)

Bases: ModelNormal

The response from the get data deletion requests endpoint.

Parameters:

data ([DataDeletionResponseItem], optional) – The list of data deletion requests that matches the query.
meta (DataDeletionResponseMeta, optional) – The metadata of the data deletion response.

datadog_api_client.v2.model.get_device_attributes module¶

class GetDeviceAttributes(arg: None)¶

class GetDeviceAttributes(arg: ModelComposed)

class GetDeviceAttributes(*args, **kwargs)

Bases: ModelNormal

The device attributes

Parameters:

description (str, optional) – A description of the device.
device_type (str, optional) – The type of the device.
integration (str, optional) – The integration of the device.
ip_address (str, optional) – The IP address of the device.
location (str, optional) – The location of the device.
model (str, optional) – The model of the device.
name (str, optional) – The name of the device.
os_hostname (str, optional) – The operating system hostname of the device.
os_name (str, optional) – The operating system name of the device.
os_version (str, optional) – The operating system version of the device.
ping_status (str, optional) – The ping status of the device.
product_name (str, optional) – The product name of the device.
serial_number (str, optional) – The serial number of the device.
status (str, optional) – The status of the device.
subnet (str, optional) – The subnet of the device.
sys_object_id (str, optional) – The device sys_object_id.
tags ([str], optional) – A list of tags associated with the device.
vendor (str, optional) – The vendor of the device.
version (str, optional) – The version of the device.

datadog_api_client.v2.model.get_device_data module¶

class GetDeviceData(arg: None)¶

class GetDeviceData(arg: ModelComposed)

class GetDeviceData(*args, **kwargs)

Bases: ModelNormal

Get device response data.

Parameters:

attributes (GetDeviceAttributes, optional) – The device attributes
id (str, optional) – The device ID
type (str, optional) – The type of the resource. The value should always be device.

datadog_api_client.v2.model.get_device_response module¶

class GetDeviceResponse(arg: None)¶

class GetDeviceResponse(arg: ModelComposed)

class GetDeviceResponse(*args, **kwargs)

Bases: ModelNormal

The GetDevice operation’s response.

Parameters:: data (GetDeviceData, optional) – Get device response data.

datadog_api_client.v2.model.get_finding_response module¶

class GetFindingResponse(arg: None)¶

class GetFindingResponse(arg: ModelComposed)

class GetFindingResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting a finding.

Parameters:: data (DetailedFinding) – A single finding with with message and resource configuration.

datadog_api_client.v2.model.get_interfaces_data module¶

class GetInterfacesData(arg: None)¶

class GetInterfacesData(arg: ModelComposed)

class GetInterfacesData(*args, **kwargs)

Bases: ModelNormal

The interfaces list data

Parameters:

attributes (InterfaceAttributes, optional) – The interface attributes
id (str, optional) – The interface ID
type (str, optional) – The type of the resource. The value should always be interface.

datadog_api_client.v2.model.get_interfaces_response module¶

class GetInterfacesResponse(arg: None)¶

class GetInterfacesResponse(arg: ModelComposed)

class GetInterfacesResponse(*args, **kwargs)

Bases: ModelNormal

The GetInterfaces operation’s response.

Parameters:: data ([GetInterfacesData], optional) – Get Interfaces response

datadog_api_client.v2.model.get_issue_include_query_parameter_item module¶

class GetIssueIncludeQueryParameterItem(arg: None)¶

class GetIssueIncludeQueryParameterItem(arg: ModelComposed)

class GetIssueIncludeQueryParameterItem(*args, **kwargs)

Bases: ModelSimple

Relationship object that should be included in the response.

Parameters:

value (str) – Must be one of [“assignee”, “case”, “team_owners”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_mapping_response module¶

class GetMappingResponse(arg: None)¶

class GetMappingResponse(arg: ModelComposed)

class GetMappingResponse(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (GetMappingResponseData, optional)

datadog_api_client.v2.model.get_mapping_response_data module¶

class GetMappingResponseData(arg: None)¶

class GetMappingResponseData(arg: ModelComposed)

class GetMappingResponseData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (GetMappingResponseDataAttributes, optional)
id (str, optional)
type (GetMappingResponseDataType) – Get mappings response resource type.

datadog_api_client.v2.model.get_mapping_response_data_attributes module¶

class GetMappingResponseDataAttributes(arg: None)¶

class GetMappingResponseDataAttributes(arg: ModelComposed)

class GetMappingResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:: attributes ([GetMappingResponseDataAttributesAttributesItems], optional)

datadog_api_client.v2.model.get_mapping_response_data_attributes_attributes_items module¶

class GetMappingResponseDataAttributesAttributesItems(arg: None)¶

class GetMappingResponseDataAttributesAttributesItems(arg: ModelComposed)

class GetMappingResponseDataAttributesAttributesItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

attribute (str, optional)
description (str, optional)
display_name (str, optional)
groups ([str], optional)
is_custom (bool, optional)
type (str, optional)

datadog_api_client.v2.model.get_mapping_response_data_type module¶

class GetMappingResponseDataType(arg: None)¶

class GetMappingResponseDataType(arg: ModelComposed)

class GetMappingResponseDataType(*args, **kwargs)

Bases: ModelSimple

Get mappings response resource type.

Parameters:

value (str) – If omitted defaults to “get_mappings_response”. Must be one of [“get_mappings_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_multiple_rulesets_request module¶

class GetMultipleRulesetsRequest(arg: None)¶

class GetMultipleRulesetsRequest(arg: ModelComposed)

class GetMultipleRulesetsRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (GetMultipleRulesetsRequestData, optional)

datadog_api_client.v2.model.get_multiple_rulesets_request_data module¶

class GetMultipleRulesetsRequestData(arg: None)¶

class GetMultipleRulesetsRequestData(arg: ModelComposed)

class GetMultipleRulesetsRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (GetMultipleRulesetsRequestDataAttributes, optional)
id (str, optional)
type (GetMultipleRulesetsRequestDataType) – Get multiple rulesets request resource type.

datadog_api_client.v2.model.get_multiple_rulesets_request_data_attributes module¶

class GetMultipleRulesetsRequestDataAttributes(arg: None)¶

class GetMultipleRulesetsRequestDataAttributes(arg: ModelComposed)

class GetMultipleRulesetsRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

include_testing_rules (bool, optional)
include_tests (bool, optional)
rulesets ([str], optional)

datadog_api_client.v2.model.get_multiple_rulesets_request_data_type module¶

class GetMultipleRulesetsRequestDataType(arg: None)¶

class GetMultipleRulesetsRequestDataType(arg: ModelComposed)

class GetMultipleRulesetsRequestDataType(*args, **kwargs)

Bases: ModelSimple

Get multiple rulesets request resource type.

Parameters:

value (str) – If omitted defaults to “get_multiple_rulesets_request”. Must be one of [“get_multiple_rulesets_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_multiple_rulesets_response module¶

class GetMultipleRulesetsResponse(arg: None)¶

class GetMultipleRulesetsResponse(arg: ModelComposed)

class GetMultipleRulesetsResponse(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (GetMultipleRulesetsResponseData, optional)

datadog_api_client.v2.model.get_multiple_rulesets_response_data module¶

class GetMultipleRulesetsResponseData(arg: None)¶

class GetMultipleRulesetsResponseData(arg: ModelComposed)

class GetMultipleRulesetsResponseData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (GetMultipleRulesetsResponseDataAttributes, optional)
id (str, optional)
type (GetMultipleRulesetsResponseDataType) – Get multiple rulesets response resource type.

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes module¶

class GetMultipleRulesetsResponseDataAttributes(arg: None)¶

class GetMultipleRulesetsResponseDataAttributes(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:: rulesets ([GetMultipleRulesetsResponseDataAttributesRulesetsItems], optional)

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItems(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItems(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

data (GetMultipleRulesetsResponseDataAttributesRulesetsItemsData)
description (str, optional)
name (str, optional)
rules ([GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems], optional)
short_description (str, optional)

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_data module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsData(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsData(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsData(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str, optional)
type (GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType) – Rulesets resource type.

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_data_type module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType(*args, **kwargs)

Bases: ModelSimple

Rulesets resource type.

Parameters:

value (str) – If omitted defaults to “rulesets”. Must be one of [“rulesets”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

arguments ([GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems], optional)
category (str, optional)
checksum (str, optional)
code (str, optional)
created_at (datetime, optional)
created_by (str, optional)
cve (str, optional)
cwe (str, optional)
data (GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData)
description (str, optional)
documentation_url (str, optional)
entity_checked (str, optional)
is_published (bool, optional)
is_testing (bool, optional)
language (str, optional)
last_updated_at (datetime, optional)
last_updated_by (str, optional)
name (str, optional)
regex (str, optional)
severity (str, optional)
short_description (str, optional)
should_use_ai_fix (bool, optional)
tests ([GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems], optional)
tree_sitter_query (str, optional)
type (str, optional)

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_arguments_items module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

description (str, optional)
name (str, optional)

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_data module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData(*args, **kwargs)

Bases: ModelNormal

Parameters:

id (str, optional)
type (GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType) – Rules resource type.

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_data_type module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType(*args, **kwargs)

Bases: ModelSimple

Rules resource type.

Parameters:

value (str) – If omitted defaults to “rules”. Must be one of [“rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_multiple_rulesets_response_data_attributes_rulesets_items_rules_items_tests_items module¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems(arg: None)¶

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems(arg: ModelComposed)

class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

annotation_count (int, optional)
code (str, optional)
filename (str, optional)

datadog_api_client.v2.model.get_multiple_rulesets_response_data_type module¶

class GetMultipleRulesetsResponseDataType(arg: None)¶

class GetMultipleRulesetsResponseDataType(arg: ModelComposed)

class GetMultipleRulesetsResponseDataType(*args, **kwargs)

Bases: ModelSimple

Get multiple rulesets response resource type.

Parameters:

value (str) – If omitted defaults to “get_multiple_rulesets_response”. Must be one of [“get_multiple_rulesets_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_resource_evaluation_filters_response module¶

class GetResourceEvaluationFiltersResponse(arg: None)¶

class GetResourceEvaluationFiltersResponse(arg: ModelComposed)

class GetResourceEvaluationFiltersResponse(*args, **kwargs)

Bases: ModelNormal

The definition of GetResourceEvaluationFiltersResponse object.

Parameters:: data (GetResourceEvaluationFiltersResponseData) – The definition of GetResourceFilterResponseData object.

datadog_api_client.v2.model.get_resource_evaluation_filters_response_data module¶

class GetResourceEvaluationFiltersResponseData(arg: None)¶

class GetResourceEvaluationFiltersResponseData(arg: ModelComposed)

class GetResourceEvaluationFiltersResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of GetResourceFilterResponseData object.

Parameters:

attributes (ResourceFilterAttributes, optional) – Attributes of a resource filter.
id (str, optional) – The data id.
type (ResourceFilterRequestType, optional) – Constant string to identify the request type.

datadog_api_client.v2.model.get_rule_version_history_data module¶

class GetRuleVersionHistoryData(arg: None)¶

class GetRuleVersionHistoryData(arg: ModelComposed)

class GetRuleVersionHistoryData(*args, **kwargs)

Bases: ModelNormal

Data for the rule version history.

Parameters:

attributes (RuleVersionHistory, optional) – Response object containing the version history of a rule.
id (str, optional) – ID of the rule.
type (GetRuleVersionHistoryDataType, optional) – Type of data.

datadog_api_client.v2.model.get_rule_version_history_data_type module¶

class GetRuleVersionHistoryDataType(arg: None)¶

class GetRuleVersionHistoryDataType(arg: ModelComposed)

class GetRuleVersionHistoryDataType(*args, **kwargs)

Bases: ModelSimple

Type of data.

Parameters:

value (str) – If omitted defaults to “GetRuleVersionHistoryResponse”. Must be one of [“GetRuleVersionHistoryResponse”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_rule_version_history_response module¶

class GetRuleVersionHistoryResponse(arg: None)¶

class GetRuleVersionHistoryResponse(arg: ModelComposed)

class GetRuleVersionHistoryResponse(*args, **kwargs)

Bases: ModelNormal

Response for getting the rule version history.

Parameters:: data (GetRuleVersionHistoryData, optional) – Data for the rule version history.

datadog_api_client.v2.model.get_sbom_response module¶

class GetSBOMResponse(arg: None)¶

class GetSBOMResponse(arg: ModelComposed)

class GetSBOMResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting an SBOM.

Parameters:: data (SBOM) – A single SBOM

datadog_api_client.v2.model.get_team_memberships_sort module¶

class GetTeamMembershipsSort(arg: None)¶

class GetTeamMembershipsSort(arg: ModelComposed)

class GetTeamMembershipsSort(*args, **kwargs)

Bases: ModelSimple

Specifies the order of returned team memberships

Parameters:

value (str) – Must be one of [“manager_name”, “-manager_name”, “name”, “-name”, “handle”, “-handle”, “email”, “-email”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.get_workflow_response module¶

class GetWorkflowResponse(arg: None)¶

class GetWorkflowResponse(arg: ModelComposed)

class GetWorkflowResponse(*args, **kwargs)

Bases: ModelNormal

The response object after getting a workflow.

Parameters:: data (WorkflowData, optional) – Data related to the workflow.

datadog_api_client.v2.model.github_webhook_trigger module¶

class GithubWebhookTrigger(arg: None)¶

class GithubWebhookTrigger(arg: ModelComposed)

class GithubWebhookTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to “base_url”/api/v2/workflows/”workflow_id”/webhook?orgId=”org_id”, select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.github_webhook_trigger_wrapper module¶

class GithubWebhookTriggerWrapper(arg: None)¶

class GithubWebhookTriggerWrapper(arg: ModelComposed)

class GithubWebhookTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a GitHub webhook-based trigger.

Parameters:

github_webhook_trigger (GithubWebhookTrigger) – Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to “base_url”/api/v2/workflows/”workflow_id”/webhook?orgId=”org_id”, select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.gitlab_api_key module¶

class GitlabAPIKey(arg: None)¶

class GitlabAPIKey(arg: ModelComposed)

class GitlabAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the GitlabAPIKey object.

Parameters:

api_token (str) – The GitlabAPIKey api_token.
type (GitlabAPIKeyType) – The definition of the GitlabAPIKey object.

datadog_api_client.v2.model.gitlab_api_key_type module¶

class GitlabAPIKeyType(arg: None)¶

class GitlabAPIKeyType(arg: ModelComposed)

class GitlabAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the GitlabAPIKey object.

Parameters:

value (str) – If omitted defaults to “GitlabAPIKey”. Must be one of [“GitlabAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gitlab_api_key_update module¶

class GitlabAPIKeyUpdate(arg: None)¶

class GitlabAPIKeyUpdate(arg: ModelComposed)

class GitlabAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GitlabAPIKey object.

Parameters:

api_token (str, optional) – The GitlabAPIKeyUpdate api_token.
type (GitlabAPIKeyType) – The definition of the GitlabAPIKey object.

datadog_api_client.v2.model.gitlab_credentials module¶

class GitlabCredentials(arg: None)¶

class GitlabCredentials(arg: ModelComposed)

class GitlabCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the GitlabCredentials object.

Parameters:

api_token (str) – The GitlabAPIKey api_token.
type (GitlabAPIKeyType) – The definition of the GitlabAPIKey object.

datadog_api_client.v2.model.gitlab_credentials_update module¶

class GitlabCredentialsUpdate(arg: None)¶

class GitlabCredentialsUpdate(arg: ModelComposed)

class GitlabCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the GitlabCredentialsUpdate object.

Parameters:

api_token (str, optional) – The GitlabAPIKeyUpdate api_token.
type (GitlabAPIKeyType) – The definition of the GitlabAPIKey object.

datadog_api_client.v2.model.gitlab_integration module¶

class GitlabIntegration(arg: None)¶

class GitlabIntegration(arg: ModelComposed)

class GitlabIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the GitlabIntegration object.

Parameters:

credentials (GitlabCredentials) – The definition of the GitlabCredentials object.
type (GitlabIntegrationType) – The definition of the GitlabIntegrationType object.

datadog_api_client.v2.model.gitlab_integration_type module¶

class GitlabIntegrationType(arg: None)¶

class GitlabIntegrationType(arg: ModelComposed)

class GitlabIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the GitlabIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Gitlab”. Must be one of [“Gitlab”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.gitlab_integration_update module¶

class GitlabIntegrationUpdate(arg: None)¶

class GitlabIntegrationUpdate(arg: ModelComposed)

class GitlabIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GitlabIntegrationUpdate object.

Parameters:

credentials (GitlabCredentialsUpdate, optional) – The definition of the GitlabCredentialsUpdate object.
type (GitlabIntegrationType) – The definition of the GitlabIntegrationType object.

datadog_api_client.v2.model.google_meet_configuration_reference module¶

class GoogleMeetConfigurationReference(arg: None)¶

class GoogleMeetConfigurationReference(arg: ModelComposed)

class GoogleMeetConfigurationReference(*args, **kwargs)

Bases: ModelNormal

A reference to a Google Meet Configuration resource.

Parameters:: data (GoogleMeetConfigurationReferenceData, none_type) – The Google Meet configuration relationship data object.

datadog_api_client.v2.model.google_meet_configuration_reference_data module¶

class GoogleMeetConfigurationReferenceData(arg: None)¶

class GoogleMeetConfigurationReferenceData(arg: ModelComposed)

class GoogleMeetConfigurationReferenceData(*args, **kwargs)

Bases: ModelNormal

The Google Meet configuration relationship data object.

Parameters:

id (str) – The unique identifier of the Google Meet configuration.
type (str) – The type of the Google Meet configuration.

datadog_api_client.v2.model.grey_noise_api_key module¶

class GreyNoiseAPIKey(arg: None)¶

class GreyNoiseAPIKey(arg: ModelComposed)

class GreyNoiseAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the GreyNoiseAPIKey object.

Parameters:

api_key (str) – The GreyNoiseAPIKey api_key.
type (GreyNoiseAPIKeyType) – The definition of the GreyNoiseAPIKey object.

datadog_api_client.v2.model.grey_noise_api_key_type module¶

class GreyNoiseAPIKeyType(arg: None)¶

class GreyNoiseAPIKeyType(arg: ModelComposed)

class GreyNoiseAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the GreyNoiseAPIKey object.

Parameters:

value (str) – If omitted defaults to “GreyNoiseAPIKey”. Must be one of [“GreyNoiseAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.grey_noise_api_key_update module¶

class GreyNoiseAPIKeyUpdate(arg: None)¶

class GreyNoiseAPIKeyUpdate(arg: ModelComposed)

class GreyNoiseAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GreyNoiseAPIKey object.

Parameters:

api_key (str, optional) – The GreyNoiseAPIKeyUpdate api_key.
type (GreyNoiseAPIKeyType) – The definition of the GreyNoiseAPIKey object.

datadog_api_client.v2.model.grey_noise_credentials module¶

class GreyNoiseCredentials(arg: None)¶

class GreyNoiseCredentials(arg: ModelComposed)

class GreyNoiseCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the GreyNoiseCredentials object.

Parameters:

api_key (str) – The GreyNoiseAPIKey api_key.
type (GreyNoiseAPIKeyType) – The definition of the GreyNoiseAPIKey object.

datadog_api_client.v2.model.grey_noise_credentials_update module¶

class GreyNoiseCredentialsUpdate(arg: None)¶

class GreyNoiseCredentialsUpdate(arg: ModelComposed)

class GreyNoiseCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the GreyNoiseCredentialsUpdate object.

Parameters:

api_key (str, optional) – The GreyNoiseAPIKeyUpdate api_key.
type (GreyNoiseAPIKeyType) – The definition of the GreyNoiseAPIKey object.

datadog_api_client.v2.model.grey_noise_integration module¶

class GreyNoiseIntegration(arg: None)¶

class GreyNoiseIntegration(arg: ModelComposed)

class GreyNoiseIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the GreyNoiseIntegration object.

Parameters:

credentials (GreyNoiseCredentials) – The definition of the GreyNoiseCredentials object.
type (GreyNoiseIntegrationType) – The definition of the GreyNoiseIntegrationType object.

datadog_api_client.v2.model.grey_noise_integration_type module¶

class GreyNoiseIntegrationType(arg: None)¶

class GreyNoiseIntegrationType(arg: ModelComposed)

class GreyNoiseIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the GreyNoiseIntegrationType object.

Parameters:

value (str) – If omitted defaults to “GreyNoise”. Must be one of [“GreyNoise”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.grey_noise_integration_update module¶

class GreyNoiseIntegrationUpdate(arg: None)¶

class GreyNoiseIntegrationUpdate(arg: ModelComposed)

class GreyNoiseIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the GreyNoiseIntegrationUpdate object.

Parameters:

credentials (GreyNoiseCredentialsUpdate, optional) – The definition of the GreyNoiseCredentialsUpdate object.
type (GreyNoiseIntegrationType) – The definition of the GreyNoiseIntegrationType object.

datadog_api_client.v2.model.group_scalar_column module¶

class GroupScalarColumn(arg: None)¶

class GroupScalarColumn(arg: ModelComposed)

class GroupScalarColumn(*args, **kwargs)

Bases: ModelNormal

A column containing the tag keys and values in a group.

Parameters:

name (str, optional) – The name of the tag key or group.
type (ScalarColumnTypeGroup, optional) – The type of column present for groups.
values ([[str]], optional) – The array of tag values for each group found for the results of the formulas or queries.

datadog_api_client.v2.model.group_tags module¶

class GroupTags(arg: None)¶

class GroupTags(arg: ModelComposed)

class GroupTags(*args, **kwargs)

Bases: ModelSimple

List of tags that apply to a single response value.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.hourly_usage module¶

class HourlyUsage(arg: None)¶

class HourlyUsage(arg: ModelComposed)

class HourlyUsage(*args, **kwargs)

Bases: ModelNormal

Hourly usage for a product family for an org.

Parameters:

attributes (HourlyUsageAttributes, optional) – Attributes of hourly usage for a product family for an org for a time period.
id (str, optional) – Unique ID of the response.
type (UsageTimeSeriesType, optional) – Type of usage data.

datadog_api_client.v2.model.hourly_usage_attributes module¶

class HourlyUsageAttributes(arg: None)¶

class HourlyUsageAttributes(arg: ModelComposed)

class HourlyUsageAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of hourly usage for a product family for an org for a time period.

Parameters:

account_name (str, optional) – The account name.
account_public_id (str, optional) – The account public ID.
measurements ([HourlyUsageMeasurement], optional) – List of the measured usage values for the product family for the org for the time period.
org_name (str, optional) – The organization name.
product_family (str, optional) – The product for which usage is being reported.
public_id (str, optional) – The organization public ID.
region (str, optional) – The region of the Datadog instance that the organization belongs to.
timestamp (datetime, optional) – Datetime in ISO-8601 format, UTC. The hour for the usage.

datadog_api_client.v2.model.hourly_usage_measurement module¶

class HourlyUsageMeasurement(arg: None)¶

class HourlyUsageMeasurement(arg: ModelComposed)

class HourlyUsageMeasurement(*args, **kwargs)

Bases: ModelNormal

Usage amount for a given usage type.

Parameters:

usage_type (str, optional) – Type of usage.
value (int, none_type, optional) – Contains the number measured for the given usage_type during the hour.

datadog_api_client.v2.model.hourly_usage_metadata module¶

class HourlyUsageMetadata(arg: None)¶

class HourlyUsageMetadata(arg: ModelComposed)

class HourlyUsageMetadata(*args, **kwargs)

Bases: ModelNormal

The object containing document metadata.

Parameters:: pagination (HourlyUsagePagination, optional) – The metadata for the current pagination.

datadog_api_client.v2.model.hourly_usage_pagination module¶

class HourlyUsagePagination(arg: None)¶

class HourlyUsagePagination(arg: ModelComposed)

class HourlyUsagePagination(*args, **kwargs)

Bases: ModelNormal

The metadata for the current pagination.

Parameters:: next_record_id (str, none_type, optional) – The cursor to get the next results (if any). To make the next request, use the same parameters and add next_record_id.

datadog_api_client.v2.model.hourly_usage_response module¶

class HourlyUsageResponse(arg: None)¶

class HourlyUsageResponse(arg: ModelComposed)

class HourlyUsageResponse(*args, **kwargs)

Bases: ModelNormal

Hourly usage response.

Parameters:

data ([HourlyUsage], optional) – Response containing hourly usage.
meta (HourlyUsageMetadata, optional) – The object containing document metadata.

datadog_api_client.v2.model.hourly_usage_type module¶

class HourlyUsageType(arg: None)¶

class HourlyUsageType(arg: ModelComposed)

class HourlyUsageType(*args, **kwargs)

Bases: ModelSimple

Usage type that is being measured.

Parameters:

value (str) – Must be one of [“app_sec_host_count”, “observability_pipelines_bytes_processed”, “lambda_traced_invocations_count”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.http_body module¶

class HTTPBody(arg: None)¶

class HTTPBody(arg: ModelComposed)

class HTTPBody(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPBody object.

Parameters:

content (str, optional) – Serialized body content
content_type (str, optional) – Content type of the body

datadog_api_client.v2.model.http_credentials module¶

class HTTPCredentials(arg: None)¶

class HTTPCredentials(arg: ModelComposed)

class HTTPCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of HTTPCredentials object.

Parameters:

body (HTTPBody, optional) – The definition of HTTPBody object.
headers ([HTTPHeader], optional) – The HTTPTokenAuth headers.
tokens ([HTTPToken], optional) – The HTTPTokenAuth tokens.
type (HTTPTokenAuthType) – The definition of HTTPTokenAuthType object.
url_parameters ([UrlParam], optional) – The HTTPTokenAuth url_parameters.

datadog_api_client.v2.model.http_credentials_update module¶

class HTTPCredentialsUpdate(arg: None)¶

class HTTPCredentialsUpdate(arg: ModelComposed)

class HTTPCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of HTTPCredentialsUpdate object.

Parameters:

body (HTTPBody, optional) – The definition of HTTPBody object.
headers ([HTTPHeaderUpdate], optional) – The HTTPTokenAuthUpdate headers.
tokens ([HTTPTokenUpdate], optional) – The HTTPTokenAuthUpdate tokens.
type (HTTPTokenAuthType) – The definition of HTTPTokenAuthType object.
url_parameters ([UrlParamUpdate], optional) – The HTTPTokenAuthUpdate url_parameters.

datadog_api_client.v2.model.http_header module¶

class HTTPHeader(arg: None)¶

class HTTPHeader(arg: ModelComposed)

class HTTPHeader(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPHeader object.

Parameters:

name (str) – The HTTPHeader name.
value (str) – The HTTPHeader value.

datadog_api_client.v2.model.http_header_update module¶

class HTTPHeaderUpdate(arg: None)¶

class HTTPHeaderUpdate(arg: ModelComposed)

class HTTPHeaderUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPHeaderUpdate object.

Parameters:

deleted (bool, optional) – Should the header be deleted.
name (str) – The HTTPHeaderUpdate name.
value (str, optional) – The HTTPHeaderUpdate value.

datadog_api_client.v2.model.http_integration module¶

class HTTPIntegration(arg: None)¶

class HTTPIntegration(arg: ModelComposed)

class HTTPIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPIntegration object.

Parameters:

base_url (str) – Base HTTP url for the integration
credentials (HTTPCredentials) – The definition of HTTPCredentials object.
type (HTTPIntegrationType) – The definition of HTTPIntegrationType object.

datadog_api_client.v2.model.http_integration_type module¶

class HTTPIntegrationType(arg: None)¶

class HTTPIntegrationType(arg: ModelComposed)

class HTTPIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of HTTPIntegrationType object.

Parameters:

value (str) – If omitted defaults to “HTTP”. Must be one of [“HTTP”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.http_integration_update module¶

class HTTPIntegrationUpdate(arg: None)¶

class HTTPIntegrationUpdate(arg: ModelComposed)

class HTTPIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPIntegrationUpdate object.

Parameters:

base_url (str, optional) – Base HTTP url for the integration
credentials (HTTPCredentialsUpdate, optional) – The definition of HTTPCredentialsUpdate object.
type (HTTPIntegrationType) – The definition of HTTPIntegrationType object.

datadog_api_client.v2.model.http_log module¶

class HTTPLog(arg: None)¶

class HTTPLog(arg: ModelComposed)

class HTTPLog(*args, **kwargs)

Bases: ModelSimple

Structured log message.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.http_log_error module¶

class HTTPLogError(arg: None)¶

class HTTPLogError(arg: ModelComposed)

class HTTPLogError(*args, **kwargs)

Bases: ModelNormal

List of errors.

Parameters:

detail (str, optional) – Error message.
status (str, optional) – Error code.
title (str, optional) – Error title.

datadog_api_client.v2.model.http_log_errors module¶

class HTTPLogErrors(arg: None)¶

class HTTPLogErrors(arg: ModelComposed)

class HTTPLogErrors(*args, **kwargs)

Bases: ModelNormal

Invalid query performed.

Parameters:: errors ([HTTPLogError], optional) – Structured errors.

datadog_api_client.v2.model.http_log_item module¶

class HTTPLogItem(arg: None)¶

class HTTPLogItem(arg: ModelComposed)

class HTTPLogItem(*args, **kwargs)

Bases: ModelNormal

Logs that are sent over HTTP.

Parameters:

ddsource (str, optional) – The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. See reserved attributes.
ddtags (str, optional) – Tags associated with your logs.
hostname (str, optional) – The name of the originating host of the log.
message (str) – The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.
service (str, optional) –
The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. See reserved attributes.

datadog_api_client.v2.model.http_token module¶

class HTTPToken(arg: None)¶

class HTTPToken(arg: ModelComposed)

class HTTPToken(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPToken object.

Parameters:

name (str) – The HTTPToken name.
type (TokenType) – The definition of TokenType object.
value (str) – The HTTPToken value.

datadog_api_client.v2.model.http_token_auth module¶

class HTTPTokenAuth(arg: None)¶

class HTTPTokenAuth(arg: ModelComposed)

class HTTPTokenAuth(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPTokenAuth object.

Parameters:

body (HTTPBody, optional) – The definition of HTTPBody object.
headers ([HTTPHeader], optional) – The HTTPTokenAuth headers.
tokens ([HTTPToken], optional) – The HTTPTokenAuth tokens.
type (HTTPTokenAuthType) – The definition of HTTPTokenAuthType object.
url_parameters ([UrlParam], optional) – The HTTPTokenAuth url_parameters.

datadog_api_client.v2.model.http_token_auth_type module¶

class HTTPTokenAuthType(arg: None)¶

class HTTPTokenAuthType(arg: ModelComposed)

class HTTPTokenAuthType(*args, **kwargs)

Bases: ModelSimple

The definition of HTTPTokenAuthType object.

Parameters:

value (str) – If omitted defaults to “HTTPTokenAuth”. Must be one of [“HTTPTokenAuth”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.http_token_auth_update module¶

class HTTPTokenAuthUpdate(arg: None)¶

class HTTPTokenAuthUpdate(arg: ModelComposed)

class HTTPTokenAuthUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPTokenAuthUpdate object.

Parameters:

body (HTTPBody, optional) – The definition of HTTPBody object.
headers ([HTTPHeaderUpdate], optional) – The HTTPTokenAuthUpdate headers.
tokens ([HTTPTokenUpdate], optional) – The HTTPTokenAuthUpdate tokens.
type (HTTPTokenAuthType) – The definition of HTTPTokenAuthType object.
url_parameters ([UrlParamUpdate], optional) – The HTTPTokenAuthUpdate url_parameters.

datadog_api_client.v2.model.http_token_update module¶

class HTTPTokenUpdate(arg: None)¶

class HTTPTokenUpdate(arg: ModelComposed)

class HTTPTokenUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of HTTPTokenUpdate object.

Parameters:

deleted (bool, optional) – Should the header be deleted.
name (str) – The HTTPToken name.
type (TokenType) – The definition of TokenType object.
value (str) – The HTTPToken value.

datadog_api_client.v2.model.httpcd_gates_bad_request_response module¶

class HTTPCDGatesBadRequestResponse(arg: None)¶

class HTTPCDGatesBadRequestResponse(arg: ModelComposed)

class HTTPCDGatesBadRequestResponse(*args, **kwargs)

Bases: ModelNormal

Bad request.

Parameters:: errors ([HTTPCIAppError], optional) – Structured errors.

datadog_api_client.v2.model.httpcd_gates_not_found_response module¶

class HTTPCDGatesNotFoundResponse(arg: None)¶

class HTTPCDGatesNotFoundResponse(arg: ModelComposed)

class HTTPCDGatesNotFoundResponse(*args, **kwargs)

Bases: ModelNormal

Deployment gate not found.

Parameters:: errors ([HTTPCIAppError], optional) – Structured errors.

datadog_api_client.v2.model.httpcd_rules_not_found_response module¶

class HTTPCDRulesNotFoundResponse(arg: None)¶

class HTTPCDRulesNotFoundResponse(arg: ModelComposed)

class HTTPCDRulesNotFoundResponse(*args, **kwargs)

Bases: ModelNormal

Deployment rule not found.

Parameters:: errors ([HTTPCIAppError], optional) – Structured errors.

datadog_api_client.v2.model.httpci_app_error module¶

class HTTPCIAppError(arg: None)¶

class HTTPCIAppError(arg: ModelComposed)

class HTTPCIAppError(*args, **kwargs)

Bases: ModelNormal

List of errors.

Parameters:

detail (str, optional) – Error message.
status (str, optional) – Error code.
title (str, optional) – Error title.

datadog_api_client.v2.model.httpci_app_errors module¶

class HTTPCIAppErrors(arg: None)¶

class HTTPCIAppErrors(arg: ModelComposed)

class HTTPCIAppErrors(*args, **kwargs)

Bases: ModelNormal

Errors occurred.

Parameters:: errors ([HTTPCIAppError], optional) – Structured errors.

datadog_api_client.v2.model.idp_metadata_form_data module¶

class IdPMetadataFormData(arg: None)¶

class IdPMetadataFormData(arg: ModelComposed)

class IdPMetadataFormData(*args, **kwargs)

Bases: ModelNormal

The form data submitted to upload IdP metadata

Parameters:: idp_file (file_type, optional) – The IdP metadata XML file

datadog_api_client.v2.model.incident_attachment_attachment_type module¶

class IncidentAttachmentAttachmentType(arg: None)¶

class IncidentAttachmentAttachmentType(arg: ModelComposed)

class IncidentAttachmentAttachmentType(*args, **kwargs)

Bases: ModelSimple

The type of the incident attachment attributes.

Parameters:

value (str) – Must be one of [“link”, “postmortem”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_attachment_attributes module¶

class IncidentAttachmentAttributes(arg: None)¶

class IncidentAttachmentAttributes(arg: ModelComposed)

class IncidentAttachmentAttributes(*args, **kwargs)

Bases: ModelComposed

The attributes object for an attachment.

Parameters:

attachment (IncidentAttachmentsPostmortemAttributesAttachmentObject) – The postmortem attachment.
attachment_type (IncidentAttachmentPostmortemAttachmentType) – The type of postmortem attachment attributes.
modified (datetime, optional) – Timestamp when the incident attachment link was last modified.

datadog_api_client.v2.model.incident_attachment_data module¶

class IncidentAttachmentData(arg: None)¶

class IncidentAttachmentData(arg: ModelComposed)

class IncidentAttachmentData(*args, **kwargs)

Bases: ModelNormal

A single incident attachment.

Parameters:

attributes (IncidentAttachmentAttributes) – The attributes object for an attachment.
id (str) – A unique identifier that represents the incident attachment.
relationships (IncidentAttachmentRelationships) – The incident attachment’s relationships.
type (IncidentAttachmentType) – The incident attachment resource type.

datadog_api_client.v2.model.incident_attachment_link_attachment_type module¶

class IncidentAttachmentLinkAttachmentType(arg: None)¶

class IncidentAttachmentLinkAttachmentType(arg: ModelComposed)

class IncidentAttachmentLinkAttachmentType(*args, **kwargs)

Bases: ModelSimple

The type of link attachment attributes.

Parameters:

value (str) – If omitted defaults to “link”. Must be one of [“link”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_attachment_link_attributes module¶

class IncidentAttachmentLinkAttributes(arg: None)¶

class IncidentAttachmentLinkAttributes(arg: ModelComposed)

class IncidentAttachmentLinkAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes object for a link attachment.

Parameters:

attachment (IncidentAttachmentLinkAttributesAttachmentObject) – The link attachment.
attachment_type (IncidentAttachmentLinkAttachmentType) – The type of link attachment attributes.
modified (datetime, optional) – Timestamp when the incident attachment link was last modified.

datadog_api_client.v2.model.incident_attachment_link_attributes_attachment_object module¶

class IncidentAttachmentLinkAttributesAttachmentObject(arg: None)¶

class IncidentAttachmentLinkAttributesAttachmentObject(arg: ModelComposed)

class IncidentAttachmentLinkAttributesAttachmentObject(*args, **kwargs)

Bases: ModelNormal

The link attachment.

Parameters:

document_url (str) – The URL of this link attachment.
title (str) – The title of this link attachment.

datadog_api_client.v2.model.incident_attachment_postmortem_attachment_type module¶

class IncidentAttachmentPostmortemAttachmentType(arg: None)¶

class IncidentAttachmentPostmortemAttachmentType(arg: ModelComposed)

class IncidentAttachmentPostmortemAttachmentType(*args, **kwargs)

Bases: ModelSimple

The type of postmortem attachment attributes.

Parameters:

value (str) – If omitted defaults to “postmortem”. Must be one of [“postmortem”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_attachment_postmortem_attributes module¶

class IncidentAttachmentPostmortemAttributes(arg: None)¶

class IncidentAttachmentPostmortemAttributes(arg: ModelComposed)

class IncidentAttachmentPostmortemAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes object for a postmortem attachment.

Parameters:

attachment (IncidentAttachmentsPostmortemAttributesAttachmentObject) – The postmortem attachment.
attachment_type (IncidentAttachmentPostmortemAttachmentType) – The type of postmortem attachment attributes.

datadog_api_client.v2.model.incident_attachment_related_object module¶

class IncidentAttachmentRelatedObject(arg: None)¶

class IncidentAttachmentRelatedObject(arg: ModelComposed)

class IncidentAttachmentRelatedObject(*args, **kwargs)

Bases: ModelSimple

The object related to an incident attachment.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_attachment_relationships module¶

class IncidentAttachmentRelationships(arg: None)¶

class IncidentAttachmentRelationships(arg: ModelComposed)

class IncidentAttachmentRelationships(*args, **kwargs)

Bases: ModelNormal

The incident attachment’s relationships.

Parameters:: last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_attachment_type module¶

class IncidentAttachmentType(arg: None)¶

class IncidentAttachmentType(arg: ModelComposed)

class IncidentAttachmentType(*args, **kwargs)

Bases: ModelSimple

The incident attachment resource type.

Parameters:

value (str) – If omitted defaults to “incident_attachments”. Must be one of [“incident_attachments”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_attachment_update_attributes module¶

class IncidentAttachmentUpdateAttributes(arg: None)¶

class IncidentAttachmentUpdateAttributes(arg: ModelComposed)

class IncidentAttachmentUpdateAttributes(*args, **kwargs)

Bases: ModelComposed

Incident attachment attributes.

Parameters:

attachment (IncidentAttachmentsPostmortemAttributesAttachmentObject) – The postmortem attachment.
attachment_type (IncidentAttachmentPostmortemAttachmentType) – The type of postmortem attachment attributes.
modified (datetime, optional) – Timestamp when the incident attachment link was last modified.

datadog_api_client.v2.model.incident_attachment_update_data module¶

class IncidentAttachmentUpdateData(arg: None)¶

class IncidentAttachmentUpdateData(arg: ModelComposed)

class IncidentAttachmentUpdateData(*args, **kwargs)

Bases: ModelNormal

A single incident attachment.

Parameters:

attributes (IncidentAttachmentUpdateAttributes, optional) – Incident attachment attributes.
id (str, optional) – A unique identifier that represents the incident attachment.
type (IncidentAttachmentType) – The incident attachment resource type.

datadog_api_client.v2.model.incident_attachment_update_request module¶

class IncidentAttachmentUpdateRequest(arg: None)¶

class IncidentAttachmentUpdateRequest(arg: ModelComposed)

class IncidentAttachmentUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The update request for an incident’s attachments.

Parameters:: data ([IncidentAttachmentUpdateData]) – An array of incident attachments. An attachment object without an “id” key indicates that you want to create that attachment. An attachment object without an “attributes” key indicates that you want to delete that attachment. An attachment object with both the “id” key and a populated “attributes” object indicates that you want to update that attachment.

datadog_api_client.v2.model.incident_attachment_update_response module¶

class IncidentAttachmentUpdateResponse(arg: None)¶

class IncidentAttachmentUpdateResponse(arg: ModelComposed)

class IncidentAttachmentUpdateResponse(*args, **kwargs)

Bases: ModelNormal

The response object containing the created or updated incident attachments.

Parameters:

data ([IncidentAttachmentData]) – An array of incident attachments. Only the attachments that were created or updated by the request are returned.
included ([IncidentAttachmentsResponseIncludedItem], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_attachments_postmortem_attributes_attachment_object module¶

class IncidentAttachmentsPostmortemAttributesAttachmentObject(arg: None)¶

class IncidentAttachmentsPostmortemAttributesAttachmentObject(arg: ModelComposed)

class IncidentAttachmentsPostmortemAttributesAttachmentObject(*args, **kwargs)

Bases: ModelNormal

The postmortem attachment.

Parameters:

document_url (str) – The URL of this notebook attachment.
title (str) – The title of this postmortem attachment.

datadog_api_client.v2.model.incident_attachments_response module¶

class IncidentAttachmentsResponse(arg: None)¶

class IncidentAttachmentsResponse(arg: ModelComposed)

class IncidentAttachmentsResponse(*args, **kwargs)

Bases: ModelNormal

The response object containing an incident’s attachments.

Parameters:

data ([IncidentAttachmentData]) – An array of incident attachments.
included ([IncidentAttachmentsResponseIncludedItem], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_attachments_response_included_item module¶

class IncidentAttachmentsResponseIncludedItem(arg: None)¶

class IncidentAttachmentsResponseIncludedItem(arg: ModelComposed)

class IncidentAttachmentsResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an attachment that is included in the response.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_create_attributes module¶

class IncidentCreateAttributes(arg: None)¶

class IncidentCreateAttributes(arg: ModelComposed)

class IncidentCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident’s attributes for a create request.

Parameters:

customer_impact_scope (str, optional) – Required if customer_impacted:"true". A summary of the impact customers experienced during the incident.
customer_impacted (bool) – A flag indicating whether the incident caused customer impact.
fields ({str: (IncidentFieldAttributes,)}, optional) – A condensed view of the user-defined fields for which to create initial selections.
incident_type_uuid (str, optional) – A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.
initial_cells ([IncidentTimelineCellCreateAttributes], optional) – An array of initial timeline cells to be placed at the beginning of the incident timeline.
is_test (bool, optional) – A flag indicating whether the incident is a test incident.
notification_handles ([IncidentNotificationHandle], optional) – Notification handles that will be notified of the incident at creation.
title (str) – The title of the incident, which summarizes what happened.

datadog_api_client.v2.model.incident_create_data module¶

class IncidentCreateData(arg: None)¶

class IncidentCreateData(arg: ModelComposed)

class IncidentCreateData(*args, **kwargs)

Bases: ModelNormal

Incident data for a create request.

Parameters:

attributes (IncidentCreateAttributes) – The incident’s attributes for a create request.
relationships (IncidentCreateRelationships, optional) – The relationships the incident will have with other resources once created.
type (IncidentType) – Incident resource type.

datadog_api_client.v2.model.incident_create_relationships module¶

class IncidentCreateRelationships(arg: None)¶

class IncidentCreateRelationships(arg: ModelComposed)

class IncidentCreateRelationships(*args, **kwargs)

Bases: ModelNormal

The relationships the incident will have with other resources once created.

Parameters:: commander_user (NullableRelationshipToUser, none_type) – Relationship to user.

datadog_api_client.v2.model.incident_create_request module¶

class IncidentCreateRequest(arg: None)¶

class IncidentCreateRequest(arg: ModelComposed)

class IncidentCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident.

Parameters:: data (IncidentCreateData) – Incident data for a create request.

datadog_api_client.v2.model.incident_field_attributes module¶

class IncidentFieldAttributes(arg: None)¶

class IncidentFieldAttributes(arg: ModelComposed)

class IncidentFieldAttributes(*args, **kwargs)

Bases: ModelComposed

Dynamic fields for which selections can be made, with field names as keys.

Parameters:

type (IncidentFieldAttributesSingleValueType, optional) – Type of the single value field definitions.
value (str, none_type, optional) – The single value selected for this field.

datadog_api_client.v2.model.incident_field_attributes_multiple_value module¶

class IncidentFieldAttributesMultipleValue(arg: None)¶

class IncidentFieldAttributesMultipleValue(arg: ModelComposed)

class IncidentFieldAttributesMultipleValue(*args, **kwargs)

Bases: ModelNormal

A field with potentially multiple values selected.

Parameters:

type (IncidentFieldAttributesValueType, optional) – Type of the multiple value field definitions.
value ([str], none_type, optional) – The multiple values selected for this field.

datadog_api_client.v2.model.incident_field_attributes_single_value module¶

class IncidentFieldAttributesSingleValue(arg: None)¶

class IncidentFieldAttributesSingleValue(arg: ModelComposed)

class IncidentFieldAttributesSingleValue(*args, **kwargs)

Bases: ModelNormal

A field with a single value selected.

Parameters:

type (IncidentFieldAttributesSingleValueType, optional) – Type of the single value field definitions.
value (str, none_type, optional) – The single value selected for this field.

datadog_api_client.v2.model.incident_field_attributes_single_value_type module¶

class IncidentFieldAttributesSingleValueType(arg: None)¶

class IncidentFieldAttributesSingleValueType(arg: ModelComposed)

class IncidentFieldAttributesSingleValueType(*args, **kwargs)

Bases: ModelSimple

Type of the single value field definitions.

Parameters:

value (str) – If omitted defaults to “dropdown”. Must be one of [“dropdown”, “textbox”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_field_attributes_value_type module¶

class IncidentFieldAttributesValueType(arg: None)¶

class IncidentFieldAttributesValueType(arg: ModelComposed)

class IncidentFieldAttributesValueType(*args, **kwargs)

Bases: ModelSimple

Type of the multiple value field definitions.

Parameters:

value (str) – If omitted defaults to “multiselect”. Must be one of [“multiselect”, “textarray”, “metrictag”, “autocomplete”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_impact_attributes module¶

class IncidentImpactAttributes(arg: None)¶

class IncidentImpactAttributes(arg: ModelComposed)

class IncidentImpactAttributes(*args, **kwargs)

Bases: ModelNormal

The incident impact’s attributes.

Parameters:

created (datetime, optional) – Timestamp when the impact was created.
description (str) – Description of the impact.
end_at (datetime, none_type, optional) – Timestamp when the impact ended.
fields (IncidentImpactFieldsObject, none_type, optional) – An object mapping impact field names to field values.
impact_type (str, optional) – The type of impact.
modified (datetime, optional) – Timestamp when the impact was last modified.
start_at (datetime) – Timestamp representing when the impact started.

datadog_api_client.v2.model.incident_impact_create_attributes module¶

class IncidentImpactCreateAttributes(arg: None)¶

class IncidentImpactCreateAttributes(arg: ModelComposed)

class IncidentImpactCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident impact’s attributes for a create request.

Parameters:

description (str) – Description of the impact.
end_at (datetime, none_type, optional) – Timestamp when the impact ended.
fields (IncidentImpactFieldsObject, none_type, optional) – An object mapping impact field names to field values.
start_at (datetime) – Timestamp when the impact started.

datadog_api_client.v2.model.incident_impact_create_data module¶

class IncidentImpactCreateData(arg: None)¶

class IncidentImpactCreateData(arg: ModelComposed)

class IncidentImpactCreateData(*args, **kwargs)

Bases: ModelNormal

Incident impact data for a create request.

Parameters:

attributes (IncidentImpactCreateAttributes) – The incident impact’s attributes for a create request.
type (IncidentImpactType) – Incident impact resource type.

datadog_api_client.v2.model.incident_impact_create_request module¶

class IncidentImpactCreateRequest(arg: None)¶

class IncidentImpactCreateRequest(arg: ModelComposed)

class IncidentImpactCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident impact.

Parameters:: data (IncidentImpactCreateData) – Incident impact data for a create request.

datadog_api_client.v2.model.incident_impact_fields_object module¶

class IncidentImpactFieldsObject(arg: None)¶

class IncidentImpactFieldsObject(arg: ModelComposed)

class IncidentImpactFieldsObject(*args, **kwargs)

Bases: ModelNormal

An object mapping impact field names to field values.

datadog_api_client.v2.model.incident_impact_related_object module¶

class IncidentImpactRelatedObject(arg: None)¶

class IncidentImpactRelatedObject(arg: ModelComposed)

class IncidentImpactRelatedObject(*args, **kwargs)

Bases: ModelSimple

A reference to a resource related to an incident impact.

Parameters:

value (str) – Must be one of [“incident”, “created_by_user”, “last_modified_by_user”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_impact_relationships module¶

class IncidentImpactRelationships(arg: None)¶

class IncidentImpactRelationships(arg: ModelComposed)

class IncidentImpactRelationships(*args, **kwargs)

Bases: ModelNormal

The incident impact’s resource relationships.

Parameters:

created_by_user (RelationshipToUser, optional) – Relationship to user.
incident (RelationshipToIncident, optional) – Relationship to incident.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_impact_response module¶

class IncidentImpactResponse(arg: None)¶

class IncidentImpactResponse(arg: ModelComposed)

class IncidentImpactResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident impact.

Parameters:

data (IncidentImpactResponseData) – Incident impact data from a response.
included ([IncidentUserData], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_impact_response_data module¶

class IncidentImpactResponseData(arg: None)¶

class IncidentImpactResponseData(arg: ModelComposed)

class IncidentImpactResponseData(*args, **kwargs)

Bases: ModelNormal

Incident impact data from a response.

Parameters:

attributes (IncidentImpactAttributes, optional) – The incident impact’s attributes.
id (str) – The incident impact’s ID.
relationships (IncidentImpactRelationships, optional) – The incident impact’s resource relationships.
type (IncidentImpactType) – Incident impact resource type.

datadog_api_client.v2.model.incident_impact_type module¶

class IncidentImpactType(arg: None)¶

class IncidentImpactType(arg: ModelComposed)

class IncidentImpactType(*args, **kwargs)

Bases: ModelSimple

Incident impact resource type.

Parameters:

value (str) – If omitted defaults to “incident_impacts”. Must be one of [“incident_impacts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_impacts_response module¶

class IncidentImpactsResponse(arg: None)¶

class IncidentImpactsResponse(arg: ModelComposed)

class IncidentImpactsResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident impacts.

Parameters:

data ([IncidentImpactResponseData]) – An array of incident impacts.
included ([IncidentUserData], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_impacts_type module¶

class IncidentImpactsType(arg: None)¶

class IncidentImpactsType(arg: ModelComposed)

class IncidentImpactsType(*args, **kwargs)

Bases: ModelSimple

The incident impacts type.

Parameters:

value (str) – If omitted defaults to “incident_impacts”. Must be one of [“incident_impacts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_integration_metadata_attributes module¶

class IncidentIntegrationMetadataAttributes(arg: None)¶

class IncidentIntegrationMetadataAttributes(arg: ModelComposed)

class IncidentIntegrationMetadataAttributes(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata’s attributes for a create request.

Parameters:

created (datetime, optional) – Timestamp when the incident todo was created.
incident_id (str, optional) – UUID of the incident this integration metadata is connected to.
integration_type (int) – A number indicating the type of integration this metadata is for. 1 indicates Slack; 8 indicates Jira.
metadata (IncidentIntegrationMetadataMetadata) – Incident integration metadata’s metadata attribute.
modified (datetime, optional) – Timestamp when the incident todo was last modified.
status (int, optional) – A number indicating the status of this integration metadata. 0 indicates unknown; 1 indicates pending; 2 indicates complete; 3 indicates manually created; 4 indicates manually updated; 5 indicates failed.

datadog_api_client.v2.model.incident_integration_metadata_create_data module¶

class IncidentIntegrationMetadataCreateData(arg: None)¶

class IncidentIntegrationMetadataCreateData(arg: ModelComposed)

class IncidentIntegrationMetadataCreateData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata data for a create request.

Parameters:

attributes (IncidentIntegrationMetadataAttributes) – Incident integration metadata’s attributes for a create request.
type (IncidentIntegrationMetadataType) – Integration metadata resource type.

datadog_api_client.v2.model.incident_integration_metadata_create_request module¶

class IncidentIntegrationMetadataCreateRequest(arg: None)¶

class IncidentIntegrationMetadataCreateRequest(arg: ModelComposed)

class IncidentIntegrationMetadataCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident integration metadata.

Parameters:: data (IncidentIntegrationMetadataCreateData) – Incident integration metadata data for a create request.

datadog_api_client.v2.model.incident_integration_metadata_list_response module¶

class IncidentIntegrationMetadataListResponse(arg: None)¶

class IncidentIntegrationMetadataListResponse(arg: ModelComposed)

class IncidentIntegrationMetadataListResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident integration metadata.

Parameters:

data ([IncidentIntegrationMetadataResponseData]) – An array of incident integration metadata.
included ([IncidentIntegrationMetadataResponseIncludedItem], optional) – Included related resources that the user requested.
meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

datadog_api_client.v2.model.incident_integration_metadata_metadata module¶

class IncidentIntegrationMetadataMetadata(arg: None)¶

class IncidentIntegrationMetadataMetadata(arg: ModelComposed)

class IncidentIntegrationMetadataMetadata(*args, **kwargs)

Bases: ModelComposed

Incident integration metadata’s metadata attribute.

Parameters:

channels ([SlackIntegrationMetadataChannelItem]) – Array of Slack channels in this integration metadata.
issues ([JiraIntegrationMetadataIssuesItem]) – Array of Jira issues in this integration metadata.
teams ([MSTeamsIntegrationMetadataTeamsItem]) – Array of Microsoft Teams in this integration metadata.

datadog_api_client.v2.model.incident_integration_metadata_patch_data module¶

class IncidentIntegrationMetadataPatchData(arg: None)¶

class IncidentIntegrationMetadataPatchData(arg: ModelComposed)

class IncidentIntegrationMetadataPatchData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata data for a patch request.

Parameters:

attributes (IncidentIntegrationMetadataAttributes) – Incident integration metadata’s attributes for a create request.
type (IncidentIntegrationMetadataType) – Integration metadata resource type.

datadog_api_client.v2.model.incident_integration_metadata_patch_request module¶

class IncidentIntegrationMetadataPatchRequest(arg: None)¶

class IncidentIntegrationMetadataPatchRequest(arg: ModelComposed)

class IncidentIntegrationMetadataPatchRequest(*args, **kwargs)

Bases: ModelNormal

Patch request for an incident integration metadata.

Parameters:: data (IncidentIntegrationMetadataPatchData) – Incident integration metadata data for a patch request.

datadog_api_client.v2.model.incident_integration_metadata_response module¶

class IncidentIntegrationMetadataResponse(arg: None)¶

class IncidentIntegrationMetadataResponse(arg: ModelComposed)

class IncidentIntegrationMetadataResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident integration metadata.

Parameters:

data (IncidentIntegrationMetadataResponseData) – Incident integration metadata from a response.
included ([IncidentIntegrationMetadataResponseIncludedItem], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_integration_metadata_response_data module¶

class IncidentIntegrationMetadataResponseData(arg: None)¶

class IncidentIntegrationMetadataResponseData(arg: ModelComposed)

class IncidentIntegrationMetadataResponseData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata from a response.

Parameters:

attributes (IncidentIntegrationMetadataAttributes, optional) – Incident integration metadata’s attributes for a create request.
id (str) – The incident integration metadata’s ID.
relationships (IncidentIntegrationRelationships, optional) – The incident’s integration relationships from a response.
type (IncidentIntegrationMetadataType) – Integration metadata resource type.

datadog_api_client.v2.model.incident_integration_metadata_response_included_item module¶

class IncidentIntegrationMetadataResponseIncludedItem(arg: None)¶

class IncidentIntegrationMetadataResponseIncludedItem(arg: ModelComposed)

class IncidentIntegrationMetadataResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an incident integration metadata that is included in the response.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_integration_metadata_type module¶

class IncidentIntegrationMetadataType(arg: None)¶

class IncidentIntegrationMetadataType(arg: ModelComposed)

class IncidentIntegrationMetadataType(*args, **kwargs)

Bases: ModelSimple

Integration metadata resource type.

Parameters:

value (str) – If omitted defaults to “incident_integrations”. Must be one of [“incident_integrations”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_integration_relationships module¶

class IncidentIntegrationRelationships(arg: None)¶

class IncidentIntegrationRelationships(arg: ModelComposed)

class IncidentIntegrationRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s integration relationships from a response.

Parameters:

created_by_user (RelationshipToUser, optional) – Relationship to user.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_non_datadog_creator module¶

class IncidentNonDatadogCreator(arg: None)¶

class IncidentNonDatadogCreator(arg: ModelComposed)

class IncidentNonDatadogCreator(*args, **kwargs)

Bases: ModelNormal

Incident’s non Datadog creator.

Parameters:

image_48_px (str, optional) – Non Datadog creator 48px image.
name (str, optional) – Non Datadog creator name.

datadog_api_client.v2.model.incident_notification_handle module¶

class IncidentNotificationHandle(arg: None)¶

class IncidentNotificationHandle(arg: ModelComposed)

class IncidentNotificationHandle(*args, **kwargs)

Bases: ModelNormal

A notification handle that will be notified at incident creation.

Parameters:

display_name (str, optional) – The name of the notified handle.
handle (str, optional) – The handle used for the notification. This includes an email address, Slack channel, or workflow.

datadog_api_client.v2.model.incident_notification_rule module¶

class IncidentNotificationRule(arg: None)¶

class IncidentNotificationRule(arg: ModelComposed)

class IncidentNotificationRule(*args, **kwargs)

Bases: ModelNormal

Response with a notification rule.

Parameters:

data (IncidentNotificationRuleResponseData) – Notification rule data from a response.
included ([IncidentNotificationRuleIncludedItems], optional) – Related objects that are included in the response.

datadog_api_client.v2.model.incident_notification_rule_array module¶

class IncidentNotificationRuleArray(arg: None)¶

class IncidentNotificationRuleArray(arg: ModelComposed)

class IncidentNotificationRuleArray(*args, **kwargs)

Bases: ModelNormal

Response with notification rules.

Parameters:

data ([IncidentNotificationRuleResponseData]) – The NotificationRuleArray data.
included ([IncidentNotificationRuleIncludedItems], optional) – Related objects that are included in the response.
meta (IncidentNotificationRuleArrayMeta, optional) – Response metadata.

datadog_api_client.v2.model.incident_notification_rule_array_meta module¶

class IncidentNotificationRuleArrayMeta(arg: None)¶

class IncidentNotificationRuleArrayMeta(arg: ModelComposed)

class IncidentNotificationRuleArrayMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata.

Parameters:: pagination (IncidentNotificationRuleArrayMetaPage, optional) – Pagination metadata.

datadog_api_client.v2.model.incident_notification_rule_array_meta_page module¶

class IncidentNotificationRuleArrayMetaPage(arg: None)¶

class IncidentNotificationRuleArrayMetaPage(arg: ModelComposed)

class IncidentNotificationRuleArrayMetaPage(*args, **kwargs)

Bases: ModelNormal

Pagination metadata.

Parameters:

next_offset (int, optional) – The offset for the next page of results.
offset (int, optional) – The current offset in the results.
size (int, optional) – The number of results returned per page.

datadog_api_client.v2.model.incident_notification_rule_attributes module¶

class IncidentNotificationRuleAttributes(arg: None)¶

class IncidentNotificationRuleAttributes(arg: ModelComposed)

class IncidentNotificationRuleAttributes(*args, **kwargs)

Bases: ModelNormal

The notification rule’s attributes.

Parameters:

conditions ([IncidentNotificationRuleConditionsItems]) – The conditions that trigger this notification rule.
created (datetime) – Timestamp when the notification rule was created.
enabled (bool) – Whether the notification rule is enabled.
handles ([str]) – The notification handles (targets) for this rule.
modified (datetime) – Timestamp when the notification rule was last modified.
renotify_on ([str], optional) – List of incident fields that trigger re-notification when changed.
trigger (str) – The trigger event for this notification rule.
visibility (IncidentNotificationRuleAttributesVisibility) – The visibility of the notification rule.

datadog_api_client.v2.model.incident_notification_rule_attributes_visibility module¶

class IncidentNotificationRuleAttributesVisibility(arg: None)¶

class IncidentNotificationRuleAttributesVisibility(arg: ModelComposed)

class IncidentNotificationRuleAttributesVisibility(*args, **kwargs)

Bases: ModelSimple

The visibility of the notification rule.

Parameters:

value (str) – Must be one of [“all”, “organization”, “private”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_notification_rule_conditions_items module¶

class IncidentNotificationRuleConditionsItems(arg: None)¶

class IncidentNotificationRuleConditionsItems(arg: ModelComposed)

class IncidentNotificationRuleConditionsItems(*args, **kwargs)

Bases: ModelNormal

A condition that must be met to trigger the notification rule.

Parameters:

field (str) – The incident field to evaluate
values ([str]) – The value(s) to compare against. Multiple values are ORed together.

datadog_api_client.v2.model.incident_notification_rule_create_attributes module¶

class IncidentNotificationRuleCreateAttributes(arg: None)¶

class IncidentNotificationRuleCreateAttributes(arg: ModelComposed)

class IncidentNotificationRuleCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes for creating a notification rule.

Parameters:

conditions ([IncidentNotificationRuleConditionsItems]) – The conditions that trigger this notification rule.
enabled (bool, optional) – Whether the notification rule is enabled.
handles ([str]) – The notification handles (targets) for this rule.
renotify_on ([str], optional) – List of incident fields that trigger re-notification when changed.
trigger (str) – The trigger event for this notification rule.
visibility (IncidentNotificationRuleCreateAttributesVisibility, optional) – The visibility of the notification rule.

datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility module¶

class IncidentNotificationRuleCreateAttributesVisibility(arg: None)¶

class IncidentNotificationRuleCreateAttributesVisibility(arg: ModelComposed)

class IncidentNotificationRuleCreateAttributesVisibility(*args, **kwargs)

Bases: ModelSimple

The visibility of the notification rule.

Parameters:

value (str) – Must be one of [“all”, “organization”, “private”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_notification_rule_create_data module¶

class IncidentNotificationRuleCreateData(arg: None)¶

class IncidentNotificationRuleCreateData(arg: ModelComposed)

class IncidentNotificationRuleCreateData(*args, **kwargs)

Bases: ModelNormal

Notification rule data for a create request.

Parameters:

attributes (IncidentNotificationRuleCreateAttributes) – The attributes for creating a notification rule.
relationships (IncidentNotificationRuleCreateDataRelationships, optional) – The definition of NotificationRuleCreateDataRelationships object.
type (IncidentNotificationRuleType) – Notification rules resource type.

datadog_api_client.v2.model.incident_notification_rule_create_data_relationships module¶

class IncidentNotificationRuleCreateDataRelationships(arg: None)¶

class IncidentNotificationRuleCreateDataRelationships(arg: ModelComposed)

class IncidentNotificationRuleCreateDataRelationships(*args, **kwargs)

Bases: ModelNormal

The definition of NotificationRuleCreateDataRelationships object.

Parameters:

incident_type (RelationshipToIncidentType, optional) – Relationship to an incident type.
notification_template (RelationshipToIncidentNotificationTemplate, optional) – A relationship reference to a notification template.

datadog_api_client.v2.model.incident_notification_rule_included_items module¶

class IncidentNotificationRuleIncludedItems(arg: None)¶

class IncidentNotificationRuleIncludedItems(arg: ModelComposed)

class IncidentNotificationRuleIncludedItems(*args, **kwargs)

Bases: ModelComposed

Objects related to a notification rule.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_notification_rule_relationships module¶

class IncidentNotificationRuleRelationships(arg: None)¶

class IncidentNotificationRuleRelationships(arg: ModelComposed)

class IncidentNotificationRuleRelationships(*args, **kwargs)

Bases: ModelNormal

The notification rule’s resource relationships.

Parameters:

created_by_user (RelationshipToUser, optional) – Relationship to user.
incident_type (RelationshipToIncidentType, optional) – Relationship to an incident type.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.
notification_template (RelationshipToIncidentNotificationTemplate, optional) – A relationship reference to a notification template.

datadog_api_client.v2.model.incident_notification_rule_response_data module¶

class IncidentNotificationRuleResponseData(arg: None)¶

class IncidentNotificationRuleResponseData(arg: ModelComposed)

class IncidentNotificationRuleResponseData(*args, **kwargs)

Bases: ModelNormal

Notification rule data from a response.

Parameters:

attributes (IncidentNotificationRuleAttributes, optional) – The notification rule’s attributes.
id (UUID) – The unique identifier of the notification rule.
relationships (IncidentNotificationRuleRelationships, optional) – The notification rule’s resource relationships.
type (IncidentNotificationRuleType) – Notification rules resource type.

datadog_api_client.v2.model.incident_notification_rule_type module¶

class IncidentNotificationRuleType(arg: None)¶

class IncidentNotificationRuleType(arg: ModelComposed)

class IncidentNotificationRuleType(*args, **kwargs)

Bases: ModelSimple

Notification rules resource type.

Parameters:

value (str) – If omitted defaults to “incident_notification_rules”. Must be one of [“incident_notification_rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_notification_rule_update_data module¶

class IncidentNotificationRuleUpdateData(arg: None)¶

class IncidentNotificationRuleUpdateData(arg: ModelComposed)

class IncidentNotificationRuleUpdateData(*args, **kwargs)

Bases: ModelNormal

Notification rule data for an update request.

Parameters:

attributes (IncidentNotificationRuleCreateAttributes) – The attributes for creating a notification rule.
id (UUID) – The unique identifier of the notification rule.
relationships (IncidentNotificationRuleCreateDataRelationships, optional) – The definition of NotificationRuleCreateDataRelationships object.
type (IncidentNotificationRuleType) – Notification rules resource type.

datadog_api_client.v2.model.incident_notification_template module¶

class IncidentNotificationTemplate(arg: None)¶

class IncidentNotificationTemplate(arg: ModelComposed)

class IncidentNotificationTemplate(*args, **kwargs)

Bases: ModelNormal

Response with a notification template.

Parameters:

data (IncidentNotificationTemplateResponseData) – Notification template data from a response.
included ([IncidentNotificationTemplateIncludedItems], optional) – Related objects that are included in the response.

datadog_api_client.v2.model.incident_notification_template_array module¶

class IncidentNotificationTemplateArray(arg: None)¶

class IncidentNotificationTemplateArray(arg: ModelComposed)

class IncidentNotificationTemplateArray(*args, **kwargs)

Bases: ModelNormal

Response with notification templates.

Parameters:

data ([IncidentNotificationTemplateResponseData]) – The NotificationTemplateArray data.
included ([IncidentNotificationTemplateIncludedItems], optional) – Related objects that are included in the response.
meta (IncidentNotificationTemplateArrayMeta, optional) – Response metadata.

datadog_api_client.v2.model.incident_notification_template_array_meta module¶

class IncidentNotificationTemplateArrayMeta(arg: None)¶

class IncidentNotificationTemplateArrayMeta(arg: ModelComposed)

class IncidentNotificationTemplateArrayMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata.

Parameters:: page (IncidentNotificationTemplateArrayMetaPage, optional) – Pagination metadata.

datadog_api_client.v2.model.incident_notification_template_array_meta_page module¶

class IncidentNotificationTemplateArrayMetaPage(arg: None)¶

class IncidentNotificationTemplateArrayMetaPage(arg: ModelComposed)

class IncidentNotificationTemplateArrayMetaPage(*args, **kwargs)

Bases: ModelNormal

Pagination metadata.

Parameters:

total_count (int, optional) – Total number of notification templates.
total_filtered_count (int, optional) – Total number of notification templates matching the filter.

datadog_api_client.v2.model.incident_notification_template_attributes module¶

class IncidentNotificationTemplateAttributes(arg: None)¶

class IncidentNotificationTemplateAttributes(arg: ModelComposed)

class IncidentNotificationTemplateAttributes(*args, **kwargs)

Bases: ModelNormal

The notification template’s attributes.

Parameters:

category (str) – The category of the notification template.
content (str) – The content body of the notification template.
created (datetime) – Timestamp when the notification template was created.
modified (datetime) – Timestamp when the notification template was last modified.
name (str) – The name of the notification template.
subject (str) – The subject line of the notification template.

datadog_api_client.v2.model.incident_notification_template_create_attributes module¶

class IncidentNotificationTemplateCreateAttributes(arg: None)¶

class IncidentNotificationTemplateCreateAttributes(arg: ModelComposed)

class IncidentNotificationTemplateCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes for creating a notification template.

Parameters:

category (str) – The category of the notification template.
content (str) – The content body of the notification template.
name (str) – The name of the notification template.
subject (str) – The subject line of the notification template.

datadog_api_client.v2.model.incident_notification_template_create_data module¶

class IncidentNotificationTemplateCreateData(arg: None)¶

class IncidentNotificationTemplateCreateData(arg: ModelComposed)

class IncidentNotificationTemplateCreateData(*args, **kwargs)

Bases: ModelNormal

Notification template data for a create request.

Parameters:

attributes (IncidentNotificationTemplateCreateAttributes) – The attributes for creating a notification template.
relationships (IncidentNotificationTemplateCreateDataRelationships, optional) – The definition of NotificationTemplateCreateDataRelationships object.
type (IncidentNotificationTemplateType) – Notification templates resource type.

datadog_api_client.v2.model.incident_notification_template_create_data_relationships module¶

class IncidentNotificationTemplateCreateDataRelationships(arg: None)¶

class IncidentNotificationTemplateCreateDataRelationships(arg: ModelComposed)

class IncidentNotificationTemplateCreateDataRelationships(*args, **kwargs)

Bases: ModelNormal

The definition of NotificationTemplateCreateDataRelationships object.

Parameters:: incident_type (RelationshipToIncidentType, optional) – Relationship to an incident type.

datadog_api_client.v2.model.incident_notification_template_included_items module¶

class IncidentNotificationTemplateIncludedItems(arg: None)¶

class IncidentNotificationTemplateIncludedItems(arg: ModelComposed)

class IncidentNotificationTemplateIncludedItems(*args, **kwargs)

Bases: ModelComposed

Objects related to a notification template.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_notification_template_object module¶

class IncidentNotificationTemplateObject(arg: None)¶

class IncidentNotificationTemplateObject(arg: ModelComposed)

class IncidentNotificationTemplateObject(*args, **kwargs)

Bases: ModelNormal

A notification template object for inclusion in other resources.

Parameters:

attributes (IncidentNotificationTemplateAttributes, optional) – The notification template’s attributes.
id (UUID) – The unique identifier of the notification template.
relationships (IncidentNotificationTemplateRelationships, optional) – The notification template’s resource relationships.
type (IncidentNotificationTemplateType) – Notification templates resource type.

datadog_api_client.v2.model.incident_notification_template_relationships module¶

class IncidentNotificationTemplateRelationships(arg: None)¶

class IncidentNotificationTemplateRelationships(arg: ModelComposed)

class IncidentNotificationTemplateRelationships(*args, **kwargs)

Bases: ModelNormal

The notification template’s resource relationships.

Parameters:

created_by_user (RelationshipToUser, optional) – Relationship to user.
incident_type (RelationshipToIncidentType, optional) – Relationship to an incident type.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_notification_template_response_data module¶

class IncidentNotificationTemplateResponseData(arg: None)¶

class IncidentNotificationTemplateResponseData(arg: ModelComposed)

class IncidentNotificationTemplateResponseData(*args, **kwargs)

Bases: ModelNormal

Notification template data from a response.

Parameters:

attributes (IncidentNotificationTemplateAttributes, optional) – The notification template’s attributes.
id (UUID) – The unique identifier of the notification template.
relationships (IncidentNotificationTemplateRelationships, optional) – The notification template’s resource relationships.
type (IncidentNotificationTemplateType) – Notification templates resource type.

datadog_api_client.v2.model.incident_notification_template_type module¶

class IncidentNotificationTemplateType(arg: None)¶

class IncidentNotificationTemplateType(arg: ModelComposed)

class IncidentNotificationTemplateType(*args, **kwargs)

Bases: ModelSimple

Notification templates resource type.

Parameters:

value (str) – If omitted defaults to “notification_templates”. Must be one of [“notification_templates”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_notification_template_update_attributes module¶

class IncidentNotificationTemplateUpdateAttributes(arg: None)¶

class IncidentNotificationTemplateUpdateAttributes(arg: ModelComposed)

class IncidentNotificationTemplateUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes to update on a notification template.

Parameters:

category (str, optional) – The category of the notification template.
content (str, optional) – The content body of the notification template.
name (str, optional) – The name of the notification template.
subject (str, optional) – The subject line of the notification template.

datadog_api_client.v2.model.incident_notification_template_update_data module¶

class IncidentNotificationTemplateUpdateData(arg: None)¶

class IncidentNotificationTemplateUpdateData(arg: ModelComposed)

class IncidentNotificationTemplateUpdateData(*args, **kwargs)

Bases: ModelNormal

Notification template data for an update request.

Parameters:

attributes (IncidentNotificationTemplateUpdateAttributes, optional) – The attributes to update on a notification template.
id (UUID) – The unique identifier of the notification template.
type (IncidentNotificationTemplateType) – Notification templates resource type.

datadog_api_client.v2.model.incident_postmortem_type module¶

class IncidentPostmortemType(arg: None)¶

class IncidentPostmortemType(arg: ModelComposed)

class IncidentPostmortemType(*args, **kwargs)

Bases: ModelSimple

Incident postmortem resource type.

Parameters:

value (str) – If omitted defaults to “incident_postmortems”. Must be one of [“incident_postmortems”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_related_object module¶

class IncidentRelatedObject(arg: None)¶

class IncidentRelatedObject(arg: ModelComposed)

class IncidentRelatedObject(*args, **kwargs)

Bases: ModelSimple

Object related to an incident.

Parameters:

value (str) – Must be one of [“users”, “attachments”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_responders_type module¶

class IncidentRespondersType(arg: None)¶

class IncidentRespondersType(arg: ModelComposed)

class IncidentRespondersType(*args, **kwargs)

Bases: ModelSimple

The incident responders type.

Parameters:

value (str) – If omitted defaults to “incident_responders”. Must be one of [“incident_responders”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_response module¶

class IncidentResponse(arg: None)¶

class IncidentResponse(arg: ModelComposed)

class IncidentResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident.

Parameters:

data (IncidentResponseData) – Incident data from a response.
included ([IncidentResponseIncludedItem], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_response_attributes module¶

class IncidentResponseAttributes(arg: None)¶

class IncidentResponseAttributes(arg: ModelComposed)

class IncidentResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The incident’s attributes from a response.

Parameters:

archived (datetime, none_type, optional) – Timestamp of when the incident was archived.
case_id (int, none_type, optional) – The incident case id.
created (datetime, optional) – Timestamp when the incident was created.
customer_impact_duration (int, optional) – Length of the incident’s customer impact in seconds. Equals the difference between customer_impact_start and customer_impact_end.
customer_impact_end (datetime, none_type, optional) – Timestamp when customers were no longer impacted by the incident.
customer_impact_scope (str, none_type, optional) – A summary of the impact customers experienced during the incident.
customer_impact_start (datetime, none_type, optional) – Timestamp when customers began being impacted by the incident.
customer_impacted (bool, optional) – A flag indicating whether the incident caused customer impact.
declared (datetime, optional) – Timestamp when the incident was declared.
declared_by (IncidentNonDatadogCreator, none_type, optional) – Incident’s non Datadog creator.
declared_by_uuid (str, none_type, optional) – UUID of the user who declared the incident.
detected (datetime, none_type, optional) – Timestamp when the incident was detected.
fields ({str: (IncidentFieldAttributes,)}, optional) – A condensed view of the user-defined fields attached to incidents.
incident_type_uuid (str, optional) – A unique identifier that represents an incident type.
is_test (bool, optional) – A flag indicating whether the incident is a test incident.
modified (datetime, optional) – Timestamp when the incident was last modified.
non_datadog_creator (IncidentNonDatadogCreator, none_type, optional) – Incident’s non Datadog creator.
notification_handles ([IncidentNotificationHandle], none_type, optional) – Notification handles that will be notified of the incident during update.
public_id (int, optional) – The monotonically increasing integer ID for the incident.
resolved (datetime, none_type, optional) – Timestamp when the incident’s state was last changed from active or stable to resolved or completed.
severity (IncidentSeverity, optional) – The incident severity.
state (str, none_type, optional) – The state incident.
time_to_detect (int, optional) – The amount of time in seconds to detect the incident. Equals the difference between customer_impact_start and detected.
time_to_internal_response (int, optional) – The amount of time in seconds to call incident after detection. Equals the difference of detected and created.
time_to_repair (int, optional) – The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between customer_impact_end and detected.
time_to_resolve (int, optional) – The amount of time in seconds to resolve the incident after it was created. Equals the difference between created and resolved.
title (str) – The title of the incident, which summarizes what happened.
visibility (str, none_type, optional) – The incident visibility status.

datadog_api_client.v2.model.incident_response_data module¶

class IncidentResponseData(arg: None)¶

class IncidentResponseData(arg: ModelComposed)

class IncidentResponseData(*args, **kwargs)

Bases: ModelNormal

Incident data from a response.

Parameters:

attributes (IncidentResponseAttributes, optional) – The incident’s attributes from a response.
id (str) – The incident’s ID.
relationships (IncidentResponseRelationships, optional) – The incident’s relationships from a response.
type (IncidentType) – Incident resource type.

datadog_api_client.v2.model.incident_response_included_item module¶

class IncidentResponseIncludedItem(arg: None)¶

class IncidentResponseIncludedItem(arg: ModelComposed)

class IncidentResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an incident that is included in the response.

Parameters:

attributes (IncidentUserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
type (UsersType, optional) – Users resource type.
relationships (IncidentAttachmentRelationships) – The incident attachment’s relationships.

datadog_api_client.v2.model.incident_response_meta module¶

class IncidentResponseMeta(arg: None)¶

class IncidentResponseMeta(arg: ModelComposed)

class IncidentResponseMeta(*args, **kwargs)

Bases: ModelNormal

The metadata object containing pagination metadata.

Parameters:: pagination (IncidentResponseMetaPagination, optional) – Pagination properties.

datadog_api_client.v2.model.incident_response_meta_pagination module¶

class IncidentResponseMetaPagination(arg: None)¶

class IncidentResponseMetaPagination(arg: ModelComposed)

class IncidentResponseMetaPagination(*args, **kwargs)

Bases: ModelNormal

Pagination properties.

Parameters:

next_offset (int, optional) – The index of the first element in the next page of results. Equal to page size added to the current offset.
offset (int, optional) – The index of the first element in the results.
size (int, optional) – Maximum size of pages to return.

datadog_api_client.v2.model.incident_response_relationships module¶

class IncidentResponseRelationships(arg: None)¶

class IncidentResponseRelationships(arg: ModelComposed)

class IncidentResponseRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships from a response.

Parameters:

attachments (RelationshipToIncidentAttachment, optional) – A relationship reference for attachments.
commander_user (NullableRelationshipToUser, none_type, optional) – Relationship to user.
created_by_user (RelationshipToUser, optional) – Relationship to user.
declared_by_user (RelationshipToUser, optional) – Relationship to user.
impacts (RelationshipToIncidentImpacts, optional) – Relationship to impacts.
integrations (RelationshipToIncidentIntegrationMetadatas, optional) – A relationship reference for multiple integration metadata objects.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.
responders (RelationshipToIncidentResponders, optional) – Relationship to incident responders.
user_defined_fields (RelationshipToIncidentUserDefinedFields, optional) – Relationship to incident user defined fields.

datadog_api_client.v2.model.incident_search_response module¶

class IncidentSearchResponse(arg: None)¶

class IncidentSearchResponse(arg: ModelComposed)

class IncidentSearchResponse(*args, **kwargs)

Bases: ModelNormal

Response with incidents and facets.

Parameters:

data (IncidentSearchResponseData) – Data returned by an incident search.
included ([IncidentResponseIncludedItem], optional) – Included related resources that the user requested.
meta (IncidentSearchResponseMeta, optional) – The metadata object containing pagination metadata.

datadog_api_client.v2.model.incident_search_response_attributes module¶

class IncidentSearchResponseAttributes(arg: None)¶

class IncidentSearchResponseAttributes(arg: ModelComposed)

class IncidentSearchResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes returned by an incident search.

Parameters:

facets (IncidentSearchResponseFacetsData) – Facet data for incidents returned by a search query.
incidents ([IncidentSearchResponseIncidentsData]) – Incidents returned by the search.
total (int) – Number of incidents returned by the search.

datadog_api_client.v2.model.incident_search_response_data module¶

class IncidentSearchResponseData(arg: None)¶

class IncidentSearchResponseData(arg: ModelComposed)

class IncidentSearchResponseData(*args, **kwargs)

Bases: ModelNormal

Data returned by an incident search.

Parameters:

attributes (IncidentSearchResponseAttributes, optional) – Attributes returned by an incident search.
type (IncidentSearchResultsType, optional) – Incident search result type.

datadog_api_client.v2.model.incident_search_response_facets_data module¶

class IncidentSearchResponseFacetsData(arg: None)¶

class IncidentSearchResponseFacetsData(arg: ModelComposed)

class IncidentSearchResponseFacetsData(*args, **kwargs)

Bases: ModelNormal

Facet data for incidents returned by a search query.

Parameters:

commander ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident commander users.
created_by ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident creator users.
fields ([IncidentSearchResponsePropertyFieldFacetData], optional) – Facet data for incident property fields.
impact ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident impact attributes.
last_modified_by ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident last modified by users.
postmortem ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident postmortem existence.
responder ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident responder users.
severity ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident severity attributes.
state ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident state attributes.
time_to_repair ([IncidentSearchResponseNumericFacetData], optional) – Facet data for incident time to repair metrics.
time_to_resolve ([IncidentSearchResponseNumericFacetData], optional) – Facet data for incident time to resolve metrics.

datadog_api_client.v2.model.incident_search_response_field_facet_data module¶

class IncidentSearchResponseFieldFacetData(arg: None)¶

class IncidentSearchResponseFieldFacetData(arg: ModelComposed)

class IncidentSearchResponseFieldFacetData(*args, **kwargs)

Bases: ModelNormal

Facet value and number of occurrences for a property field of an incident.

Parameters:

count (int, optional) – Count of the facet value appearing in search results.
name (str, optional) – The facet value appearing in search results.

datadog_api_client.v2.model.incident_search_response_incidents_data module¶

class IncidentSearchResponseIncidentsData(arg: None)¶

class IncidentSearchResponseIncidentsData(arg: ModelComposed)

class IncidentSearchResponseIncidentsData(*args, **kwargs)

Bases: ModelNormal

Incident returned by the search.

Parameters:: data (IncidentResponseData) – Incident data from a response.

datadog_api_client.v2.model.incident_search_response_meta module¶

class IncidentSearchResponseMeta(arg: None)¶

class IncidentSearchResponseMeta(arg: ModelComposed)

class IncidentSearchResponseMeta(*args, **kwargs)

Bases: ModelNormal

The metadata object containing pagination metadata.

Parameters:: pagination (IncidentResponseMetaPagination, optional) – Pagination properties.

datadog_api_client.v2.model.incident_search_response_numeric_facet_data module¶

class IncidentSearchResponseNumericFacetData(arg: None)¶

class IncidentSearchResponseNumericFacetData(arg: ModelComposed)

class IncidentSearchResponseNumericFacetData(*args, **kwargs)

Bases: ModelNormal

Facet data numeric attributes of an incident.

Parameters:

aggregates (IncidentSearchResponseNumericFacetDataAggregates) – Aggregate information for numeric incident data.
name (str) – Name of the incident property field.

datadog_api_client.v2.model.incident_search_response_numeric_facet_data_aggregates module¶

class IncidentSearchResponseNumericFacetDataAggregates(arg: None)¶

class IncidentSearchResponseNumericFacetDataAggregates(arg: ModelComposed)

class IncidentSearchResponseNumericFacetDataAggregates(*args, **kwargs)

Bases: ModelNormal

Aggregate information for numeric incident data.

Parameters:

max (float, none_type, optional) – Maximum value of the numeric aggregates.
min (float, none_type, optional) – Minimum value of the numeric aggregates.

datadog_api_client.v2.model.incident_search_response_property_field_facet_data module¶

class IncidentSearchResponsePropertyFieldFacetData(arg: None)¶

class IncidentSearchResponsePropertyFieldFacetData(arg: ModelComposed)

class IncidentSearchResponsePropertyFieldFacetData(*args, **kwargs)

Bases: ModelNormal

Facet data for the incident property fields.

Parameters:

aggregates (IncidentSearchResponseNumericFacetDataAggregates, optional) – Aggregate information for numeric incident data.
facets ([IncidentSearchResponseFieldFacetData]) – Facet data for the property field of an incident.
name (str) – Name of the incident property field.

datadog_api_client.v2.model.incident_search_response_user_facet_data module¶

class IncidentSearchResponseUserFacetData(arg: None)¶

class IncidentSearchResponseUserFacetData(arg: ModelComposed)

class IncidentSearchResponseUserFacetData(*args, **kwargs)

Bases: ModelNormal

Facet data for user attributes of an incident.

Parameters:

count (int, optional) – Count of the facet value appearing in search results.
email (str, optional) – Email of the user.
handle (str, optional) – Handle of the user.
name (str, optional) – Name of the user.
uuid (str, optional) – ID of the user.

datadog_api_client.v2.model.incident_search_results_type module¶

class IncidentSearchResultsType(arg: None)¶

class IncidentSearchResultsType(arg: ModelComposed)

class IncidentSearchResultsType(*args, **kwargs)

Bases: ModelSimple

Incident search result type.

Parameters:

value (str) – If omitted defaults to “incidents_search_results”. Must be one of [“incidents_search_results”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_search_sort_order module¶

class IncidentSearchSortOrder(arg: None)¶

class IncidentSearchSortOrder(arg: ModelComposed)

class IncidentSearchSortOrder(*args, **kwargs)

Bases: ModelSimple

The ways searched incidents can be sorted.

Parameters:

value (str) – Must be one of [“created”, “-created”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_service_create_attributes module¶

class IncidentServiceCreateAttributes(arg: None)¶

class IncidentServiceCreateAttributes(arg: ModelComposed)

class IncidentServiceCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident service’s attributes for a create request.

Parameters:: name (str) – Name of the incident service.

datadog_api_client.v2.model.incident_service_create_data module¶

class IncidentServiceCreateData(arg: None)¶

class IncidentServiceCreateData(arg: ModelComposed)

class IncidentServiceCreateData(*args, **kwargs)

Bases: ModelNormal

Incident Service payload for create requests.

Parameters:

attributes (IncidentServiceCreateAttributes, optional) – The incident service’s attributes for a create request.
relationships (IncidentServiceRelationships, optional) – The incident service’s relationships.
type (IncidentServiceType) – Incident service resource type.

datadog_api_client.v2.model.incident_service_create_request module¶

class IncidentServiceCreateRequest(arg: None)¶

class IncidentServiceCreateRequest(arg: ModelComposed)

class IncidentServiceCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request with an incident service payload.

Parameters:: data (IncidentServiceCreateData) – Incident Service payload for create requests.

datadog_api_client.v2.model.incident_service_included_items module¶

class IncidentServiceIncludedItems(arg: None)¶

class IncidentServiceIncludedItems(arg: ModelComposed)

class IncidentServiceIncludedItems(*args, **kwargs)

Bases: ModelComposed

An object related to an incident service which is present in the included payload.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_service_relationships module¶

class IncidentServiceRelationships(arg: None)¶

class IncidentServiceRelationships(arg: ModelComposed)

class IncidentServiceRelationships(*args, **kwargs)

Bases: ModelNormal

The incident service’s relationships.

Parameters:

created_by (RelationshipToUser, optional) – Relationship to user.
last_modified_by (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_service_response module¶

class IncidentServiceResponse(arg: None)¶

class IncidentServiceResponse(arg: ModelComposed)

class IncidentServiceResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident service payload.

Parameters:

data (IncidentServiceResponseData) – Incident Service data from responses.
included ([IncidentServiceIncludedItems], optional) – Included objects from relationships.

datadog_api_client.v2.model.incident_service_response_attributes module¶

class IncidentServiceResponseAttributes(arg: None)¶

class IncidentServiceResponseAttributes(arg: ModelComposed)

class IncidentServiceResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The incident service’s attributes from a response.

Parameters:

created (datetime, optional) – Timestamp of when the incident service was created.
modified (datetime, optional) – Timestamp of when the incident service was modified.
name (str, optional) – Name of the incident service.

datadog_api_client.v2.model.incident_service_response_data module¶

class IncidentServiceResponseData(arg: None)¶

class IncidentServiceResponseData(arg: ModelComposed)

class IncidentServiceResponseData(*args, **kwargs)

Bases: ModelNormal

Incident Service data from responses.

Parameters:

attributes (IncidentServiceResponseAttributes, optional) – The incident service’s attributes from a response.
id (str) – The incident service’s ID.
relationships (IncidentServiceRelationships, optional) – The incident service’s relationships.
type (IncidentServiceType) – Incident service resource type.

datadog_api_client.v2.model.incident_service_type module¶

class IncidentServiceType(arg: None)¶

class IncidentServiceType(arg: ModelComposed)

class IncidentServiceType(*args, **kwargs)

Bases: ModelSimple

Incident service resource type.

Parameters:

value (str) – If omitted defaults to “services”. Must be one of [“services”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_service_update_attributes module¶

class IncidentServiceUpdateAttributes(arg: None)¶

class IncidentServiceUpdateAttributes(arg: ModelComposed)

class IncidentServiceUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident service’s attributes for an update request.

Parameters:: name (str) – Name of the incident service.

datadog_api_client.v2.model.incident_service_update_data module¶

class IncidentServiceUpdateData(arg: None)¶

class IncidentServiceUpdateData(arg: ModelComposed)

class IncidentServiceUpdateData(*args, **kwargs)

Bases: ModelNormal

Incident Service payload for update requests.

Parameters:

attributes (IncidentServiceUpdateAttributes, optional) – The incident service’s attributes for an update request.
id (str, optional) – The incident service’s ID.
relationships (IncidentServiceRelationships, optional) – The incident service’s relationships.
type (IncidentServiceType) – Incident service resource type.

datadog_api_client.v2.model.incident_service_update_request module¶

class IncidentServiceUpdateRequest(arg: None)¶

class IncidentServiceUpdateRequest(arg: ModelComposed)

class IncidentServiceUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request with an incident service payload.

Parameters:: data (IncidentServiceUpdateData) – Incident Service payload for update requests.

datadog_api_client.v2.model.incident_services_response module¶

class IncidentServicesResponse(arg: None)¶

class IncidentServicesResponse(arg: ModelComposed)

class IncidentServicesResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident service payloads.

Parameters:

data ([IncidentServiceResponseData]) – An array of incident services.
included ([IncidentServiceIncludedItems], optional) – Included related resources which the user requested.
meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

datadog_api_client.v2.model.incident_severity module¶

class IncidentSeverity(arg: None)¶

class IncidentSeverity(arg: ModelComposed)

class IncidentSeverity(*args, **kwargs)

Bases: ModelSimple

The incident severity.

Parameters:

value (str) – Must be one of [“UNKNOWN”, “SEV-0”, “SEV-1”, “SEV-2”, “SEV-3”, “SEV-4”, “SEV-5”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_team_create_attributes module¶

class IncidentTeamCreateAttributes(arg: None)¶

class IncidentTeamCreateAttributes(arg: ModelComposed)

class IncidentTeamCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident team’s attributes for a create request.

Parameters:: name (str) – Name of the incident team.

datadog_api_client.v2.model.incident_team_create_data module¶

class IncidentTeamCreateData(arg: None)¶

class IncidentTeamCreateData(arg: ModelComposed)

class IncidentTeamCreateData(*args, **kwargs)

Bases: ModelNormal

Incident Team data for a create request.

Parameters:

attributes (IncidentTeamCreateAttributes, optional) – The incident team’s attributes for a create request.
relationships (IncidentTeamRelationships, optional) – The incident team’s relationships.
type (IncidentTeamType) – Incident Team resource type.

datadog_api_client.v2.model.incident_team_create_request module¶

class IncidentTeamCreateRequest(arg: None)¶

class IncidentTeamCreateRequest(arg: ModelComposed)

class IncidentTeamCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request with an incident team payload.

Parameters:: data (IncidentTeamCreateData) – Incident Team data for a create request.

datadog_api_client.v2.model.incident_team_included_items module¶

class IncidentTeamIncludedItems(arg: None)¶

class IncidentTeamIncludedItems(arg: ModelComposed)

class IncidentTeamIncludedItems(*args, **kwargs)

Bases: ModelComposed

An object related to an incident team which is present in the included payload.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_team_relationships module¶

class IncidentTeamRelationships(arg: None)¶

class IncidentTeamRelationships(arg: ModelComposed)

class IncidentTeamRelationships(*args, **kwargs)

Bases: ModelNormal

The incident team’s relationships.

Parameters:

created_by (RelationshipToUser, optional) – Relationship to user.
last_modified_by (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_team_response module¶

class IncidentTeamResponse(arg: None)¶

class IncidentTeamResponse(arg: ModelComposed)

class IncidentTeamResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident team payload.

Parameters:

data (IncidentTeamResponseData) – Incident Team data from a response.
included ([IncidentTeamIncludedItems], optional) – Included objects from relationships.

datadog_api_client.v2.model.incident_team_response_attributes module¶

class IncidentTeamResponseAttributes(arg: None)¶

class IncidentTeamResponseAttributes(arg: ModelComposed)

class IncidentTeamResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The incident team’s attributes from a response.

Parameters:

created (datetime, optional) – Timestamp of when the incident team was created.
modified (datetime, optional) – Timestamp of when the incident team was modified.
name (str, optional) – Name of the incident team.

datadog_api_client.v2.model.incident_team_response_data module¶

class IncidentTeamResponseData(arg: None)¶

class IncidentTeamResponseData(arg: ModelComposed)

class IncidentTeamResponseData(*args, **kwargs)

Bases: ModelNormal

Incident Team data from a response.

Parameters:

attributes (IncidentTeamResponseAttributes, optional) – The incident team’s attributes from a response.
id (str, optional) – The incident team’s ID.
relationships (IncidentTeamRelationships, optional) – The incident team’s relationships.
type (IncidentTeamType, optional) – Incident Team resource type.

datadog_api_client.v2.model.incident_team_type module¶

class IncidentTeamType(arg: None)¶

class IncidentTeamType(arg: ModelComposed)

class IncidentTeamType(*args, **kwargs)

Bases: ModelSimple

Incident Team resource type.

Parameters:

value (str) – If omitted defaults to “teams”. Must be one of [“teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_team_update_attributes module¶

class IncidentTeamUpdateAttributes(arg: None)¶

class IncidentTeamUpdateAttributes(arg: ModelComposed)

class IncidentTeamUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident team’s attributes for an update request.

Parameters:: name (str) – Name of the incident team.

datadog_api_client.v2.model.incident_team_update_data module¶

class IncidentTeamUpdateData(arg: None)¶

class IncidentTeamUpdateData(arg: ModelComposed)

class IncidentTeamUpdateData(*args, **kwargs)

Bases: ModelNormal

Incident Team data for an update request.

Parameters:

attributes (IncidentTeamUpdateAttributes, optional) – The incident team’s attributes for an update request.
id (str, optional) – The incident team’s ID.
relationships (IncidentTeamRelationships, optional) – The incident team’s relationships.
type (IncidentTeamType) – Incident Team resource type.

datadog_api_client.v2.model.incident_team_update_request module¶

class IncidentTeamUpdateRequest(arg: None)¶

class IncidentTeamUpdateRequest(arg: ModelComposed)

class IncidentTeamUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request with an incident team payload.

Parameters:: data (IncidentTeamUpdateData) – Incident Team data for an update request.

datadog_api_client.v2.model.incident_teams_response module¶

class IncidentTeamsResponse(arg: None)¶

class IncidentTeamsResponse(arg: ModelComposed)

class IncidentTeamsResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident team payloads.

Parameters:

data ([IncidentTeamResponseData]) – An array of incident teams.
included ([IncidentTeamIncludedItems], optional) – Included related resources which the user requested.
meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

datadog_api_client.v2.model.incident_timeline_cell_create_attributes module¶

class IncidentTimelineCellCreateAttributes(arg: None)¶

class IncidentTimelineCellCreateAttributes(arg: ModelComposed)

class IncidentTimelineCellCreateAttributes(*args, **kwargs)

Bases: ModelComposed

The timeline cell’s attributes for a create request.

Parameters:

cell_type (IncidentTimelineCellMarkdownContentType) – Type of the Markdown timeline cell.
content (IncidentTimelineCellMarkdownCreateAttributesContent) – The Markdown timeline cell contents.
important (bool, optional) – A flag indicating whether the timeline cell is important and should be highlighted.

datadog_api_client.v2.model.incident_timeline_cell_markdown_content_type module¶

class IncidentTimelineCellMarkdownContentType(arg: None)¶

class IncidentTimelineCellMarkdownContentType(arg: ModelComposed)

class IncidentTimelineCellMarkdownContentType(*args, **kwargs)

Bases: ModelSimple

Type of the Markdown timeline cell.

Parameters:

value (str) – If omitted defaults to “markdown”. Must be one of [“markdown”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_timeline_cell_markdown_create_attributes module¶

class IncidentTimelineCellMarkdownCreateAttributes(arg: None)¶

class IncidentTimelineCellMarkdownCreateAttributes(arg: ModelComposed)

class IncidentTimelineCellMarkdownCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Timeline cell data for Markdown timeline cells for a create request.

Parameters:

cell_type (IncidentTimelineCellMarkdownContentType) – Type of the Markdown timeline cell.
content (IncidentTimelineCellMarkdownCreateAttributesContent) – The Markdown timeline cell contents.
important (bool, optional) – A flag indicating whether the timeline cell is important and should be highlighted.

datadog_api_client.v2.model.incident_timeline_cell_markdown_create_attributes_content module¶

class IncidentTimelineCellMarkdownCreateAttributesContent(arg: None)¶

class IncidentTimelineCellMarkdownCreateAttributesContent(arg: ModelComposed)

class IncidentTimelineCellMarkdownCreateAttributesContent(*args, **kwargs)

Bases: ModelNormal

The Markdown timeline cell contents.

Parameters:: content (str, optional) – The Markdown content of the cell.

datadog_api_client.v2.model.incident_todo_anonymous_assignee module¶

class IncidentTodoAnonymousAssignee(arg: None)¶

class IncidentTodoAnonymousAssignee(arg: ModelComposed)

class IncidentTodoAnonymousAssignee(*args, **kwargs)

Bases: ModelNormal

Anonymous assignee entity.

Parameters:

icon (str) – URL for assignee’s icon.
id (str) – Anonymous assignee’s ID.
name (str) – Assignee’s name.
source (IncidentTodoAnonymousAssigneeSource) – The source of the anonymous assignee.

datadog_api_client.v2.model.incident_todo_anonymous_assignee_source module¶

class IncidentTodoAnonymousAssigneeSource(arg: None)¶

class IncidentTodoAnonymousAssigneeSource(arg: ModelComposed)

class IncidentTodoAnonymousAssigneeSource(*args, **kwargs)

Bases: ModelSimple

The source of the anonymous assignee.

Parameters:

value (str) – If omitted defaults to “slack”. Must be one of [“slack”, “microsoft_teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_todo_assignee module¶

class IncidentTodoAssignee(arg: None)¶

class IncidentTodoAssignee(arg: ModelComposed)

class IncidentTodoAssignee(*args, **kwargs)

Bases: ModelComposed

A todo assignee.

Parameters:

icon (str) – URL for assignee’s icon.
id (str) – Anonymous assignee’s ID.
name (str) – Assignee’s name.
source (IncidentTodoAnonymousAssigneeSource) – The source of the anonymous assignee.

datadog_api_client.v2.model.incident_todo_assignee_array module¶

class IncidentTodoAssigneeArray(arg: None)¶

class IncidentTodoAssigneeArray(arg: ModelComposed)

class IncidentTodoAssigneeArray(*args, **kwargs)

Bases: ModelSimple

Array of todo assignees.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_todo_attributes module¶

class IncidentTodoAttributes(arg: None)¶

class IncidentTodoAttributes(arg: ModelComposed)

class IncidentTodoAttributes(*args, **kwargs)

Bases: ModelNormal

Incident todo’s attributes.

Parameters:

assignees (IncidentTodoAssigneeArray) – Array of todo assignees.
completed (str, none_type, optional) – Timestamp when the todo was completed.
content (str) – The follow-up task’s content.
created (datetime, optional) – Timestamp when the incident todo was created.
due_date (str, none_type, optional) – Timestamp when the todo should be completed by.
incident_id (str, optional) – UUID of the incident this todo is connected to.
modified (datetime, optional) – Timestamp when the incident todo was last modified.

datadog_api_client.v2.model.incident_todo_create_data module¶

class IncidentTodoCreateData(arg: None)¶

class IncidentTodoCreateData(arg: ModelComposed)

class IncidentTodoCreateData(*args, **kwargs)

Bases: ModelNormal

Incident todo data for a create request.

Parameters:

attributes (IncidentTodoAttributes) – Incident todo’s attributes.
type (IncidentTodoType) – Todo resource type.

datadog_api_client.v2.model.incident_todo_create_request module¶

class IncidentTodoCreateRequest(arg: None)¶

class IncidentTodoCreateRequest(arg: ModelComposed)

class IncidentTodoCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident todo.

Parameters:: data (IncidentTodoCreateData) – Incident todo data for a create request.

datadog_api_client.v2.model.incident_todo_list_response module¶

class IncidentTodoListResponse(arg: None)¶

class IncidentTodoListResponse(arg: ModelComposed)

class IncidentTodoListResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident todos.

Parameters:

data ([IncidentTodoResponseData]) – An array of incident todos.
included ([IncidentTodoResponseIncludedItem], optional) – Included related resources that the user requested.
meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

datadog_api_client.v2.model.incident_todo_patch_data module¶

class IncidentTodoPatchData(arg: None)¶

class IncidentTodoPatchData(arg: ModelComposed)

class IncidentTodoPatchData(*args, **kwargs)

Bases: ModelNormal

Incident todo data for a patch request.

Parameters:

attributes (IncidentTodoAttributes) – Incident todo’s attributes.
type (IncidentTodoType) – Todo resource type.

datadog_api_client.v2.model.incident_todo_patch_request module¶

class IncidentTodoPatchRequest(arg: None)¶

class IncidentTodoPatchRequest(arg: ModelComposed)

class IncidentTodoPatchRequest(*args, **kwargs)

Bases: ModelNormal

Patch request for an incident todo.

Parameters:: data (IncidentTodoPatchData) – Incident todo data for a patch request.

datadog_api_client.v2.model.incident_todo_relationships module¶

class IncidentTodoRelationships(arg: None)¶

class IncidentTodoRelationships(arg: ModelComposed)

class IncidentTodoRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships from a response.

Parameters:

created_by_user (RelationshipToUser, optional) – Relationship to user.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.incident_todo_response module¶

class IncidentTodoResponse(arg: None)¶

class IncidentTodoResponse(arg: ModelComposed)

class IncidentTodoResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident todo.

Parameters:

data (IncidentTodoResponseData) – Incident todo response data.
included ([IncidentTodoResponseIncludedItem], optional) – Included related resources that the user requested.

datadog_api_client.v2.model.incident_todo_response_data module¶

class IncidentTodoResponseData(arg: None)¶

class IncidentTodoResponseData(arg: ModelComposed)

class IncidentTodoResponseData(*args, **kwargs)

Bases: ModelNormal

Incident todo response data.

Parameters:

attributes (IncidentTodoAttributes, optional) – Incident todo’s attributes.
id (str) – The incident todo’s ID.
relationships (IncidentTodoRelationships, optional) – The incident’s relationships from a response.
type (IncidentTodoType) – Todo resource type.

datadog_api_client.v2.model.incident_todo_response_included_item module¶

class IncidentTodoResponseIncludedItem(arg: None)¶

class IncidentTodoResponseIncludedItem(arg: ModelComposed)

class IncidentTodoResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an incident todo that is included in the response.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_todo_type module¶

class IncidentTodoType(arg: None)¶

class IncidentTodoType(arg: ModelComposed)

class IncidentTodoType(*args, **kwargs)

Bases: ModelSimple

Todo resource type.

Parameters:

value (str) – If omitted defaults to “incident_todos”. Must be one of [“incident_todos”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_trigger module¶

class IncidentTrigger(arg: None)¶

class IncidentTrigger(arg: ModelComposed)

class IncidentTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.incident_trigger_wrapper module¶

class IncidentTriggerWrapper(arg: None)¶

class IncidentTriggerWrapper(arg: ModelComposed)

class IncidentTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for an Incident-based trigger.

Parameters:

incident_trigger (IncidentTrigger) – Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.incident_type module¶

class IncidentType(arg: None)¶

class IncidentType(arg: ModelComposed)

class IncidentType(*args, **kwargs)

Bases: ModelSimple

Incident resource type.

Parameters:

value (str) – If omitted defaults to “incidents”. Must be one of [“incidents”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_type_attributes module¶

class IncidentTypeAttributes(arg: None)¶

class IncidentTypeAttributes(arg: ModelComposed)

class IncidentTypeAttributes(*args, **kwargs)

Bases: ModelNormal

Incident type’s attributes.

Parameters:

created_at (datetime, optional) – Timestamp when the incident type was created.
created_by (str, optional) – A unique identifier that represents the user that created the incident type.
description (str, optional) – Text that describes the incident type.
is_default (bool, optional) – If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
last_modified_by (str, optional) – A unique identifier that represents the user that last modified the incident type.
modified_at (datetime, optional) – Timestamp when the incident type was last modified.
name (str) – The name of the incident type.
prefix (str, optional) – The string that will be prepended to the incident title across the Datadog app.

datadog_api_client.v2.model.incident_type_create_data module¶

class IncidentTypeCreateData(arg: None)¶

class IncidentTypeCreateData(arg: ModelComposed)

class IncidentTypeCreateData(*args, **kwargs)

Bases: ModelNormal

Incident type data for a create request.

Parameters:

attributes (IncidentTypeAttributes) – Incident type’s attributes.
type (IncidentTypeType) – Incident type resource type.

datadog_api_client.v2.model.incident_type_create_request module¶

class IncidentTypeCreateRequest(arg: None)¶

class IncidentTypeCreateRequest(arg: ModelComposed)

class IncidentTypeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident type.

Parameters:: data (IncidentTypeCreateData) – Incident type data for a create request.

datadog_api_client.v2.model.incident_type_list_response module¶

class IncidentTypeListResponse(arg: None)¶

class IncidentTypeListResponse(arg: ModelComposed)

class IncidentTypeListResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident types.

Parameters:: data ([IncidentTypeObject]) – An array of incident type objects.

datadog_api_client.v2.model.incident_type_object module¶

class IncidentTypeObject(arg: None)¶

class IncidentTypeObject(arg: ModelComposed)

class IncidentTypeObject(*args, **kwargs)

Bases: ModelNormal

Incident type response data.

Parameters:

attributes (IncidentTypeAttributes, optional) – Incident type’s attributes.
id (str) – The incident type’s ID.
relationships (IncidentTypeRelationships, optional) – The incident type’s resource relationships.
type (IncidentTypeType) – Incident type resource type.

datadog_api_client.v2.model.incident_type_patch_data module¶

class IncidentTypePatchData(arg: None)¶

class IncidentTypePatchData(arg: ModelComposed)

class IncidentTypePatchData(*args, **kwargs)

Bases: ModelNormal

Incident type data for a patch request.

Parameters:

attributes (IncidentTypeUpdateAttributes) – Incident type’s attributes for updates.
id (str) – The incident type’s ID.
type (IncidentTypeType) – Incident type resource type.

datadog_api_client.v2.model.incident_type_patch_request module¶

class IncidentTypePatchRequest(arg: None)¶

class IncidentTypePatchRequest(arg: ModelComposed)

class IncidentTypePatchRequest(*args, **kwargs)

Bases: ModelNormal

Patch request for an incident type.

Parameters:: data (IncidentTypePatchData) – Incident type data for a patch request.

datadog_api_client.v2.model.incident_type_relationships module¶

class IncidentTypeRelationships(arg: None)¶

class IncidentTypeRelationships(arg: ModelComposed)

class IncidentTypeRelationships(*args, **kwargs)

Bases: ModelNormal

The incident type’s resource relationships.

Parameters:

created_by_user (RelationshipToUser, optional) – Relationship to user.
google_meet_configuration (GoogleMeetConfigurationReference, none_type, optional) – A reference to a Google Meet Configuration resource.
last_modified_by_user (RelationshipToUser, optional) – Relationship to user.
microsoft_teams_configuration (MicrosoftTeamsConfigurationReference, none_type, optional) – A reference to a Microsoft Teams Configuration resource.
zoom_configuration (ZoomConfigurationReference, none_type, optional) – A reference to a Zoom configuration resource.

datadog_api_client.v2.model.incident_type_response module¶

class IncidentTypeResponse(arg: None)¶

class IncidentTypeResponse(arg: ModelComposed)

class IncidentTypeResponse(*args, **kwargs)

Bases: ModelNormal

Incident type response data.

Parameters:: data (IncidentTypeObject) – Incident type response data.

datadog_api_client.v2.model.incident_type_type module¶

class IncidentTypeType(arg: None)¶

class IncidentTypeType(arg: ModelComposed)

class IncidentTypeType(*args, **kwargs)

Bases: ModelSimple

Incident type resource type.

Parameters:

value (str) – If omitted defaults to “incident_types”. Must be one of [“incident_types”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incident_type_update_attributes module¶

class IncidentTypeUpdateAttributes(arg: None)¶

class IncidentTypeUpdateAttributes(arg: ModelComposed)

class IncidentTypeUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Incident type’s attributes for updates.

Parameters:

created_at (datetime, optional) – Timestamp when the incident type was created.
created_by (str, optional) – A unique identifier that represents the user that created the incident type.
description (str, optional) – Text that describes the incident type.
is_default (bool, optional) – When true, this incident type will be used as the default type when an incident type is not specified.
last_modified_by (str, optional) – A unique identifier that represents the user that last modified the incident type.
modified_at (datetime, optional) – Timestamp when the incident type was last modified.
name (str, optional) – The name of the incident type.
prefix (str, optional) – The string that will be prepended to the incident title across the Datadog app.

datadog_api_client.v2.model.incident_update_attributes module¶

class IncidentUpdateAttributes(arg: None)¶

class IncidentUpdateAttributes(arg: ModelComposed)

class IncidentUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident’s attributes for an update request.

Parameters:

customer_impact_end (datetime, none_type, optional) – Timestamp when customers were no longer impacted by the incident.
customer_impact_scope (str, optional) – A summary of the impact customers experienced during the incident.
customer_impact_start (datetime, none_type, optional) – Timestamp when customers began being impacted by the incident.
customer_impacted (bool, optional) – A flag indicating whether the incident caused customer impact.
detected (datetime, none_type, optional) – Timestamp when the incident was detected.
fields ({str: (IncidentFieldAttributes,)}, optional) – A condensed view of the user-defined fields for which to update selections.
notification_handles ([IncidentNotificationHandle], optional) – Notification handles that will be notified of the incident during update.
title (str, optional) – The title of the incident, which summarizes what happened.

datadog_api_client.v2.model.incident_update_data module¶

class IncidentUpdateData(arg: None)¶

class IncidentUpdateData(arg: ModelComposed)

class IncidentUpdateData(*args, **kwargs)

Bases: ModelNormal

Incident data for an update request.

Parameters:

attributes (IncidentUpdateAttributes, optional) – The incident’s attributes for an update request.
id (str) – The incident’s ID.
relationships (IncidentUpdateRelationships, optional) – The incident’s relationships for an update request.
type (IncidentType) – Incident resource type.

datadog_api_client.v2.model.incident_update_relationships module¶

class IncidentUpdateRelationships(arg: None)¶

class IncidentUpdateRelationships(arg: ModelComposed)

class IncidentUpdateRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships for an update request.

Parameters:

commander_user (NullableRelationshipToUser, none_type, optional) – Relationship to user.
integrations (RelationshipToIncidentIntegrationMetadatas, optional) – A relationship reference for multiple integration metadata objects.
postmortem (RelationshipToIncidentPostmortem, optional) – A relationship reference for postmortems.

datadog_api_client.v2.model.incident_update_request module¶

class IncidentUpdateRequest(arg: None)¶

class IncidentUpdateRequest(arg: ModelComposed)

class IncidentUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for an incident.

Parameters:: data (IncidentUpdateData) – Incident data for an update request.

datadog_api_client.v2.model.incident_user_attributes module¶

class IncidentUserAttributes(arg: None)¶

class IncidentUserAttributes(arg: ModelComposed)

class IncidentUserAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of user object returned by the API.

Parameters:

email (str, optional) – Email of the user.
handle (str, optional) – Handle of the user.
icon (str, optional) – URL of the user’s icon.
name (str, none_type, optional) – Name of the user.
uuid (str, optional) – UUID of the user.

datadog_api_client.v2.model.incident_user_data module¶

class IncidentUserData(arg: None)¶

class IncidentUserData(arg: ModelComposed)

class IncidentUserData(*args, **kwargs)

Bases: ModelNormal

User object returned by the API.

Parameters:

attributes (IncidentUserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.incident_user_defined_field_type module¶

class IncidentUserDefinedFieldType(arg: None)¶

class IncidentUserDefinedFieldType(arg: ModelComposed)

class IncidentUserDefinedFieldType(*args, **kwargs)

Bases: ModelSimple

The incident user defined fields type.

Parameters:

value (str) – If omitted defaults to “user_defined_field”. Must be one of [“user_defined_field”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.incidents_response module¶

class IncidentsResponse(arg: None)¶

class IncidentsResponse(arg: ModelComposed)

class IncidentsResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incidents.

Parameters:

data ([IncidentResponseData]) – An array of incidents.
included ([IncidentResponseIncludedItem], optional) – Included related resources that the user requested.
meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

datadog_api_client.v2.model.include_type module¶

class IncludeType(arg: None)¶

class IncludeType(arg: ModelComposed)

class IncludeType(*args, **kwargs)

Bases: ModelSimple

Supported include types.

Parameters:

value (str) – Must be one of [“schema”, “raw_schema”, “oncall”, “incident”, “relation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.input_schema module¶

class InputSchema(arg: None)¶

class InputSchema(arg: ModelComposed)

class InputSchema(*args, **kwargs)

Bases: ModelNormal

A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.

Parameters:: parameters ([InputSchemaParameters], optional) – The InputSchema parameters.

datadog_api_client.v2.model.input_schema_parameters module¶

class InputSchemaParameters(arg: None)¶

class InputSchemaParameters(arg: ModelComposed)

class InputSchemaParameters(*args, **kwargs)

Bases: ModelNormal

The definition of InputSchemaParameters object.

Parameters:

default_value (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The InputSchemaParameters defaultValue.
description (str, optional) – The InputSchemaParameters description.
label (str, optional) – The InputSchemaParameters label.
name (str) – The InputSchemaParameters name.
type (InputSchemaParametersType) – The definition of InputSchemaParametersType object.

datadog_api_client.v2.model.input_schema_parameters_type module¶

class InputSchemaParametersType(arg: None)¶

class InputSchemaParametersType(arg: ModelComposed)

class InputSchemaParametersType(*args, **kwargs)

Bases: ModelSimple

The definition of InputSchemaParametersType object.

Parameters:

value (str) – Must be one of [“STRING”, “NUMBER”, “BOOLEAN”, “OBJECT”, “ARRAY_STRING”, “ARRAY_NUMBER”, “ARRAY_BOOLEAN”, “ARRAY_OBJECT”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.intake_payload_accepted module¶

class IntakePayloadAccepted(arg: None)¶

class IntakePayloadAccepted(arg: ModelComposed)

class IntakePayloadAccepted(*args, **kwargs)

Bases: ModelNormal

The payload accepted for intake.

Parameters:: errors ([str], optional) – A list of errors.

datadog_api_client.v2.model.interface_attributes module¶

class InterfaceAttributes(arg: None)¶

class InterfaceAttributes(arg: ModelComposed)

class InterfaceAttributes(*args, **kwargs)

Bases: ModelNormal

The interface attributes

Parameters:

alias (str, optional) – The interface alias
description (str, optional) – The interface description
index (int, optional) – The interface index
ip_addresses ([str], optional) – The interface IP addresses
mac_address (str, optional) – The interface MAC address
name (str, optional) – The interface name
status (InterfaceAttributesStatus, optional) – The interface status

datadog_api_client.v2.model.interface_attributes_status module¶

class InterfaceAttributesStatus(arg: None)¶

class InterfaceAttributesStatus(arg: ModelComposed)

class InterfaceAttributesStatus(*args, **kwargs)

Bases: ModelSimple

The interface status

Parameters:

value (str) – Must be one of [“up”, “down”, “warning”, “off”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ip_allowlist_attributes module¶

class IPAllowlistAttributes(arg: None)¶

class IPAllowlistAttributes(arg: ModelComposed)

class IPAllowlistAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the IP allowlist.

Parameters:

enabled (bool, optional) – Whether the IP allowlist logic is enabled or not.
entries ([IPAllowlistEntry], optional) – Array of entries in the IP allowlist.

datadog_api_client.v2.model.ip_allowlist_data module¶

class IPAllowlistData(arg: None)¶

class IPAllowlistData(arg: ModelComposed)

class IPAllowlistData(*args, **kwargs)

Bases: ModelNormal

IP allowlist data.

Parameters:

attributes (IPAllowlistAttributes, optional) – Attributes of the IP allowlist.
id (str, optional) – The unique identifier of the org.
type (IPAllowlistType) – IP allowlist type.

datadog_api_client.v2.model.ip_allowlist_entry module¶

class IPAllowlistEntry(arg: None)¶

class IPAllowlistEntry(arg: ModelComposed)

class IPAllowlistEntry(*args, **kwargs)

Bases: ModelNormal

IP allowlist entry object.

Parameters:: data (IPAllowlistEntryData) – Data of the IP allowlist entry object.

datadog_api_client.v2.model.ip_allowlist_entry_attributes module¶

class IPAllowlistEntryAttributes(arg: None)¶

class IPAllowlistEntryAttributes(arg: ModelComposed)

class IPAllowlistEntryAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the IP allowlist entry.

Parameters:

cidr_block (str, optional) – The CIDR block describing the IP range of the entry.
created_at (datetime, optional) – Creation time of the entry.
modified_at (datetime, optional) – Time of last entry modification.
note (str, optional) – A note describing the IP allowlist entry.

datadog_api_client.v2.model.ip_allowlist_entry_data module¶

class IPAllowlistEntryData(arg: None)¶

class IPAllowlistEntryData(arg: ModelComposed)

class IPAllowlistEntryData(*args, **kwargs)

Bases: ModelNormal

Data of the IP allowlist entry object.

Parameters:

attributes (IPAllowlistEntryAttributes, optional) – Attributes of the IP allowlist entry.
id (str, optional) – The unique identifier of the IP allowlist entry.
type (IPAllowlistEntryType) – IP allowlist Entry type.

datadog_api_client.v2.model.ip_allowlist_entry_type module¶

class IPAllowlistEntryType(arg: None)¶

class IPAllowlistEntryType(arg: ModelComposed)

class IPAllowlistEntryType(*args, **kwargs)

Bases: ModelSimple

IP allowlist Entry type.

Parameters:

value (str) – If omitted defaults to “ip_allowlist_entry”. Must be one of [“ip_allowlist_entry”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ip_allowlist_response module¶

class IPAllowlistResponse(arg: None)¶

class IPAllowlistResponse(arg: ModelComposed)

class IPAllowlistResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about the IP allowlist.

Parameters:: data (IPAllowlistData, optional) – IP allowlist data.

datadog_api_client.v2.model.ip_allowlist_type module¶

class IPAllowlistType(arg: None)¶

class IPAllowlistType(arg: ModelComposed)

class IPAllowlistType(*args, **kwargs)

Bases: ModelSimple

IP allowlist type.

Parameters:

value (str) – If omitted defaults to “ip_allowlist”. Must be one of [“ip_allowlist”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ip_allowlist_update_request module¶

class IPAllowlistUpdateRequest(arg: None)¶

class IPAllowlistUpdateRequest(arg: ModelComposed)

class IPAllowlistUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update the IP allowlist.

Parameters:: data (IPAllowlistData) – IP allowlist data.

datadog_api_client.v2.model.issue module¶

class Issue(arg: None)¶

class Issue(arg: ModelComposed)

class Issue(*args, **kwargs)

Bases: ModelNormal

The issue matching the request.

Parameters:

attributes (IssueAttributes) – Object containing the information of an issue.
id (str) – Issue identifier.
relationships (IssueRelationships, optional) – Relationship between the issue and an assignee, case and/or teams.
type (IssueType) – Type of the object.

datadog_api_client.v2.model.issue_assignee_relationship module¶

class IssueAssigneeRelationship(arg: None)¶

class IssueAssigneeRelationship(arg: ModelComposed)

class IssueAssigneeRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship between the issue and assignee.

Parameters:: data (IssueUserReference) – The user the issue is assigned to.

datadog_api_client.v2.model.issue_attributes module¶

class IssueAttributes(arg: None)¶

class IssueAttributes(arg: ModelComposed)

class IssueAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the information of an issue.

Parameters:

error_message (str, optional) – Error message associated with the issue.
error_type (str, optional) – Type of the error that matches the issue.
file_path (str, optional) – Path of the file where the issue occurred.
first_seen (int, optional) – Timestamp of the first seen error in milliseconds since the Unix epoch.
first_seen_version (str, optional) – The application version (for example, git commit hash) where the issue was first observed.
function_name (str, optional) – Name of the function where the issue occurred.
is_crash (bool, optional) – Error is a crash.
languages ([IssueLanguage], optional) – Array of programming languages associated with the issue.
last_seen (int, optional) – Timestamp of the last seen error in milliseconds since the Unix epoch.
last_seen_version (str, optional) – The application version (for example, git commit hash) where the issue was last observed.
platform (IssuePlatform, optional) – Platform associated with the issue.
service (str, optional) – Service name.
state (IssueState, optional) – State of the issue

datadog_api_client.v2.model.issue_case module¶

class IssueCase(arg: None)¶

class IssueCase(arg: ModelComposed)

class IssueCase(*args, **kwargs)

Bases: ModelNormal

The case attached to the issue.

Parameters:

attributes (IssueCaseAttributes) – Object containing the information of a case.
id (str) – Case identifier.
relationships (IssueCaseRelationships, optional) – Resources related to a case.
type (IssueCaseResourceType) – Type of the object.

datadog_api_client.v2.model.issue_case_attributes module¶

class IssueCaseAttributes(arg: None)¶

class IssueCaseAttributes(arg: ModelComposed)

class IssueCaseAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the information of a case.

Parameters:

archived_at (datetime, optional) – Timestamp of when the case was archived.
closed_at (datetime, optional) – Timestamp of when the case was closed.
created_at (datetime, optional) – Timestamp of when the case was created.
creation_source (str, optional) – Source of the case creation.
description (str, optional) – Description of the case.
due_date (str, optional) – Due date of the case.
insights ([IssueCaseInsight], optional) – Insights of the case.
jira_issue (IssueCaseJiraIssue, optional) – Jira issue of the case.
key (str, optional) – Key of the case.
modified_at (datetime, optional) – Timestamp of when the case was last modified.
priority (CasePriority, optional) – Case priority
status (CaseStatus, optional) – Case status
title (str, optional) – Title of the case.
type (str, optional) – Type of the case.

datadog_api_client.v2.model.issue_case_insight module¶

class IssueCaseInsight(arg: None)¶

class IssueCaseInsight(arg: ModelComposed)

class IssueCaseInsight(*args, **kwargs)

Bases: ModelNormal

Insight of the case.

Parameters:

ref (str, optional) – Reference of the insight.
resource_id (str, optional) – Insight identifier.
type (str, optional) – Type of the insight.

datadog_api_client.v2.model.issue_case_jira_issue module¶

class IssueCaseJiraIssue(arg: None)¶

class IssueCaseJiraIssue(arg: ModelComposed)

class IssueCaseJiraIssue(*args, **kwargs)

Bases: ModelNormal

Jira issue of the case.

Parameters:

result (IssueCaseJiraIssueResult, optional) – Contains the identifiers and URL for a successfully created Jira issue.
status (str, optional) – Creation status of the Jira issue.

datadog_api_client.v2.model.issue_case_jira_issue_result module¶

class IssueCaseJiraIssueResult(arg: None)¶

class IssueCaseJiraIssueResult(arg: ModelComposed)

class IssueCaseJiraIssueResult(*args, **kwargs)

Bases: ModelNormal

Contains the identifiers and URL for a successfully created Jira issue.

Parameters:

issue_id (str, optional) – Jira issue identifier.
issue_key (str, optional) – Jira issue key.
issue_url (str, optional) – Jira issue URL.
project_key (str, optional) – Jira project key.

datadog_api_client.v2.model.issue_case_reference module¶

class IssueCaseReference(arg: None)¶

class IssueCaseReference(arg: ModelComposed)

class IssueCaseReference(*args, **kwargs)

Bases: ModelNormal

The case the issue is attached to.

Parameters:

id (str) – Case identifier.
type (IssueCaseResourceType) – Type of the object.

datadog_api_client.v2.model.issue_case_relationship module¶

class IssueCaseRelationship(arg: None)¶

class IssueCaseRelationship(arg: ModelComposed)

class IssueCaseRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship between the issue and case.

Parameters:: data (IssueCaseReference) – The case the issue is attached to.

datadog_api_client.v2.model.issue_case_relationships module¶

class IssueCaseRelationships(arg: None)¶

class IssueCaseRelationships(arg: ModelComposed)

class IssueCaseRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to a case.

Parameters:

assignee (NullableUserRelationship, none_type, optional) – Relationship to user.
created_by (NullableUserRelationship, none_type, optional) – Relationship to user.
modified_by (NullableUserRelationship, none_type, optional) – Relationship to user.
project (ProjectRelationship, optional) – Relationship to project

datadog_api_client.v2.model.issue_case_resource_type module¶

class IssueCaseResourceType(arg: None)¶

class IssueCaseResourceType(arg: ModelComposed)

class IssueCaseResourceType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “case”. Must be one of [“case”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_included module¶

class IssueIncluded(arg: None)¶

class IssueIncluded(arg: ModelComposed)

class IssueIncluded(*args, **kwargs)

Bases: ModelComposed

An array of related resources, returned when the include query parameter is used.

Parameters:

attributes (IssueCaseAttributes) – Object containing the information of a case.
id (str) – Case identifier.
relationships (IssueCaseRelationships, optional) – Resources related to a case.
type (IssueCaseResourceType) – Type of the object.

datadog_api_client.v2.model.issue_language module¶

class IssueLanguage(arg: None)¶

class IssueLanguage(arg: ModelComposed)

class IssueLanguage(*args, **kwargs)

Bases: ModelSimple

Programming language associated with the issue.

Parameters:

value (str) – Must be one of [“BRIGHTSCRIPT”, “C”, “C_PLUS_PLUS”, “C_SHARP”, “CLOJURE”, “DOT_NET”, “ELIXIR”, “ERLANG”, “GO”, “GROOVY”, “HASKELL”, “HCL”, “JAVA”, “JAVASCRIPT”, “JVM”, “KOTLIN”, “OBJECTIVE_C”, “PERL”, “PHP”, “PYTHON”, “RUBY”, “RUST”, “SCALA”, “SWIFT”, “TERRAFORM”, “TYPESCRIPT”, “UNKNOWN”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_platform module¶

class IssuePlatform(arg: None)¶

class IssuePlatform(arg: ModelComposed)

class IssuePlatform(*args, **kwargs)

Bases: ModelSimple

Platform associated with the issue.

Parameters:

value (str) – Must be one of [“ANDROID”, “BACKEND”, “BROWSER”, “FLUTTER”, “IOS”, “REACT_NATIVE”, “ROKU”, “UNKNOWN”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_reference module¶

class IssueReference(arg: None)¶

class IssueReference(arg: ModelComposed)

class IssueReference(*args, **kwargs)

Bases: ModelNormal

The issue the search result corresponds to.

Parameters:

id (str) – Issue identifier.
type (IssueType) – Type of the object.

datadog_api_client.v2.model.issue_relationships module¶

class IssueRelationships(arg: None)¶

class IssueRelationships(arg: ModelComposed)

class IssueRelationships(*args, **kwargs)

Bases: ModelNormal

Relationship between the issue and an assignee, case and/or teams.

Parameters:

assignee (IssueAssigneeRelationship, optional) – Relationship between the issue and assignee.
case (IssueCaseRelationship, optional) – Relationship between the issue and case.
team_owners (IssueTeamOwnersRelationship, optional) – Relationship between the issue and teams.

datadog_api_client.v2.model.issue_response module¶

class IssueResponse(arg: None)¶

class IssueResponse(arg: ModelComposed)

class IssueResponse(*args, **kwargs)

Bases: ModelNormal

Response containing error tracking issue data.

Parameters:

data (Issue, optional) – The issue matching the request.
included ([IssueIncluded], optional) – Array of resources related to the issue.

datadog_api_client.v2.model.issue_state module¶

class IssueState(arg: None)¶

class IssueState(arg: ModelComposed)

class IssueState(*args, **kwargs)

Bases: ModelSimple

State of the issue

Parameters:

value (str) – Must be one of [“OPEN”, “ACKNOWLEDGED”, “RESOLVED”, “IGNORED”, “EXCLUDED”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_team module¶

class IssueTeam(arg: None)¶

class IssueTeam(arg: ModelComposed)

class IssueTeam(*args, **kwargs)

Bases: ModelNormal

A team that owns an issue.

Parameters:

attributes (IssueTeamAttributes) – Object containing the information of a team.
id (str) – Team identifier.
type (IssueTeamType) – Type of the object.

datadog_api_client.v2.model.issue_team_attributes module¶

class IssueTeamAttributes(arg: None)¶

class IssueTeamAttributes(arg: ModelComposed)

class IssueTeamAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the information of a team.

Parameters:

handle (str, optional) – The team’s identifier.
name (str, optional) – The name of the team.
summary (str, optional) – A brief summary of the team, derived from its description.

datadog_api_client.v2.model.issue_team_owners_relationship module¶

class IssueTeamOwnersRelationship(arg: None)¶

class IssueTeamOwnersRelationship(arg: ModelComposed)

class IssueTeamOwnersRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship between the issue and teams.

Parameters:: data ([IssueTeamReference]) – Array of teams that are owners of the issue.

datadog_api_client.v2.model.issue_team_reference module¶

class IssueTeamReference(arg: None)¶

class IssueTeamReference(arg: ModelComposed)

class IssueTeamReference(*args, **kwargs)

Bases: ModelNormal

A team that owns the issue.

Parameters:

id (str) – Team identifier.
type (IssueTeamType) – Type of the object.

datadog_api_client.v2.model.issue_team_type module¶

class IssueTeamType(arg: None)¶

class IssueTeamType(arg: ModelComposed)

class IssueTeamType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “team”. Must be one of [“team”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_type module¶

class IssueType(arg: None)¶

class IssueType(arg: ModelComposed)

class IssueType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “issue”. Must be one of [“issue”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_update_assignee_request module¶

class IssueUpdateAssigneeRequest(arg: None)¶

class IssueUpdateAssigneeRequest(arg: ModelComposed)

class IssueUpdateAssigneeRequest(*args, **kwargs)

Bases: ModelNormal

Update issue assignee request payload.

Parameters:: data (IssueUpdateAssigneeRequestData) – Update issue assignee request.

datadog_api_client.v2.model.issue_update_assignee_request_data module¶

class IssueUpdateAssigneeRequestData(arg: None)¶

class IssueUpdateAssigneeRequestData(arg: ModelComposed)

class IssueUpdateAssigneeRequestData(*args, **kwargs)

Bases: ModelNormal

Update issue assignee request.

Parameters:

id (str) – User identifier.
type (IssueUpdateAssigneeRequestDataType) – Type of the object.

datadog_api_client.v2.model.issue_update_assignee_request_data_type module¶

class IssueUpdateAssigneeRequestDataType(arg: None)¶

class IssueUpdateAssigneeRequestDataType(arg: ModelComposed)

class IssueUpdateAssigneeRequestDataType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “assignee”. Must be one of [“assignee”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_update_state_request module¶

class IssueUpdateStateRequest(arg: None)¶

class IssueUpdateStateRequest(arg: ModelComposed)

class IssueUpdateStateRequest(*args, **kwargs)

Bases: ModelNormal

Update issue state request payload.

Parameters:: data (IssueUpdateStateRequestData) – Update issue state request.

datadog_api_client.v2.model.issue_update_state_request_data module¶

class IssueUpdateStateRequestData(arg: None)¶

class IssueUpdateStateRequestData(arg: ModelComposed)

class IssueUpdateStateRequestData(*args, **kwargs)

Bases: ModelNormal

Update issue state request.

Parameters:

attributes (IssueUpdateStateRequestDataAttributes) – Object describing an issue state update request.
id (str) – Issue identifier.
type (IssueUpdateStateRequestDataType) – Type of the object.

datadog_api_client.v2.model.issue_update_state_request_data_attributes module¶

class IssueUpdateStateRequestDataAttributes(arg: None)¶

class IssueUpdateStateRequestDataAttributes(arg: ModelComposed)

class IssueUpdateStateRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Object describing an issue state update request.

Parameters:: state (IssueState) – State of the issue

datadog_api_client.v2.model.issue_update_state_request_data_type module¶

class IssueUpdateStateRequestDataType(arg: None)¶

class IssueUpdateStateRequestDataType(arg: ModelComposed)

class IssueUpdateStateRequestDataType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “error_tracking_issue”. Must be one of [“error_tracking_issue”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issue_user module¶

class IssueUser(arg: None)¶

class IssueUser(arg: ModelComposed)

class IssueUser(*args, **kwargs)

Bases: ModelNormal

The user to whom the issue is assigned.

Parameters:

attributes (IssueUserAttributes) – Object containing the information of a user.
id (str) – User identifier.
type (IssueUserType) – Type of the object

datadog_api_client.v2.model.issue_user_attributes module¶

class IssueUserAttributes(arg: None)¶

class IssueUserAttributes(arg: ModelComposed)

class IssueUserAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the information of a user.

Parameters:

email (str, optional) – Email of the user.
handle (str, optional) – Handle of the user.
name (str, optional) – Name of the user.

datadog_api_client.v2.model.issue_user_reference module¶

class IssueUserReference(arg: None)¶

class IssueUserReference(arg: ModelComposed)

class IssueUserReference(*args, **kwargs)

Bases: ModelNormal

The user the issue is assigned to.

Parameters:

id (str) – User identifier.
type (IssueUserType) – Type of the object

datadog_api_client.v2.model.issue_user_type module¶

class IssueUserType(arg: None)¶

class IssueUserType(arg: ModelComposed)

class IssueUserType(*args, **kwargs)

Bases: ModelSimple

Type of the object

Parameters:

value (str) – If omitted defaults to “user”. Must be one of [“user”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issues_search_request module¶

class IssuesSearchRequest(arg: None)¶

class IssuesSearchRequest(arg: ModelComposed)

class IssuesSearchRequest(*args, **kwargs)

Bases: ModelNormal

Search issues request payload.

Parameters:: data (IssuesSearchRequestData) – Search issues request.

datadog_api_client.v2.model.issues_search_request_data module¶

class IssuesSearchRequestData(arg: None)¶

class IssuesSearchRequestData(arg: ModelComposed)

class IssuesSearchRequestData(*args, **kwargs)

Bases: ModelNormal

Search issues request.

Parameters:

attributes (IssuesSearchRequestDataAttributes) – Object describing a search issue request.
type (IssuesSearchRequestDataType) – Type of the object.

datadog_api_client.v2.model.issues_search_request_data_attributes module¶

class IssuesSearchRequestDataAttributes(arg: None)¶

class IssuesSearchRequestDataAttributes(arg: ModelComposed)

class IssuesSearchRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Object describing a search issue request.

Parameters:

_from (int) – Start date (inclusive) of the query in milliseconds since the Unix epoch.
order_by (IssuesSearchRequestDataAttributesOrderBy, optional) – The attribute to sort the search results by.
persona (IssuesSearchRequestDataAttributesPersona, optional) – Persona for the search. Either track(s) or persona(s) must be specified.
query (str) – Search query following the event search syntax.
to (int) – End date (exclusive) of the query in milliseconds since the Unix epoch.
track (IssuesSearchRequestDataAttributesTrack, optional) – Track of the events to query. Either track(s) or persona(s) must be specified.

datadog_api_client.v2.model.issues_search_request_data_attributes_order_by module¶

class IssuesSearchRequestDataAttributesOrderBy(arg: None)¶

class IssuesSearchRequestDataAttributesOrderBy(arg: ModelComposed)

class IssuesSearchRequestDataAttributesOrderBy(*args, **kwargs)

Bases: ModelSimple

The attribute to sort the search results by.

Parameters:

value (str) – Must be one of [“TOTAL_COUNT”, “FIRST_SEEN”, “IMPACTED_SESSIONS”, “PRIORITY”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issues_search_request_data_attributes_persona module¶

class IssuesSearchRequestDataAttributesPersona(arg: None)¶

class IssuesSearchRequestDataAttributesPersona(arg: ModelComposed)

class IssuesSearchRequestDataAttributesPersona(*args, **kwargs)

Bases: ModelSimple

Persona for the search. Either track(s) or persona(s) must be specified.

Parameters:

value (str) – Must be one of [“ALL”, “BROWSER”, “MOBILE”, “BACKEND”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issues_search_request_data_attributes_track module¶

class IssuesSearchRequestDataAttributesTrack(arg: None)¶

class IssuesSearchRequestDataAttributesTrack(arg: ModelComposed)

class IssuesSearchRequestDataAttributesTrack(*args, **kwargs)

Bases: ModelSimple

Track of the events to query. Either track(s) or persona(s) must be specified.

Parameters:

value (str) – Must be one of [“trace”, “logs”, “rum”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issues_search_request_data_type module¶

class IssuesSearchRequestDataType(arg: None)¶

class IssuesSearchRequestDataType(arg: ModelComposed)

class IssuesSearchRequestDataType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “search_request”. Must be one of [“search_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.issues_search_response module¶

class IssuesSearchResponse(arg: None)¶

class IssuesSearchResponse(arg: ModelComposed)

class IssuesSearchResponse(*args, **kwargs)

Bases: ModelNormal

Search issues response payload.

Parameters:

data ([IssuesSearchResult], optional) – Array of results matching the search query.
included ([IssuesSearchResultIncluded], optional) – Array of resources related to the search results.

datadog_api_client.v2.model.issues_search_result module¶

class IssuesSearchResult(arg: None)¶

class IssuesSearchResult(arg: ModelComposed)

class IssuesSearchResult(*args, **kwargs)

Bases: ModelNormal

Result matching the search query.

Parameters:

attributes (IssuesSearchResultAttributes) – Object containing the information of a search result.
id (str) – Search result identifier (matches the nested issue’s identifier).
relationships (IssuesSearchResultRelationships, optional) – Relationships between the search result and other resources.
type (IssuesSearchResultType) – Type of the object.

datadog_api_client.v2.model.issues_search_result_attributes module¶

class IssuesSearchResultAttributes(arg: None)¶

class IssuesSearchResultAttributes(arg: ModelComposed)

class IssuesSearchResultAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the information of a search result.

Parameters:

impacted_sessions (int, optional) – Count of sessions impacted by the issue over the queried time window.
impacted_users (int, optional) – Count of users impacted by the issue over the queried time window.
total_count (int, optional) – Total count of errors that match the issue over the queried time window.

datadog_api_client.v2.model.issues_search_result_included module¶

class IssuesSearchResultIncluded(arg: None)¶

class IssuesSearchResultIncluded(arg: ModelComposed)

class IssuesSearchResultIncluded(*args, **kwargs)

Bases: ModelComposed

An array of related resources, returned when the include query parameter is used.

Parameters:

attributes (IssueAttributes) – Object containing the information of an issue.
id (str) – Issue identifier.
relationships (IssueRelationships, optional) – Relationship between the issue and an assignee, case and/or teams.
type (IssueType) – Type of the object.

datadog_api_client.v2.model.issues_search_result_issue_relationship module¶

class IssuesSearchResultIssueRelationship(arg: None)¶

class IssuesSearchResultIssueRelationship(arg: ModelComposed)

class IssuesSearchResultIssueRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship between the search result and the corresponding issue.

Parameters:: data (IssueReference) – The issue the search result corresponds to.

datadog_api_client.v2.model.issues_search_result_relationships module¶

class IssuesSearchResultRelationships(arg: None)¶

class IssuesSearchResultRelationships(arg: ModelComposed)

class IssuesSearchResultRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships between the search result and other resources.

Parameters:: issue (IssuesSearchResultIssueRelationship, optional) – Relationship between the search result and the corresponding issue.

datadog_api_client.v2.model.issues_search_result_type module¶

class IssuesSearchResultType(arg: None)¶

class IssuesSearchResultType(arg: ModelComposed)

class IssuesSearchResultType(*args, **kwargs)

Bases: ModelSimple

Type of the object.

Parameters:

value (str) – If omitted defaults to “error_tracking_search_result”. Must be one of [“error_tracking_search_result”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.item_api_payload module¶

class ItemApiPayload(arg: None)¶

class ItemApiPayload(arg: ModelComposed)

class ItemApiPayload(*args, **kwargs)

Bases: ModelNormal

A single datastore item with its content and metadata.

Parameters:: data (ItemApiPayloadData, optional) – Core data and metadata for a single datastore item.

datadog_api_client.v2.model.item_api_payload_array module¶

class ItemApiPayloadArray(arg: None)¶

class ItemApiPayloadArray(arg: ModelComposed)

class ItemApiPayloadArray(*args, **kwargs)

Bases: ModelNormal

A collection of datastore items with pagination and schema metadata.

Parameters:

data ([ItemApiPayloadData]) – An array of datastore items with their content and metadata.
meta (ItemApiPayloadMeta, optional) – Additional metadata about a collection of datastore items, including pagination and schema information.

datadog_api_client.v2.model.item_api_payload_data module¶

class ItemApiPayloadData(arg: None)¶

class ItemApiPayloadData(arg: ModelComposed)

class ItemApiPayloadData(*args, **kwargs)

Bases: ModelNormal

Core data and metadata for a single datastore item.

Parameters:

attributes (ItemApiPayloadDataAttributes, optional) – Metadata and content of a datastore item.
id (str, optional) – The unique identifier of the datastore.
type (DatastoreItemsDataType) – The resource type for datastore items.

datadog_api_client.v2.model.item_api_payload_data_attributes module¶

class ItemApiPayloadDataAttributes(arg: None)¶

class ItemApiPayloadDataAttributes(arg: ModelComposed)

class ItemApiPayloadDataAttributes(*args, **kwargs)

Bases: ModelNormal

Metadata and content of a datastore item.

Parameters:

created_at (datetime, optional) – Timestamp when the item was first created.
modified_at (datetime, optional) – Timestamp when the item was last modified.
org_id (int, optional) – The ID of the organization that owns this item.
primary_column_name (str, optional) –
The name of the primary key column for this datastore. Primary column names:
- Must abide by both PostgreSQL naming conventions
- Cannot exceed 63 characters
signature (str, optional) – A unique signature identifying this item version.
store_id (str, optional) – The unique identifier of the datastore containing this item.
value (ItemApiPayloadDataAttributesValue, optional) – The data content (as key-value pairs) of a datastore item.

datadog_api_client.v2.model.item_api_payload_data_attributes_value module¶

class ItemApiPayloadDataAttributesValue(arg: None)¶

class ItemApiPayloadDataAttributesValue(arg: ModelComposed)

class ItemApiPayloadDataAttributesValue(*args, **kwargs)

Bases: ModelNormal

The data content (as key-value pairs) of a datastore item.

datadog_api_client.v2.model.item_api_payload_meta module¶

class ItemApiPayloadMeta(arg: None)¶

class ItemApiPayloadMeta(arg: ModelComposed)

class ItemApiPayloadMeta(*args, **kwargs)

Bases: ModelNormal

Additional metadata about a collection of datastore items, including pagination and schema information.

Parameters:

page (ItemApiPayloadMetaPage, optional) – Pagination information for a collection of datastore items.
schema (ItemApiPayloadMetaSchema, optional) – Schema information about the datastore, including its primary key and field definitions.

datadog_api_client.v2.model.item_api_payload_meta_page module¶

class ItemApiPayloadMetaPage(arg: None)¶

class ItemApiPayloadMetaPage(arg: ModelComposed)

class ItemApiPayloadMetaPage(*args, **kwargs)

Bases: ModelNormal

Pagination information for a collection of datastore items.

Parameters:

has_more (bool, optional) – Whether there are additional pages of items beyond the current page.
total_count (int, optional) – The total number of items in the datastore, ignoring any filters.
total_filtered_count (int, optional) – The total number of items that match the current filter criteria.

datadog_api_client.v2.model.item_api_payload_meta_schema module¶

class ItemApiPayloadMetaSchema(arg: None)¶

class ItemApiPayloadMetaSchema(arg: ModelComposed)

class ItemApiPayloadMetaSchema(*args, **kwargs)

Bases: ModelNormal

Schema information about the datastore, including its primary key and field definitions.

Parameters:

fields ([ItemApiPayloadMetaSchemaField], optional) – An array describing the columns available in this datastore.
primary_key (str, optional) – The name of the primary key column for this datastore.

datadog_api_client.v2.model.item_api_payload_meta_schema_field module¶

class ItemApiPayloadMetaSchemaField(arg: None)¶

class ItemApiPayloadMetaSchemaField(arg: ModelComposed)

class ItemApiPayloadMetaSchemaField(*args, **kwargs)

Bases: ModelNormal

Information about a specific column in the datastore schema.

Parameters:

name (str) – The name of this column in the datastore.
type (str) – The data type of this column. For example, ‘string’, ‘number’, or ‘boolean’.

datadog_api_client.v2.model.jira_integration_metadata module¶

class JiraIntegrationMetadata(arg: None)¶

class JiraIntegrationMetadata(arg: ModelComposed)

class JiraIntegrationMetadata(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata for the Jira integration.

Parameters:: issues ([JiraIntegrationMetadataIssuesItem]) – Array of Jira issues in this integration metadata.

datadog_api_client.v2.model.jira_integration_metadata_issues_item module¶

class JiraIntegrationMetadataIssuesItem(arg: None)¶

class JiraIntegrationMetadataIssuesItem(arg: ModelComposed)

class JiraIntegrationMetadataIssuesItem(*args, **kwargs)

Bases: ModelNormal

Item in the Jira integration metadata issue array.

Parameters:

account (str) – URL of issue’s Jira account.
issue_key (str, optional) – Jira issue’s issue key.
issuetype_id (str, optional) – Jira issue’s issue type.
project_key (str) – Jira issue’s project keys.
redirect_url (str, optional) – URL redirecting to the Jira issue.

datadog_api_client.v2.model.jira_issue module¶

class JiraIssue(arg: None)¶

class JiraIssue(arg: ModelComposed)

class JiraIssue(*args, **kwargs)

Bases: ModelNormal

Jira issue attached to case

Parameters:

result (JiraIssueResult, optional) – Jira issue information
status (Case3rdPartyTicketStatus, optional) – Case status

datadog_api_client.v2.model.jira_issue_result module¶

class JiraIssueResult(arg: None)¶

class JiraIssueResult(arg: ModelComposed)

class JiraIssueResult(*args, **kwargs)

Bases: ModelNormal

Jira issue information

Parameters:

issue_id (str, optional) – Jira issue ID
issue_key (str, optional) – Jira issue key
issue_url (str, optional) – Jira issue URL
project_key (str, optional) – Jira project key

datadog_api_client.v2.model.job_create_response module¶

class JobCreateResponse(arg: None)¶

class JobCreateResponse(arg: ModelComposed)

class JobCreateResponse(*args, **kwargs)

Bases: ModelNormal

Run a threat hunting job response.

Parameters:: data (JobCreateResponseData, optional) – The definition of JobCreateResponseData object.

datadog_api_client.v2.model.job_create_response_data module¶

class JobCreateResponseData(arg: None)¶

class JobCreateResponseData(arg: ModelComposed)

class JobCreateResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of JobCreateResponseData object.

Parameters:

id (str, optional) – ID of the created job.
type (ThreatHuntingJobDataType, optional) – Type of payload.

datadog_api_client.v2.model.job_definition module¶

class JobDefinition(arg: None)¶

class JobDefinition(arg: ModelComposed)

class JobDefinition(*args, **kwargs)

Bases: ModelNormal

Definition of a threat hunting job.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases used for generating job results.
_from (int) – Starting time of data analyzed by the job.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
index (str) – Index used to load the data.
message (str) – Message for generated results.
name (str) – Job name.
options (ThreatHuntingJobOptions, optional) – Job options.
queries ([ThreatHuntingJobQuery]) – Queries for selecting logs analyzed by the job.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables used in the queries.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating results from third-party detection method. Only available for third-party detection method.
to (int) – Ending time of data analyzed by the job.
type (str, optional) – Job type.

datadog_api_client.v2.model.job_definition_from_rule module¶

class JobDefinitionFromRule(arg: None)¶

class JobDefinitionFromRule(arg: ModelComposed)

class JobDefinitionFromRule(*args, **kwargs)

Bases: ModelNormal

Definition of a threat hunting job based on a security monitoring rule.

Parameters:

_from (int) – Starting time of data analyzed by the job.
id (str) – ID of the detection rule used to create the job.
index (str) – Index used to load the data.
notifications ([str], optional) – Notifications sent when the job is completed.
to (int) – Ending time of data analyzed by the job.

datadog_api_client.v2.model.jsonapi_error_item module¶

class JSONAPIErrorItem(arg: None)¶

class JSONAPIErrorItem(arg: ModelComposed)

class JSONAPIErrorItem(*args, **kwargs)

Bases: ModelNormal

API error response body

Parameters:

detail (str, optional) – A human-readable explanation specific to this occurrence of the error.
meta ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Non-standard meta-information about the error
source (JSONAPIErrorItemSource, optional) – References to the source of the error.
status (str, optional) – Status code of the response.
title (str, optional) – Short human-readable summary of the error.

datadog_api_client.v2.model.jsonapi_error_item_source module¶

class JSONAPIErrorItemSource(arg: None)¶

class JSONAPIErrorItemSource(arg: ModelComposed)

class JSONAPIErrorItemSource(*args, **kwargs)

Bases: ModelNormal

References to the source of the error.

Parameters:

header (str, optional) – A string indicating the name of a single request header which caused the error.
parameter (str, optional) – A string indicating which URI query parameter caused the error.
pointer (str, optional) – A JSON pointer to the value in the request document that caused the error.

datadog_api_client.v2.model.jsonapi_error_response module¶

class JSONAPIErrorResponse(arg: None)¶

class JSONAPIErrorResponse(arg: ModelComposed)

class JSONAPIErrorResponse(*args, **kwargs)

Bases: ModelNormal

API error response.

Parameters:: errors ([JSONAPIErrorItem]) – A list of errors.

datadog_api_client.v2.model.kind_attributes module¶

class KindAttributes(arg: None)¶

class KindAttributes(arg: ModelComposed)

class KindAttributes(*args, **kwargs)

Bases: ModelNormal

Kind attributes.

Parameters:

description (str, optional) – Short description of the kind.
display_name (str, optional) – User friendly name of the kind.
name (str, optional) – The kind name.

datadog_api_client.v2.model.kind_data module¶

class KindData(arg: None)¶

class KindData(arg: ModelComposed)

class KindData(*args, **kwargs)

Bases: ModelNormal

Schema that defines the structure of a Kind object in the Software Catalog.

Parameters:

attributes (KindAttributes, optional) – Kind attributes.
id (str, optional) – A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
meta (KindMetadata, optional) – Kind metadata.
type (str, optional) – Kind.

datadog_api_client.v2.model.kind_metadata module¶

class KindMetadata(arg: None)¶

class KindMetadata(arg: ModelComposed)

class KindMetadata(*args, **kwargs)

Bases: ModelNormal

Kind metadata.

Parameters:

created_at (str, optional) – The creation time.
modified_at (str, optional) – The modification time.

datadog_api_client.v2.model.kind_obj module¶

class KindObj(arg: None)¶

class KindObj(arg: ModelComposed)

class KindObj(*args, **kwargs)

Bases: ModelNormal

Schema for kind.

Parameters:

description (str, optional) – Short description of the kind.
display_name (str, optional) – The display name of the kind. Automatically generated if not provided.
kind (str) – The name of the kind to create or update. This must be in kebab-case format.

datadog_api_client.v2.model.kind_response_meta module¶

class KindResponseMeta(arg: None)¶

class KindResponseMeta(arg: ModelComposed)

class KindResponseMeta(*args, **kwargs)

Bases: ModelNormal

Kind response metadata.

Parameters:: count (int, optional) – Total kinds count.

datadog_api_client.v2.model.launch_darkly_api_key module¶

class LaunchDarklyAPIKey(arg: None)¶

class LaunchDarklyAPIKey(arg: ModelComposed)

class LaunchDarklyAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the LaunchDarklyAPIKey object.

Parameters:

api_token (str) – The LaunchDarklyAPIKey api_token.
type (LaunchDarklyAPIKeyType) – The definition of the LaunchDarklyAPIKey object.

datadog_api_client.v2.model.launch_darkly_api_key_type module¶

class LaunchDarklyAPIKeyType(arg: None)¶

class LaunchDarklyAPIKeyType(arg: ModelComposed)

class LaunchDarklyAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the LaunchDarklyAPIKey object.

Parameters:

value (str) – If omitted defaults to “LaunchDarklyAPIKey”. Must be one of [“LaunchDarklyAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.launch_darkly_api_key_update module¶

class LaunchDarklyAPIKeyUpdate(arg: None)¶

class LaunchDarklyAPIKeyUpdate(arg: ModelComposed)

class LaunchDarklyAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the LaunchDarklyAPIKey object.

Parameters:

api_token (str, optional) – The LaunchDarklyAPIKeyUpdate api_token.
type (LaunchDarklyAPIKeyType) – The definition of the LaunchDarklyAPIKey object.

datadog_api_client.v2.model.launch_darkly_credentials module¶

class LaunchDarklyCredentials(arg: None)¶

class LaunchDarklyCredentials(arg: ModelComposed)

class LaunchDarklyCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the LaunchDarklyCredentials object.

Parameters:

api_token (str) – The LaunchDarklyAPIKey api_token.
type (LaunchDarklyAPIKeyType) – The definition of the LaunchDarklyAPIKey object.

datadog_api_client.v2.model.launch_darkly_credentials_update module¶

class LaunchDarklyCredentialsUpdate(arg: None)¶

class LaunchDarklyCredentialsUpdate(arg: ModelComposed)

class LaunchDarklyCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the LaunchDarklyCredentialsUpdate object.

Parameters:

api_token (str, optional) – The LaunchDarklyAPIKeyUpdate api_token.
type (LaunchDarklyAPIKeyType) – The definition of the LaunchDarklyAPIKey object.

datadog_api_client.v2.model.launch_darkly_integration module¶

class LaunchDarklyIntegration(arg: None)¶

class LaunchDarklyIntegration(arg: ModelComposed)

class LaunchDarklyIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the LaunchDarklyIntegration object.

Parameters:

credentials (LaunchDarklyCredentials) – The definition of the LaunchDarklyCredentials object.
type (LaunchDarklyIntegrationType) – The definition of the LaunchDarklyIntegrationType object.

datadog_api_client.v2.model.launch_darkly_integration_type module¶

class LaunchDarklyIntegrationType(arg: None)¶

class LaunchDarklyIntegrationType(arg: ModelComposed)

class LaunchDarklyIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the LaunchDarklyIntegrationType object.

Parameters:

value (str) – If omitted defaults to “LaunchDarkly”. Must be one of [“LaunchDarkly”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.launch_darkly_integration_update module¶

class LaunchDarklyIntegrationUpdate(arg: None)¶

class LaunchDarklyIntegrationUpdate(arg: ModelComposed)

class LaunchDarklyIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the LaunchDarklyIntegrationUpdate object.

Parameters:

credentials (LaunchDarklyCredentialsUpdate, optional) – The definition of the LaunchDarklyCredentialsUpdate object.
type (LaunchDarklyIntegrationType) – The definition of the LaunchDarklyIntegrationType object.

datadog_api_client.v2.model.layer module¶

class Layer(arg: None)¶

class Layer(arg: ModelComposed)

class Layer(*args, **kwargs)

Bases: ModelNormal

Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.

Parameters:

attributes (LayerAttributes, optional) – Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
id (str, optional) – A unique identifier for this layer.
relationships (LayerRelationships, optional) – Holds references to objects related to the Layer entity, such as its members.
type (LayerType) – Layers resource type.

datadog_api_client.v2.model.layer_attributes module¶

class LayerAttributes(arg: None)¶

class LayerAttributes(arg: ModelComposed)

class LayerAttributes(*args, **kwargs)

Bases: ModelNormal

Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.

Parameters:

effective_date (datetime, optional) – When the layer becomes active (ISO 8601).
end_date (datetime, optional) – When the layer ceases to be active (ISO 8601).
interval (LayerAttributesInterval, optional) – Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
name (str, optional) – The name of this layer.
restrictions ([TimeRestriction], optional) – An optional list of time restrictions for when this layer is in effect.
rotation_start (datetime, optional) – The date/time when the rotation starts (ISO 8601).
time_zone (str, optional) – The time zone for this layer.

datadog_api_client.v2.model.layer_attributes_interval module¶

class LayerAttributesInterval(arg: None)¶

class LayerAttributesInterval(arg: ModelComposed)

class LayerAttributesInterval(*args, **kwargs)

Bases: ModelNormal

Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.

Parameters:

days (int, optional) – The number of days in each rotation cycle.
seconds (int, optional) – Any additional seconds for the rotation cycle (up to 30 days).

datadog_api_client.v2.model.layer_relationships module¶

class LayerRelationships(arg: None)¶

class LayerRelationships(arg: ModelComposed)

class LayerRelationships(*args, **kwargs)

Bases: ModelNormal

Holds references to objects related to the Layer entity, such as its members.

Parameters:: members (LayerRelationshipsMembers, optional) – Holds an array of references to the members of a Layer, each containing member IDs.

datadog_api_client.v2.model.layer_relationships_members module¶

class LayerRelationshipsMembers(arg: None)¶

class LayerRelationshipsMembers(arg: ModelComposed)

class LayerRelationshipsMembers(*args, **kwargs)

Bases: ModelNormal

Holds an array of references to the members of a Layer, each containing member IDs.

Parameters:: data ([LayerRelationshipsMembersDataItems], optional) – The list of members who belong to this layer.

datadog_api_client.v2.model.layer_relationships_members_data_items module¶

class LayerRelationshipsMembersDataItems(arg: None)¶

class LayerRelationshipsMembersDataItems(arg: ModelComposed)

class LayerRelationshipsMembersDataItems(*args, **kwargs)

Bases: ModelNormal

Represents a single member object in a layer’s members array, referencing a unique Datadog user ID.

Parameters:

id (str) – The unique user ID of the layer member.
type (LayerRelationshipsMembersDataItemsType) – Members resource type.

datadog_api_client.v2.model.layer_relationships_members_data_items_type module¶

class LayerRelationshipsMembersDataItemsType(arg: None)¶

class LayerRelationshipsMembersDataItemsType(arg: ModelComposed)

class LayerRelationshipsMembersDataItemsType(*args, **kwargs)

Bases: ModelSimple

Members resource type.

Parameters:

value (str) – If omitted defaults to “members”. Must be one of [“members”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.layer_type module¶

class LayerType(arg: None)¶

class LayerType(arg: ModelComposed)

class LayerType(*args, **kwargs)

Bases: ModelSimple

Layers resource type.

Parameters:

value (str) – If omitted defaults to “layers”. Must be one of [“layers”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.leaked_key module¶

class LeakedKey(arg: None)¶

class LeakedKey(arg: ModelComposed)

class LeakedKey(*args, **kwargs)

Bases: ModelNormal

The definition of LeakedKey object.

Parameters:

attributes (LeakedKeyAttributes) – The definition of LeakedKeyAttributes object.
id (str) – The LeakedKey id.
type (LeakedKeyType) – The definition of LeakedKeyType object.

datadog_api_client.v2.model.leaked_key_attributes module¶

class LeakedKeyAttributes(arg: None)¶

class LeakedKeyAttributes(arg: ModelComposed)

class LeakedKeyAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of LeakedKeyAttributes object.

Parameters:

date (datetime) – The LeakedKeyAttributes date.
leak_source (str, optional) – The LeakedKeyAttributes leak_source.

datadog_api_client.v2.model.leaked_key_type module¶

class LeakedKeyType(arg: None)¶

class LeakedKeyType(arg: ModelComposed)

class LeakedKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of LeakedKeyType object.

Parameters:

value (str) – If omitted defaults to “leaked_keys”. Must be one of [“leaked_keys”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.library module¶

class Library(arg: None)¶

class Library(arg: ModelComposed)

class Library(*args, **kwargs)

Bases: ModelNormal

Vulnerability library.

Parameters:

name (str) – Vulnerability library name.
version (str, optional) – Vulnerability library version.

datadog_api_client.v2.model.links module¶

class Links(arg: None)¶

class Links(arg: ModelComposed)

class Links(*args, **kwargs)

Bases: ModelNormal

The JSON:API links related to pagination.

Parameters:

first (str) – First page link.
last (str) – Last page link.
next (str, optional) – Next page link.
previous (str, optional) – Previous page link.
self (str) – Request link.

datadog_api_client.v2.model.list_apis_response module¶

class ListAPIsResponse(arg: None)¶

class ListAPIsResponse(arg: ModelComposed)

class ListAPIsResponse(*args, **kwargs)

Bases: ModelNormal

Response for ListAPIs.

Parameters:

data ([ListAPIsResponseData], optional) – List of API items.
meta (ListAPIsResponseMeta, optional) – Metadata for ListAPIsResponse.

datadog_api_client.v2.model.list_apis_response_data module¶

class ListAPIsResponseData(arg: None)¶

class ListAPIsResponseData(arg: ModelComposed)

class ListAPIsResponseData(*args, **kwargs)

Bases: ModelNormal

Data envelope for ListAPIsResponse.

Parameters:

attributes (ListAPIsResponseDataAttributes, optional) – Attributes for ListAPIsResponseData.
id (UUID, optional) – API identifier.

datadog_api_client.v2.model.list_apis_response_data_attributes module¶

class ListAPIsResponseDataAttributes(arg: None)¶

class ListAPIsResponseDataAttributes(arg: ModelComposed)

class ListAPIsResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for ListAPIsResponseData.

Parameters:: name (str, optional) – API name.

datadog_api_client.v2.model.list_apis_response_meta module¶

class ListAPIsResponseMeta(arg: None)¶

class ListAPIsResponseMeta(arg: ModelComposed)

class ListAPIsResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata for ListAPIsResponse.

Parameters:: pagination (ListAPIsResponseMetaPagination, optional) – Pagination metadata information for ListAPIsResponse.

datadog_api_client.v2.model.list_apis_response_meta_pagination module¶

class ListAPIsResponseMetaPagination(arg: None)¶

class ListAPIsResponseMetaPagination(arg: ModelComposed)

class ListAPIsResponseMetaPagination(*args, **kwargs)

Bases: ModelNormal

Pagination metadata information for ListAPIsResponse.

Parameters:

limit (int, optional) – Number of items in the current page.
offset (int, optional) – Offset for pagination.
total_count (int, optional) – Total number of items.

datadog_api_client.v2.model.list_app_key_registrations_response module¶

class ListAppKeyRegistrationsResponse(arg: None)¶

class ListAppKeyRegistrationsResponse(arg: ModelComposed)

class ListAppKeyRegistrationsResponse(*args, **kwargs)

Bases: ModelNormal

A paginated list of app key registrations.

Parameters:

data ([AppKeyRegistrationData], optional) – An array of app key registrations.
meta (ListAppKeyRegistrationsResponseMeta, optional) – The definition of ListAppKeyRegistrationsResponseMeta object.

datadog_api_client.v2.model.list_app_key_registrations_response_meta module¶

class ListAppKeyRegistrationsResponseMeta(arg: None)¶

class ListAppKeyRegistrationsResponseMeta(arg: ModelComposed)

class ListAppKeyRegistrationsResponseMeta(*args, **kwargs)

Bases: ModelNormal

The definition of ListAppKeyRegistrationsResponseMeta object.

Parameters:

total (int, optional) – The total number of app key registrations.
total_filtered (int, optional) – The total number of app key registrations that match the specified filters.

datadog_api_client.v2.model.list_application_keys_response module¶

class ListApplicationKeysResponse(arg: None)¶

class ListApplicationKeysResponse(arg: ModelComposed)

class ListApplicationKeysResponse(*args, **kwargs)

Bases: ModelNormal

Response for a list of application keys.

Parameters:

data ([PartialApplicationKey], optional) – Array of application keys.
included ([ApplicationKeyResponseIncludedItem], optional) – Array of objects related to the application key.
meta (ApplicationKeyResponseMeta, optional) – Additional information related to the application key response.

datadog_api_client.v2.model.list_apps_response module¶

class ListAppsResponse(arg: None)¶

class ListAppsResponse(arg: ModelComposed)

class ListAppsResponse(*args, **kwargs)

Bases: ModelNormal

A paginated list of apps matching the specified filters and sorting.

Parameters:

data ([ListAppsResponseDataItems], optional) – An array of app definitions.
included ([Deployment], optional) – Data on the version of the app that was published.
meta (ListAppsResponseMeta, optional) – Pagination metadata.

datadog_api_client.v2.model.list_apps_response_data_items module¶

class ListAppsResponseDataItems(arg: None)¶

class ListAppsResponseDataItems(arg: ModelComposed)

class ListAppsResponseDataItems(*args, **kwargs)

Bases: ModelNormal

An app definition object. This contains only basic information about the app such as ID, name, and tags.

Parameters:

attributes (ListAppsResponseDataItemsAttributes) – Basic information about the app such as name, description, and tags.
id (UUID) – The ID of the app.
meta (AppMeta, optional) – Metadata of an app.
relationships (ListAppsResponseDataItemsRelationships, optional) – The app’s publication information.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.list_apps_response_data_items_attributes module¶

class ListAppsResponseDataItemsAttributes(arg: None)¶

class ListAppsResponseDataItemsAttributes(arg: ModelComposed)

class ListAppsResponseDataItemsAttributes(*args, **kwargs)

Bases: ModelNormal

Basic information about the app such as name, description, and tags.

Parameters:

description (str, optional) – A human-readable description for the app.
favorite (bool, optional) – Whether the app is marked as a favorite by the current user.
name (str, optional) – The name of the app.
self_service (bool, optional) – Whether the app is enabled for use in the Datadog self-service hub.
tags ([str], optional) – A list of tags for the app, which can be used to filter apps.

datadog_api_client.v2.model.list_apps_response_data_items_relationships module¶

class ListAppsResponseDataItemsRelationships(arg: None)¶

class ListAppsResponseDataItemsRelationships(arg: ModelComposed)

class ListAppsResponseDataItemsRelationships(*args, **kwargs)

Bases: ModelNormal

The app’s publication information.

Parameters:: deployment (DeploymentRelationship, optional) – Information pointing to the app’s publication status.

datadog_api_client.v2.model.list_apps_response_meta module¶

class ListAppsResponseMeta(arg: None)¶

class ListAppsResponseMeta(arg: ModelComposed)

class ListAppsResponseMeta(*args, **kwargs)

Bases: ModelNormal

Pagination metadata.

Parameters:: page (ListAppsResponseMetaPage, optional) – Information on the total number of apps, to be used for pagination.

datadog_api_client.v2.model.list_apps_response_meta_page module¶

class ListAppsResponseMetaPage(arg: None)¶

class ListAppsResponseMetaPage(arg: ModelComposed)

class ListAppsResponseMetaPage(*args, **kwargs)

Bases: ModelNormal

Information on the total number of apps, to be used for pagination.

Parameters:

total_count (int, optional) – The total number of apps under the Datadog organization, disregarding any filters applied.
total_filtered_count (int, optional) – The total number of apps that match the specified filters.

datadog_api_client.v2.model.list_assets_sbo_ms_response module¶

class ListAssetsSBOMsResponse(arg: None)¶

class ListAssetsSBOMsResponse(arg: ModelComposed)

class ListAssetsSBOMsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing assets SBOMs.

Parameters:

data ([SBOM]) – List of assets SBOMs.
links (Links, optional) – The JSON:API links related to pagination.
meta (Metadata, optional) – The metadata related to this request.

datadog_api_client.v2.model.list_connections_response module¶

class ListConnectionsResponse(arg: None)¶

class ListConnectionsResponse(arg: ModelComposed)

class ListConnectionsResponse(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (ListConnectionsResponseData, optional)

datadog_api_client.v2.model.list_connections_response_data module¶

class ListConnectionsResponseData(arg: None)¶

class ListConnectionsResponseData(arg: ModelComposed)

class ListConnectionsResponseData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (ListConnectionsResponseDataAttributes, optional)
id (str, optional)
type (ListConnectionsResponseDataType) – List connections response resource type.

datadog_api_client.v2.model.list_connections_response_data_attributes module¶

class ListConnectionsResponseDataAttributes(arg: None)¶

class ListConnectionsResponseDataAttributes(arg: ModelComposed)

class ListConnectionsResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:: connections ([ListConnectionsResponseDataAttributesConnectionsItems], optional)

datadog_api_client.v2.model.list_connections_response_data_attributes_connections_items module¶

class ListConnectionsResponseDataAttributesConnectionsItems(arg: None)¶

class ListConnectionsResponseDataAttributesConnectionsItems(arg: ModelComposed)

class ListConnectionsResponseDataAttributesConnectionsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

created_at (datetime, optional)
created_by (str, optional)
fields ([CreateConnectionRequestDataAttributesFieldsItems], optional)
id (str, optional)
join (ListConnectionsResponseDataAttributesConnectionsItemsJoin, optional)
metadata ({str: (str,)}, optional)
type (str, optional)
updated_at (datetime, optional)
updated_by (str, optional)

datadog_api_client.v2.model.list_connections_response_data_attributes_connections_items_join module¶

class ListConnectionsResponseDataAttributesConnectionsItemsJoin(arg: None)¶

class ListConnectionsResponseDataAttributesConnectionsItemsJoin(arg: ModelComposed)

class ListConnectionsResponseDataAttributesConnectionsItemsJoin(*args, **kwargs)

Bases: ModelNormal

Parameters:

attribute (str, optional)
type (str, optional)

datadog_api_client.v2.model.list_connections_response_data_type module¶

class ListConnectionsResponseDataType(arg: None)¶

class ListConnectionsResponseDataType(arg: ModelComposed)

class ListConnectionsResponseDataType(*args, **kwargs)

Bases: ModelSimple

List connections response resource type.

Parameters:

value (str) – If omitted defaults to “list_connections_response”. Must be one of [“list_connections_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.list_devices_response module¶

class ListDevicesResponse(arg: None)¶

class ListDevicesResponse(arg: ModelComposed)

class ListDevicesResponse(*args, **kwargs)

Bases: ModelNormal

List devices response.

Parameters:

data ([DevicesListData], optional) – The list devices response data.
meta (ListDevicesResponseMetadata, optional) – Object describing meta attributes of response.

datadog_api_client.v2.model.list_devices_response_metadata module¶

class ListDevicesResponseMetadata(arg: None)¶

class ListDevicesResponseMetadata(arg: ModelComposed)

class ListDevicesResponseMetadata(*args, **kwargs)

Bases: ModelNormal

Object describing meta attributes of response.

Parameters:: page (ListDevicesResponseMetadataPage, optional) – Pagination object.

datadog_api_client.v2.model.list_devices_response_metadata_page module¶

class ListDevicesResponseMetadataPage(arg: None)¶

class ListDevicesResponseMetadataPage(arg: ModelComposed)

class ListDevicesResponseMetadataPage(*args, **kwargs)

Bases: ModelNormal

Pagination object.

Parameters:: total_filtered_count (int, optional) – Total count of devices matched by the filter.

datadog_api_client.v2.model.list_downtimes_response module¶

class ListDowntimesResponse(arg: None)¶

class ListDowntimesResponse(arg: ModelComposed)

class ListDowntimesResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all downtimes.

Parameters:

data ([DowntimeResponseData], optional) – An array of downtimes.
included ([DowntimeResponseIncludedItem], optional) – Array of objects related to the downtimes.
meta (DowntimeMeta, optional) – Pagination metadata returned by the API.

datadog_api_client.v2.model.list_entity_catalog_response module¶

class ListEntityCatalogResponse(arg: None)¶

class ListEntityCatalogResponse(arg: ModelComposed)

class ListEntityCatalogResponse(*args, **kwargs)

Bases: ModelNormal

List entity response.

Parameters:

data ([EntityData], optional) – List of entity data.
included ([ListEntityCatalogResponseIncludedItem], optional) – List entity response included.
links (ListEntityCatalogResponseLinks, optional) – List entity response links.
meta (EntityResponseMeta, optional) – Entity metadata.

datadog_api_client.v2.model.list_entity_catalog_response_included_item module¶

class ListEntityCatalogResponseIncludedItem(arg: None)¶

class ListEntityCatalogResponseIncludedItem(arg: ModelComposed)

class ListEntityCatalogResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

List entity response included item.

Parameters:

attributes (EntityResponseIncludedSchemaAttributes, optional) – Included schema.
id (str, optional) – Entity ID.
type (EntityResponseIncludedSchemaType, optional) – Schema type.
meta (EntityResponseIncludedRelatedEntityMeta, optional) – Included related entity meta.

datadog_api_client.v2.model.list_entity_catalog_response_links module¶

class ListEntityCatalogResponseLinks(arg: None)¶

class ListEntityCatalogResponseLinks(arg: ModelComposed)

class ListEntityCatalogResponseLinks(*args, **kwargs)

Bases: ModelNormal

List entity response links.

Parameters:

next (str, optional) – Next link.
previous (str, optional) – Previous link.
self (str, optional) – Current link.

datadog_api_client.v2.model.list_findings_meta module¶

class ListFindingsMeta(arg: None)¶

class ListFindingsMeta(arg: ModelComposed)

class ListFindingsMeta(*args, **kwargs)

Bases: ModelNormal

Metadata for pagination.

Parameters:

page (ListFindingsPage, optional) – Pagination and findings count information.
snapshot_timestamp (int, optional) – The point in time corresponding to the listed findings.

additional_properties_type = None¶

datadog_api_client.v2.model.list_findings_page module¶

class ListFindingsPage(arg: None)¶

class ListFindingsPage(arg: ModelComposed)

class ListFindingsPage(*args, **kwargs)

Bases: ModelNormal

Pagination and findings count information.

Parameters:

cursor (str, optional) – The cursor used to paginate requests.
total_filtered_count (int, optional) – The total count of findings after the filter has been applied.

additional_properties_type = None¶

datadog_api_client.v2.model.list_findings_response module¶

class ListFindingsResponse(arg: None)¶

class ListFindingsResponse(arg: ModelComposed)

class ListFindingsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing findings.

Parameters:

data ([Finding]) – Array of findings.
meta (ListFindingsMeta) – Metadata for pagination.

datadog_api_client.v2.model.list_kind_catalog_response module¶

class ListKindCatalogResponse(arg: None)¶

class ListKindCatalogResponse(arg: ModelComposed)

class ListKindCatalogResponse(*args, **kwargs)

Bases: ModelNormal

List kind response.

Parameters:

data ([KindData], optional) – List of kind responses.
meta (KindResponseMeta, optional) – Kind response metadata.

datadog_api_client.v2.model.list_pipelines_response module¶

class ListPipelinesResponse(arg: None)¶

class ListPipelinesResponse(arg: ModelComposed)

class ListPipelinesResponse(*args, **kwargs)

Bases: ModelNormal

Represents the response payload containing a list of pipelines and associated metadata.

Parameters:

data ([ObservabilityPipelineData]) – The schema data.
meta (ListPipelinesResponseMeta, optional) – Metadata about the response.

datadog_api_client.v2.model.list_pipelines_response_meta module¶

class ListPipelinesResponseMeta(arg: None)¶

class ListPipelinesResponseMeta(arg: ModelComposed)

class ListPipelinesResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata about the response.

Parameters:: total_count (int, optional) – The total number of pipelines.

datadog_api_client.v2.model.list_powerpacks_response module¶

class ListPowerpacksResponse(arg: None)¶

class ListPowerpacksResponse(arg: ModelComposed)

class ListPowerpacksResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes all powerpack configurations.

Parameters:

data ([PowerpackData], optional) – List of powerpack definitions.
included ([User], optional) – Array of objects related to the users.
links (PowerpackResponseLinks, optional) – Links attributes.
meta (PowerpacksResponseMeta, optional) – Powerpack response metadata.

datadog_api_client.v2.model.list_relation_catalog_response module¶

class ListRelationCatalogResponse(arg: None)¶

class ListRelationCatalogResponse(arg: ModelComposed)

class ListRelationCatalogResponse(*args, **kwargs)

Bases: ModelNormal

List entity relation response.

Parameters:

data ([RelationResponse], optional) – Array of relation responses
included ([EntityData], optional) – List relation response included entities.
links (ListRelationCatalogResponseLinks, optional) – List relation response links.
meta (RelationResponseMeta, optional) – Relation response metadata.

datadog_api_client.v2.model.list_relation_catalog_response_links module¶

class ListRelationCatalogResponseLinks(arg: None)¶

class ListRelationCatalogResponseLinks(arg: ModelComposed)

class ListRelationCatalogResponseLinks(*args, **kwargs)

Bases: ModelNormal

List relation response links.

Parameters:

next (str, optional) – Next link.
previous (str, optional) – Previous link.
self (str, optional) – Current link.

datadog_api_client.v2.model.list_rules_response module¶

class ListRulesResponse(arg: None)¶

class ListRulesResponse(arg: ModelComposed)

class ListRulesResponse(*args, **kwargs)

Bases: ModelNormal

Scorecard rules response.

Parameters:

data ([ListRulesResponseDataItem], optional) – Array of rule details.
links (ListRulesResponseLinks, optional) – Links attributes.

datadog_api_client.v2.model.list_rules_response_data_item module¶

class ListRulesResponseDataItem(arg: None)¶

class ListRulesResponseDataItem(arg: ModelComposed)

class ListRulesResponseDataItem(*args, **kwargs)

Bases: ModelNormal

Rule details.

Parameters:

attributes (RuleAttributes, optional) – Details of a rule.
id (str, optional) – The unique ID for a scorecard rule.
relationships (RelationshipToRule, optional) – Scorecard create rule response relationship.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.list_rules_response_links module¶

class ListRulesResponseLinks(arg: None)¶

class ListRulesResponseLinks(arg: ModelComposed)

class ListRulesResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of rules.

datadog_api_client.v2.model.list_tags_response module¶

class ListTagsResponse(arg: None)¶

class ListTagsResponse(arg: ModelComposed)

class ListTagsResponse(*args, **kwargs)

Bases: ModelNormal

List tags response.

Parameters:: data (ListTagsResponseData, optional) – The list tags response data.

datadog_api_client.v2.model.list_tags_response_data module¶

class ListTagsResponseData(arg: None)¶

class ListTagsResponseData(arg: ModelComposed)

class ListTagsResponseData(*args, **kwargs)

Bases: ModelNormal

The list tags response data.

Parameters:

attributes (ListTagsResponseDataAttributes, optional) – The definition of ListTagsResponseDataAttributes object.
id (str, optional) – The device ID
type (str, optional) – The type of the resource. The value should always be tags.

datadog_api_client.v2.model.list_tags_response_data_attributes module¶

class ListTagsResponseDataAttributes(arg: None)¶

class ListTagsResponseDataAttributes(arg: ModelComposed)

class ListTagsResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of ListTagsResponseDataAttributes object.

Parameters:: tags ([str], optional) – The list of tags

datadog_api_client.v2.model.list_teams_include module¶

class ListTeamsInclude(arg: None)¶

class ListTeamsInclude(arg: ModelComposed)

class ListTeamsInclude(*args, **kwargs)

Bases: ModelSimple

Included related resources optionally requested.

Parameters:

value (str) – Must be one of [“team_links”, “user_team_permissions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.list_teams_sort module¶

class ListTeamsSort(arg: None)¶

class ListTeamsSort(arg: ModelComposed)

class ListTeamsSort(*args, **kwargs)

Bases: ModelSimple

Specifies the order of the returned teams

Parameters:

value (str) – Must be one of [“name”, “-name”, “user_count”, “-user_count”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.list_threat_hunting_jobs_response module¶

class ListThreatHuntingJobsResponse(arg: None)¶

class ListThreatHuntingJobsResponse(arg: ModelComposed)

class ListThreatHuntingJobsResponse(*args, **kwargs)

Bases: ModelNormal

List of threat hunting jobs.

Parameters:

data ([ThreatHuntingJobResponseData], optional) – Array containing the list of threat hunting jobs.
meta (ThreatHuntingJobListMeta, optional) – Metadata about the list of jobs.

datadog_api_client.v2.model.list_vulnerabilities_response module¶

class ListVulnerabilitiesResponse(arg: None)¶

class ListVulnerabilitiesResponse(arg: ModelComposed)

class ListVulnerabilitiesResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing vulnerabilities.

Parameters:

data ([Vulnerability]) – List of vulnerabilities.
links (Links, optional) – The JSON:API links related to pagination.
meta (Metadata, optional) – The metadata related to this request.

datadog_api_client.v2.model.list_vulnerable_assets_response module¶

class ListVulnerableAssetsResponse(arg: None)¶

class ListVulnerableAssetsResponse(arg: ModelComposed)

class ListVulnerableAssetsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing vulnerable assets.

Parameters:

data ([Asset]) – List of vulnerable assets.
links (Links, optional) – The JSON:API links related to pagination.
meta (Metadata, optional) – The metadata related to this request.

datadog_api_client.v2.model.log module¶

class Log(arg: None)¶

class Log(arg: ModelComposed)

class Log(*args, **kwargs)

Bases: ModelNormal

Object description of a log after being processed and stored by Datadog.

Parameters:

attributes (LogAttributes, optional) – JSON object containing all log attributes and their associated values.
id (str, optional) – Unique ID of the Log.
type (LogType, optional) – Type of the event.

datadog_api_client.v2.model.log_attributes module¶

class LogAttributes(arg: None)¶

class LogAttributes(arg: ModelComposed)

class LogAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all log attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of attributes from your log.
host (str, optional) – Name of the machine from where the logs are being sent.
message (str, optional) –
The message reserved attribute of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search.
service (str, optional) – The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products.
status (str, optional) – Status of the message associated with your log.
tags ([str], optional) – Array of tags associated with your log.
timestamp (datetime, optional) – Timestamp of your log.

datadog_api_client.v2.model.log_type module¶

class LogType(arg: None)¶

class LogType(arg: ModelComposed)

class LogType(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “log”. Must be one of [“log”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_aggregate_bucket module¶

class LogsAggregateBucket(arg: None)¶

class LogsAggregateBucket(arg: ModelComposed)

class LogsAggregateBucket(*args, **kwargs)

Bases: ModelNormal

A bucket values

Parameters:

by ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The key, value pairs for each group by
computes ({str: (LogsAggregateBucketValue,)}, optional) – A map of the metric name -> value for regular compute or list of values for a timeseries

datadog_api_client.v2.model.logs_aggregate_bucket_value module¶

class LogsAggregateBucketValue(arg: None)¶

class LogsAggregateBucketValue(arg: ModelComposed)

class LogsAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

A bucket value, can be either a timeseries or a single value

datadog_api_client.v2.model.logs_aggregate_bucket_value_timeseries module¶

class LogsAggregateBucketValueTimeseries(arg: None)¶

class LogsAggregateBucketValueTimeseries(arg: ModelComposed)

class LogsAggregateBucketValueTimeseries(*args, **kwargs)

Bases: ModelSimple

A timeseries array

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_aggregate_bucket_value_timeseries_point module¶

class LogsAggregateBucketValueTimeseriesPoint(arg: None)¶

class LogsAggregateBucketValueTimeseriesPoint(arg: ModelComposed)

class LogsAggregateBucketValueTimeseriesPoint(*args, **kwargs)

Bases: ModelNormal

A timeseries point

Parameters:

time (str, optional) – The time value for this point
value (float, optional) – The value for this point

datadog_api_client.v2.model.logs_aggregate_request module¶

class LogsAggregateRequest(arg: None)¶

class LogsAggregateRequest(arg: ModelComposed)

class LogsAggregateRequest(*args, **kwargs)

Bases: ModelNormal

The object sent with the request to retrieve a list of logs from your organization.

Parameters:

compute ([LogsCompute], optional) – The list of metrics or timeseries to compute for the retrieved buckets.
filter (LogsQueryFilter, optional) – The search and filter query settings
group_by ([LogsGroupBy], optional) – The rules for the group by
options (LogsQueryOptions, optional) – Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results. Deprecated.
page (LogsAggregateRequestPage, optional) – Paging settings

datadog_api_client.v2.model.logs_aggregate_request_page module¶

class LogsAggregateRequestPage(arg: None)¶

class LogsAggregateRequestPage(arg: ModelComposed)

class LogsAggregateRequestPage(*args, **kwargs)

Bases: ModelNormal

Paging settings

Parameters:: cursor (str, optional) – The returned paging point to use to get the next results. Note: at most 1000 results can be paged.

datadog_api_client.v2.model.logs_aggregate_response module¶

class LogsAggregateResponse(arg: None)¶

class LogsAggregateResponse(arg: ModelComposed)

class LogsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the logs aggregate API endpoint

Parameters:

data (LogsAggregateResponseData, optional) – The query results
meta (LogsResponseMetadata, optional) – The metadata associated with a request

datadog_api_client.v2.model.logs_aggregate_response_data module¶

class LogsAggregateResponseData(arg: None)¶

class LogsAggregateResponseData(arg: ModelComposed)

class LogsAggregateResponseData(*args, **kwargs)

Bases: ModelNormal

The query results

Parameters:: buckets ([LogsAggregateBucket], optional) – The list of matching buckets, one item per bucket

datadog_api_client.v2.model.logs_aggregate_response_status module¶

class LogsAggregateResponseStatus(arg: None)¶

class LogsAggregateResponseStatus(arg: ModelComposed)

class LogsAggregateResponseStatus(*args, **kwargs)

Bases: ModelSimple

The status of the response

Parameters:

value (str) – Must be one of [“done”, “timeout”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_aggregate_sort module¶

class LogsAggregateSort(arg: None)¶

class LogsAggregateSort(arg: ModelComposed)

class LogsAggregateSort(*args, **kwargs)

Bases: ModelNormal

A sort rule

Parameters:

aggregation (LogsAggregationFunction, optional) – An aggregation function
metric (str, optional) – The metric to sort by (only used for type=measure )
order (LogsSortOrder, optional) – The order to use, ascending or descending
type (LogsAggregateSortType, optional) – The type of sorting algorithm

datadog_api_client.v2.model.logs_aggregate_sort_type module¶

class LogsAggregateSortType(arg: None)¶

class LogsAggregateSortType(arg: ModelComposed)

class LogsAggregateSortType(*args, **kwargs)

Bases: ModelSimple

The type of sorting algorithm

Parameters:

value (str) – If omitted defaults to “alphabetical”. Must be one of [“alphabetical”, “measure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_aggregation_function module¶

class LogsAggregationFunction(arg: None)¶

class LogsAggregationFunction(arg: ModelComposed)

class LogsAggregationFunction(*args, **kwargs)

Bases: ModelSimple

An aggregation function

Parameters:

value (str) – Must be one of [“count”, “cardinality”, “pc75”, “pc90”, “pc95”, “pc98”, “pc99”, “sum”, “min”, “max”, “avg”, “median”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive module¶

class LogsArchive(arg: None)¶

class LogsArchive(arg: ModelComposed)

class LogsArchive(*args, **kwargs)

Bases: ModelNormal

The logs archive.

Parameters:: data (LogsArchiveDefinition, optional) – The definition of an archive.

datadog_api_client.v2.model.logs_archive_attributes module¶

class LogsArchiveAttributes(arg: None)¶

class LogsArchiveAttributes(arg: ModelComposed)

class LogsArchiveAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes associated with the archive.

Parameters:

destination (LogsArchiveDestination, none_type) – An archive’s destination.
include_tags (bool, optional) – To store the tags in the archive, set the value “true”. If it is set to “false”, the tags will be deleted when the logs are sent to the archive.
name (str) – The archive name.
query (str) – The archive query/filter. Logs matching this query are included in the archive.
rehydration_max_scan_size_in_gb (int, none_type, optional) – Maximum scan size for rehydration from this archive.
rehydration_tags ([str], optional) – An array of tags to add to rehydrated logs from an archive.
state (LogsArchiveState, optional) – The state of the archive.

datadog_api_client.v2.model.logs_archive_create_request module¶

class LogsArchiveCreateRequest(arg: None)¶

class LogsArchiveCreateRequest(arg: ModelComposed)

class LogsArchiveCreateRequest(*args, **kwargs)

Bases: ModelNormal

The logs archive.

Parameters:: data (LogsArchiveCreateRequestDefinition, optional) – The definition of an archive.

datadog_api_client.v2.model.logs_archive_create_request_attributes module¶

class LogsArchiveCreateRequestAttributes(arg: None)¶

class LogsArchiveCreateRequestAttributes(arg: ModelComposed)

class LogsArchiveCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes associated with the archive.

Parameters:

destination (LogsArchiveCreateRequestDestination) – An archive’s destination.
include_tags (bool, optional) – To store the tags in the archive, set the value “true”. If it is set to “false”, the tags will be deleted when the logs are sent to the archive.
name (str) – The archive name.
query (str) – The archive query/filter. Logs matching this query are included in the archive.
rehydration_max_scan_size_in_gb (int, none_type, optional) – Maximum scan size for rehydration from this archive.
rehydration_tags ([str], optional) – An array of tags to add to rehydrated logs from an archive.

datadog_api_client.v2.model.logs_archive_create_request_definition module¶

class LogsArchiveCreateRequestDefinition(arg: None)¶

class LogsArchiveCreateRequestDefinition(arg: ModelComposed)

class LogsArchiveCreateRequestDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of an archive.

Parameters:

attributes (LogsArchiveCreateRequestAttributes, optional) – The attributes associated with the archive.
type (str) – The type of the resource. The value should always be archives.

datadog_api_client.v2.model.logs_archive_create_request_destination module¶

class LogsArchiveCreateRequestDestination(arg: None)¶

class LogsArchiveCreateRequestDestination(arg: ModelComposed)

class LogsArchiveCreateRequestDestination(*args, **kwargs)

Bases: ModelComposed

An archive’s destination.

Parameters:

container (str) – The container where the archive will be stored.
integration (LogsArchiveIntegrationAzure) – The Azure archive’s integration destination.
path (str, optional) – The archive path.
region (str, optional) – The region where the archive will be stored.
storage_account (str) – The associated storage account.
type (LogsArchiveDestinationAzureType) – Type of the Azure archive destination.
bucket (str) – The bucket where the archive will be stored.
encryption (LogsArchiveEncryptionS3, optional) – The S3 encryption settings.
storage_class (LogsArchiveStorageClassS3Type, optional) – The storage class where the archive will be stored.

datadog_api_client.v2.model.logs_archive_definition module¶

class LogsArchiveDefinition(arg: None)¶

class LogsArchiveDefinition(arg: ModelComposed)

class LogsArchiveDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of an archive.

Parameters:

attributes (LogsArchiveAttributes, optional) – The attributes associated with the archive.
id (str, optional) – The archive ID.
type (str) – The type of the resource. The value should always be archives.

datadog_api_client.v2.model.logs_archive_destination module¶

class LogsArchiveDestination(arg: None)¶

class LogsArchiveDestination(arg: ModelComposed)

class LogsArchiveDestination(*args, **kwargs)

Bases: ModelComposed

An archive’s destination.

Parameters:

container (str) – The container where the archive will be stored.
integration (LogsArchiveIntegrationAzure) – The Azure archive’s integration destination.
path (str, optional) – The archive path.
region (str, optional) – The region where the archive will be stored.
storage_account (str) – The associated storage account.
type (LogsArchiveDestinationAzureType) – Type of the Azure archive destination.
bucket (str) – The bucket where the archive will be stored.
encryption (LogsArchiveEncryptionS3, optional) – The S3 encryption settings.
storage_class (LogsArchiveStorageClassS3Type, optional) – The storage class where the archive will be stored.

datadog_api_client.v2.model.logs_archive_destination_azure module¶

class LogsArchiveDestinationAzure(arg: None)¶

class LogsArchiveDestinationAzure(arg: ModelComposed)

class LogsArchiveDestinationAzure(*args, **kwargs)

Bases: ModelNormal

The Azure archive destination.

Parameters:

container (str) – The container where the archive will be stored.
integration (LogsArchiveIntegrationAzure) – The Azure archive’s integration destination.
path (str, optional) – The archive path.
region (str, optional) – The region where the archive will be stored.
storage_account (str) – The associated storage account.
type (LogsArchiveDestinationAzureType) – Type of the Azure archive destination.

datadog_api_client.v2.model.logs_archive_destination_azure_type module¶

class LogsArchiveDestinationAzureType(arg: None)¶

class LogsArchiveDestinationAzureType(arg: ModelComposed)

class LogsArchiveDestinationAzureType(*args, **kwargs)

Bases: ModelSimple

Type of the Azure archive destination.

Parameters:

value (str) – If omitted defaults to “azure”. Must be one of [“azure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive_destination_gcs module¶

class LogsArchiveDestinationGCS(arg: None)¶

class LogsArchiveDestinationGCS(arg: ModelComposed)

class LogsArchiveDestinationGCS(*args, **kwargs)

Bases: ModelNormal

The GCS archive destination.

Parameters:

bucket (str) – The bucket where the archive will be stored.
integration (LogsArchiveIntegrationGCS) – The GCS archive’s integration destination.
path (str, optional) – The archive path.
type (LogsArchiveDestinationGCSType) – Type of the GCS archive destination.

datadog_api_client.v2.model.logs_archive_destination_gcs_type module¶

class LogsArchiveDestinationGCSType(arg: None)¶

class LogsArchiveDestinationGCSType(arg: ModelComposed)

class LogsArchiveDestinationGCSType(*args, **kwargs)

Bases: ModelSimple

Type of the GCS archive destination.

Parameters:

value (str) – If omitted defaults to “gcs”. Must be one of [“gcs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive_destination_s3 module¶

class LogsArchiveDestinationS3(arg: None)¶

class LogsArchiveDestinationS3(arg: ModelComposed)

class LogsArchiveDestinationS3(*args, **kwargs)

Bases: ModelNormal

The S3 archive destination.

Parameters:

bucket (str) – The bucket where the archive will be stored.
encryption (LogsArchiveEncryptionS3, optional) – The S3 encryption settings.
integration (LogsArchiveIntegrationS3) – The S3 Archive’s integration destination.
path (str, optional) – The archive path.
storage_class (LogsArchiveStorageClassS3Type, optional) – The storage class where the archive will be stored.
type (LogsArchiveDestinationS3Type) – Type of the S3 archive destination.

datadog_api_client.v2.model.logs_archive_destination_s3_type module¶

class LogsArchiveDestinationS3Type(arg: None)¶

class LogsArchiveDestinationS3Type(arg: ModelComposed)

class LogsArchiveDestinationS3Type(*args, **kwargs)

Bases: ModelSimple

Type of the S3 archive destination.

Parameters:

value (str) – If omitted defaults to “s3”. Must be one of [“s3”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive_encryption_s3 module¶

class LogsArchiveEncryptionS3(arg: None)¶

class LogsArchiveEncryptionS3(arg: ModelComposed)

class LogsArchiveEncryptionS3(*args, **kwargs)

Bases: ModelNormal

The S3 encryption settings.

Parameters:

key (str, optional) – An Amazon Resource Name (ARN) used to identify an AWS KMS key.
type (LogsArchiveEncryptionS3Type) – Type of S3 encryption for a destination.

datadog_api_client.v2.model.logs_archive_encryption_s3_type module¶

class LogsArchiveEncryptionS3Type(arg: None)¶

class LogsArchiveEncryptionS3Type(arg: ModelComposed)

class LogsArchiveEncryptionS3Type(*args, **kwargs)

Bases: ModelSimple

Type of S3 encryption for a destination.

Parameters:

value (str) – Must be one of [“NO_OVERRIDE”, “SSE_S3”, “SSE_KMS”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive_integration_azure module¶

class LogsArchiveIntegrationAzure(arg: None)¶

class LogsArchiveIntegrationAzure(arg: ModelComposed)

class LogsArchiveIntegrationAzure(*args, **kwargs)

Bases: ModelNormal

The Azure archive’s integration destination.

Parameters:

client_id (str) – A client ID.
tenant_id (str) – A tenant ID.

datadog_api_client.v2.model.logs_archive_integration_gcs module¶

class LogsArchiveIntegrationGCS(arg: None)¶

class LogsArchiveIntegrationGCS(arg: ModelComposed)

class LogsArchiveIntegrationGCS(*args, **kwargs)

Bases: ModelNormal

The GCS archive’s integration destination.

Parameters:

client_email (str) – A client email.
project_id (str, optional) – A project ID.

datadog_api_client.v2.model.logs_archive_integration_s3 module¶

class LogsArchiveIntegrationS3(arg: None)¶

class LogsArchiveIntegrationS3(arg: ModelComposed)

class LogsArchiveIntegrationS3(*args, **kwargs)

Bases: ModelNormal

The S3 Archive’s integration destination.

Parameters:

account_id (str) – The account ID for the integration.
role_name (str) – The path of the integration.

datadog_api_client.v2.model.logs_archive_order module¶

class LogsArchiveOrder(arg: None)¶

class LogsArchiveOrder(arg: ModelComposed)

class LogsArchiveOrder(*args, **kwargs)

Bases: ModelNormal

A ordered list of archive IDs.

Parameters:: data (LogsArchiveOrderDefinition, optional) – The definition of an archive order.

datadog_api_client.v2.model.logs_archive_order_attributes module¶

class LogsArchiveOrderAttributes(arg: None)¶

class LogsArchiveOrderAttributes(arg: ModelComposed)

class LogsArchiveOrderAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes associated with the archive order.

Parameters:: archive_ids ([str]) – An ordered array of <ARCHIVE_ID> strings, the order of archive IDs in the array define the overall archives order for Datadog.

datadog_api_client.v2.model.logs_archive_order_definition module¶

class LogsArchiveOrderDefinition(arg: None)¶

class LogsArchiveOrderDefinition(arg: ModelComposed)

class LogsArchiveOrderDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of an archive order.

Parameters:

attributes (LogsArchiveOrderAttributes) – The attributes associated with the archive order.
type (LogsArchiveOrderDefinitionType) – Type of the archive order definition.

datadog_api_client.v2.model.logs_archive_order_definition_type module¶

class LogsArchiveOrderDefinitionType(arg: None)¶

class LogsArchiveOrderDefinitionType(arg: ModelComposed)

class LogsArchiveOrderDefinitionType(*args, **kwargs)

Bases: ModelSimple

Type of the archive order definition.

Parameters:

value (str) – If omitted defaults to “archive_order”. Must be one of [“archive_order”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive_state module¶

class LogsArchiveState(arg: None)¶

class LogsArchiveState(arg: ModelComposed)

class LogsArchiveState(*args, **kwargs)

Bases: ModelSimple

The state of the archive.

Parameters:

value (str) – Must be one of [“UNKNOWN”, “WORKING”, “FAILING”, “WORKING_AUTH_LEGACY”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archive_storage_class_s3_type module¶

class LogsArchiveStorageClassS3Type(arg: None)¶

class LogsArchiveStorageClassS3Type(arg: ModelComposed)

class LogsArchiveStorageClassS3Type(*args, **kwargs)

Bases: ModelSimple

The storage class where the archive will be stored.

Parameters:

value (str) – If omitted defaults to “STANDARD”. Must be one of [“STANDARD”, “STANDARD_IA”, “ONEZONE_IA”, “INTELLIGENT_TIERING”, “GLACIER_IR”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_archives module¶

class LogsArchives(arg: None)¶

class LogsArchives(arg: ModelComposed)

class LogsArchives(*args, **kwargs)

Bases: ModelNormal

The available archives.

Parameters:: data ([LogsArchiveDefinition], optional) – A list of archives.

datadog_api_client.v2.model.logs_compute module¶

class LogsCompute(arg: None)¶

class LogsCompute(arg: ModelComposed)

class LogsCompute(*args, **kwargs)

Bases: ModelNormal

A compute rule to compute metrics or timeseries

Parameters:

aggregation (LogsAggregationFunction) – An aggregation function
interval (str, optional) – The time buckets’ size (only used for type=timeseries) Defaults to a resolution of 150 points
metric (str, optional) – The metric to use
type (LogsComputeType, optional) – The type of compute

datadog_api_client.v2.model.logs_compute_type module¶

class LogsComputeType(arg: None)¶

class LogsComputeType(arg: ModelComposed)

class LogsComputeType(*args, **kwargs)

Bases: ModelSimple

The type of compute

Parameters:

value (str) – If omitted defaults to “total”. Must be one of [“timeseries”, “total”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_group_by module¶

class LogsGroupBy(arg: None)¶

class LogsGroupBy(arg: ModelComposed)

class LogsGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule

Parameters:

facet (str) – The name of the facet to use (required)
histogram (LogsGroupByHistogram, optional) – Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
limit (int, optional) – The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. If grouping by multiple facets, the product of limits must not exceed 10000.
missing (LogsGroupByMissing, optional) – The value to use for logs that don’t have the facet used to group by
sort (LogsAggregateSort, optional) – A sort rule
total (LogsGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.logs_group_by_histogram module¶

class LogsGroupByHistogram(arg: None)¶

class LogsGroupByHistogram(arg: ModelComposed)

class LogsGroupByHistogram(*args, **kwargs)

Bases: ModelNormal

Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.

Parameters:

interval (float) – The bin size of the histogram buckets
max (float) – The maximum value for the measure used in the histogram (values greater than this one are filtered out)
min (float) – The minimum value for the measure used in the histogram (values smaller than this one are filtered out)

datadog_api_client.v2.model.logs_group_by_missing module¶

class LogsGroupByMissing(arg: None)¶

class LogsGroupByMissing(arg: ModelComposed)

class LogsGroupByMissing(*args, **kwargs)

Bases: ModelComposed

The value to use for logs that don’t have the facet used to group by

datadog_api_client.v2.model.logs_group_by_total module¶

class LogsGroupByTotal(arg: None)¶

class LogsGroupByTotal(arg: ModelComposed)

class LogsGroupByTotal(*args, **kwargs)

Bases: ModelComposed

A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.logs_list_request module¶

class LogsListRequest(arg: None)¶

class LogsListRequest(arg: ModelComposed)

class LogsListRequest(*args, **kwargs)

Bases: ModelNormal

The request for a logs list.

Parameters:

filter (LogsQueryFilter, optional) – The search and filter query settings
options (LogsQueryOptions, optional) – Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results. Deprecated.
page (LogsListRequestPage, optional) – Paging attributes for listing logs.
sort (LogsSort, optional) – Sort parameters when querying logs.

datadog_api_client.v2.model.logs_list_request_page module¶

class LogsListRequestPage(arg: None)¶

class LogsListRequestPage(arg: ModelComposed)

class LogsListRequestPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes for listing logs.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous query.
limit (int, optional) – Maximum number of logs in the response.

datadog_api_client.v2.model.logs_list_response module¶

class LogsListResponse(arg: None)¶

class LogsListResponse(arg: ModelComposed)

class LogsListResponse(*args, **kwargs)

Bases: ModelNormal

Response object with all logs matching the request and pagination information.

Parameters:

data ([Log], optional) – Array of logs matching the request.
links (LogsListResponseLinks, optional) – Links attributes.
meta (LogsResponseMetadata, optional) – The metadata associated with a request

datadog_api_client.v2.model.logs_list_response_links module¶

class LogsListResponseLinks(arg: None)¶

class LogsListResponseLinks(arg: ModelComposed)

class LogsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. Note that the request can also be made using the POST endpoint.

datadog_api_client.v2.model.logs_metric_compute module¶

class LogsMetricCompute(arg: None)¶

class LogsMetricCompute(arg: ModelComposed)

class LogsMetricCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the log-based metric.

Parameters:

aggregation_type (LogsMetricComputeAggregationType) – The type of aggregation to use.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path (str, optional) – The path to the value the log-based metric will aggregate on (only used if the aggregation type is a “distribution”).

datadog_api_client.v2.model.logs_metric_compute_aggregation_type module¶

class LogsMetricComputeAggregationType(arg: None)¶

class LogsMetricComputeAggregationType(arg: ModelComposed)

class LogsMetricComputeAggregationType(*args, **kwargs)

Bases: ModelSimple

The type of aggregation to use.

Parameters:

value (str) – Must be one of [“count”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_metric_create_attributes module¶

class LogsMetricCreateAttributes(arg: None)¶

class LogsMetricCreateAttributes(arg: ModelComposed)

class LogsMetricCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing the Datadog log-based metric to create.

Parameters:

compute (LogsMetricCompute) – The compute rule to compute the log-based metric.
filter (LogsMetricFilter, optional) – The log-based metric filter. Logs matching this filter will be aggregated in this metric.
group_by ([LogsMetricGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.logs_metric_create_data module¶

class LogsMetricCreateData(arg: None)¶

class LogsMetricCreateData(arg: ModelComposed)

class LogsMetricCreateData(*args, **kwargs)

Bases: ModelNormal

The new log-based metric properties.

Parameters:

attributes (LogsMetricCreateAttributes) – The object describing the Datadog log-based metric to create.
id (str) – The name of the log-based metric.
type (LogsMetricType) – The type of the resource. The value should always be logs_metrics.

datadog_api_client.v2.model.logs_metric_create_request module¶

class LogsMetricCreateRequest(arg: None)¶

class LogsMetricCreateRequest(arg: ModelComposed)

class LogsMetricCreateRequest(*args, **kwargs)

Bases: ModelNormal

The new log-based metric body.

Parameters:: data (LogsMetricCreateData) – The new log-based metric properties.

datadog_api_client.v2.model.logs_metric_filter module¶

class LogsMetricFilter(arg: None)¶

class LogsMetricFilter(arg: ModelComposed)

class LogsMetricFilter(*args, **kwargs)

Bases: ModelNormal

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

Parameters:: query (str, optional) – The search query - following the log search syntax.

datadog_api_client.v2.model.logs_metric_group_by module¶

class LogsMetricGroupBy(arg: None)¶

class LogsMetricGroupBy(arg: ModelComposed)

class LogsMetricGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

path (str) – The path to the value the log-based metric will be aggregated over.
tag_name (str, optional) – Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

datadog_api_client.v2.model.logs_metric_response module¶

class LogsMetricResponse(arg: None)¶

class LogsMetricResponse(arg: ModelComposed)

class LogsMetricResponse(*args, **kwargs)

Bases: ModelNormal

The log-based metric object.

Parameters:: data (LogsMetricResponseData, optional) – The log-based metric properties.

datadog_api_client.v2.model.logs_metric_response_attributes module¶

class LogsMetricResponseAttributes(arg: None)¶

class LogsMetricResponseAttributes(arg: ModelComposed)

class LogsMetricResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog log-based metric.

Parameters:

compute (LogsMetricResponseCompute, optional) – The compute rule to compute the log-based metric.
filter (LogsMetricResponseFilter, optional) – The log-based metric filter. Logs matching this filter will be aggregated in this metric.
group_by ([LogsMetricResponseGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.logs_metric_response_compute module¶

class LogsMetricResponseCompute(arg: None)¶

class LogsMetricResponseCompute(arg: ModelComposed)

class LogsMetricResponseCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the log-based metric.

Parameters:

aggregation_type (LogsMetricResponseComputeAggregationType, optional) – The type of aggregation to use.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path (str, optional) – The path to the value the log-based metric will aggregate on (only used if the aggregation type is a “distribution”).

datadog_api_client.v2.model.logs_metric_response_compute_aggregation_type module¶

class LogsMetricResponseComputeAggregationType(arg: None)¶

class LogsMetricResponseComputeAggregationType(arg: ModelComposed)

class LogsMetricResponseComputeAggregationType(*args, **kwargs)

Bases: ModelSimple

The type of aggregation to use.

Parameters:

value (str) – Must be one of [“count”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_metric_response_data module¶

class LogsMetricResponseData(arg: None)¶

class LogsMetricResponseData(arg: ModelComposed)

class LogsMetricResponseData(*args, **kwargs)

Bases: ModelNormal

The log-based metric properties.

Parameters:

attributes (LogsMetricResponseAttributes, optional) – The object describing a Datadog log-based metric.
id (str, optional) – The name of the log-based metric.
type (LogsMetricType, optional) – The type of the resource. The value should always be logs_metrics.

datadog_api_client.v2.model.logs_metric_response_filter module¶

class LogsMetricResponseFilter(arg: None)¶

class LogsMetricResponseFilter(arg: ModelComposed)

class LogsMetricResponseFilter(*args, **kwargs)

Bases: ModelNormal

The log-based metric filter. Logs matching this filter will be aggregated in this metric.

Parameters:: query (str, optional) – The search query - following the log search syntax.

datadog_api_client.v2.model.logs_metric_response_group_by module¶

class LogsMetricResponseGroupBy(arg: None)¶

class LogsMetricResponseGroupBy(arg: ModelComposed)

class LogsMetricResponseGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

path (str, optional) – The path to the value the log-based metric will be aggregated over.
tag_name (str, optional) – Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

datadog_api_client.v2.model.logs_metric_type module¶

class LogsMetricType(arg: None)¶

class LogsMetricType(arg: ModelComposed)

class LogsMetricType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be logs_metrics.

Parameters:

value (str) – If omitted defaults to “logs_metrics”. Must be one of [“logs_metrics”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_metric_update_attributes module¶

class LogsMetricUpdateAttributes(arg: None)¶

class LogsMetricUpdateAttributes(arg: ModelComposed)

class LogsMetricUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The log-based metric properties that will be updated.

Parameters:

compute (LogsMetricUpdateCompute, optional) – The compute rule to compute the log-based metric.
filter (LogsMetricFilter, optional) – The log-based metric filter. Logs matching this filter will be aggregated in this metric.
group_by ([LogsMetricGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.logs_metric_update_compute module¶

class LogsMetricUpdateCompute(arg: None)¶

class LogsMetricUpdateCompute(arg: ModelComposed)

class LogsMetricUpdateCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the log-based metric.

Parameters:: include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.

datadog_api_client.v2.model.logs_metric_update_data module¶

class LogsMetricUpdateData(arg: None)¶

class LogsMetricUpdateData(arg: ModelComposed)

class LogsMetricUpdateData(*args, **kwargs)

Bases: ModelNormal

The new log-based metric properties.

Parameters:

attributes (LogsMetricUpdateAttributes) – The log-based metric properties that will be updated.
type (LogsMetricType) – The type of the resource. The value should always be logs_metrics.

datadog_api_client.v2.model.logs_metric_update_request module¶

class LogsMetricUpdateRequest(arg: None)¶

class LogsMetricUpdateRequest(arg: ModelComposed)

class LogsMetricUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new log-based metric body.

Parameters:: data (LogsMetricUpdateData) – The new log-based metric properties.

datadog_api_client.v2.model.logs_metrics_response module¶

class LogsMetricsResponse(arg: None)¶

class LogsMetricsResponse(arg: ModelComposed)

class LogsMetricsResponse(*args, **kwargs)

Bases: ModelNormal

All the available log-based metric objects.

Parameters:: data ([LogsMetricResponseData], optional) – A list of log-based metric objects.

datadog_api_client.v2.model.logs_query_filter module¶

class LogsQueryFilter(arg: None)¶

class LogsQueryFilter(arg: ModelComposed)

class LogsQueryFilter(*args, **kwargs)

Bases: ModelNormal

The search and filter query settings

Parameters:

_from (str, optional) – The minimum time for the requested logs, supports date math and regular timestamps (milliseconds).
indexes ([str], optional) – For customers with multiple indexes, the indexes to search. Defaults to [‘*’] which means all indexes.
query (str, optional) – The search query - following the log search syntax.
storage_tier (LogsStorageTier, optional) – Specifies storage type as indexes, online-archives or flex
to (str, optional) – The maximum time for the requested logs, supports date math and regular timestamps (milliseconds).

datadog_api_client.v2.model.logs_query_options module¶

class LogsQueryOptions(arg: None)¶

class LogsQueryOptions(arg: ModelComposed)

class LogsQueryOptions(*args, **kwargs)

Bases: ModelNormal

Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results.

Parameters:

time_offset (int, optional) – The time offset (in seconds) to apply to the query.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

datadog_api_client.v2.model.logs_response_metadata module¶

class LogsResponseMetadata(arg: None)¶

class LogsResponseMetadata(arg: ModelComposed)

class LogsResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds
page (LogsResponseMetadataPage, optional) – Paging attributes.
request_id (str, optional) – The identifier of the request
status (LogsAggregateResponseStatus, optional) – The status of the response
warnings ([LogsWarning], optional) – A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response.

datadog_api_client.v2.model.logs_response_metadata_page module¶

class LogsResponseMetadataPage(arg: None)¶

class LogsResponseMetadataPage(arg: ModelComposed)

class LogsResponseMetadataPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

datadog_api_client.v2.model.logs_sort module¶

class LogsSort(arg: None)¶

class LogsSort(arg: ModelComposed)

class LogsSort(*args, **kwargs)

Bases: ModelSimple

Sort parameters when querying logs.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_sort_order module¶

class LogsSortOrder(arg: None)¶

class LogsSortOrder(arg: ModelComposed)

class LogsSortOrder(*args, **kwargs)

Bases: ModelSimple

The order to use, ascending or descending

Parameters:

value (str) – Must be one of [“asc”, “desc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_storage_tier module¶

class LogsStorageTier(arg: None)¶

class LogsStorageTier(arg: ModelComposed)

class LogsStorageTier(*args, **kwargs)

Bases: ModelSimple

Specifies storage type as indexes, online-archives or flex

Parameters:

value (str) – If omitted defaults to “indexes”. Must be one of [“indexes”, “online-archives”, “flex”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.logs_warning module¶

class LogsWarning(arg: None)¶

class LogsWarning(arg: ModelComposed)

class LogsWarning(*args, **kwargs)

Bases: ModelNormal

A warning message indicating something that went wrong with the query

Parameters:

code (str, optional) – A unique code for this type of warning
detail (str, optional) – A detailed explanation of this specific warning
title (str, optional) – A short human-readable summary of the warning

datadog_api_client.v2.model.member_team module¶

class MemberTeam(arg: None)¶

class MemberTeam(arg: ModelComposed)

class MemberTeam(*args, **kwargs)

Bases: ModelNormal

A member team

Parameters:

id (str) – The member team’s identifier
type (MemberTeamType) – Member team type

datadog_api_client.v2.model.member_team_type module¶

class MemberTeamType(arg: None)¶

class MemberTeamType(arg: ModelComposed)

class MemberTeamType(*args, **kwargs)

Bases: ModelSimple

Member team type

Parameters:

value (str) – If omitted defaults to “member_teams”. Must be one of [“member_teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metadata module¶

class Metadata(arg: None)¶

class Metadata(arg: ModelComposed)

class Metadata(*args, **kwargs)

Bases: ModelNormal

The metadata related to this request.

Parameters:

count (int) – Number of entities included in the response.
token (str) – The token that identifies the request.
total (int) – Total number of entities across all pages.

datadog_api_client.v2.model.metric module¶

class Metric(arg: None)¶

class Metric(arg: ModelComposed)

class Metric(*args, **kwargs)

Bases: ModelNormal

Object for a single metric tag configuration.

Parameters:

id (str, optional) – The metric name for this resource.
type (MetricType, optional) – The metric resource type.

datadog_api_client.v2.model.metric_active_configuration_type module¶

class MetricActiveConfigurationType(arg: None)¶

class MetricActiveConfigurationType(arg: ModelComposed)

class MetricActiveConfigurationType(*args, **kwargs)

Bases: ModelSimple

The metric actively queried configuration resource type.

Parameters:

value (str) – If omitted defaults to “actively_queried_configurations”. Must be one of [“actively_queried_configurations”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_all_tags module¶

class MetricAllTags(arg: None)¶

class MetricAllTags(arg: ModelComposed)

class MetricAllTags(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s indexed tags.

Parameters:

attributes (MetricAllTagsAttributes, optional) – Object containing the definition of a metric’s tags.
id (str, optional) – The metric name for this resource.
type (MetricType, optional) – The metric resource type.

datadog_api_client.v2.model.metric_all_tags_attributes module¶

class MetricAllTagsAttributes(arg: None)¶

class MetricAllTagsAttributes(arg: ModelComposed)

class MetricAllTagsAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric’s tags.

Parameters:: tags ([str], optional) – List of indexed tag value pairs.

datadog_api_client.v2.model.metric_all_tags_response module¶

class MetricAllTagsResponse(arg: None)¶

class MetricAllTagsResponse(arg: ModelComposed)

class MetricAllTagsResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a single metric’s indexed tags.

Parameters:: data (MetricAllTags, optional) – Object for a single metric’s indexed tags.

datadog_api_client.v2.model.metric_asset_attributes module¶

class MetricAssetAttributes(arg: None)¶

class MetricAssetAttributes(arg: ModelComposed)

class MetricAssetAttributes(*args, **kwargs)

Bases: ModelNormal

Assets related to the object, including title, url, and tags.

Parameters:

tags ([str], optional) – List of tag keys used in the asset.
title (str, optional) – Title of the asset.
url (str, optional) – URL path of the asset.

datadog_api_client.v2.model.metric_asset_dashboard_relationship module¶

class MetricAssetDashboardRelationship(arg: None)¶

class MetricAssetDashboardRelationship(arg: ModelComposed)

class MetricAssetDashboardRelationship(*args, **kwargs)

Bases: ModelNormal

An object of type dashboard that can be referenced in the included data.

Parameters:

id (str, optional) – The related dashboard’s ID.
type (MetricDashboardType, optional) – Dashboard resource type.

datadog_api_client.v2.model.metric_asset_dashboard_relationships module¶

class MetricAssetDashboardRelationships(arg: None)¶

class MetricAssetDashboardRelationships(arg: ModelComposed)

class MetricAssetDashboardRelationships(*args, **kwargs)

Bases: ModelNormal

An object containing the list of dashboards that can be referenced in the included data.

Parameters:: data ([MetricAssetDashboardRelationship], optional) – A list of dashboards that can be referenced in the included data.

datadog_api_client.v2.model.metric_asset_monitor_relationship module¶

class MetricAssetMonitorRelationship(arg: None)¶

class MetricAssetMonitorRelationship(arg: ModelComposed)

class MetricAssetMonitorRelationship(*args, **kwargs)

Bases: ModelNormal

An object of type monitor that can be referenced in the included data.

Parameters:

id (str, optional) – The related monitor’s ID.
type (MetricMonitorType, optional) – Monitor resource type.

datadog_api_client.v2.model.metric_asset_monitor_relationships module¶

class MetricAssetMonitorRelationships(arg: None)¶

class MetricAssetMonitorRelationships(arg: ModelComposed)

class MetricAssetMonitorRelationships(*args, **kwargs)

Bases: ModelNormal

A object containing the list of monitors that can be referenced in the included data.

Parameters:: data ([MetricAssetMonitorRelationship], optional) – A list of monitors that can be referenced in the included data.

datadog_api_client.v2.model.metric_asset_notebook_relationship module¶

class MetricAssetNotebookRelationship(arg: None)¶

class MetricAssetNotebookRelationship(arg: ModelComposed)

class MetricAssetNotebookRelationship(*args, **kwargs)

Bases: ModelNormal

An object of type notebook that can be referenced in the included data.

Parameters:

id (str, optional) – The related notebook’s ID.
type (MetricNotebookType, optional) – Notebook resource type.

datadog_api_client.v2.model.metric_asset_notebook_relationships module¶

class MetricAssetNotebookRelationships(arg: None)¶

class MetricAssetNotebookRelationships(arg: ModelComposed)

class MetricAssetNotebookRelationships(*args, **kwargs)

Bases: ModelNormal

An object containing the list of notebooks that can be referenced in the included data.

Parameters:: data ([MetricAssetNotebookRelationship], optional) – A list of notebooks that can be referenced in the included data.

datadog_api_client.v2.model.metric_asset_response_data module¶

class MetricAssetResponseData(arg: None)¶

class MetricAssetResponseData(arg: ModelComposed)

class MetricAssetResponseData(*args, **kwargs)

Bases: ModelNormal

Metric assets response data.

Parameters:

id (str) – The metric name for this resource.
relationships (MetricAssetResponseRelationships, optional) – Relationships to assets related to the metric.
type (MetricType) – The metric resource type.

datadog_api_client.v2.model.metric_asset_response_included module¶

class MetricAssetResponseIncluded(arg: None)¶

class MetricAssetResponseIncluded(arg: ModelComposed)

class MetricAssetResponseIncluded(*args, **kwargs)

Bases: ModelComposed

List of included assets with full set of attributes.

Parameters:

attributes (MetricDashboardAttributes, optional) – Attributes related to the dashboard, including title, popularity, and url.
id (str) – The related dashboard’s ID.
type (MetricDashboardType) – Dashboard resource type.

datadog_api_client.v2.model.metric_asset_response_relationships module¶

class MetricAssetResponseRelationships(arg: None)¶

class MetricAssetResponseRelationships(arg: ModelComposed)

class MetricAssetResponseRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships to assets related to the metric.

Parameters:

dashboards (MetricAssetDashboardRelationships, optional) – An object containing the list of dashboards that can be referenced in the included data.
monitors (MetricAssetMonitorRelationships, optional) – A object containing the list of monitors that can be referenced in the included data.
notebooks (MetricAssetNotebookRelationships, optional) – An object containing the list of notebooks that can be referenced in the included data.
slos (MetricAssetSLORelationships, optional) – An object containing a list of SLOs that can be referenced in the included data.

datadog_api_client.v2.model.metric_asset_slo_relationship module¶

class MetricAssetSLORelationship(arg: None)¶

class MetricAssetSLORelationship(arg: ModelComposed)

class MetricAssetSLORelationship(*args, **kwargs)

Bases: ModelNormal

An object of type slos that can be referenced in the included data.

Parameters:

id (str, optional) – The SLO ID.
type (MetricSLOType, optional) – SLO resource type.

datadog_api_client.v2.model.metric_asset_slo_relationships module¶

class MetricAssetSLORelationships(arg: None)¶

class MetricAssetSLORelationships(arg: ModelComposed)

class MetricAssetSLORelationships(*args, **kwargs)

Bases: ModelNormal

An object containing a list of SLOs that can be referenced in the included data.

Parameters:: data ([MetricAssetSLORelationship], optional) – A list of SLOs that can be referenced in the included data.

datadog_api_client.v2.model.metric_assets_response module¶

class MetricAssetsResponse(arg: None)¶

class MetricAssetsResponse(arg: ModelComposed)

class MetricAssetsResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes related dashboards, monitors, notebooks, and SLOs.

Parameters:

data (MetricAssetResponseData, optional) – Metric assets response data.
included ([MetricAssetResponseIncluded], optional) – Array of objects related to the metric assets.

datadog_api_client.v2.model.metric_bulk_configure_tags_type module¶

class MetricBulkConfigureTagsType(arg: None)¶

class MetricBulkConfigureTagsType(arg: ModelComposed)

class MetricBulkConfigureTagsType(*args, **kwargs)

Bases: ModelSimple

The metric bulk configure tags resource.

Parameters:

value (str) – If omitted defaults to “metric_bulk_configure_tags”. Must be one of [“metric_bulk_configure_tags”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_bulk_tag_config_create module¶

class MetricBulkTagConfigCreate(arg: None)¶

class MetricBulkTagConfigCreate(arg: ModelComposed)

class MetricBulkTagConfigCreate(*args, **kwargs)

Bases: ModelNormal

Request object to bulk configure tags for metrics matching the given prefix.

Parameters:

attributes (MetricBulkTagConfigCreateAttributes, optional) – Optional parameters for bulk creating metric tag configurations.
id (str) – A text prefix to match against metric names.
type (MetricBulkConfigureTagsType) – The metric bulk configure tags resource.

datadog_api_client.v2.model.metric_bulk_tag_config_create_attributes module¶

class MetricBulkTagConfigCreateAttributes(arg: None)¶

class MetricBulkTagConfigCreateAttributes(arg: ModelComposed)

class MetricBulkTagConfigCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Optional parameters for bulk creating metric tag configurations.

Parameters:

emails (MetricBulkTagConfigEmailList, optional) – A list of account emails to notify when the configuration is applied.
exclude_tags_mode (bool, optional) – When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags. Defaults to false.
include_actively_queried_tags_window (float, optional) – When provided, all tags that have been actively queried are configured (and, therefore, remain queryable) for each metric that matches the given prefix. Minimum value is 1 second, and maximum value is 7,776,000 seconds (90 days).
override_existing_configurations (bool, optional) – When set to true, the configuration overrides any existing configurations for the given metric with the new set of tags in this configuration request. If false, old configurations are kept and are merged with the set of tags in this configuration request. Defaults to true.
tags (MetricBulkTagConfigTagNameList, optional) – A list of tag names to apply to the configuration.

datadog_api_client.v2.model.metric_bulk_tag_config_create_request module¶

class MetricBulkTagConfigCreateRequest(arg: None)¶

class MetricBulkTagConfigCreateRequest(arg: ModelComposed)

class MetricBulkTagConfigCreateRequest(*args, **kwargs)

Bases: ModelNormal

Wrapper object for a single bulk tag configuration request.

Parameters:: data (MetricBulkTagConfigCreate) – Request object to bulk configure tags for metrics matching the given prefix.

datadog_api_client.v2.model.metric_bulk_tag_config_delete module¶

class MetricBulkTagConfigDelete(arg: None)¶

class MetricBulkTagConfigDelete(arg: ModelComposed)

class MetricBulkTagConfigDelete(*args, **kwargs)

Bases: ModelNormal

Request object to bulk delete all tag configurations for metrics matching the given prefix.

Parameters:

attributes (MetricBulkTagConfigDeleteAttributes, optional) – Optional parameters for bulk deleting metric tag configurations.
id (str) – A text prefix to match against metric names.
type (MetricBulkConfigureTagsType) – The metric bulk configure tags resource.

datadog_api_client.v2.model.metric_bulk_tag_config_delete_attributes module¶

class MetricBulkTagConfigDeleteAttributes(arg: None)¶

class MetricBulkTagConfigDeleteAttributes(arg: ModelComposed)

class MetricBulkTagConfigDeleteAttributes(*args, **kwargs)

Bases: ModelNormal

Optional parameters for bulk deleting metric tag configurations.

Parameters:: emails (MetricBulkTagConfigEmailList, optional) – A list of account emails to notify when the configuration is applied.

datadog_api_client.v2.model.metric_bulk_tag_config_delete_request module¶

class MetricBulkTagConfigDeleteRequest(arg: None)¶

class MetricBulkTagConfigDeleteRequest(arg: ModelComposed)

class MetricBulkTagConfigDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Wrapper object for a single bulk tag deletion request.

Parameters:: data (MetricBulkTagConfigDelete) – Request object to bulk delete all tag configurations for metrics matching the given prefix.

datadog_api_client.v2.model.metric_bulk_tag_config_email_list module¶

class MetricBulkTagConfigEmailList(arg: None)¶

class MetricBulkTagConfigEmailList(arg: ModelComposed)

class MetricBulkTagConfigEmailList(*args, **kwargs)

Bases: ModelSimple

A list of account emails to notify when the configuration is applied.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_bulk_tag_config_response module¶

class MetricBulkTagConfigResponse(arg: None)¶

class MetricBulkTagConfigResponse(arg: ModelComposed)

class MetricBulkTagConfigResponse(*args, **kwargs)

Bases: ModelNormal

Wrapper for a single bulk tag configuration status response.

Parameters:: data (MetricBulkTagConfigStatus, optional) – The status of a request to bulk configure metric tags. It contains the fields from the original request for reference.

datadog_api_client.v2.model.metric_bulk_tag_config_status module¶

class MetricBulkTagConfigStatus(arg: None)¶

class MetricBulkTagConfigStatus(arg: ModelComposed)

class MetricBulkTagConfigStatus(*args, **kwargs)

Bases: ModelNormal

The status of a request to bulk configure metric tags. It contains the fields from the original request for reference.

Parameters:

attributes (MetricBulkTagConfigStatusAttributes, optional) – Optional attributes for the status of a bulk tag configuration request.
id (str) – A text prefix to match against metric names.
type (MetricBulkConfigureTagsType) – The metric bulk configure tags resource.

datadog_api_client.v2.model.metric_bulk_tag_config_status_attributes module¶

class MetricBulkTagConfigStatusAttributes(arg: None)¶

class MetricBulkTagConfigStatusAttributes(arg: ModelComposed)

class MetricBulkTagConfigStatusAttributes(*args, **kwargs)

Bases: ModelNormal

Optional attributes for the status of a bulk tag configuration request.

Parameters:

emails (MetricBulkTagConfigEmailList, optional) – A list of account emails to notify when the configuration is applied.
exclude_tags_mode (bool, optional) – When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags.
status (str, optional) – The status of the request.
tags (MetricBulkTagConfigTagNameList, optional) – A list of tag names to apply to the configuration.

datadog_api_client.v2.model.metric_bulk_tag_config_tag_name_list module¶

class MetricBulkTagConfigTagNameList(arg: None)¶

class MetricBulkTagConfigTagNameList(arg: ModelComposed)

class MetricBulkTagConfigTagNameList(*args, **kwargs)

Bases: ModelSimple

A list of tag names to apply to the configuration.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_content_encoding module¶

class MetricContentEncoding(arg: None)¶

class MetricContentEncoding(arg: ModelComposed)

class MetricContentEncoding(*args, **kwargs)

Bases: ModelSimple

HTTP header used to compress the media-type.

Parameters:

value (str) – If omitted defaults to “deflate”. Must be one of [“deflate”, “zstd1”, “gzip”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_custom_aggregation module¶

class MetricCustomAggregation(arg: None)¶

class MetricCustomAggregation(arg: ModelComposed)

class MetricCustomAggregation(*args, **kwargs)

Bases: ModelNormal

A time and space aggregation combination for use in query.

Parameters:

space (MetricCustomSpaceAggregation) – A space aggregation for use in query.
time (MetricCustomTimeAggregation) – A time aggregation for use in query.

datadog_api_client.v2.model.metric_custom_aggregations module¶

class MetricCustomAggregations(arg: None)¶

class MetricCustomAggregations(arg: ModelComposed)

class MetricCustomAggregations(*args, **kwargs)

Bases: ModelSimple

Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_custom_space_aggregation module¶

class MetricCustomSpaceAggregation(arg: None)¶

class MetricCustomSpaceAggregation(arg: ModelComposed)

class MetricCustomSpaceAggregation(*args, **kwargs)

Bases: ModelSimple

A space aggregation for use in query.

Parameters:

value (str) – Must be one of [“avg”, “max”, “min”, “sum”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_custom_time_aggregation module¶

class MetricCustomTimeAggregation(arg: None)¶

class MetricCustomTimeAggregation(arg: ModelComposed)

class MetricCustomTimeAggregation(*args, **kwargs)

Bases: ModelSimple

A time aggregation for use in query.

Parameters:

value (str) – Must be one of [“avg”, “count”, “max”, “min”, “sum”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_dashboard_asset module¶

class MetricDashboardAsset(arg: None)¶

class MetricDashboardAsset(arg: ModelComposed)

class MetricDashboardAsset(*args, **kwargs)

Bases: ModelNormal

A dashboard object with title and popularity.

Parameters:

attributes (MetricDashboardAttributes, optional) – Attributes related to the dashboard, including title, popularity, and url.
id (str) – The related dashboard’s ID.
type (MetricDashboardType) – Dashboard resource type.

datadog_api_client.v2.model.metric_dashboard_attributes module¶

class MetricDashboardAttributes(arg: None)¶

class MetricDashboardAttributes(arg: ModelComposed)

class MetricDashboardAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes related to the dashboard, including title, popularity, and url.

Parameters:

popularity (float, optional) – Value from 0 to 5 that ranks popularity of the dashboard.
tags ([str], optional) – List of tag keys used in the asset.
title (str, optional) – Title of the asset.
url (str, optional) – URL path of the asset.

datadog_api_client.v2.model.metric_dashboard_type module¶

class MetricDashboardType(arg: None)¶

class MetricDashboardType(arg: ModelComposed)

class MetricDashboardType(*args, **kwargs)

Bases: ModelSimple

Dashboard resource type.

Parameters:

value (str) – If omitted defaults to “dashboards”. Must be one of [“dashboards”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_distinct_volume module¶

class MetricDistinctVolume(arg: None)¶

class MetricDistinctVolume(arg: ModelComposed)

class MetricDistinctVolume(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s distinct volume.

Parameters:

attributes (MetricDistinctVolumeAttributes, optional) – Object containing the definition of a metric’s distinct volume.
id (str, optional) – The metric name for this resource.
type (MetricDistinctVolumeType, optional) – The metric distinct volume type.

datadog_api_client.v2.model.metric_distinct_volume_attributes module¶

class MetricDistinctVolumeAttributes(arg: None)¶

class MetricDistinctVolumeAttributes(arg: ModelComposed)

class MetricDistinctVolumeAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric’s distinct volume.

Parameters:: distinct_volume (int, optional) – Distinct volume for the given metric.

datadog_api_client.v2.model.metric_distinct_volume_type module¶

class MetricDistinctVolumeType(arg: None)¶

class MetricDistinctVolumeType(arg: ModelComposed)

class MetricDistinctVolumeType(*args, **kwargs)

Bases: ModelSimple

The metric distinct volume type.

Parameters:

value (str) – If omitted defaults to “distinct_metric_volumes”. Must be one of [“distinct_metric_volumes”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_estimate module¶

class MetricEstimate(arg: None)¶

class MetricEstimate(arg: ModelComposed)

class MetricEstimate(*args, **kwargs)

Bases: ModelNormal

Object for a metric cardinality estimate.

Parameters:

attributes (MetricEstimateAttributes, optional) – Object containing the definition of a metric estimate attribute.
id (str, optional) – The metric name for this resource.
type (MetricEstimateResourceType, optional) – The metric estimate resource type.

datadog_api_client.v2.model.metric_estimate_attributes module¶

class MetricEstimateAttributes(arg: None)¶

class MetricEstimateAttributes(arg: ModelComposed)

class MetricEstimateAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric estimate attribute.

Parameters:

estimate_type (MetricEstimateType, optional) – Estimate type based on the queried configuration. By default, count_or_gauge is returned. distribution is returned for distribution metrics without percentiles enabled. Lastly, percentile is returned if filter[pct]=true is queried with a distribution metric.
estimated_at (datetime, optional) – Timestamp when the cardinality estimate was requested.
estimated_output_series (int, optional) – Estimated cardinality of the metric based on the queried configuration.

datadog_api_client.v2.model.metric_estimate_resource_type module¶

class MetricEstimateResourceType(arg: None)¶

class MetricEstimateResourceType(arg: ModelComposed)

class MetricEstimateResourceType(*args, **kwargs)

Bases: ModelSimple

The metric estimate resource type.

Parameters:

value (str) – If omitted defaults to “metric_cardinality_estimate”. Must be one of [“metric_cardinality_estimate”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_estimate_response module¶

class MetricEstimateResponse(arg: None)¶

class MetricEstimateResponse(arg: ModelComposed)

class MetricEstimateResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes metric cardinality estimates.

Parameters:: data (MetricEstimate, optional) – Object for a metric cardinality estimate.

datadog_api_client.v2.model.metric_estimate_type module¶

class MetricEstimateType(arg: None)¶

class MetricEstimateType(arg: ModelComposed)

class MetricEstimateType(*args, **kwargs)

Bases: ModelSimple

Estimate type based on the queried configuration. By default, count_or_gauge is returned. distribution is returned for distribution metrics without percentiles enabled. Lastly, percentile is returned if filter[pct]=true is queried with a distribution metric.

Parameters:

value (str) – If omitted defaults to “count_or_gauge”. Must be one of [“count_or_gauge”, “distribution”, “percentile”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_ingested_indexed_volume module¶

class MetricIngestedIndexedVolume(arg: None)¶

class MetricIngestedIndexedVolume(arg: ModelComposed)

class MetricIngestedIndexedVolume(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s ingested and indexed volume.

Parameters:

attributes (MetricIngestedIndexedVolumeAttributes, optional) – Object containing the definition of a metric’s ingested and indexed volume.
id (str, optional) – The metric name for this resource.
type (MetricIngestedIndexedVolumeType, optional) – The metric ingested and indexed volume type.

datadog_api_client.v2.model.metric_ingested_indexed_volume_attributes module¶

class MetricIngestedIndexedVolumeAttributes(arg: None)¶

class MetricIngestedIndexedVolumeAttributes(arg: ModelComposed)

class MetricIngestedIndexedVolumeAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric’s ingested and indexed volume.

Parameters:

indexed_volume (int, optional) – Indexed volume for the given metric.
ingested_volume (int, optional) – Ingested volume for the given metric.

datadog_api_client.v2.model.metric_ingested_indexed_volume_type module¶

class MetricIngestedIndexedVolumeType(arg: None)¶

class MetricIngestedIndexedVolumeType(arg: ModelComposed)

class MetricIngestedIndexedVolumeType(*args, **kwargs)

Bases: ModelSimple

The metric ingested and indexed volume type.

Parameters:

value (str) – If omitted defaults to “metric_volumes”. Must be one of [“metric_volumes”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_intake_type module¶

class MetricIntakeType(arg: None)¶

class MetricIntakeType(arg: ModelComposed)

class MetricIntakeType(*args, **kwargs)

Bases: ModelSimple

The type of metric. The available types are 0 (unspecified), 1 (count), 2 (rate), and 3 (gauge).

Parameters:

value (int) – Must be one of [0, 1, 2, 3].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_meta_page module¶

class MetricMetaPage(arg: None)¶

class MetricMetaPage(arg: ModelComposed)

class MetricMetaPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes. Only present if pagination query parameters were provided.

Parameters:

cursor (str, none_type, optional) – The cursor used to get the current results, if any.
limit (int, optional) – Number of results returned
next_cursor (str, none_type, optional) – The cursor used to get the next results, if any.
type (MetricMetaPageType, optional) – Type of metric pagination.

datadog_api_client.v2.model.metric_meta_page_type module¶

class MetricMetaPageType(arg: None)¶

class MetricMetaPageType(arg: ModelComposed)

class MetricMetaPageType(*args, **kwargs)

Bases: ModelSimple

Type of metric pagination.

Parameters:

value (str) – If omitted defaults to “cursor_limit”. Must be one of [“cursor_limit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_metadata module¶

class MetricMetadata(arg: None)¶

class MetricMetadata(arg: ModelComposed)

class MetricMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata for the metric.

Parameters:: origin (MetricOrigin, optional) – Metric origin information.

datadog_api_client.v2.model.metric_monitor_asset module¶

class MetricMonitorAsset(arg: None)¶

class MetricMonitorAsset(arg: ModelComposed)

class MetricMonitorAsset(*args, **kwargs)

Bases: ModelNormal

A monitor object with title.

Parameters:

attributes (MetricAssetAttributes, optional) – Assets related to the object, including title, url, and tags.
id (str) – The related monitor’s ID.
type (MetricMonitorType) – Monitor resource type.

datadog_api_client.v2.model.metric_monitor_type module¶

class MetricMonitorType(arg: None)¶

class MetricMonitorType(arg: ModelComposed)

class MetricMonitorType(*args, **kwargs)

Bases: ModelSimple

Monitor resource type.

Parameters:

value (str) – If omitted defaults to “monitors”. Must be one of [“monitors”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_notebook_asset module¶

class MetricNotebookAsset(arg: None)¶

class MetricNotebookAsset(arg: ModelComposed)

class MetricNotebookAsset(*args, **kwargs)

Bases: ModelNormal

A notebook object with title.

Parameters:

attributes (MetricAssetAttributes, optional) – Assets related to the object, including title, url, and tags.
id (str) – The related notebook’s ID.
type (MetricNotebookType) – Notebook resource type.

datadog_api_client.v2.model.metric_notebook_type module¶

class MetricNotebookType(arg: None)¶

class MetricNotebookType(arg: ModelComposed)

class MetricNotebookType(*args, **kwargs)

Bases: ModelSimple

Notebook resource type.

Parameters:

value (str) – If omitted defaults to “notebooks”. Must be one of [“notebooks”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_origin module¶

class MetricOrigin(arg: None)¶

class MetricOrigin(arg: ModelComposed)

class MetricOrigin(*args, **kwargs)

Bases: ModelNormal

Metric origin information.

Parameters:

metric_type (int, optional) – The origin metric type code
product (int, optional) – The origin product code
service (int, optional) – The origin service code

datadog_api_client.v2.model.metric_pagination_meta module¶

class MetricPaginationMeta(arg: None)¶

class MetricPaginationMeta(arg: ModelComposed)

class MetricPaginationMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:: pagination (MetricMetaPage, optional) – Paging attributes. Only present if pagination query parameters were provided.

datadog_api_client.v2.model.metric_payload module¶

class MetricPayload(arg: None)¶

class MetricPayload(arg: ModelComposed)

class MetricPayload(*args, **kwargs)

Bases: ModelNormal

The metrics’ payload.

Parameters:: series ([MetricSeries]) – A list of timeseries to submit to Datadog.

datadog_api_client.v2.model.metric_point module¶

class MetricPoint(arg: None)¶

class MetricPoint(arg: ModelComposed)

class MetricPoint(*args, **kwargs)

Bases: ModelNormal

A point object is of the form {POSIX_timestamp, numeric_value}.

Parameters:

timestamp (int, optional) – The timestamp should be in seconds and current. Current is defined as not more than 10 minutes in the future or more than 1 hour in the past.
value (float, optional) – The numeric value format should be a 64bit float gauge-type value.

datadog_api_client.v2.model.metric_resource module¶

class MetricResource(arg: None)¶

class MetricResource(arg: ModelComposed)

class MetricResource(*args, **kwargs)

Bases: ModelNormal

Metric resource.

Parameters:

name (str, optional) – The name of the resource.
type (str, optional) – The type of the resource.

datadog_api_client.v2.model.metric_series module¶

class MetricSeries(arg: None)¶

class MetricSeries(arg: ModelComposed)

class MetricSeries(*args, **kwargs)

Bases: ModelNormal

A metric to submit to Datadog. See Datadog metrics.

Parameters:

interval (int, optional) – If the type of the metric is rate or count, define the corresponding interval in seconds.
metadata (MetricMetadata, optional) – Metadata for the metric.
metric (str) – The name of the timeseries.
points ([MetricPoint]) – Points relating to a metric. All points must be objects with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past.
resources ([MetricResource], optional) – A list of resources to associate with this metric.
source_type_name (str, optional) – The source type name.
tags ([str], optional) – A list of tags associated with the metric.
type (MetricIntakeType, optional) – The type of metric. The available types are 0 (unspecified), 1 (count), 2 (rate), and 3 (gauge).
unit (str, optional) – The unit of point value.

datadog_api_client.v2.model.metric_slo_asset module¶

class MetricSLOAsset(arg: None)¶

class MetricSLOAsset(arg: ModelComposed)

class MetricSLOAsset(*args, **kwargs)

Bases: ModelNormal

A SLO object with title.

Parameters:

attributes (MetricAssetAttributes, optional) – Assets related to the object, including title, url, and tags.
id (str) – The SLO ID.
type (MetricSLOType) – SLO resource type.

datadog_api_client.v2.model.metric_slo_type module¶

class MetricSLOType(arg: None)¶

class MetricSLOType(arg: ModelComposed)

class MetricSLOType(*args, **kwargs)

Bases: ModelSimple

SLO resource type.

Parameters:

value (str) – If omitted defaults to “slos”. Must be one of [“slos”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_suggested_aggregations module¶

class MetricSuggestedAggregations(arg: None)¶

class MetricSuggestedAggregations(arg: ModelComposed)

class MetricSuggestedAggregations(*args, **kwargs)

Bases: ModelSimple

List of aggregation combinations that have been actively queried.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_suggested_tags_and_aggregations module¶

class MetricSuggestedTagsAndAggregations(arg: None)¶

class MetricSuggestedTagsAndAggregations(arg: ModelComposed)

class MetricSuggestedTagsAndAggregations(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s actively queried tags and aggregations.

Parameters:

attributes (MetricSuggestedTagsAttributes, optional) – Object containing the definition of a metric’s actively queried tags and aggregations.
id (str, optional) – The metric name for this resource.
type (MetricActiveConfigurationType, optional) – The metric actively queried configuration resource type.

datadog_api_client.v2.model.metric_suggested_tags_and_aggregations_response module¶

class MetricSuggestedTagsAndAggregationsResponse(arg: None)¶

class MetricSuggestedTagsAndAggregationsResponse(arg: ModelComposed)

class MetricSuggestedTagsAndAggregationsResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes a single metric’s actively queried tags and aggregations.

Parameters:: data (MetricSuggestedTagsAndAggregations, optional) – Object for a single metric’s actively queried tags and aggregations.

datadog_api_client.v2.model.metric_suggested_tags_attributes module¶

class MetricSuggestedTagsAttributes(arg: None)¶

class MetricSuggestedTagsAttributes(arg: ModelComposed)

class MetricSuggestedTagsAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric’s actively queried tags and aggregations.

Parameters:

active_aggregations (MetricSuggestedAggregations, optional) – List of aggregation combinations that have been actively queried.
active_tags ([str], optional) – List of tag keys that have been actively queried.

datadog_api_client.v2.model.metric_tag_cardinalities_meta module¶

class MetricTagCardinalitiesMeta(arg: None)¶

class MetricTagCardinalitiesMeta(arg: ModelComposed)

class MetricTagCardinalitiesMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:: metric_name (str, optional) – The name of metric for which the tag cardinalities are returned. This matches the metric name provided in the request.

datadog_api_client.v2.model.metric_tag_cardinalities_response module¶

class MetricTagCardinalitiesResponse(arg: None)¶

class MetricTagCardinalitiesResponse(arg: ModelComposed)

class MetricTagCardinalitiesResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes an array of objects representing the cardinality details of a metric’s tags.

Parameters:

data ([MetricTagCardinality], optional) – A list of tag cardinalities associated with the given metric.
meta (MetricTagCardinalitiesMeta, optional) – Response metadata object.

datadog_api_client.v2.model.metric_tag_cardinality module¶

class MetricTagCardinality(arg: None)¶

class MetricTagCardinality(arg: ModelComposed)

class MetricTagCardinality(*args, **kwargs)

Bases: ModelNormal

Object containing metadata and attributes related to a specific tag key associated with the metric.

Parameters:

attributes (MetricTagCardinalityAttributes, optional) – An object containing properties related to the tag key
id (str, optional) – The name of the tag key.
type (str, optional) – This describes the endpoint action.

datadog_api_client.v2.model.metric_tag_cardinality_attributes module¶

class MetricTagCardinalityAttributes(arg: None)¶

class MetricTagCardinalityAttributes(arg: ModelComposed)

class MetricTagCardinalityAttributes(*args, **kwargs)

Bases: ModelNormal

An object containing properties related to the tag key

Parameters:: cardinality_delta (int, optional) – This describes the recent change in the tag keys cardinality

datadog_api_client.v2.model.metric_tag_configuration module¶

class MetricTagConfiguration(arg: None)¶

class MetricTagConfiguration(arg: ModelComposed)

class MetricTagConfiguration(*args, **kwargs)

Bases: ModelNormal

Object for a single metric tag configuration.

Parameters:

attributes (MetricTagConfigurationAttributes, optional) – Object containing the definition of a metric tag configuration attributes.
id (str, optional) – The metric name for this resource.
type (MetricTagConfigurationType, optional) – The metric tag configuration resource type.

datadog_api_client.v2.model.metric_tag_configuration_attributes module¶

class MetricTagConfigurationAttributes(arg: None)¶

class MetricTagConfigurationAttributes(arg: ModelComposed)

class MetricTagConfigurationAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric tag configuration attributes.

Parameters:

aggregations (MetricCustomAggregations, optional) – Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
created_at (datetime, optional) – Timestamp when the tag configuration was created.
exclude_tags_mode (bool, optional) – When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags. Defaults to false. Requires tags property.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the metric_type is distribution.
metric_type (MetricTagConfigurationMetricTypes, optional) – The metric’s type.
modified_at (datetime, optional) – Timestamp when the tag configuration was last modified.
tags ([str], optional) – List of tag keys on which to group.

datadog_api_client.v2.model.metric_tag_configuration_create_attributes module¶

class MetricTagConfigurationCreateAttributes(arg: None)¶

class MetricTagConfigurationCreateAttributes(arg: ModelComposed)

class MetricTagConfigurationCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric tag configuration to be created.

Parameters:

aggregations (MetricCustomAggregations, optional) – Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
exclude_tags_mode (bool, optional) – When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags. Defaults to false. Requires tags property.
include_percentiles (bool, optional) – Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a metric_type of distribution.
metric_type (MetricTagConfigurationMetricTypes) – The metric’s type.
tags ([str]) – A list of tag keys that will be queryable for your metric.

datadog_api_client.v2.model.metric_tag_configuration_create_data module¶

class MetricTagConfigurationCreateData(arg: None)¶

class MetricTagConfigurationCreateData(arg: ModelComposed)

class MetricTagConfigurationCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single metric to be configure tags on.

Parameters:

attributes (MetricTagConfigurationCreateAttributes, optional) – Object containing the definition of a metric tag configuration to be created.
id (str) – The metric name for this resource.
type (MetricTagConfigurationType) – The metric tag configuration resource type.

datadog_api_client.v2.model.metric_tag_configuration_create_request module¶

class MetricTagConfigurationCreateRequest(arg: None)¶

class MetricTagConfigurationCreateRequest(arg: ModelComposed)

class MetricTagConfigurationCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the metric that you would like to configure tags for.

Parameters:: data (MetricTagConfigurationCreateData) – Object for a single metric to be configure tags on.

datadog_api_client.v2.model.metric_tag_configuration_metric_type_category module¶

class MetricTagConfigurationMetricTypeCategory(arg: None)¶

class MetricTagConfigurationMetricTypeCategory(arg: ModelComposed)

class MetricTagConfigurationMetricTypeCategory(*args, **kwargs)

Bases: ModelSimple

The metric’s type category.

Parameters:

value (str) – If omitted defaults to “distribution”. Must be one of [“non_distribution”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_tag_configuration_metric_types module¶

class MetricTagConfigurationMetricTypes(arg: None)¶

class MetricTagConfigurationMetricTypes(arg: ModelComposed)

class MetricTagConfigurationMetricTypes(*args, **kwargs)

Bases: ModelSimple

The metric’s type.

Parameters:

value (str) – If omitted defaults to “gauge”. Must be one of [“gauge”, “count”, “rate”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_tag_configuration_response module¶

class MetricTagConfigurationResponse(arg: None)¶

class MetricTagConfigurationResponse(arg: ModelComposed)

class MetricTagConfigurationResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes a single metric’s tag configuration.

Parameters:: data (MetricTagConfiguration, optional) – Object for a single metric tag configuration.

datadog_api_client.v2.model.metric_tag_configuration_type module¶

class MetricTagConfigurationType(arg: None)¶

class MetricTagConfigurationType(arg: ModelComposed)

class MetricTagConfigurationType(*args, **kwargs)

Bases: ModelSimple

The metric tag configuration resource type.

Parameters:

value (str) – If omitted defaults to “manage_tags”. Must be one of [“manage_tags”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_tag_configuration_update_attributes module¶

class MetricTagConfigurationUpdateAttributes(arg: None)¶

class MetricTagConfigurationUpdateAttributes(arg: ModelComposed)

class MetricTagConfigurationUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric tag configuration to be updated.

Parameters:

aggregations (MetricCustomAggregations, optional) – Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
exclude_tags_mode (bool, optional) – When set to true, the configuration will exclude the configured tags and include any other submitted tags. When set to false, the configuration will include the configured tags and exclude any other submitted tags. Defaults to false. Requires tags property.
include_percentiles (bool, optional) – Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a metric_type of distribution.
tags ([str], optional) – A list of tag keys that will be queryable for your metric.

datadog_api_client.v2.model.metric_tag_configuration_update_data module¶

class MetricTagConfigurationUpdateData(arg: None)¶

class MetricTagConfigurationUpdateData(arg: ModelComposed)

class MetricTagConfigurationUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single tag configuration to be edited.

Parameters:

attributes (MetricTagConfigurationUpdateAttributes, optional) – Object containing the definition of a metric tag configuration to be updated.
id (str) – The metric name for this resource.
type (MetricTagConfigurationType) – The metric tag configuration resource type.

datadog_api_client.v2.model.metric_tag_configuration_update_request module¶

class MetricTagConfigurationUpdateRequest(arg: None)¶

class MetricTagConfigurationUpdateRequest(arg: ModelComposed)

class MetricTagConfigurationUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the metric that you would like to edit the tag configuration on.

Parameters:: data (MetricTagConfigurationUpdateData) – Object for a single tag configuration to be edited.

datadog_api_client.v2.model.metric_type module¶

class MetricType(arg: None)¶

class MetricType(arg: ModelComposed)

class MetricType(*args, **kwargs)

Bases: ModelSimple

The metric resource type.

Parameters:

value (str) – If omitted defaults to “metrics”. Must be one of [“metrics”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metric_volumes module¶

class MetricVolumes(arg: None)¶

class MetricVolumes(arg: ModelComposed)

class MetricVolumes(*args, **kwargs)

Bases: ModelComposed

Possible response objects for a metric’s volume.

Parameters:

attributes (MetricDistinctVolumeAttributes, optional) – Object containing the definition of a metric’s distinct volume.
id (str, optional) – The metric name for this resource.
type (MetricDistinctVolumeType, optional) – The metric distinct volume type.

datadog_api_client.v2.model.metric_volumes_response module¶

class MetricVolumesResponse(arg: None)¶

class MetricVolumesResponse(arg: ModelComposed)

class MetricVolumesResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes a single metric’s volume.

Parameters:: data (MetricVolumes, optional) – Possible response objects for a metric’s volume.

datadog_api_client.v2.model.metrics_aggregator module¶

class MetricsAggregator(arg: None)¶

class MetricsAggregator(arg: ModelComposed)

class MetricsAggregator(*args, **kwargs)

Bases: ModelSimple

The type of aggregation that can be performed on metrics-based queries.

Parameters:

value (str) – If omitted defaults to “avg”. Must be one of [“avg”, “min”, “max”, “sum”, “last”, “percentile”, “mean”, “l2norm”, “area”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metrics_and_metric_tag_configurations module¶

class MetricsAndMetricTagConfigurations(arg: None)¶

class MetricsAndMetricTagConfigurations(arg: ModelComposed)

class MetricsAndMetricTagConfigurations(*args, **kwargs)

Bases: ModelComposed

Object for a metrics and metric tag configurations.

Parameters:

id (str, optional) – The metric name for this resource.
type (MetricType, optional) – The metric resource type.
attributes (MetricTagConfigurationAttributes, optional) – Object containing the definition of a metric tag configuration attributes.

datadog_api_client.v2.model.metrics_and_metric_tag_configurations_response module¶

class MetricsAndMetricTagConfigurationsResponse(arg: None)¶

class MetricsAndMetricTagConfigurationsResponse(arg: ModelComposed)

class MetricsAndMetricTagConfigurationsResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes metrics and metric tag configurations.

Parameters:

data ([MetricsAndMetricTagConfigurations], optional) – Array of metrics and metric tag configurations.
links (MetricsListResponseLinks, optional) – Pagination links. Only present if pagination query parameters were provided.
meta (MetricPaginationMeta, optional) – Response metadata object.

datadog_api_client.v2.model.metrics_data_source module¶

class MetricsDataSource(arg: None)¶

class MetricsDataSource(arg: ModelComposed)

class MetricsDataSource(*args, **kwargs)

Bases: ModelSimple

A data source that is powered by the Metrics platform.

Parameters:

value (str) – If omitted defaults to “metrics”. Must be one of [“metrics”, “cloud_cost”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.metrics_list_response_links module¶

class MetricsListResponseLinks(arg: None)¶

class MetricsListResponseLinks(arg: ModelComposed)

class MetricsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Pagination links. Only present if pagination query parameters were provided.

Parameters:

first (str, optional) – Link to the first page.
last (str, none_type, optional) – Link to the last page.
next (str, none_type, optional) – Link to the next page.
prev (str, none_type, optional) – Link to previous page.
self (str, optional) – Link to current page.

datadog_api_client.v2.model.metrics_scalar_query module¶

class MetricsScalarQuery(arg: None)¶

class MetricsScalarQuery(arg: ModelComposed)

class MetricsScalarQuery(*args, **kwargs)

Bases: ModelNormal

An individual scalar metrics query.

Parameters:

aggregator (MetricsAggregator) – The type of aggregation that can be performed on metrics-based queries.
data_source (MetricsDataSource) – A data source that is powered by the Metrics platform.
name (str, optional) – The variable name for use in formulas.
query (str) – A classic metrics query string.

datadog_api_client.v2.model.metrics_timeseries_query module¶

class MetricsTimeseriesQuery(arg: None)¶

class MetricsTimeseriesQuery(arg: ModelComposed)

class MetricsTimeseriesQuery(*args, **kwargs)

Bases: ModelNormal

An individual timeseries metrics query.

Parameters:

data_source (MetricsDataSource) – A data source that is powered by the Metrics platform.
name (str, optional) – The variable name for use in formulas.
query (str) – A classic metrics query string.

datadog_api_client.v2.model.microsoft_sentinel_destination module¶

class MicrosoftSentinelDestination(arg: None)¶

class MicrosoftSentinelDestination(arg: ModelComposed)

class MicrosoftSentinelDestination(*args, **kwargs)

Bases: ModelNormal

The microsoft_sentinel destination forwards logs to Microsoft Sentinel.

Parameters:

client_id (str) – Azure AD client ID used for authentication.
dcr_immutable_id (str) – The immutable ID of the Data Collection Rule (DCR).
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
table (str) – The name of the Log Analytics table where logs are sent.
tenant_id (str) – Azure AD tenant ID.
type (MicrosoftSentinelDestinationType) – The destination type. The value should always be microsoft_sentinel.

datadog_api_client.v2.model.microsoft_sentinel_destination_type module¶

class MicrosoftSentinelDestinationType(arg: None)¶

class MicrosoftSentinelDestinationType(arg: ModelComposed)

class MicrosoftSentinelDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be microsoft_sentinel.

Parameters:

value (str) – If omitted defaults to “microsoft_sentinel”. Must be one of [“microsoft_sentinel”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.microsoft_teams_channel_info_response_attributes module¶

class MicrosoftTeamsChannelInfoResponseAttributes(arg: None)¶

class MicrosoftTeamsChannelInfoResponseAttributes(arg: ModelComposed)

class MicrosoftTeamsChannelInfoResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Channel attributes.

Parameters:

is_primary (bool, optional) – Indicates if this is the primary channel.
team_id (str, optional) – Team id.
tenant_id (str, optional) – Tenant id.

datadog_api_client.v2.model.microsoft_teams_channel_info_response_data module¶

class MicrosoftTeamsChannelInfoResponseData(arg: None)¶

class MicrosoftTeamsChannelInfoResponseData(arg: ModelComposed)

class MicrosoftTeamsChannelInfoResponseData(*args, **kwargs)

Bases: ModelNormal

Channel data from a response.

Parameters:

attributes (MicrosoftTeamsChannelInfoResponseAttributes, optional) – Channel attributes.
id (str, optional) – The ID of the channel.
type (MicrosoftTeamsChannelInfoType, optional) – Channel info resource type.

datadog_api_client.v2.model.microsoft_teams_channel_info_type module¶

class MicrosoftTeamsChannelInfoType(arg: None)¶

class MicrosoftTeamsChannelInfoType(arg: ModelComposed)

class MicrosoftTeamsChannelInfoType(*args, **kwargs)

Bases: ModelSimple

Channel info resource type.

Parameters:

value (str) – If omitted defaults to “ms-teams-channel-info”. Must be one of [“ms-teams-channel-info”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.microsoft_teams_configuration_reference module¶

class MicrosoftTeamsConfigurationReference(arg: None)¶

class MicrosoftTeamsConfigurationReference(arg: ModelComposed)

class MicrosoftTeamsConfigurationReference(*args, **kwargs)

Bases: ModelNormal

A reference to a Microsoft Teams Configuration resource.

Parameters:: data (MicrosoftTeamsConfigurationReferenceData, none_type) – The Microsoft Teams configuration relationship data object.

datadog_api_client.v2.model.microsoft_teams_configuration_reference_data module¶

class MicrosoftTeamsConfigurationReferenceData(arg: None)¶

class MicrosoftTeamsConfigurationReferenceData(arg: ModelComposed)

class MicrosoftTeamsConfigurationReferenceData(*args, **kwargs)

Bases: ModelNormal

The Microsoft Teams configuration relationship data object.

Parameters:

id (str) – The unique identifier of the Microsoft Teams configuration.
type (str) – The type of the Microsoft Teams configuration.

datadog_api_client.v2.model.microsoft_teams_create_tenant_based_handle_request module¶

class MicrosoftTeamsCreateTenantBasedHandleRequest(arg: None)¶

class MicrosoftTeamsCreateTenantBasedHandleRequest(arg: ModelComposed)

class MicrosoftTeamsCreateTenantBasedHandleRequest(*args, **kwargs)

Bases: ModelNormal

Create tenant-based handle request.

Parameters:: data (MicrosoftTeamsTenantBasedHandleRequestData) – Tenant-based handle data from a response.

datadog_api_client.v2.model.microsoft_teams_create_workflows_webhook_handle_request module¶

class MicrosoftTeamsCreateWorkflowsWebhookHandleRequest(arg: None)¶

class MicrosoftTeamsCreateWorkflowsWebhookHandleRequest(arg: ModelComposed)

class MicrosoftTeamsCreateWorkflowsWebhookHandleRequest(*args, **kwargs)

Bases: ModelNormal

Create Workflows webhook handle request.

Parameters:: data (MicrosoftTeamsWorkflowsWebhookHandleRequestData) – Workflows Webhook handle data from a response.

datadog_api_client.v2.model.microsoft_teams_get_channel_by_name_response module¶

class MicrosoftTeamsGetChannelByNameResponse(arg: None)¶

class MicrosoftTeamsGetChannelByNameResponse(arg: ModelComposed)

class MicrosoftTeamsGetChannelByNameResponse(*args, **kwargs)

Bases: ModelNormal

Response with channel, team, and tenant ID information.

Parameters:: data (MicrosoftTeamsChannelInfoResponseData, optional) – Channel data from a response.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_attributes module¶

class MicrosoftTeamsTenantBasedHandleAttributes(arg: None)¶

class MicrosoftTeamsTenantBasedHandleAttributes(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleAttributes(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle attributes.

Parameters:

channel_id (str, optional) – Channel id.
name (str, optional) – Tenant-based handle name.
team_id (str, optional) – Team id.
tenant_id (str, optional) – Tenant id.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_info_response_attributes module¶

class MicrosoftTeamsTenantBasedHandleInfoResponseAttributes(arg: None)¶

class MicrosoftTeamsTenantBasedHandleInfoResponseAttributes(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleInfoResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle attributes.

Parameters:

channel_id (str, optional) – Channel id.
channel_name (str, optional) – Channel name.
name (str, optional) – Tenant-based handle name.
team_id (str, optional) – Team id.
team_name (str, optional) – Team name.
tenant_id (str, optional) – Tenant id.
tenant_name (str, optional) – Tenant name.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_info_response_data module¶

class MicrosoftTeamsTenantBasedHandleInfoResponseData(arg: None)¶

class MicrosoftTeamsTenantBasedHandleInfoResponseData(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleInfoResponseData(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

attributes (MicrosoftTeamsTenantBasedHandleInfoResponseAttributes, optional) – Tenant-based handle attributes.
id (str, optional) – The ID of the tenant-based handle.
type (MicrosoftTeamsTenantBasedHandleInfoType, optional) – Tenant-based handle resource type.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_info_type module¶

class MicrosoftTeamsTenantBasedHandleInfoType(arg: None)¶

class MicrosoftTeamsTenantBasedHandleInfoType(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleInfoType(*args, **kwargs)

Bases: ModelSimple

Tenant-based handle resource type.

Parameters:

value (str) – If omitted defaults to “ms-teams-tenant-based-handle-info”. Must be one of [“ms-teams-tenant-based-handle-info”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_request_attributes module¶

class MicrosoftTeamsTenantBasedHandleRequestAttributes(arg: None)¶

class MicrosoftTeamsTenantBasedHandleRequestAttributes(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle attributes.

Parameters:

channel_id (str) – Channel id.
name (str) – Tenant-based handle name.
team_id (str) – Team id.
tenant_id (str) – Tenant id.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_request_data module¶

class MicrosoftTeamsTenantBasedHandleRequestData(arg: None)¶

class MicrosoftTeamsTenantBasedHandleRequestData(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleRequestData(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

attributes (MicrosoftTeamsTenantBasedHandleRequestAttributes) – Tenant-based handle attributes.
type (MicrosoftTeamsTenantBasedHandleType) – Specifies the tenant-based handle resource type.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_response module¶

class MicrosoftTeamsTenantBasedHandleResponse(arg: None)¶

class MicrosoftTeamsTenantBasedHandleResponse(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleResponse(*args, **kwargs)

Bases: ModelNormal

Response of a tenant-based handle.

Parameters:: data (MicrosoftTeamsTenantBasedHandleResponseData) – Tenant-based handle data from a response.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_response_data module¶

class MicrosoftTeamsTenantBasedHandleResponseData(arg: None)¶

class MicrosoftTeamsTenantBasedHandleResponseData(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleResponseData(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

attributes (MicrosoftTeamsTenantBasedHandleAttributes, optional) – Tenant-based handle attributes.
id (str, optional) – The ID of the tenant-based handle.
type (MicrosoftTeamsTenantBasedHandleType, optional) – Specifies the tenant-based handle resource type.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_type module¶

class MicrosoftTeamsTenantBasedHandleType(arg: None)¶

class MicrosoftTeamsTenantBasedHandleType(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandleType(*args, **kwargs)

Bases: ModelSimple

Specifies the tenant-based handle resource type.

Parameters:

value (str) – If omitted defaults to “tenant-based-handle”. Must be one of [“tenant-based-handle”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.microsoft_teams_tenant_based_handles_response module¶

class MicrosoftTeamsTenantBasedHandlesResponse(arg: None)¶

class MicrosoftTeamsTenantBasedHandlesResponse(arg: ModelComposed)

class MicrosoftTeamsTenantBasedHandlesResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of tenant-based handles.

Parameters:: data ([MicrosoftTeamsTenantBasedHandleInfoResponseData]) – An array of tenant-based handles.

datadog_api_client.v2.model.microsoft_teams_update_tenant_based_handle_request module¶

class MicrosoftTeamsUpdateTenantBasedHandleRequest(arg: None)¶

class MicrosoftTeamsUpdateTenantBasedHandleRequest(arg: ModelComposed)

class MicrosoftTeamsUpdateTenantBasedHandleRequest(*args, **kwargs)

Bases: ModelNormal

Update tenant-based handle request.

Parameters:: data (MicrosoftTeamsUpdateTenantBasedHandleRequestData) – Tenant-based handle data from a response.

datadog_api_client.v2.model.microsoft_teams_update_tenant_based_handle_request_data module¶

class MicrosoftTeamsUpdateTenantBasedHandleRequestData(arg: None)¶

class MicrosoftTeamsUpdateTenantBasedHandleRequestData(arg: ModelComposed)

class MicrosoftTeamsUpdateTenantBasedHandleRequestData(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

attributes (MicrosoftTeamsTenantBasedHandleAttributes) – Tenant-based handle attributes.
type (MicrosoftTeamsTenantBasedHandleType) – Specifies the tenant-based handle resource type.

datadog_api_client.v2.model.microsoft_teams_update_workflows_webhook_handle_request module¶

class MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest(arg: None)¶

class MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest(arg: ModelComposed)

class MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest(*args, **kwargs)

Bases: ModelNormal

Update Workflows webhook handle request.

Parameters:: data (MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData) – Workflows Webhook handle data from a response.

datadog_api_client.v2.model.microsoft_teams_update_workflows_webhook_handle_request_data module¶

class MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData(arg: None)¶

class MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData(arg: ModelComposed)

class MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData(*args, **kwargs)

Bases: ModelNormal

Workflows Webhook handle data from a response.

Parameters:

attributes (MicrosoftTeamsWorkflowsWebhookHandleAttributes) – Workflows Webhook handle attributes.
type (MicrosoftTeamsWorkflowsWebhookHandleType) – Specifies the Workflows webhook handle resource type.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handle_attributes module¶

class MicrosoftTeamsWorkflowsWebhookHandleAttributes(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandleAttributes(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandleAttributes(*args, **kwargs)

Bases: ModelNormal

Workflows Webhook handle attributes.

Parameters:

name (str, optional) – Workflows Webhook handle name.
url (str, optional) – Workflows Webhook URL.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handle_request_attributes module¶

class MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Workflows Webhook handle attributes.

Parameters:

name (str) – Workflows Webhook handle name.
url (str) – Workflows Webhook URL.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handle_request_data module¶

class MicrosoftTeamsWorkflowsWebhookHandleRequestData(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandleRequestData(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandleRequestData(*args, **kwargs)

Bases: ModelNormal

Workflows Webhook handle data from a response.

Parameters:

attributes (MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes) – Workflows Webhook handle attributes.
type (MicrosoftTeamsWorkflowsWebhookHandleType) – Specifies the Workflows webhook handle resource type.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handle_response module¶

class MicrosoftTeamsWorkflowsWebhookHandleResponse(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandleResponse(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandleResponse(*args, **kwargs)

Bases: ModelNormal

Response of a Workflows webhook handle.

Parameters:: data (MicrosoftTeamsWorkflowsWebhookHandleResponseData) – Workflows Webhook handle data from a response.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handle_response_data module¶

class MicrosoftTeamsWorkflowsWebhookHandleResponseData(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandleResponseData(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandleResponseData(*args, **kwargs)

Bases: ModelNormal

Workflows Webhook handle data from a response.

Parameters:

attributes (MicrosoftTeamsWorkflowsWebhookResponseAttributes, optional) – Workflows Webhook handle attributes.
id (str, optional) – The ID of the Workflows webhook handle.
type (MicrosoftTeamsWorkflowsWebhookHandleType, optional) – Specifies the Workflows webhook handle resource type.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handle_type module¶

class MicrosoftTeamsWorkflowsWebhookHandleType(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandleType(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandleType(*args, **kwargs)

Bases: ModelSimple

Specifies the Workflows webhook handle resource type.

Parameters:

value (str) – If omitted defaults to “workflows-webhook-handle”. Must be one of [“workflows-webhook-handle”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_handles_response module¶

class MicrosoftTeamsWorkflowsWebhookHandlesResponse(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookHandlesResponse(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookHandlesResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of Workflows webhook handles.

Parameters:: data ([MicrosoftTeamsWorkflowsWebhookHandleResponseData]) – An array of Workflows webhook handles.

datadog_api_client.v2.model.microsoft_teams_workflows_webhook_response_attributes module¶

class MicrosoftTeamsWorkflowsWebhookResponseAttributes(arg: None)¶

class MicrosoftTeamsWorkflowsWebhookResponseAttributes(arg: ModelComposed)

class MicrosoftTeamsWorkflowsWebhookResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Workflows Webhook handle attributes.

Parameters:: name (str, optional) – Workflows Webhook handle name.

datadog_api_client.v2.model.monitor_config_policy_attribute_create_request module¶

class MonitorConfigPolicyAttributeCreateRequest(arg: None)¶

class MonitorConfigPolicyAttributeCreateRequest(arg: ModelComposed)

class MonitorConfigPolicyAttributeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

policy (MonitorConfigPolicyPolicyCreateRequest) – Configuration for the policy.
policy_type (MonitorConfigPolicyType) – The monitor configuration policy type.

datadog_api_client.v2.model.monitor_config_policy_attribute_edit_request module¶

class MonitorConfigPolicyAttributeEditRequest(arg: None)¶

class MonitorConfigPolicyAttributeEditRequest(arg: ModelComposed)

class MonitorConfigPolicyAttributeEditRequest(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

policy (MonitorConfigPolicyPolicy) – Configuration for the policy.
policy_type (MonitorConfigPolicyType) – The monitor configuration policy type.

datadog_api_client.v2.model.monitor_config_policy_attribute_response module¶

class MonitorConfigPolicyAttributeResponse(arg: None)¶

class MonitorConfigPolicyAttributeResponse(arg: ModelComposed)

class MonitorConfigPolicyAttributeResponse(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

policy (MonitorConfigPolicyPolicy, optional) – Configuration for the policy.
policy_type (MonitorConfigPolicyType, optional) – The monitor configuration policy type.

datadog_api_client.v2.model.monitor_config_policy_create_data module¶

class MonitorConfigPolicyCreateData(arg: None)¶

class MonitorConfigPolicyCreateData(arg: ModelComposed)

class MonitorConfigPolicyCreateData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

attributes (MonitorConfigPolicyAttributeCreateRequest) – Policy and policy type for a monitor configuration policy.
type (MonitorConfigPolicyResourceType) – Monitor configuration policy resource type.

datadog_api_client.v2.model.monitor_config_policy_create_request module¶

class MonitorConfigPolicyCreateRequest(arg: None)¶

class MonitorConfigPolicyCreateRequest(arg: ModelComposed)

class MonitorConfigPolicyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a monitor configuration policy.

Parameters:: data (MonitorConfigPolicyCreateData) – A monitor configuration policy data.

datadog_api_client.v2.model.monitor_config_policy_edit_data module¶

class MonitorConfigPolicyEditData(arg: None)¶

class MonitorConfigPolicyEditData(arg: ModelComposed)

class MonitorConfigPolicyEditData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

attributes (MonitorConfigPolicyAttributeEditRequest) – Policy and policy type for a monitor configuration policy.
id (str) – ID of this monitor configuration policy.
type (MonitorConfigPolicyResourceType) – Monitor configuration policy resource type.

datadog_api_client.v2.model.monitor_config_policy_edit_request module¶

class MonitorConfigPolicyEditRequest(arg: None)¶

class MonitorConfigPolicyEditRequest(arg: ModelComposed)

class MonitorConfigPolicyEditRequest(*args, **kwargs)

Bases: ModelNormal

Request for editing a monitor configuration policy.

Parameters:: data (MonitorConfigPolicyEditData) – A monitor configuration policy data.

datadog_api_client.v2.model.monitor_config_policy_list_response module¶

class MonitorConfigPolicyListResponse(arg: None)¶

class MonitorConfigPolicyListResponse(arg: ModelComposed)

class MonitorConfigPolicyListResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all monitor configuration policies.

Parameters:: data ([MonitorConfigPolicyResponseData], optional) – An array of monitor configuration policies.

datadog_api_client.v2.model.monitor_config_policy_policy module¶

class MonitorConfigPolicyPolicy(arg: None)¶

class MonitorConfigPolicyPolicy(arg: ModelComposed)

class MonitorConfigPolicyPolicy(*args, **kwargs)

Bases: ModelComposed

Configuration for the policy.

Parameters:

tag_key (str, optional) – The key of the tag.
tag_key_required (bool, optional) – If a tag key is required for monitor creation.
valid_tag_values ([str], optional) – Valid values for the tag.

datadog_api_client.v2.model.monitor_config_policy_policy_create_request module¶

class MonitorConfigPolicyPolicyCreateRequest(arg: None)¶

class MonitorConfigPolicyPolicyCreateRequest(arg: ModelComposed)

class MonitorConfigPolicyPolicyCreateRequest(*args, **kwargs)

Bases: ModelComposed

Configuration for the policy.

Parameters:

tag_key (str) – The key of the tag.
tag_key_required (bool) – If a tag key is required for monitor creation.
valid_tag_values ([str]) – Valid values for the tag.

datadog_api_client.v2.model.monitor_config_policy_resource_type module¶

class MonitorConfigPolicyResourceType(arg: None)¶

class MonitorConfigPolicyResourceType(arg: ModelComposed)

class MonitorConfigPolicyResourceType(*args, **kwargs)

Bases: ModelSimple

Monitor configuration policy resource type.

Parameters:

value (str) – If omitted defaults to “monitor-config-policy”. Must be one of [“monitor-config-policy”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.monitor_config_policy_response module¶

class MonitorConfigPolicyResponse(arg: None)¶

class MonitorConfigPolicyResponse(arg: ModelComposed)

class MonitorConfigPolicyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving a monitor configuration policy.

Parameters:: data (MonitorConfigPolicyResponseData, optional) – A monitor configuration policy data.

datadog_api_client.v2.model.monitor_config_policy_response_data module¶

class MonitorConfigPolicyResponseData(arg: None)¶

class MonitorConfigPolicyResponseData(arg: ModelComposed)

class MonitorConfigPolicyResponseData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

attributes (MonitorConfigPolicyAttributeResponse, optional) – Policy and policy type for a monitor configuration policy.
id (str, optional) – ID of this monitor configuration policy.
type (MonitorConfigPolicyResourceType, optional) – Monitor configuration policy resource type.

datadog_api_client.v2.model.monitor_config_policy_tag_policy module¶

class MonitorConfigPolicyTagPolicy(arg: None)¶

class MonitorConfigPolicyTagPolicy(arg: ModelComposed)

class MonitorConfigPolicyTagPolicy(*args, **kwargs)

Bases: ModelNormal

Tag attributes of a monitor configuration policy.

Parameters:

tag_key (str, optional) – The key of the tag.
tag_key_required (bool, optional) – If a tag key is required for monitor creation.
valid_tag_values ([str], optional) – Valid values for the tag.

datadog_api_client.v2.model.monitor_config_policy_tag_policy_create_request module¶

class MonitorConfigPolicyTagPolicyCreateRequest(arg: None)¶

class MonitorConfigPolicyTagPolicyCreateRequest(arg: ModelComposed)

class MonitorConfigPolicyTagPolicyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Tag attributes of a monitor configuration policy.

Parameters:

tag_key (str) – The key of the tag.
tag_key_required (bool) – If a tag key is required for monitor creation.
valid_tag_values ([str]) – Valid values for the tag.

datadog_api_client.v2.model.monitor_config_policy_type module¶

class MonitorConfigPolicyType(arg: None)¶

class MonitorConfigPolicyType(arg: ModelComposed)

class MonitorConfigPolicyType(*args, **kwargs)

Bases: ModelSimple

The monitor configuration policy type.

Parameters:

value (str) – If omitted defaults to “tag”. Must be one of [“tag”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.monitor_downtime_match_resource_type module¶

class MonitorDowntimeMatchResourceType(arg: None)¶

class MonitorDowntimeMatchResourceType(arg: ModelComposed)

class MonitorDowntimeMatchResourceType(*args, **kwargs)

Bases: ModelSimple

Monitor Downtime Match resource type.

Parameters:

value (str) – If omitted defaults to “downtime_match”. Must be one of [“downtime_match”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.monitor_downtime_match_response module¶

class MonitorDowntimeMatchResponse(arg: None)¶

class MonitorDowntimeMatchResponse(arg: ModelComposed)

class MonitorDowntimeMatchResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all downtime matches for a monitor.

Parameters:

data ([MonitorDowntimeMatchResponseData], optional) – An array of downtime matches.
meta (DowntimeMeta, optional) – Pagination metadata returned by the API.

datadog_api_client.v2.model.monitor_downtime_match_response_attributes module¶

class MonitorDowntimeMatchResponseAttributes(arg: None)¶

class MonitorDowntimeMatchResponseAttributes(arg: ModelComposed)

class MonitorDowntimeMatchResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Downtime match details.

Parameters:

end (datetime, none_type, optional) – The end of the downtime.
groups ([str], optional) – An array of groups associated with the downtime.
scope (str, optional) –
The scope to which the downtime applies. Must follow the common search syntax.
start (datetime, optional) – The start of the downtime.

datadog_api_client.v2.model.monitor_downtime_match_response_data module¶

class MonitorDowntimeMatchResponseData(arg: None)¶

class MonitorDowntimeMatchResponseData(arg: ModelComposed)

class MonitorDowntimeMatchResponseData(*args, **kwargs)

Bases: ModelNormal

A downtime match.

Parameters:

attributes (MonitorDowntimeMatchResponseAttributes, optional) – Downtime match details.
id (str, none_type, optional) – The downtime ID.
type (MonitorDowntimeMatchResourceType, optional) – Monitor Downtime Match resource type.

datadog_api_client.v2.model.monitor_notification_rule_attributes module¶

class MonitorNotificationRuleAttributes(arg: None)¶

class MonitorNotificationRuleAttributes(arg: ModelComposed)

class MonitorNotificationRuleAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the monitor notification rule.

Parameters:

conditional_recipients (MonitorNotificationRuleConditionalRecipients, optional) – Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
filter (MonitorNotificationRuleFilter, optional) – Filter used to associate the notification rule with monitors.
name (str) – The name of the monitor notification rule.
recipients ([str], optional) – A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an ‘@’. Cannot be used with conditional_recipients.

additional_properties_type = None¶

datadog_api_client.v2.model.monitor_notification_rule_condition module¶

class MonitorNotificationRuleCondition(arg: None)¶

class MonitorNotificationRuleCondition(arg: ModelComposed)

class MonitorNotificationRuleCondition(*args, **kwargs)

Bases: ModelNormal

Conditions for conditional_recipients.

Parameters:

recipients ([str]) – A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an ‘@’. Cannot be used with conditional_recipients.
scope (str) – The scope to which the monitor applied.

datadog_api_client.v2.model.monitor_notification_rule_conditional_recipients module¶

class MonitorNotificationRuleConditionalRecipients(arg: None)¶

class MonitorNotificationRuleConditionalRecipients(arg: ModelComposed)

class MonitorNotificationRuleConditionalRecipients(*args, **kwargs)

Bases: ModelNormal

Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.

Parameters:

conditions ([MonitorNotificationRuleCondition]) – Conditions of the notification rule.
fallback_recipients ([str], optional) – A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an ‘@’. Cannot be used with conditional_recipients.

datadog_api_client.v2.model.monitor_notification_rule_create_request module¶

class MonitorNotificationRuleCreateRequest(arg: None)¶

class MonitorNotificationRuleCreateRequest(arg: ModelComposed)

class MonitorNotificationRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a monitor notification rule.

Parameters:: data (MonitorNotificationRuleCreateRequestData) – Object to create a monitor notification rule.

datadog_api_client.v2.model.monitor_notification_rule_create_request_data module¶

class MonitorNotificationRuleCreateRequestData(arg: None)¶

class MonitorNotificationRuleCreateRequestData(arg: ModelComposed)

class MonitorNotificationRuleCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Object to create a monitor notification rule.

Parameters:

attributes (MonitorNotificationRuleAttributes) – Attributes of the monitor notification rule.
type (MonitorNotificationRuleResourceType, optional) – Monitor notification rule resource type.

datadog_api_client.v2.model.monitor_notification_rule_data module¶

class MonitorNotificationRuleData(arg: None)¶

class MonitorNotificationRuleData(arg: ModelComposed)

class MonitorNotificationRuleData(*args, **kwargs)

Bases: ModelNormal

Monitor notification rule data.

Parameters:

attributes (MonitorNotificationRuleResponseAttributes, optional) – Attributes of the monitor notification rule.
id (str, optional) – The ID of the monitor notification rule.
relationships (MonitorNotificationRuleRelationships, optional) – All relationships associated with monitor notification rule.
type (MonitorNotificationRuleResourceType, optional) – Monitor notification rule resource type.

datadog_api_client.v2.model.monitor_notification_rule_filter module¶

class MonitorNotificationRuleFilter(arg: None)¶

class MonitorNotificationRuleFilter(arg: ModelComposed)

class MonitorNotificationRuleFilter(*args, **kwargs)

Bases: ModelComposed

Filter used to associate the notification rule with monitors.

Parameters:

tags ([str]) – A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.
scope (str) – A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

datadog_api_client.v2.model.monitor_notification_rule_filter_scope module¶

class MonitorNotificationRuleFilterScope(arg: None)¶

class MonitorNotificationRuleFilterScope(arg: ModelComposed)

class MonitorNotificationRuleFilterScope(*args, **kwargs)

Bases: ModelNormal

Filter monitor notifications. A monitor notification must match the scope.

Parameters:: scope (str) – A scope composed of one or several key:value pairs, which can be used to filter monitor notifications on monitor and group tags.

additional_properties_type = None¶

datadog_api_client.v2.model.monitor_notification_rule_filter_tags module¶

class MonitorNotificationRuleFilterTags(arg: None)¶

class MonitorNotificationRuleFilterTags(arg: ModelComposed)

class MonitorNotificationRuleFilterTags(*args, **kwargs)

Bases: ModelNormal

Filter monitor notifications by tags. A monitor notification must match all tags.

Parameters:: tags ([str]) – A list of tags (key:value pairs), which can be used to filter monitor notifications on monitor and group tags.

additional_properties_type = None¶

datadog_api_client.v2.model.monitor_notification_rule_list_response module¶

class MonitorNotificationRuleListResponse(arg: None)¶

class MonitorNotificationRuleListResponse(arg: ModelComposed)

class MonitorNotificationRuleListResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all monitor notification rules.

Parameters:

data ([MonitorNotificationRuleData], optional) – A list of monitor notification rules.
included ([MonitorNotificationRuleResponseIncludedItem], optional) – Array of objects related to the monitor notification rules.

datadog_api_client.v2.model.monitor_notification_rule_relationships module¶

class MonitorNotificationRuleRelationships(arg: None)¶

class MonitorNotificationRuleRelationships(arg: ModelComposed)

class MonitorNotificationRuleRelationships(*args, **kwargs)

Bases: ModelNormal

All relationships associated with monitor notification rule.

Parameters:: created_by (MonitorNotificationRuleRelationshipsCreatedBy, optional) – The user who created the monitor notification rule.

datadog_api_client.v2.model.monitor_notification_rule_relationships_created_by module¶

class MonitorNotificationRuleRelationshipsCreatedBy(arg: None)¶

class MonitorNotificationRuleRelationshipsCreatedBy(arg: ModelComposed)

class MonitorNotificationRuleRelationshipsCreatedBy(*args, **kwargs)

Bases: ModelNormal

The user who created the monitor notification rule.

Parameters:: data (MonitorNotificationRuleRelationshipsCreatedByData, none_type, optional) – Data for the user who created the monitor notification rule.

datadog_api_client.v2.model.monitor_notification_rule_relationships_created_by_data module¶

class MonitorNotificationRuleRelationshipsCreatedByData(arg: None)¶

class MonitorNotificationRuleRelationshipsCreatedByData(arg: ModelComposed)

class MonitorNotificationRuleRelationshipsCreatedByData(*args, **kwargs)

Bases: ModelNormal

Data for the user who created the monitor notification rule.

Parameters:

id (str, optional) – User ID of the monitor notification rule creator.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.monitor_notification_rule_resource_type module¶

class MonitorNotificationRuleResourceType(arg: None)¶

class MonitorNotificationRuleResourceType(arg: ModelComposed)

class MonitorNotificationRuleResourceType(*args, **kwargs)

Bases: ModelSimple

Monitor notification rule resource type.

Parameters:

value (str) – If omitted defaults to “monitor-notification-rule”. Must be one of [“monitor-notification-rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.monitor_notification_rule_response module¶

class MonitorNotificationRuleResponse(arg: None)¶

class MonitorNotificationRuleResponse(arg: ModelComposed)

class MonitorNotificationRuleResponse(*args, **kwargs)

Bases: ModelNormal

A monitor notification rule.

Parameters:

data (MonitorNotificationRuleData, optional) – Monitor notification rule data.
included ([MonitorNotificationRuleResponseIncludedItem], optional) – Array of objects related to the monitor notification rule that the user requested.

datadog_api_client.v2.model.monitor_notification_rule_response_attributes module¶

class MonitorNotificationRuleResponseAttributes(arg: None)¶

class MonitorNotificationRuleResponseAttributes(arg: ModelComposed)

class MonitorNotificationRuleResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the monitor notification rule.

Parameters:

conditional_recipients (MonitorNotificationRuleConditionalRecipients, optional) – Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
created (datetime, optional) – Creation time of the monitor notification rule.
filter (MonitorNotificationRuleFilter, optional) – Filter used to associate the notification rule with monitors.
modified (datetime, optional) – Time the monitor notification rule was last modified.
name (str, optional) – The name of the monitor notification rule.
recipients ([str], optional) – A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an ‘@’. Cannot be used with conditional_recipients.

datadog_api_client.v2.model.monitor_notification_rule_response_included_item module¶

class MonitorNotificationRuleResponseIncludedItem(arg: None)¶

class MonitorNotificationRuleResponseIncludedItem(arg: ModelComposed)

class MonitorNotificationRuleResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to a monitor notification rule.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.monitor_notification_rule_update_request module¶

class MonitorNotificationRuleUpdateRequest(arg: None)¶

class MonitorNotificationRuleUpdateRequest(arg: ModelComposed)

class MonitorNotificationRuleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request for updating a monitor notification rule.

Parameters:: data (MonitorNotificationRuleUpdateRequestData) – Object to update a monitor notification rule.

datadog_api_client.v2.model.monitor_notification_rule_update_request_data module¶

class MonitorNotificationRuleUpdateRequestData(arg: None)¶

class MonitorNotificationRuleUpdateRequestData(arg: ModelComposed)

class MonitorNotificationRuleUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Object to update a monitor notification rule.

Parameters:

attributes (MonitorNotificationRuleAttributes) – Attributes of the monitor notification rule.
id (str) – The ID of the monitor notification rule.
type (MonitorNotificationRuleResourceType, optional) – Monitor notification rule resource type.

datadog_api_client.v2.model.monitor_trigger module¶

class MonitorTrigger(arg: None)¶

class MonitorTrigger(arg: ModelComposed)

class MonitorTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.monitor_trigger_wrapper module¶

class MonitorTriggerWrapper(arg: None)¶

class MonitorTriggerWrapper(arg: ModelComposed)

class MonitorTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Monitor-based trigger.

Parameters:

monitor_trigger (MonitorTrigger) – Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.monitor_type module¶

class MonitorType(arg: None)¶

class MonitorType(arg: ModelComposed)

class MonitorType(*args, **kwargs)

Bases: ModelNormal

Attributes from the monitor that triggered the event.

Parameters:

created_at (int, optional) – The POSIX timestamp of the monitor’s creation in nanoseconds.
group_status (int, optional) – Monitor group status used when there is no result_groups.
groups ([str], optional) – Groups to which the monitor belongs.
id (int, optional) – The monitor ID.
message (str, optional) – The monitor message.
modified (int, optional) – The monitor’s last-modified timestamp.
name (str, optional) – The monitor name.
query (str, optional) – The query that triggers the alert.
tags ([str], optional) – A list of tags attached to the monitor.
templated_name (str, optional) – The templated name of the monitor before resolving any template variables.
type (str, optional) – The monitor type.

datadog_api_client.v2.model.monitor_user_template module¶

class MonitorUserTemplate(arg: None)¶

class MonitorUserTemplate(arg: ModelComposed)

class MonitorUserTemplate(*args, **kwargs)

Bases: ModelNormal

A monitor user template object.

Parameters:

created (datetime, optional) – The created timestamp of the template.
description (str, none_type, optional) – A brief description of the monitor user template.
modified (datetime, optional) – The last modified timestamp. When the template version was created.
monitor_definition ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – A valid monitor definition in the same format as the V1 Monitor API.
tags ([str], optional) – The definition of MonitorUserTemplateTags object.
template_variables ([MonitorUserTemplateTemplateVariablesItems], optional) – The definition of MonitorUserTemplateTemplateVariables object.
title (str, optional) – The title of the monitor user template.
version (int, none_type, optional) – The version of the monitor user template.
versions ([SimpleMonitorUserTemplate], optional) – All versions of the monitor user template.

datadog_api_client.v2.model.monitor_user_template_create_data module¶

class MonitorUserTemplateCreateData(arg: None)¶

class MonitorUserTemplateCreateData(arg: ModelComposed)

class MonitorUserTemplateCreateData(*args, **kwargs)

Bases: ModelNormal

Monitor user template data.

Parameters:

attributes (MonitorUserTemplateRequestAttributes) – Attributes for a monitor user template.
type (MonitorUserTemplateResourceType) – Monitor user template resource type.

datadog_api_client.v2.model.monitor_user_template_create_request module¶

class MonitorUserTemplateCreateRequest(arg: None)¶

class MonitorUserTemplateCreateRequest(arg: ModelComposed)

class MonitorUserTemplateCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a monitor user template.

Parameters:: data (MonitorUserTemplateCreateData) – Monitor user template data.

datadog_api_client.v2.model.monitor_user_template_create_response module¶

class MonitorUserTemplateCreateResponse(arg: None)¶

class MonitorUserTemplateCreateResponse(arg: ModelComposed)

class MonitorUserTemplateCreateResponse(*args, **kwargs)

Bases: ModelNormal

Response for creating a monitor user template.

Parameters:: data (MonitorUserTemplateResponseData, optional) – Monitor user template list response data.

datadog_api_client.v2.model.monitor_user_template_list_response module¶

class MonitorUserTemplateListResponse(arg: None)¶

class MonitorUserTemplateListResponse(arg: ModelComposed)

class MonitorUserTemplateListResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all monitor user templates.

Parameters:: data ([MonitorUserTemplateResponseData], optional) – An array of monitor user templates.

datadog_api_client.v2.model.monitor_user_template_request_attributes module¶

class MonitorUserTemplateRequestAttributes(arg: None)¶

class MonitorUserTemplateRequestAttributes(arg: ModelComposed)

class MonitorUserTemplateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a monitor user template.

Parameters:

description (str, none_type, optional) – A brief description of the monitor user template.
monitor_definition ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}) –
A valid monitor definition in the same format as the V1 Monitor API.
tags ([str]) – The definition of MonitorUserTemplateTags object.
template_variables ([MonitorUserTemplateTemplateVariablesItems], optional) – The definition of MonitorUserTemplateTemplateVariables object.
title (str) – The title of the monitor user template.

additional_properties_type = None¶

datadog_api_client.v2.model.monitor_user_template_resource_type module¶

class MonitorUserTemplateResourceType(arg: None)¶

class MonitorUserTemplateResourceType(arg: ModelComposed)

class MonitorUserTemplateResourceType(*args, **kwargs)

Bases: ModelSimple

Monitor user template resource type.

Parameters:

value (str) – If omitted defaults to “monitor-user-template”. Must be one of [“monitor-user-template”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.monitor_user_template_response module¶

class MonitorUserTemplateResponse(arg: None)¶

class MonitorUserTemplateResponse(arg: ModelComposed)

class MonitorUserTemplateResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving a monitor user template.

Parameters:: data (MonitorUserTemplateResponseDataWithVersions, optional) – Monitor user template data.

datadog_api_client.v2.model.monitor_user_template_response_attributes module¶

class MonitorUserTemplateResponseAttributes(arg: None)¶

class MonitorUserTemplateResponseAttributes(arg: ModelComposed)

class MonitorUserTemplateResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a monitor user template.

Parameters:

created (datetime, optional) – The created timestamp of the template.
description (str, none_type, optional) – A brief description of the monitor user template.
modified (datetime, optional) – The last modified timestamp. When the template version was created.
monitor_definition ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) –
A valid monitor definition in the same format as the V1 Monitor API.
tags ([str], optional) – The definition of MonitorUserTemplateTags object.
template_variables ([MonitorUserTemplateTemplateVariablesItems], optional) – The definition of MonitorUserTemplateTemplateVariables object.
title (str, optional) – The title of the monitor user template.
version (int, none_type, optional) – The version of the monitor user template.

datadog_api_client.v2.model.monitor_user_template_response_data module¶

class MonitorUserTemplateResponseData(arg: None)¶

class MonitorUserTemplateResponseData(arg: ModelComposed)

class MonitorUserTemplateResponseData(*args, **kwargs)

Bases: ModelNormal

Monitor user template list response data.

Parameters:

attributes (MonitorUserTemplateResponseAttributes, optional) – Attributes for a monitor user template.
id (str, optional) – The unique identifier.
type (MonitorUserTemplateResourceType, optional) – Monitor user template resource type.

datadog_api_client.v2.model.monitor_user_template_response_data_with_versions module¶

class MonitorUserTemplateResponseDataWithVersions(arg: None)¶

class MonitorUserTemplateResponseDataWithVersions(arg: ModelComposed)

class MonitorUserTemplateResponseDataWithVersions(*args, **kwargs)

Bases: ModelNormal

Monitor user template data.

Parameters:

attributes (MonitorUserTemplate, optional) – A monitor user template object.
id (str, optional) – The unique identifier.
type (MonitorUserTemplateResourceType, optional) – Monitor user template resource type.

datadog_api_client.v2.model.monitor_user_template_template_variables_items module¶

class MonitorUserTemplateTemplateVariablesItems(arg: None)¶

class MonitorUserTemplateTemplateVariablesItems(arg: ModelComposed)

class MonitorUserTemplateTemplateVariablesItems(*args, **kwargs)

Bases: ModelNormal

List of objects representing template variables on the monitor which can have selectable values.

Parameters:

available_values ([str], optional) – Available values for the variable.
defaults ([str], optional) – Default values of the template variable.
name (str) – The name of the template variable.
tag_key (str, optional) – The tag key associated with the variable. This works the same as dashboard template variables.

additional_properties_type = None¶

datadog_api_client.v2.model.monitor_user_template_update_data module¶

class MonitorUserTemplateUpdateData(arg: None)¶

class MonitorUserTemplateUpdateData(arg: ModelComposed)

class MonitorUserTemplateUpdateData(*args, **kwargs)

Bases: ModelNormal

Monitor user template data.

Parameters:

attributes (MonitorUserTemplateRequestAttributes) – Attributes for a monitor user template.
id (str) – The unique identifier.
type (MonitorUserTemplateResourceType) – Monitor user template resource type.

datadog_api_client.v2.model.monitor_user_template_update_request module¶

class MonitorUserTemplateUpdateRequest(arg: None)¶

class MonitorUserTemplateUpdateRequest(arg: ModelComposed)

class MonitorUserTemplateUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a new monitor user template version.

Parameters:: data (MonitorUserTemplateUpdateData) – Monitor user template data.

datadog_api_client.v2.model.monthly_cost_attribution_attributes module¶

class MonthlyCostAttributionAttributes(arg: None)¶

class MonthlyCostAttributionAttributes(arg: ModelComposed)

class MonthlyCostAttributionAttributes(*args, **kwargs)

Bases: ModelNormal

Cost Attribution by Tag for a given organization.

Parameters:

month (datetime, optional) – Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh].
org_name (str, optional) – The name of the organization.
public_id (str, optional) – The organization public ID.
tag_config_source (str, optional) – The source of the cost attribution tag configuration and the selected tags in the format <source_org_name>:::<selected tag 1>///<selected tag 2>///<selected tag 3>.
tags (CostAttributionTagNames, none_type, optional) –
Tag keys and values. A null value here means that the requested tag breakdown cannot be applied because it does not match the tags configured for usage attribution. In this scenario the API returns the total cost, not broken down by tags.
updated_at (str, optional) – Shows the most recent hour in the current months for all organizations for which all costs were calculated.
values (dict, optional) – Fields in Cost Attribution by tag(s). Example: infra_host_on_demand_cost , infra_host_committed_cost , infra_host_total_cost , infra_host_percentage_in_org , infra_host_percentage_in_account.

datadog_api_client.v2.model.monthly_cost_attribution_body module¶

class MonthlyCostAttributionBody(arg: None)¶

class MonthlyCostAttributionBody(arg: ModelComposed)

class MonthlyCostAttributionBody(*args, **kwargs)

Bases: ModelNormal

Cost data.

Parameters:

attributes (MonthlyCostAttributionAttributes, optional) – Cost Attribution by Tag for a given organization.
id (str, optional) – Unique ID of the response.
type (CostAttributionType, optional) – Type of cost attribution data.

datadog_api_client.v2.model.monthly_cost_attribution_meta module¶

class MonthlyCostAttributionMeta(arg: None)¶

class MonthlyCostAttributionMeta(arg: ModelComposed)

class MonthlyCostAttributionMeta(*args, **kwargs)

Bases: ModelNormal

The object containing document metadata.

Parameters:

aggregates ([CostAttributionAggregatesBody], optional) – An array of available aggregates.
pagination (MonthlyCostAttributionPagination, optional) – The metadata for the current pagination.

datadog_api_client.v2.model.monthly_cost_attribution_pagination module¶

class MonthlyCostAttributionPagination(arg: None)¶

class MonthlyCostAttributionPagination(arg: ModelComposed)

class MonthlyCostAttributionPagination(*args, **kwargs)

Bases: ModelNormal

The metadata for the current pagination.

Parameters:: next_record_id (str, none_type, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the next_record_id.

datadog_api_client.v2.model.monthly_cost_attribution_response module¶

class MonthlyCostAttributionResponse(arg: None)¶

class MonthlyCostAttributionResponse(arg: ModelComposed)

class MonthlyCostAttributionResponse(*args, **kwargs)

Bases: ModelNormal

Response containing the monthly cost attribution by tag(s).

Parameters:

data ([MonthlyCostAttributionBody], optional) – Response containing cost attribution.
meta (MonthlyCostAttributionMeta, optional) – The object containing document metadata.

datadog_api_client.v2.model.ms_teams_integration_metadata module¶

class MSTeamsIntegrationMetadata(arg: None)¶

class MSTeamsIntegrationMetadata(arg: ModelComposed)

class MSTeamsIntegrationMetadata(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata for the Microsoft Teams integration.

Parameters:: teams ([MSTeamsIntegrationMetadataTeamsItem]) – Array of Microsoft Teams in this integration metadata.

datadog_api_client.v2.model.ms_teams_integration_metadata_teams_item module¶

class MSTeamsIntegrationMetadataTeamsItem(arg: None)¶

class MSTeamsIntegrationMetadataTeamsItem(arg: ModelComposed)

class MSTeamsIntegrationMetadataTeamsItem(*args, **kwargs)

Bases: ModelNormal

Item in the Microsoft Teams integration metadata teams array.

Parameters:

ms_channel_id (str) – Microsoft Teams channel ID.
ms_channel_name (str) – Microsoft Teams channel name.
ms_tenant_id (str) – Microsoft Teams tenant ID.
redirect_url (str) – URL redirecting to the Microsoft Teams channel.

datadog_api_client.v2.model.notebook_trigger_wrapper module¶

class NotebookTriggerWrapper(arg: None)¶

class NotebookTriggerWrapper(arg: ModelComposed)

class NotebookTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Notebook-based trigger.

Parameters:

notebook_trigger (dict) – Trigger a workflow from a Notebook.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.notification_rule module¶

class NotificationRule(arg: None)¶

class NotificationRule(arg: ModelComposed)

class NotificationRule(*args, **kwargs)

Bases: ModelNormal

Notification rules allow full control over notifications generated by the various Datadog security products. They allow users to define the conditions under which a notification should be generated (based on rule severities, rule types, rule tags, and so on), and the targets to notify. A notification rule is composed of a rule ID, a rule type, and the rule attributes. All fields are required.

Parameters:

attributes (NotificationRuleAttributes) – Attributes of the notification rule.
id (str) – The ID of a notification rule.
type (NotificationRulesType) – The rule type associated to notification rules.

datadog_api_client.v2.model.notification_rule_attributes module¶

class NotificationRuleAttributes(arg: None)¶

class NotificationRuleAttributes(arg: ModelComposed)

class NotificationRuleAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the notification rule.

Parameters:

created_at (int) – Date as Unix timestamp in milliseconds.
created_by (RuleUser) – User creating or modifying a rule.
enabled (bool) – Field used to enable or disable the rule.
modified_at (int) – Date as Unix timestamp in milliseconds.
modified_by (RuleUser) – User creating or modifying a rule.
name (str) – Name of the notification rule.
selectors (Selectors) – Selectors are used to filter security issues for which notifications should be generated. Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source. Only the trigger_source field is required.
targets ([str]) – List of recipients to notify when a notification rule is triggered. Many different target types are supported, such as email addresses, Slack channels, and PagerDuty services. The appropriate integrations need to be properly configured to send notifications to the specified targets.
time_aggregation (int, optional) – Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation. Results are aggregated over a selected time frame using a rolling window, which updates with each new evaluation. Notifications are only sent for new issues discovered during the window. Time aggregation is only available for vulnerability-based notification rules. When omitted or set to 0, no aggregation is done.
version (int) – Version of the notification rule. It is updated when the rule is modified.

datadog_api_client.v2.model.notification_rule_response module¶

class NotificationRuleResponse(arg: None)¶

class NotificationRuleResponse(arg: ModelComposed)

class NotificationRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes a notification rule.

Parameters:: data (NotificationRule, optional) – Notification rules allow full control over notifications generated by the various Datadog security products. They allow users to define the conditions under which a notification should be generated (based on rule severities, rule types, rule tags, and so on), and the targets to notify. A notification rule is composed of a rule ID, a rule type, and the rule attributes. All fields are required.

datadog_api_client.v2.model.notification_rules_type module¶

class NotificationRulesType(arg: None)¶

class NotificationRulesType(arg: ModelComposed)

class NotificationRulesType(*args, **kwargs)

Bases: ModelSimple

The rule type associated to notification rules.

Parameters:

value (str) – If omitted defaults to “notification_rules”. Must be one of [“notification_rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.notion_api_key module¶

class NotionAPIKey(arg: None)¶

class NotionAPIKey(arg: ModelComposed)

class NotionAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the NotionAPIKey object.

Parameters:

api_token (str) – The NotionAPIKey api_token.
type (NotionAPIKeyType) – The definition of the NotionAPIKey object.

datadog_api_client.v2.model.notion_api_key_type module¶

class NotionAPIKeyType(arg: None)¶

class NotionAPIKeyType(arg: ModelComposed)

class NotionAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the NotionAPIKey object.

Parameters:

value (str) – If omitted defaults to “NotionAPIKey”. Must be one of [“NotionAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.notion_api_key_update module¶

class NotionAPIKeyUpdate(arg: None)¶

class NotionAPIKeyUpdate(arg: ModelComposed)

class NotionAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the NotionAPIKey object.

Parameters:

api_token (str, optional) – The NotionAPIKeyUpdate api_token.
type (NotionAPIKeyType) – The definition of the NotionAPIKey object.

datadog_api_client.v2.model.notion_credentials module¶

class NotionCredentials(arg: None)¶

class NotionCredentials(arg: ModelComposed)

class NotionCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the NotionCredentials object.

Parameters:

api_token (str) – The NotionAPIKey api_token.
type (NotionAPIKeyType) – The definition of the NotionAPIKey object.

datadog_api_client.v2.model.notion_credentials_update module¶

class NotionCredentialsUpdate(arg: None)¶

class NotionCredentialsUpdate(arg: ModelComposed)

class NotionCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the NotionCredentialsUpdate object.

Parameters:

api_token (str, optional) – The NotionAPIKeyUpdate api_token.
type (NotionAPIKeyType) – The definition of the NotionAPIKey object.

datadog_api_client.v2.model.notion_integration module¶

class NotionIntegration(arg: None)¶

class NotionIntegration(arg: ModelComposed)

class NotionIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the NotionIntegration object.

Parameters:

credentials (NotionCredentials) – The definition of the NotionCredentials object.
type (NotionIntegrationType) – The definition of the NotionIntegrationType object.

datadog_api_client.v2.model.notion_integration_type module¶

class NotionIntegrationType(arg: None)¶

class NotionIntegrationType(arg: ModelComposed)

class NotionIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the NotionIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Notion”. Must be one of [“Notion”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.notion_integration_update module¶

class NotionIntegrationUpdate(arg: None)¶

class NotionIntegrationUpdate(arg: ModelComposed)

class NotionIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the NotionIntegrationUpdate object.

Parameters:

credentials (NotionCredentialsUpdate, optional) – The definition of the NotionCredentialsUpdate object.
type (NotionIntegrationType) – The definition of the NotionIntegrationType object.

datadog_api_client.v2.model.nullable_relationship_to_user module¶

class NullableRelationshipToUser(arg: None)¶

class NullableRelationshipToUser(arg: ModelComposed)

class NullableRelationshipToUser(*args, **kwargs)

Bases: ModelNormal

Relationship to user.

Parameters:: data (NullableRelationshipToUserData, none_type) – Relationship to user object.

datadog_api_client.v2.model.nullable_relationship_to_user_data module¶

class NullableRelationshipToUserData(arg: None)¶

class NullableRelationshipToUserData(arg: ModelComposed)

class NullableRelationshipToUserData(*args, **kwargs)

Bases: ModelNormal

Relationship to user object.

Parameters:

id (str) – A unique identifier that represents the user.
type (UsersType) – Users resource type.

datadog_api_client.v2.model.nullable_user_relationship module¶

class NullableUserRelationship(arg: None)¶

class NullableUserRelationship(arg: ModelComposed)

class NullableUserRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship to user.

Parameters:: data (NullableUserRelationshipData, none_type) – Relationship to user object.

datadog_api_client.v2.model.nullable_user_relationship_data module¶

class NullableUserRelationshipData(arg: None)¶

class NullableUserRelationshipData(arg: ModelComposed)

class NullableUserRelationshipData(*args, **kwargs)

Bases: ModelNormal

Relationship to user object.

Parameters:

id (str) – A unique identifier that represents the user.
type (UserResourceType) – User resource type.

datadog_api_client.v2.model.observability_pipeline module¶

class ObservabilityPipeline(arg: None)¶

class ObservabilityPipeline(arg: ModelComposed)

class ObservabilityPipeline(*args, **kwargs)

Bases: ModelNormal

Top-level schema representing a pipeline.

Parameters:: data (ObservabilityPipelineData) – Contains the pipeline’s ID, type, and configuration attributes.

datadog_api_client.v2.model.observability_pipeline_add_env_vars_processor module¶

class ObservabilityPipelineAddEnvVarsProcessor(arg: None)¶

class ObservabilityPipelineAddEnvVarsProcessor(arg: ModelComposed)

class ObservabilityPipelineAddEnvVarsProcessor(*args, **kwargs)

Bases: ModelNormal

The add_env_vars processor adds environment variable values to log events.

Parameters:

id (str) – The unique identifier for this component. Used to reference this processor in the pipeline.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
type (ObservabilityPipelineAddEnvVarsProcessorType) – The processor type. The value should always be add_env_vars.
variables ([ObservabilityPipelineAddEnvVarsProcessorVariable]) – A list of environment variable mappings to apply to log fields.

datadog_api_client.v2.model.observability_pipeline_add_env_vars_processor_type module¶

class ObservabilityPipelineAddEnvVarsProcessorType(arg: None)¶

class ObservabilityPipelineAddEnvVarsProcessorType(arg: ModelComposed)

class ObservabilityPipelineAddEnvVarsProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be add_env_vars.

Parameters:

value (str) – If omitted defaults to “add_env_vars”. Must be one of [“add_env_vars”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_add_env_vars_processor_variable module¶

class ObservabilityPipelineAddEnvVarsProcessorVariable(arg: None)¶

class ObservabilityPipelineAddEnvVarsProcessorVariable(arg: ModelComposed)

class ObservabilityPipelineAddEnvVarsProcessorVariable(*args, **kwargs)

Bases: ModelNormal

Defines a mapping between an environment variable and a log field.

Parameters:

field (str) – The target field in the log event.
name (str) – The name of the environment variable to read.

datadog_api_client.v2.model.observability_pipeline_add_fields_processor module¶

class ObservabilityPipelineAddFieldsProcessor(arg: None)¶

class ObservabilityPipelineAddFieldsProcessor(arg: ModelComposed)

class ObservabilityPipelineAddFieldsProcessor(*args, **kwargs)

Bases: ModelNormal

The add_fields processor adds static key-value fields to logs.

Parameters:

fields ([ObservabilityPipelineFieldValue]) – A list of static fields (key-value pairs) that is added to each log event processed by this component.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineAddFieldsProcessorType) – The processor type. The value should always be add_fields.

datadog_api_client.v2.model.observability_pipeline_add_fields_processor_type module¶

class ObservabilityPipelineAddFieldsProcessorType(arg: None)¶

class ObservabilityPipelineAddFieldsProcessorType(arg: ModelComposed)

class ObservabilityPipelineAddFieldsProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be add_fields.

Parameters:

value (str) – If omitted defaults to “add_fields”. Must be one of [“add_fields”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_data_firehose_source module¶

class ObservabilityPipelineAmazonDataFirehoseSource(arg: None)¶

class ObservabilityPipelineAmazonDataFirehoseSource(arg: ModelComposed)

class ObservabilityPipelineAmazonDataFirehoseSource(*args, **kwargs)

Bases: ModelNormal

The amazon_data_firehose source ingests logs from AWS Data Firehose.

Parameters:

auth (ObservabilityPipelineAwsAuth, optional) – AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineAmazonDataFirehoseSourceType) – The source type. The value should always be amazon_data_firehose.

datadog_api_client.v2.model.observability_pipeline_amazon_data_firehose_source_type module¶

class ObservabilityPipelineAmazonDataFirehoseSourceType(arg: None)¶

class ObservabilityPipelineAmazonDataFirehoseSourceType(arg: ModelComposed)

class ObservabilityPipelineAmazonDataFirehoseSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be amazon_data_firehose.

Parameters:

value (str) – If omitted defaults to “amazon_data_firehose”. Must be one of [“amazon_data_firehose”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_open_search_destination module¶

class ObservabilityPipelineAmazonOpenSearchDestination(arg: None)¶

class ObservabilityPipelineAmazonOpenSearchDestination(arg: ModelComposed)

class ObservabilityPipelineAmazonOpenSearchDestination(*args, **kwargs)

Bases: ModelNormal

The amazon_opensearch destination writes logs to Amazon OpenSearch.

Parameters:

auth (ObservabilityPipelineAmazonOpenSearchDestinationAuth) – Authentication settings for the Amazon OpenSearch destination. The strategy field determines whether basic or AWS-based authentication is used.
bulk_index (str, optional) – The index to write logs to.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineAmazonOpenSearchDestinationType) – The destination type. The value should always be amazon_opensearch.

datadog_api_client.v2.model.observability_pipeline_amazon_open_search_destination_auth module¶

class ObservabilityPipelineAmazonOpenSearchDestinationAuth(arg: None)¶

class ObservabilityPipelineAmazonOpenSearchDestinationAuth(arg: ModelComposed)

class ObservabilityPipelineAmazonOpenSearchDestinationAuth(*args, **kwargs)

Bases: ModelNormal

Authentication settings for the Amazon OpenSearch destination. The strategy field determines whether basic or AWS-based authentication is used.

Parameters:

assume_role (str, optional) – The ARN of the role to assume (used with aws strategy).
aws_region (str, optional) – AWS region
external_id (str, optional) – External ID for the assumed role (used with aws strategy).
session_name (str, optional) – Session name for the assumed role (used with aws strategy).
strategy (ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy) – The authentication strategy to use.

datadog_api_client.v2.model.observability_pipeline_amazon_open_search_destination_auth_strategy module¶

class ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy(arg: None)¶

class ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy(arg: ModelComposed)

class ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy(*args, **kwargs)

Bases: ModelSimple

The authentication strategy to use.

Parameters:

value (str) – Must be one of [“basic”, “aws”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_open_search_destination_type module¶

class ObservabilityPipelineAmazonOpenSearchDestinationType(arg: None)¶

class ObservabilityPipelineAmazonOpenSearchDestinationType(arg: ModelComposed)

class ObservabilityPipelineAmazonOpenSearchDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be amazon_opensearch.

Parameters:

value (str) – If omitted defaults to “amazon_opensearch”. Must be one of [“amazon_opensearch”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_s3_destination module¶

class ObservabilityPipelineAmazonS3Destination(arg: None)¶

class ObservabilityPipelineAmazonS3Destination(arg: ModelComposed)

class ObservabilityPipelineAmazonS3Destination(*args, **kwargs)

Bases: ModelNormal

The amazon_s3 destination sends your logs in Datadog-rehydratable format to an Amazon S3 bucket for archiving.

Parameters:

auth (ObservabilityPipelineAwsAuth, optional) – AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
bucket (str) – S3 bucket name.
id (str) – Unique identifier for the destination component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
key_prefix (str, optional) – Optional prefix for object keys.
region (str) – AWS region of the S3 bucket.
storage_class (ObservabilityPipelineAmazonS3DestinationStorageClass) – S3 storage class.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineAmazonS3DestinationType) – The destination type. Always amazon_s3.

datadog_api_client.v2.model.observability_pipeline_amazon_s3_destination_storage_class module¶

class ObservabilityPipelineAmazonS3DestinationStorageClass(arg: None)¶

class ObservabilityPipelineAmazonS3DestinationStorageClass(arg: ModelComposed)

class ObservabilityPipelineAmazonS3DestinationStorageClass(*args, **kwargs)

Bases: ModelSimple

S3 storage class.

Parameters:

value (str) – Must be one of [“STANDARD”, “REDUCED_REDUNDANCY”, “INTELLIGENT_TIERING”, “STANDARD_IA”, “EXPRESS_ONEZONE”, “ONEZONE_IA”, “GLACIER”, “GLACIER_IR”, “DEEP_ARCHIVE”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_s3_destination_type module¶

class ObservabilityPipelineAmazonS3DestinationType(arg: None)¶

class ObservabilityPipelineAmazonS3DestinationType(arg: ModelComposed)

class ObservabilityPipelineAmazonS3DestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. Always amazon_s3.

Parameters:

value (str) – If omitted defaults to “amazon_s3”. Must be one of [“amazon_s3”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_s3_source module¶

class ObservabilityPipelineAmazonS3Source(arg: None)¶

class ObservabilityPipelineAmazonS3Source(arg: ModelComposed)

class ObservabilityPipelineAmazonS3Source(*args, **kwargs)

Bases: ModelNormal

The amazon_s3 source ingests logs from an Amazon S3 bucket. It supports AWS authentication and TLS encryption.

Parameters:

auth (ObservabilityPipelineAwsAuth, optional) – AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
region (str) – AWS region where the S3 bucket resides.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineAmazonS3SourceType) – The source type. Always amazon_s3.

datadog_api_client.v2.model.observability_pipeline_amazon_s3_source_type module¶

class ObservabilityPipelineAmazonS3SourceType(arg: None)¶

class ObservabilityPipelineAmazonS3SourceType(arg: ModelComposed)

class ObservabilityPipelineAmazonS3SourceType(*args, **kwargs)

Bases: ModelSimple

The source type. Always amazon_s3.

Parameters:

value (str) – If omitted defaults to “amazon_s3”. Must be one of [“amazon_s3”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_amazon_security_lake_destination module¶

class ObservabilityPipelineAmazonSecurityLakeDestination(arg: None)¶

class ObservabilityPipelineAmazonSecurityLakeDestination(arg: ModelComposed)

class ObservabilityPipelineAmazonSecurityLakeDestination(*args, **kwargs)

Bases: ModelNormal

The amazon_security_lake destination sends your logs to Amazon Security Lake.

Parameters:

auth (ObservabilityPipelineAwsAuth, optional) – AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
bucket (str) – Name of the Amazon S3 bucket in Security Lake (3-63 characters).
custom_source_name (str) – Custom source name for the logs in Security Lake.
id (str) – Unique identifier for the destination component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
region (str) – AWS region of the S3 bucket.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineAmazonSecurityLakeDestinationType) – The destination type. Always amazon_security_lake.

datadog_api_client.v2.model.observability_pipeline_amazon_security_lake_destination_type module¶

class ObservabilityPipelineAmazonSecurityLakeDestinationType(arg: None)¶

class ObservabilityPipelineAmazonSecurityLakeDestinationType(arg: ModelComposed)

class ObservabilityPipelineAmazonSecurityLakeDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. Always amazon_security_lake.

Parameters:

value (str) – If omitted defaults to “amazon_security_lake”. Must be one of [“amazon_security_lake”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_aws_auth module¶

class ObservabilityPipelineAwsAuth(arg: None)¶

class ObservabilityPipelineAwsAuth(arg: ModelComposed)

class ObservabilityPipelineAwsAuth(*args, **kwargs)

Bases: ModelNormal

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

Parameters:

assume_role (str, optional) – The Amazon Resource Name (ARN) of the role to assume.
external_id (str, optional) – A unique identifier for cross-account role assumption.
session_name (str, optional) – A session identifier used for logging and tracing the assumed role session.

datadog_api_client.v2.model.observability_pipeline_config module¶

class ObservabilityPipelineConfig(arg: None)¶

class ObservabilityPipelineConfig(arg: ModelComposed)

class ObservabilityPipelineConfig(*args, **kwargs)

Bases: ModelNormal

Specifies the pipeline’s configuration, including its sources, processors, and destinations.

Parameters:

destinations ([ObservabilityPipelineConfigDestinationItem]) – A list of destination components where processed logs are sent.
processors ([ObservabilityPipelineConfigProcessorItem], optional) – A list of processors that transform or enrich log data.
sources ([ObservabilityPipelineConfigSourceItem]) – A list of configured data sources for the pipeline.

datadog_api_client.v2.model.observability_pipeline_config_destination_item module¶

class ObservabilityPipelineConfigDestinationItem(arg: None)¶

class ObservabilityPipelineConfigDestinationItem(arg: ModelComposed)

class ObservabilityPipelineConfigDestinationItem(*args, **kwargs)

Bases: ModelComposed

A destination for the pipeline.

Parameters:

id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineDatadogLogsDestinationType) – The destination type. The value should always be datadog_logs.
auth (ObservabilityPipelineAwsAuth, optional) – AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
bucket (str) – S3 bucket name.
key_prefix (str, optional) – Optional prefix for object keys.
region (str) – AWS region of the S3 bucket.
storage_class (ObservabilityPipelineAmazonS3DestinationStorageClass) – S3 storage class.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
acl (ObservabilityPipelineGoogleCloudStorageDestinationAcl, optional) – Access control list setting for objects written to the bucket.
metadata ([ObservabilityPipelineMetadataEntry], optional) – Custom metadata to attach to each object uploaded to the GCS bucket.
auto_extract_timestamp (bool, optional) – If true, Splunk tries to extract timestamps from incoming log events. If false, Splunk assigns the time the event was received.
encoding (ObservabilityPipelineSplunkHecDestinationEncoding, optional) – Encoding format for log events.
index (str, optional) – Optional name of the Splunk index where logs are written.
sourcetype (str, optional) – The Splunk sourcetype to assign to log events.
header_custom_fields ([ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem], optional) – A list of custom headers to include in the request to Sumo Logic.
header_host_name (str, optional) – Optional override for the host name header.
header_source_category (str, optional) – Optional override for the source category header.
header_source_name (str, optional) – Optional override for the source name header.
api_version (ObservabilityPipelineElasticsearchDestinationApiVersion, optional) – The Elasticsearch API version to use. Set to auto to auto-detect.
bulk_index (str, optional) – The index to write logs to in Elasticsearch.
keepalive (int, optional) – Optional socket keepalive duration in milliseconds.
blob_prefix (str, optional) – Optional prefix for blobs written to the container.
container_name (str) – The name of the Azure Blob Storage container to store logs in.
client_id (str) – Azure AD client ID used for authentication.
dcr_immutable_id (str) – The immutable ID of the Data Collection Rule (DCR).
table (str) – The name of the Log Analytics table where logs are sent.
tenant_id (str) – Azure AD tenant ID.
customer_id (str) – The Google Chronicle customer ID.
log_type (str, optional) – The log type metadata associated with the Chronicle destination.
framing (ObservabilityPipelineSocketDestinationFraming) – Framing method configuration.
mode (ObservabilityPipelineSocketDestinationMode) – Protocol used to send logs.
custom_source_name (str) – Custom source name for the logs in Security Lake.
compression (ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression, optional) – Compression configuration for log events.
project (str) – The GCP project ID that owns the Pub/Sub topic.
topic (str) – The Pub/Sub topic name to publish logs to.

datadog_api_client.v2.model.observability_pipeline_config_processor_item module¶

class ObservabilityPipelineConfigProcessorItem(arg: None)¶

class ObservabilityPipelineConfigProcessorItem(arg: ModelComposed)

class ObservabilityPipelineConfigProcessorItem(*args, **kwargs)

Bases: ModelComposed

A processor for the pipeline.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
include (str) – A Datadog search query used to determine which logs should pass through the filter. Logs that match this query continue to downstream components; others are dropped.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineFilterProcessorType) – The processor type. The value should always be filter.
field (str) – The name of the log field that contains a JSON string.
drop_events (bool) – If set to true, logs that matched the quota filter and sent after the quota has been met are dropped; only logs that did not match the filter query continue through the pipeline.
ignore_when_missing_partitions (bool, optional) – If true, the processor skips quota checks when partition fields are missing from the logs.
limit (ObservabilityPipelineQuotaProcessorLimit) – The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.
name (str) – Name of the quota.
overflow_action (ObservabilityPipelineQuotaProcessorOverflowAction, optional) – The action to take when the quota is exceeded. Options: - drop: Drop the event. - no_action: Let the event pass through. - overflow_routing: Route to an overflow destination.
overrides ([ObservabilityPipelineQuotaProcessorOverride], optional) – A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.
partition_fields ([str], optional) – A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.
fields ([ObservabilityPipelineFieldValue]) – A list of static fields (key-value pairs) that is added to each log event processed by this component.
metrics ([ObservabilityPipelineGeneratedMetric]) – Configuration for generating individual metrics.
percentage (float, optional) – The percentage of logs to sample.
rate (int, optional) – Number of events to sample (1 in N).
disable_library_rules (bool, optional) – If set to true, disables the default Grok rules provided by Datadog.
rules ([ObservabilityPipelineParseGrokProcessorRule]) – The list of Grok parsing rules. If multiple matching rules are provided, they are evaluated in order. The first successful match is applied.
mappings ([ObservabilityPipelineOcsfMapperProcessorMapping]) – A list of mapping rules to convert events to the OCSF format.
variables ([ObservabilityPipelineAddEnvVarsProcessorVariable]) – A list of environment variable mappings to apply to log fields.
mode (ObservabilityPipelineDedupeProcessorMode) – The deduplication mode to apply to the fields.
file (ObservabilityPipelineEnrichmentTableFile, optional) – Defines a static enrichment table loaded from a CSV file.
geoip (ObservabilityPipelineEnrichmentTableGeoIp, optional) – Uses a GeoIP database to enrich logs based on an IP field.
target (str) – Path where enrichment results should be stored in the log.
group_by ([str]) – A list of fields used to group log events for merging.
merge_strategies ([ObservabilityPipelineReduceProcessorMergeStrategy]) – List of merge strategies defining how values from grouped events should be combined.
threshold (int) – the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.
window (float) – The time window in seconds over which the threshold applies.
remaps ([ObservabilityPipelineCustomProcessorRemap]) – Array of VRL remap rules.
action (ObservabilityPipelineDatadogTagsProcessorAction) – The action to take on tags with matching keys.
keys ([str]) – A list of tag keys.

datadog_api_client.v2.model.observability_pipeline_config_source_item module¶

class ObservabilityPipelineConfigSourceItem(arg: None)¶

class ObservabilityPipelineConfigSourceItem(arg: ModelComposed)

class ObservabilityPipelineConfigSourceItem(*args, **kwargs)

Bases: ModelComposed

A data source for the pipeline.

Parameters:

group_id (str) – Consumer group ID used by the Kafka client.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
librdkafka_options ([ObservabilityPipelineKafkaSourceLibrdkafkaOption], optional) – Optional list of advanced Kafka client configuration options, defined as key-value pairs.
sasl (ObservabilityPipelineKafkaSourceSasl, optional) – Specifies the SASL mechanism for authenticating with a Kafka cluster.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
topics ([str]) – A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified.
type (ObservabilityPipelineKafkaSourceType) – The source type. The value should always be kafka.
auth (ObservabilityPipelineAwsAuth, optional) – AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
region (str) – AWS region where the S3 bucket resides.
auth_strategy (ObservabilityPipelineHttpServerSourceAuthStrategy) – HTTP authentication method.
decoding (ObservabilityPipelineDecoding) – The decoding format used to interpret incoming logs.
mode (ObservabilityPipelineSyslogSourceMode) – Protocol used by the syslog source to receive messages.
project (str) – The GCP project ID that owns the Pub/Sub subscription.
subscription (str) – The Pub/Sub subscription name from which messages are consumed.
scrape_interval_secs (int, optional) – The interval (in seconds) between HTTP scrape requests.
scrape_timeout_secs (int, optional) – The timeout (in seconds) for each scrape request.
framing (ObservabilityPipelineSocketSourceFraming) – Framing method configuration for the socket source.

datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination module¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestination(arg: None)¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestination(arg: ModelComposed)

class ObservabilityPipelineCrowdStrikeNextGenSiemDestination(*args, **kwargs)

Bases: ModelNormal

The crowdstrike_next_gen_siem destination forwards logs to CrowdStrike Next Gen SIEM.

Parameters:

compression (ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression, optional) – Compression configuration for log events.
encoding (ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding) – Encoding format for log events.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType) – The destination type. The value should always be crowdstrike_next_gen_siem.

datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination_compression module¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression(arg: None)¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression(arg: ModelComposed)

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression(*args, **kwargs)

Bases: ModelNormal

Compression configuration for log events.

Parameters:

algorithm (ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm) – Compression algorithm for log events.
level (int, optional) – Compression level.

datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination_compression_algorithm module¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm(arg: None)¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm(arg: ModelComposed)

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm(*args, **kwargs)

Bases: ModelSimple

Compression algorithm for log events.

Parameters:

value (str) – Must be one of [“gzip”, “zlib”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination_encoding module¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding(arg: None)¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding(arg: ModelComposed)

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding(*args, **kwargs)

Bases: ModelSimple

Encoding format for log events.

Parameters:

value (str) – Must be one of [“json”, “raw_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_crowd_strike_next_gen_siem_destination_type module¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType(arg: None)¶

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType(arg: ModelComposed)

class ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be crowdstrike_next_gen_siem.

Parameters:

value (str) – If omitted defaults to “crowdstrike_next_gen_siem”. Must be one of [“crowdstrike_next_gen_siem”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_custom_processor module¶

class ObservabilityPipelineCustomProcessor(arg: None)¶

class ObservabilityPipelineCustomProcessor(arg: ModelComposed)

class ObservabilityPipelineCustomProcessor(*args, **kwargs)

Bases: ModelNormal

The custom_processor processor transforms events using Vector Remap Language (VRL) scripts with advanced filtering capabilities.

Parameters:

id (str) – The unique identifier for this processor.
include (str) – A Datadog search query used to determine which logs this processor targets. This field should always be set to * for the custom_processor processor.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
remaps ([ObservabilityPipelineCustomProcessorRemap]) – Array of VRL remap rules.
type (ObservabilityPipelineCustomProcessorType) – The processor type. The value should always be custom_processor.

datadog_api_client.v2.model.observability_pipeline_custom_processor_remap module¶

class ObservabilityPipelineCustomProcessorRemap(arg: None)¶

class ObservabilityPipelineCustomProcessorRemap(arg: ModelComposed)

class ObservabilityPipelineCustomProcessorRemap(*args, **kwargs)

Bases: ModelNormal

Defines a single VRL remap rule with its own filtering and transformation logic.

Parameters:

drop_on_error (bool) – Whether to drop events that caused errors during processing.
enabled (bool) – Whether this remap rule is enabled.
include (str) – A Datadog search query used to filter events for this specific remap rule.
name (str) – A descriptive name for this remap rule.
source (str) – The VRL script source code that defines the processing logic.

datadog_api_client.v2.model.observability_pipeline_custom_processor_type module¶

class ObservabilityPipelineCustomProcessorType(arg: None)¶

class ObservabilityPipelineCustomProcessorType(arg: ModelComposed)

class ObservabilityPipelineCustomProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be custom_processor.

Parameters:

value (str) – If omitted defaults to “custom_processor”. Must be one of [“custom_processor”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_data module¶

class ObservabilityPipelineData(arg: None)¶

class ObservabilityPipelineData(arg: ModelComposed)

class ObservabilityPipelineData(*args, **kwargs)

Bases: ModelNormal

Contains the pipeline’s ID, type, and configuration attributes.

Parameters:

attributes (ObservabilityPipelineDataAttributes) – Defines the pipeline’s name and its components (sources, processors, and destinations).
id (str) – Unique identifier for the pipeline.
type (str) – The resource type identifier. For pipeline resources, this should always be set to pipelines.

datadog_api_client.v2.model.observability_pipeline_data_attributes module¶

class ObservabilityPipelineDataAttributes(arg: None)¶

class ObservabilityPipelineDataAttributes(arg: ModelComposed)

class ObservabilityPipelineDataAttributes(*args, **kwargs)

Bases: ModelNormal

Defines the pipeline’s name and its components (sources, processors, and destinations).

Parameters:

config (ObservabilityPipelineConfig) – Specifies the pipeline’s configuration, including its sources, processors, and destinations.
name (str) – Name of the pipeline.

datadog_api_client.v2.model.observability_pipeline_datadog_agent_source module¶

class ObservabilityPipelineDatadogAgentSource(arg: None)¶

class ObservabilityPipelineDatadogAgentSource(arg: ModelComposed)

class ObservabilityPipelineDatadogAgentSource(*args, **kwargs)

Bases: ModelNormal

The datadog_agent source collects logs from the Datadog Agent.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineDatadogAgentSourceType) – The source type. The value should always be datadog_agent.

datadog_api_client.v2.model.observability_pipeline_datadog_agent_source_type module¶

class ObservabilityPipelineDatadogAgentSourceType(arg: None)¶

class ObservabilityPipelineDatadogAgentSourceType(arg: ModelComposed)

class ObservabilityPipelineDatadogAgentSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be datadog_agent.

Parameters:

value (str) – If omitted defaults to “datadog_agent”. Must be one of [“datadog_agent”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination module¶

class ObservabilityPipelineDatadogLogsDestination(arg: None)¶

class ObservabilityPipelineDatadogLogsDestination(arg: ModelComposed)

class ObservabilityPipelineDatadogLogsDestination(*args, **kwargs)

Bases: ModelNormal

The datadog_logs destination forwards logs to Datadog Log Management.

Parameters:

id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineDatadogLogsDestinationType) – The destination type. The value should always be datadog_logs.

datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type module¶

class ObservabilityPipelineDatadogLogsDestinationType(arg: None)¶

class ObservabilityPipelineDatadogLogsDestinationType(arg: ModelComposed)

class ObservabilityPipelineDatadogLogsDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be datadog_logs.

Parameters:

value (str) – If omitted defaults to “datadog_logs”. Must be one of [“datadog_logs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_datadog_tags_processor module¶

class ObservabilityPipelineDatadogTagsProcessor(arg: None)¶

class ObservabilityPipelineDatadogTagsProcessor(arg: ModelComposed)

class ObservabilityPipelineDatadogTagsProcessor(*args, **kwargs)

Bases: ModelNormal

The datadog_tags processor includes or excludes specific Datadog tags in your logs.

Parameters:

action (ObservabilityPipelineDatadogTagsProcessorAction) – The action to take on tags with matching keys.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
keys ([str]) – A list of tag keys.
mode (ObservabilityPipelineDatadogTagsProcessorMode) – The processing mode.
type (ObservabilityPipelineDatadogTagsProcessorType) – The processor type. The value should always be datadog_tags.

datadog_api_client.v2.model.observability_pipeline_datadog_tags_processor_action module¶

class ObservabilityPipelineDatadogTagsProcessorAction(arg: None)¶

class ObservabilityPipelineDatadogTagsProcessorAction(arg: ModelComposed)

class ObservabilityPipelineDatadogTagsProcessorAction(*args, **kwargs)

Bases: ModelSimple

The action to take on tags with matching keys.

Parameters:

value (str) – Must be one of [“include”, “exclude”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_datadog_tags_processor_mode module¶

class ObservabilityPipelineDatadogTagsProcessorMode(arg: None)¶

class ObservabilityPipelineDatadogTagsProcessorMode(arg: ModelComposed)

class ObservabilityPipelineDatadogTagsProcessorMode(*args, **kwargs)

Bases: ModelSimple

The processing mode.

Parameters:

value (str) – If omitted defaults to “filter”. Must be one of [“filter”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_datadog_tags_processor_type module¶

class ObservabilityPipelineDatadogTagsProcessorType(arg: None)¶

class ObservabilityPipelineDatadogTagsProcessorType(arg: ModelComposed)

class ObservabilityPipelineDatadogTagsProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be datadog_tags.

Parameters:

value (str) – If omitted defaults to “datadog_tags”. Must be one of [“datadog_tags”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_decoding module¶

class ObservabilityPipelineDecoding(arg: None)¶

class ObservabilityPipelineDecoding(arg: ModelComposed)

class ObservabilityPipelineDecoding(*args, **kwargs)

Bases: ModelSimple

The decoding format used to interpret incoming logs.

Parameters:

value (str) – Must be one of [“bytes”, “gelf”, “json”, “syslog”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_dedupe_processor module¶

class ObservabilityPipelineDedupeProcessor(arg: None)¶

class ObservabilityPipelineDedupeProcessor(arg: ModelComposed)

class ObservabilityPipelineDedupeProcessor(*args, **kwargs)

Bases: ModelNormal

The dedupe processor removes duplicate fields in log events.

Parameters:

fields ([str]) – A list of log field paths to check for duplicates.
id (str) – The unique identifier for this processor.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
mode (ObservabilityPipelineDedupeProcessorMode) – The deduplication mode to apply to the fields.
type (ObservabilityPipelineDedupeProcessorType) – The processor type. The value should always be dedupe.

datadog_api_client.v2.model.observability_pipeline_dedupe_processor_mode module¶

class ObservabilityPipelineDedupeProcessorMode(arg: None)¶

class ObservabilityPipelineDedupeProcessorMode(arg: ModelComposed)

class ObservabilityPipelineDedupeProcessorMode(*args, **kwargs)

Bases: ModelSimple

The deduplication mode to apply to the fields.

Parameters:

value (str) – Must be one of [“match”, “ignore”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_dedupe_processor_type module¶

class ObservabilityPipelineDedupeProcessorType(arg: None)¶

class ObservabilityPipelineDedupeProcessorType(arg: ModelComposed)

class ObservabilityPipelineDedupeProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be dedupe.

Parameters:

value (str) – If omitted defaults to “dedupe”. Must be one of [“dedupe”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination module¶

class ObservabilityPipelineElasticsearchDestination(arg: None)¶

class ObservabilityPipelineElasticsearchDestination(arg: ModelComposed)

class ObservabilityPipelineElasticsearchDestination(*args, **kwargs)

Bases: ModelNormal

The elasticsearch destination writes logs to an Elasticsearch cluster.

Parameters:

api_version (ObservabilityPipelineElasticsearchDestinationApiVersion, optional) – The Elasticsearch API version to use. Set to auto to auto-detect.
bulk_index (str, optional) – The index to write logs to in Elasticsearch.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineElasticsearchDestinationType) – The destination type. The value should always be elasticsearch.

datadog_api_client.v2.model.observability_pipeline_elasticsearch_destination_type module¶

class ObservabilityPipelineElasticsearchDestinationType(arg: None)¶

class ObservabilityPipelineElasticsearchDestinationType(arg: ModelComposed)

class ObservabilityPipelineElasticsearchDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be elasticsearch.

Parameters:

value (str) – If omitted defaults to “elasticsearch”. Must be one of [“elasticsearch”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file module¶

class ObservabilityPipelineEnrichmentTableFile(arg: None)¶

class ObservabilityPipelineEnrichmentTableFile(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFile(*args, **kwargs)

Bases: ModelNormal

Defines a static enrichment table loaded from a CSV file.

Parameters:

encoding (ObservabilityPipelineEnrichmentTableFileEncoding) – File encoding format.
key ([ObservabilityPipelineEnrichmentTableFileKeyItems]) – Key fields used to look up enrichment values.
path (str) – Path to the CSV file.
schema ([ObservabilityPipelineEnrichmentTableFileSchemaItems]) – Schema defining column names and their types.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file_encoding module¶

class ObservabilityPipelineEnrichmentTableFileEncoding(arg: None)¶

class ObservabilityPipelineEnrichmentTableFileEncoding(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFileEncoding(*args, **kwargs)

Bases: ModelNormal

File encoding format.

Parameters:

delimiter (str) – The encoding delimiter.
includes_headers (bool) – The encoding includes_headers.
type (ObservabilityPipelineEnrichmentTableFileEncodingType) – Specifies the encoding format (e.g., CSV) used for enrichment tables.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file_encoding_type module¶

class ObservabilityPipelineEnrichmentTableFileEncodingType(arg: None)¶

class ObservabilityPipelineEnrichmentTableFileEncodingType(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFileEncodingType(*args, **kwargs)

Bases: ModelSimple

Specifies the encoding format (e.g., CSV) used for enrichment tables.

Parameters:

value (str) – If omitted defaults to “csv”. Must be one of [“csv”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file_key_items module¶

class ObservabilityPipelineEnrichmentTableFileKeyItems(arg: None)¶

class ObservabilityPipelineEnrichmentTableFileKeyItems(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFileKeyItems(*args, **kwargs)

Bases: ModelNormal

Defines how to map log fields to enrichment table columns during lookups.

Parameters:

column (str) – The items column.
comparison (ObservabilityPipelineEnrichmentTableFileKeyItemsComparison) – Defines how to compare key fields for enrichment table lookups.
field (str) – The items field.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file_key_items_comparison module¶

class ObservabilityPipelineEnrichmentTableFileKeyItemsComparison(arg: None)¶

class ObservabilityPipelineEnrichmentTableFileKeyItemsComparison(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFileKeyItemsComparison(*args, **kwargs)

Bases: ModelSimple

Defines how to compare key fields for enrichment table lookups.

Parameters:

value (str) – If omitted defaults to “equals”. Must be one of [“equals”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file_schema_items module¶

class ObservabilityPipelineEnrichmentTableFileSchemaItems(arg: None)¶

class ObservabilityPipelineEnrichmentTableFileSchemaItems(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFileSchemaItems(*args, **kwargs)

Bases: ModelNormal

Describes a single column and its type in an enrichment table schema.

Parameters:

column (str) – The items column.
type (ObservabilityPipelineEnrichmentTableFileSchemaItemsType) – Declares allowed data types for enrichment table columns.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_file_schema_items_type module¶

class ObservabilityPipelineEnrichmentTableFileSchemaItemsType(arg: None)¶

class ObservabilityPipelineEnrichmentTableFileSchemaItemsType(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableFileSchemaItemsType(*args, **kwargs)

Bases: ModelSimple

Declares allowed data types for enrichment table columns.

Parameters:

value (str) – Must be one of [“string”, “boolean”, “integer”, “float”, “date”, “timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_geo_ip module¶

class ObservabilityPipelineEnrichmentTableGeoIp(arg: None)¶

class ObservabilityPipelineEnrichmentTableGeoIp(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableGeoIp(*args, **kwargs)

Bases: ModelNormal

Uses a GeoIP database to enrich logs based on an IP field.

Parameters:

key_field (str) – Path to the IP field in the log.
locale (str) – Locale used to resolve geographical names.
path (str) – Path to the GeoIP database file.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_processor module¶

class ObservabilityPipelineEnrichmentTableProcessor(arg: None)¶

class ObservabilityPipelineEnrichmentTableProcessor(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableProcessor(*args, **kwargs)

Bases: ModelNormal

The enrichment_table processor enriches logs using a static CSV file or GeoIP database.

Parameters:

file (ObservabilityPipelineEnrichmentTableFile, optional) – Defines a static enrichment table loaded from a CSV file.
geoip (ObservabilityPipelineEnrichmentTableGeoIp, optional) – Uses a GeoIP database to enrich logs based on an IP field.
id (str) – The unique identifier for this processor.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
target (str) – Path where enrichment results should be stored in the log.
type (ObservabilityPipelineEnrichmentTableProcessorType) – The processor type. The value should always be enrichment_table.

datadog_api_client.v2.model.observability_pipeline_enrichment_table_processor_type module¶

class ObservabilityPipelineEnrichmentTableProcessorType(arg: None)¶

class ObservabilityPipelineEnrichmentTableProcessorType(arg: ModelComposed)

class ObservabilityPipelineEnrichmentTableProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be enrichment_table.

Parameters:

value (str) – If omitted defaults to “enrichment_table”. Must be one of [“enrichment_table”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_field_value module¶

class ObservabilityPipelineFieldValue(arg: None)¶

class ObservabilityPipelineFieldValue(arg: ModelComposed)

class ObservabilityPipelineFieldValue(*args, **kwargs)

Bases: ModelNormal

Represents a static key-value pair used in various processors.

Parameters:

name (str) – The field name.
value (str) – The field value.

datadog_api_client.v2.model.observability_pipeline_filter_processor module¶

class ObservabilityPipelineFilterProcessor(arg: None)¶

class ObservabilityPipelineFilterProcessor(arg: ModelComposed)

class ObservabilityPipelineFilterProcessor(*args, **kwargs)

Bases: ModelNormal

The filter processor allows conditional processing of logs based on a Datadog search query. Logs that match the include query are passed through; others are discarded.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
include (str) – A Datadog search query used to determine which logs should pass through the filter. Logs that match this query continue to downstream components; others are dropped.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineFilterProcessorType) – The processor type. The value should always be filter.

datadog_api_client.v2.model.observability_pipeline_filter_processor_type module¶

class ObservabilityPipelineFilterProcessorType(arg: None)¶

class ObservabilityPipelineFilterProcessorType(arg: ModelComposed)

class ObservabilityPipelineFilterProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be filter.

Parameters:

value (str) – If omitted defaults to “filter”. Must be one of [“filter”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_fluent_bit_source module¶

class ObservabilityPipelineFluentBitSource(arg: None)¶

class ObservabilityPipelineFluentBitSource(arg: ModelComposed)

class ObservabilityPipelineFluentBitSource(*args, **kwargs)

Bases: ModelNormal

The fluent_bit source ingests logs from Fluent Bit.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineFluentBitSourceType) – The source type. The value should always be fluent_bit.

datadog_api_client.v2.model.observability_pipeline_fluent_bit_source_type module¶

class ObservabilityPipelineFluentBitSourceType(arg: None)¶

class ObservabilityPipelineFluentBitSourceType(arg: ModelComposed)

class ObservabilityPipelineFluentBitSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be fluent_bit.

Parameters:

value (str) – If omitted defaults to “fluent_bit”. Must be one of [“fluent_bit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_fluentd_source module¶

class ObservabilityPipelineFluentdSource(arg: None)¶

class ObservabilityPipelineFluentdSource(arg: ModelComposed)

class ObservabilityPipelineFluentdSource(*args, **kwargs)

Bases: ModelNormal

The fluentd source ingests logs from a Fluentd-compatible service.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineFluentdSourceType) – The source type. The value should always be `fluentd.

datadog_api_client.v2.model.observability_pipeline_fluentd_source_type module¶

class ObservabilityPipelineFluentdSourceType(arg: None)¶

class ObservabilityPipelineFluentdSourceType(arg: ModelComposed)

class ObservabilityPipelineFluentdSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be `fluentd.

Parameters:

value (str) – If omitted defaults to “fluentd”. Must be one of [“fluentd”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_gcp_auth module¶

class ObservabilityPipelineGcpAuth(arg: None)¶

class ObservabilityPipelineGcpAuth(arg: ModelComposed)

class ObservabilityPipelineGcpAuth(*args, **kwargs)

Bases: ModelNormal

GCP credentials used to authenticate with Google Cloud Storage.

Parameters:: credentials_file (str) – Path to the GCP service account key file.

datadog_api_client.v2.model.observability_pipeline_generate_metrics_processor module¶

class ObservabilityPipelineGenerateMetricsProcessor(arg: None)¶

class ObservabilityPipelineGenerateMetricsProcessor(arg: ModelComposed)

class ObservabilityPipelineGenerateMetricsProcessor(*args, **kwargs)

Bases: ModelNormal

The generate_datadog_metrics processor creates custom metrics from logs and sends them to Datadog. Metrics can be counters, gauges, or distributions and optionally grouped by log fields.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
metrics ([ObservabilityPipelineGeneratedMetric]) – Configuration for generating individual metrics.
type (ObservabilityPipelineGenerateMetricsProcessorType) – The processor type. Always generate_datadog_metrics.

datadog_api_client.v2.model.observability_pipeline_generate_metrics_processor_type module¶

class ObservabilityPipelineGenerateMetricsProcessorType(arg: None)¶

class ObservabilityPipelineGenerateMetricsProcessorType(arg: ModelComposed)

class ObservabilityPipelineGenerateMetricsProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. Always generate_datadog_metrics.

Parameters:

value (str) – If omitted defaults to “generate_datadog_metrics”. Must be one of [“generate_datadog_metrics”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_generated_metric module¶

class ObservabilityPipelineGeneratedMetric(arg: None)¶

class ObservabilityPipelineGeneratedMetric(arg: ModelComposed)

class ObservabilityPipelineGeneratedMetric(*args, **kwargs)

Bases: ModelNormal

Defines a log-based custom metric, including its name, type, filter, value computation strategy, and optional grouping fields.

Parameters:

group_by ([str], optional) – Optional fields used to group the metric series.
include (str) – Datadog filter query to match logs for metric generation.
metric_type (ObservabilityPipelineGeneratedMetricMetricType) – Type of metric to create.
name (str) – Name of the custom metric to be created.
value (ObservabilityPipelineMetricValue) – Specifies how the value of the generated metric is computed.

datadog_api_client.v2.model.observability_pipeline_generated_metric_increment_by_field module¶

class ObservabilityPipelineGeneratedMetricIncrementByField(arg: None)¶

class ObservabilityPipelineGeneratedMetricIncrementByField(arg: ModelComposed)

class ObservabilityPipelineGeneratedMetricIncrementByField(*args, **kwargs)

Bases: ModelNormal

Strategy that increments a generated metric based on the value of a log field.

Parameters:

field (str) – Name of the log field containing the numeric value to increment the metric by.
strategy (ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy) – Uses a numeric field in the log event as the metric increment.

datadog_api_client.v2.model.observability_pipeline_generated_metric_increment_by_field_strategy module¶

class ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy(arg: None)¶

class ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy(arg: ModelComposed)

class ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy(*args, **kwargs)

Bases: ModelSimple

Uses a numeric field in the log event as the metric increment.

Parameters:

value (str) – If omitted defaults to “increment_by_field”. Must be one of [“increment_by_field”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_generated_metric_increment_by_one module¶

class ObservabilityPipelineGeneratedMetricIncrementByOne(arg: None)¶

class ObservabilityPipelineGeneratedMetricIncrementByOne(arg: ModelComposed)

class ObservabilityPipelineGeneratedMetricIncrementByOne(*args, **kwargs)

Bases: ModelNormal

Strategy that increments a generated metric by one for each matching event.

Parameters:: strategy (ObservabilityPipelineGeneratedMetricIncrementByOneStrategy) – Increments the metric by 1 for each matching event.

datadog_api_client.v2.model.observability_pipeline_generated_metric_increment_by_one_strategy module¶

class ObservabilityPipelineGeneratedMetricIncrementByOneStrategy(arg: None)¶

class ObservabilityPipelineGeneratedMetricIncrementByOneStrategy(arg: ModelComposed)

class ObservabilityPipelineGeneratedMetricIncrementByOneStrategy(*args, **kwargs)

Bases: ModelSimple

Increments the metric by 1 for each matching event.

Parameters:

value (str) – If omitted defaults to “increment_by_one”. Must be one of [“increment_by_one”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_generated_metric_metric_type module¶

class ObservabilityPipelineGeneratedMetricMetricType(arg: None)¶

class ObservabilityPipelineGeneratedMetricMetricType(arg: ModelComposed)

class ObservabilityPipelineGeneratedMetricMetricType(*args, **kwargs)

Bases: ModelSimple

Type of metric to create.

Parameters:

value (str) – Must be one of [“count”, “gauge”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_chronicle_destination module¶

class ObservabilityPipelineGoogleChronicleDestination(arg: None)¶

class ObservabilityPipelineGoogleChronicleDestination(arg: ModelComposed)

class ObservabilityPipelineGoogleChronicleDestination(*args, **kwargs)

Bases: ModelNormal

The google_chronicle destination sends logs to Google Chronicle.

Parameters:

auth (ObservabilityPipelineGcpAuth, optional) – GCP credentials used to authenticate with Google Cloud Storage.
customer_id (str) – The Google Chronicle customer ID.
encoding (ObservabilityPipelineGoogleChronicleDestinationEncoding, optional) – The encoding format for the logs sent to Chronicle.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
log_type (str, optional) – The log type metadata associated with the Chronicle destination.
type (ObservabilityPipelineGoogleChronicleDestinationType) – The destination type. The value should always be google_chronicle.

datadog_api_client.v2.model.observability_pipeline_google_chronicle_destination_encoding module¶

class ObservabilityPipelineGoogleChronicleDestinationEncoding(arg: None)¶

class ObservabilityPipelineGoogleChronicleDestinationEncoding(arg: ModelComposed)

class ObservabilityPipelineGoogleChronicleDestinationEncoding(*args, **kwargs)

Bases: ModelSimple

The encoding format for the logs sent to Chronicle.

Parameters:

value (str) – Must be one of [“json”, “raw_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_chronicle_destination_type module¶

class ObservabilityPipelineGoogleChronicleDestinationType(arg: None)¶

class ObservabilityPipelineGoogleChronicleDestinationType(arg: ModelComposed)

class ObservabilityPipelineGoogleChronicleDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be google_chronicle.

Parameters:

value (str) – If omitted defaults to “google_chronicle”. Must be one of [“google_chronicle”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_cloud_storage_destination module¶

class ObservabilityPipelineGoogleCloudStorageDestination(arg: None)¶

class ObservabilityPipelineGoogleCloudStorageDestination(arg: ModelComposed)

class ObservabilityPipelineGoogleCloudStorageDestination(*args, **kwargs)

Bases: ModelNormal

The google_cloud_storage destination stores logs in a Google Cloud Storage (GCS) bucket. It requires a bucket name, GCP authentication, and metadata fields.

Parameters:

acl (ObservabilityPipelineGoogleCloudStorageDestinationAcl, optional) – Access control list setting for objects written to the bucket.
auth (ObservabilityPipelineGcpAuth, optional) – GCP credentials used to authenticate with Google Cloud Storage.
bucket (str) – Name of the GCS bucket.
id (str) – Unique identifier for the destination component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
key_prefix (str, optional) – Optional prefix for object keys within the GCS bucket.
metadata ([ObservabilityPipelineMetadataEntry], optional) – Custom metadata to attach to each object uploaded to the GCS bucket.
storage_class (ObservabilityPipelineGoogleCloudStorageDestinationStorageClass) – Storage class used for objects stored in GCS.
type (ObservabilityPipelineGoogleCloudStorageDestinationType) – The destination type. Always google_cloud_storage.

datadog_api_client.v2.model.observability_pipeline_google_cloud_storage_destination_acl module¶

class ObservabilityPipelineGoogleCloudStorageDestinationAcl(arg: None)¶

class ObservabilityPipelineGoogleCloudStorageDestinationAcl(arg: ModelComposed)

class ObservabilityPipelineGoogleCloudStorageDestinationAcl(*args, **kwargs)

Bases: ModelSimple

Access control list setting for objects written to the bucket.

Parameters:

value (str) – Must be one of [“private”, “project-private”, “public-read”, “authenticated-read”, “bucket-owner-read”, “bucket-owner-full-control”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_cloud_storage_destination_storage_class module¶

class ObservabilityPipelineGoogleCloudStorageDestinationStorageClass(arg: None)¶

class ObservabilityPipelineGoogleCloudStorageDestinationStorageClass(arg: ModelComposed)

class ObservabilityPipelineGoogleCloudStorageDestinationStorageClass(*args, **kwargs)

Bases: ModelSimple

Storage class used for objects stored in GCS.

Parameters:

value (str) – Must be one of [“STANDARD”, “NEARLINE”, “COLDLINE”, “ARCHIVE”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_cloud_storage_destination_type module¶

class ObservabilityPipelineGoogleCloudStorageDestinationType(arg: None)¶

class ObservabilityPipelineGoogleCloudStorageDestinationType(arg: ModelComposed)

class ObservabilityPipelineGoogleCloudStorageDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. Always google_cloud_storage.

Parameters:

value (str) – If omitted defaults to “google_cloud_storage”. Must be one of [“google_cloud_storage”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination module¶

class ObservabilityPipelineGooglePubSubDestination(arg: None)¶

class ObservabilityPipelineGooglePubSubDestination(arg: ModelComposed)

class ObservabilityPipelineGooglePubSubDestination(*args, **kwargs)

Bases: ModelNormal

The google_pubsub destination publishes logs to a Google Cloud Pub/Sub topic.

Parameters:

auth (ObservabilityPipelineGcpAuth, optional) – GCP credentials used to authenticate with Google Cloud Storage.
encoding (ObservabilityPipelineGooglePubSubDestinationEncoding) – Encoding format for log events.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
project (str) – The GCP project ID that owns the Pub/Sub topic.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
topic (str) – The Pub/Sub topic name to publish logs to.
type (ObservabilityPipelineGooglePubSubDestinationType) – The destination type. The value should always be google_pubsub.

datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_encoding module¶

class ObservabilityPipelineGooglePubSubDestinationEncoding(arg: None)¶

class ObservabilityPipelineGooglePubSubDestinationEncoding(arg: ModelComposed)

class ObservabilityPipelineGooglePubSubDestinationEncoding(*args, **kwargs)

Bases: ModelSimple

Encoding format for log events.

Parameters:

value (str) – Must be one of [“json”, “raw_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_pub_sub_destination_type module¶

class ObservabilityPipelineGooglePubSubDestinationType(arg: None)¶

class ObservabilityPipelineGooglePubSubDestinationType(arg: ModelComposed)

class ObservabilityPipelineGooglePubSubDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be google_pubsub.

Parameters:

value (str) – If omitted defaults to “google_pubsub”. Must be one of [“google_pubsub”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_google_pub_sub_source module¶

class ObservabilityPipelineGooglePubSubSource(arg: None)¶

class ObservabilityPipelineGooglePubSubSource(arg: ModelComposed)

class ObservabilityPipelineGooglePubSubSource(*args, **kwargs)

Bases: ModelNormal

The google_pubsub source ingests logs from a Google Cloud Pub/Sub subscription.

Parameters:

auth (ObservabilityPipelineGcpAuth, optional) – GCP credentials used to authenticate with Google Cloud Storage.
decoding (ObservabilityPipelineDecoding) – The decoding format used to interpret incoming logs.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
project (str) – The GCP project ID that owns the Pub/Sub subscription.
subscription (str) – The Pub/Sub subscription name from which messages are consumed.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineGooglePubSubSourceType) – The source type. The value should always be google_pubsub.

datadog_api_client.v2.model.observability_pipeline_google_pub_sub_source_type module¶

class ObservabilityPipelineGooglePubSubSourceType(arg: None)¶

class ObservabilityPipelineGooglePubSubSourceType(arg: ModelComposed)

class ObservabilityPipelineGooglePubSubSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be google_pubsub.

Parameters:

value (str) – If omitted defaults to “google_pubsub”. Must be one of [“google_pubsub”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_http_client_source module¶

class ObservabilityPipelineHttpClientSource(arg: None)¶

class ObservabilityPipelineHttpClientSource(arg: ModelComposed)

class ObservabilityPipelineHttpClientSource(*args, **kwargs)

Bases: ModelNormal

The http_client source scrapes logs from HTTP endpoints at regular intervals.

Parameters:

auth_strategy (ObservabilityPipelineHttpClientSourceAuthStrategy, optional) – Optional authentication strategy for HTTP requests.
decoding (ObservabilityPipelineDecoding) – The decoding format used to interpret incoming logs.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
scrape_interval_secs (int, optional) – The interval (in seconds) between HTTP scrape requests.
scrape_timeout_secs (int, optional) – The timeout (in seconds) for each scrape request.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineHttpClientSourceType) – The source type. The value should always be http_client.

datadog_api_client.v2.model.observability_pipeline_http_client_source_auth_strategy module¶

class ObservabilityPipelineHttpClientSourceAuthStrategy(arg: None)¶

class ObservabilityPipelineHttpClientSourceAuthStrategy(arg: ModelComposed)

class ObservabilityPipelineHttpClientSourceAuthStrategy(*args, **kwargs)

Bases: ModelSimple

Optional authentication strategy for HTTP requests.

Parameters:

value (str) – Must be one of [“basic”, “bearer”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_http_client_source_type module¶

class ObservabilityPipelineHttpClientSourceType(arg: None)¶

class ObservabilityPipelineHttpClientSourceType(arg: ModelComposed)

class ObservabilityPipelineHttpClientSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be http_client.

Parameters:

value (str) – If omitted defaults to “http_client”. Must be one of [“http_client”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_http_server_source module¶

class ObservabilityPipelineHttpServerSource(arg: None)¶

class ObservabilityPipelineHttpServerSource(arg: ModelComposed)

class ObservabilityPipelineHttpServerSource(*args, **kwargs)

Bases: ModelNormal

The http_server source collects logs over HTTP POST from external services.

Parameters:

auth_strategy (ObservabilityPipelineHttpServerSourceAuthStrategy) – HTTP authentication method.
decoding (ObservabilityPipelineDecoding) – The decoding format used to interpret incoming logs.
id (str) – Unique ID for the HTTP server source.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineHttpServerSourceType) – The source type. The value should always be http_server.

datadog_api_client.v2.model.observability_pipeline_http_server_source_auth_strategy module¶

class ObservabilityPipelineHttpServerSourceAuthStrategy(arg: None)¶

class ObservabilityPipelineHttpServerSourceAuthStrategy(arg: ModelComposed)

class ObservabilityPipelineHttpServerSourceAuthStrategy(*args, **kwargs)

Bases: ModelSimple

HTTP authentication method.

Parameters:

value (str) – Must be one of [“none”, “plain”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_http_server_source_type module¶

class ObservabilityPipelineHttpServerSourceType(arg: None)¶

class ObservabilityPipelineHttpServerSourceType(arg: ModelComposed)

class ObservabilityPipelineHttpServerSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be http_server.

Parameters:

value (str) – If omitted defaults to “http_server”. Must be one of [“http_server”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_kafka_source module¶

class ObservabilityPipelineKafkaSource(arg: None)¶

class ObservabilityPipelineKafkaSource(arg: ModelComposed)

class ObservabilityPipelineKafkaSource(*args, **kwargs)

Bases: ModelNormal

The kafka source ingests data from Apache Kafka topics.

Parameters:

group_id (str) – Consumer group ID used by the Kafka client.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
librdkafka_options ([ObservabilityPipelineKafkaSourceLibrdkafkaOption], optional) – Optional list of advanced Kafka client configuration options, defined as key-value pairs.
sasl (ObservabilityPipelineKafkaSourceSasl, optional) – Specifies the SASL mechanism for authenticating with a Kafka cluster.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
topics ([str]) – A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified.
type (ObservabilityPipelineKafkaSourceType) – The source type. The value should always be kafka.

datadog_api_client.v2.model.observability_pipeline_kafka_source_librdkafka_option module¶

class ObservabilityPipelineKafkaSourceLibrdkafkaOption(arg: None)¶

class ObservabilityPipelineKafkaSourceLibrdkafkaOption(arg: ModelComposed)

class ObservabilityPipelineKafkaSourceLibrdkafkaOption(*args, **kwargs)

Bases: ModelNormal

Represents a key-value pair used to configure low-level librdkafka client options for Kafka sources, such as timeouts, buffer sizes, and security settings.

Parameters:

name (str) – The name of the librdkafka configuration option to set.
value (str) – The value assigned to the specified librdkafka configuration option.

datadog_api_client.v2.model.observability_pipeline_kafka_source_sasl module¶

class ObservabilityPipelineKafkaSourceSasl(arg: None)¶

class ObservabilityPipelineKafkaSourceSasl(arg: ModelComposed)

class ObservabilityPipelineKafkaSourceSasl(*args, **kwargs)

Bases: ModelNormal

Specifies the SASL mechanism for authenticating with a Kafka cluster.

Parameters:: mechanism (ObservabilityPipelinePipelineKafkaSourceSaslMechanism, optional) – SASL mechanism used for Kafka authentication.

datadog_api_client.v2.model.observability_pipeline_kafka_source_type module¶

class ObservabilityPipelineKafkaSourceType(arg: None)¶

class ObservabilityPipelineKafkaSourceType(arg: ModelComposed)

class ObservabilityPipelineKafkaSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be kafka.

Parameters:

value (str) – If omitted defaults to “kafka”. Must be one of [“kafka”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_logstash_source module¶

class ObservabilityPipelineLogstashSource(arg: None)¶

class ObservabilityPipelineLogstashSource(arg: ModelComposed)

class ObservabilityPipelineLogstashSource(*args, **kwargs)

Bases: ModelNormal

The logstash source ingests logs from a Logstash forwarder.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineLogstashSourceType) – The source type. The value should always be logstash.

datadog_api_client.v2.model.observability_pipeline_logstash_source_type module¶

class ObservabilityPipelineLogstashSourceType(arg: None)¶

class ObservabilityPipelineLogstashSourceType(arg: ModelComposed)

class ObservabilityPipelineLogstashSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be logstash.

Parameters:

value (str) – If omitted defaults to “logstash”. Must be one of [“logstash”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_metadata_entry module¶

class ObservabilityPipelineMetadataEntry(arg: None)¶

class ObservabilityPipelineMetadataEntry(arg: ModelComposed)

class ObservabilityPipelineMetadataEntry(*args, **kwargs)

Bases: ModelNormal

A custom metadata entry.

Parameters:

name (str) – The metadata key.
value (str) – The metadata value.

datadog_api_client.v2.model.observability_pipeline_metric_value module¶

class ObservabilityPipelineMetricValue(arg: None)¶

class ObservabilityPipelineMetricValue(arg: ModelComposed)

class ObservabilityPipelineMetricValue(*args, **kwargs)

Bases: ModelComposed

Specifies how the value of the generated metric is computed.

Parameters:

strategy (ObservabilityPipelineGeneratedMetricIncrementByOneStrategy) – Increments the metric by 1 for each matching event.
field (str) – Name of the log field containing the numeric value to increment the metric by.

datadog_api_client.v2.model.observability_pipeline_new_relic_destination module¶

class ObservabilityPipelineNewRelicDestination(arg: None)¶

class ObservabilityPipelineNewRelicDestination(arg: ModelComposed)

class ObservabilityPipelineNewRelicDestination(*args, **kwargs)

Bases: ModelNormal

The new_relic destination sends logs to the New Relic platform.

Parameters:

id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
region (ObservabilityPipelineNewRelicDestinationRegion) – The New Relic region.
type (ObservabilityPipelineNewRelicDestinationType) – The destination type. The value should always be new_relic.

datadog_api_client.v2.model.observability_pipeline_new_relic_destination_region module¶

class ObservabilityPipelineNewRelicDestinationRegion(arg: None)¶

class ObservabilityPipelineNewRelicDestinationRegion(arg: ModelComposed)

class ObservabilityPipelineNewRelicDestinationRegion(*args, **kwargs)

Bases: ModelSimple

The New Relic region.

Parameters:

value (str) – Must be one of [“us”, “eu”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_new_relic_destination_type module¶

class ObservabilityPipelineNewRelicDestinationType(arg: None)¶

class ObservabilityPipelineNewRelicDestinationType(arg: ModelComposed)

class ObservabilityPipelineNewRelicDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be new_relic.

Parameters:

value (str) – If omitted defaults to “new_relic”. Must be one of [“new_relic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor module¶

class ObservabilityPipelineOcsfMapperProcessor(arg: None)¶

class ObservabilityPipelineOcsfMapperProcessor(arg: ModelComposed)

class ObservabilityPipelineOcsfMapperProcessor(*args, **kwargs)

Bases: ModelNormal

The ocsf_mapper processor transforms logs into the OCSF schema using a predefined mapping configuration.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
mappings ([ObservabilityPipelineOcsfMapperProcessorMapping]) – A list of mapping rules to convert events to the OCSF format.
type (ObservabilityPipelineOcsfMapperProcessorType) – The processor type. The value should always be ocsf_mapper.

datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_mapping module¶

class ObservabilityPipelineOcsfMapperProcessorMapping(arg: None)¶

class ObservabilityPipelineOcsfMapperProcessorMapping(arg: ModelComposed)

class ObservabilityPipelineOcsfMapperProcessorMapping(*args, **kwargs)

Bases: ModelNormal

Defines how specific events are transformed to OCSF using a mapping configuration.

Parameters:

include (str) – A Datadog search query used to select the logs that this mapping should apply to.
mapping (ObservabilityPipelineOcsfMapperProcessorMappingMapping) – Defines a single mapping rule for transforming logs into the OCSF schema.

datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_mapping_mapping module¶

class ObservabilityPipelineOcsfMapperProcessorMappingMapping(arg: None)¶

class ObservabilityPipelineOcsfMapperProcessorMappingMapping(arg: ModelComposed)

class ObservabilityPipelineOcsfMapperProcessorMappingMapping(*args, **kwargs)

Bases: ModelComposed

Defines a single mapping rule for transforming logs into the OCSF schema.

datadog_api_client.v2.model.observability_pipeline_ocsf_mapper_processor_type module¶

class ObservabilityPipelineOcsfMapperProcessorType(arg: None)¶

class ObservabilityPipelineOcsfMapperProcessorType(arg: ModelComposed)

class ObservabilityPipelineOcsfMapperProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be ocsf_mapper.

Parameters:

value (str) – If omitted defaults to “ocsf_mapper”. Must be one of [“ocsf_mapper”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_ocsf_mapping_library module¶

class ObservabilityPipelineOcsfMappingLibrary(arg: None)¶

class ObservabilityPipelineOcsfMappingLibrary(arg: ModelComposed)

class ObservabilityPipelineOcsfMappingLibrary(*args, **kwargs)

Bases: ModelSimple

Predefined library mappings for common log formats.

Parameters:

value (str) – Must be one of [“CloudTrail Account Change”, “GCP Cloud Audit CreateBucket”, “GCP Cloud Audit CreateSink”, “GCP Cloud Audit SetIamPolicy”, “GCP Cloud Audit UpdateSink”, “Github Audit Log API Activity”, “Google Workspace Admin Audit addPrivilege”, “Microsoft 365 Defender Incident”, “Microsoft 365 Defender UserLoggedIn”, “Okta System Log Authentication”, “Palo Alto Networks Firewall Traffic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_open_search_destination module¶

class ObservabilityPipelineOpenSearchDestination(arg: None)¶

class ObservabilityPipelineOpenSearchDestination(arg: ModelComposed)

class ObservabilityPipelineOpenSearchDestination(*args, **kwargs)

Bases: ModelNormal

The opensearch destination writes logs to an OpenSearch cluster.

Parameters:

bulk_index (str, optional) – The index to write logs to.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineOpenSearchDestinationType) – The destination type. The value should always be opensearch.

datadog_api_client.v2.model.observability_pipeline_open_search_destination_type module¶

class ObservabilityPipelineOpenSearchDestinationType(arg: None)¶

class ObservabilityPipelineOpenSearchDestinationType(arg: ModelComposed)

class ObservabilityPipelineOpenSearchDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be opensearch.

Parameters:

value (str) – If omitted defaults to “opensearch”. Must be one of [“opensearch”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_parse_grok_processor module¶

class ObservabilityPipelineParseGrokProcessor(arg: None)¶

class ObservabilityPipelineParseGrokProcessor(arg: ModelComposed)

class ObservabilityPipelineParseGrokProcessor(*args, **kwargs)

Bases: ModelNormal

The parse_grok processor extracts structured fields from unstructured log messages using Grok patterns.

Parameters:

disable_library_rules (bool, optional) – If set to true , disables the default Grok rules provided by Datadog.
id (str) – A unique identifier for this processor.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
rules ([ObservabilityPipelineParseGrokProcessorRule]) – The list of Grok parsing rules. If multiple matching rules are provided, they are evaluated in order. The first successful match is applied.
type (ObservabilityPipelineParseGrokProcessorType) – The processor type. The value should always be parse_grok.

datadog_api_client.v2.model.observability_pipeline_parse_grok_processor_rule module¶

class ObservabilityPipelineParseGrokProcessorRule(arg: None)¶

class ObservabilityPipelineParseGrokProcessorRule(arg: ModelComposed)

class ObservabilityPipelineParseGrokProcessorRule(*args, **kwargs)

Bases: ModelNormal

A Grok parsing rule used in the parse_grok processor. Each rule defines how to extract structured fields from a specific log field using Grok patterns.

Parameters:

match_rules ([ObservabilityPipelineParseGrokProcessorRuleMatchRule]) – A list of Grok parsing rules that define how to extract fields from the source field. Each rule must contain a name and a valid Grok pattern.
source (str) – The name of the field in the log event to apply the Grok rules to.
support_rules ([ObservabilityPipelineParseGrokProcessorRuleSupportRule], optional) – A list of Grok helper rules that can be referenced by the parsing rules.

datadog_api_client.v2.model.observability_pipeline_parse_grok_processor_rule_match_rule module¶

class ObservabilityPipelineParseGrokProcessorRuleMatchRule(arg: None)¶

class ObservabilityPipelineParseGrokProcessorRuleMatchRule(arg: ModelComposed)

class ObservabilityPipelineParseGrokProcessorRuleMatchRule(*args, **kwargs)

Bases: ModelNormal

Defines a Grok parsing rule, which extracts structured fields from log content using named Grok patterns. Each rule must have a unique name and a valid Datadog Grok pattern that will be applied to the source field.

Parameters:

name (str) – The name of the rule.
rule (str) – The definition of the Grok rule.

datadog_api_client.v2.model.observability_pipeline_parse_grok_processor_rule_support_rule module¶

class ObservabilityPipelineParseGrokProcessorRuleSupportRule(arg: None)¶

class ObservabilityPipelineParseGrokProcessorRuleSupportRule(arg: ModelComposed)

class ObservabilityPipelineParseGrokProcessorRuleSupportRule(*args, **kwargs)

Bases: ModelNormal

The Grok helper rule referenced in the parsing rules.

Parameters:

name (str) – The name of the Grok helper rule.
rule (str) – The definition of the Grok helper rule.

datadog_api_client.v2.model.observability_pipeline_parse_grok_processor_type module¶

class ObservabilityPipelineParseGrokProcessorType(arg: None)¶

class ObservabilityPipelineParseGrokProcessorType(arg: ModelComposed)

class ObservabilityPipelineParseGrokProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be parse_grok.

Parameters:

value (str) – If omitted defaults to “parse_grok”. Must be one of [“parse_grok”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_parse_json_processor module¶

class ObservabilityPipelineParseJSONProcessor(arg: None)¶

class ObservabilityPipelineParseJSONProcessor(arg: ModelComposed)

class ObservabilityPipelineParseJSONProcessor(*args, **kwargs)

Bases: ModelNormal

The parse_json processor extracts JSON from a specified field and flattens it into the event. This is useful when logs contain embedded JSON as a string.

Parameters:

field (str) – The name of the log field that contains a JSON string.
id (str) – A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineParseJSONProcessorType) – The processor type. The value should always be parse_json.

datadog_api_client.v2.model.observability_pipeline_parse_json_processor_type module¶

class ObservabilityPipelineParseJSONProcessorType(arg: None)¶

class ObservabilityPipelineParseJSONProcessorType(arg: ModelComposed)

class ObservabilityPipelineParseJSONProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be parse_json.

Parameters:

value (str) – If omitted defaults to “parse_json”. Must be one of [“parse_json”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_pipeline_kafka_source_sasl_mechanism module¶

class ObservabilityPipelinePipelineKafkaSourceSaslMechanism(arg: None)¶

class ObservabilityPipelinePipelineKafkaSourceSaslMechanism(arg: ModelComposed)

class ObservabilityPipelinePipelineKafkaSourceSaslMechanism(*args, **kwargs)

Bases: ModelSimple

SASL mechanism used for Kafka authentication.

Parameters:

value (str) – Must be one of [“PLAIN”, “SCRAM-SHA-256”, “SCRAM-SHA-512”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_quota_processor module¶

class ObservabilityPipelineQuotaProcessor(arg: None)¶

class ObservabilityPipelineQuotaProcessor(arg: ModelComposed)

class ObservabilityPipelineQuotaProcessor(*args, **kwargs)

Bases: ModelNormal

The Quota Processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.

Parameters:

drop_events (bool) – If set to true , logs that matched the quota filter and sent after the quota has been met are dropped; only logs that did not match the filter query continue through the pipeline.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
ignore_when_missing_partitions (bool, optional) – If true , the processor skips quota checks when partition fields are missing from the logs.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
limit (ObservabilityPipelineQuotaProcessorLimit) – The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.
name (str) – Name of the quota.
overflow_action (ObservabilityPipelineQuotaProcessorOverflowAction, optional) –
The action to take when the quota is exceeded. Options:
- drop : Drop the event.
- no_action : Let the event pass through.
- overflow_routing : Route to an overflow destination.
overrides ([ObservabilityPipelineQuotaProcessorOverride], optional) – A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.
partition_fields ([str], optional) – A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.
type (ObservabilityPipelineQuotaProcessorType) – The processor type. The value should always be quota.

datadog_api_client.v2.model.observability_pipeline_quota_processor_limit module¶

class ObservabilityPipelineQuotaProcessorLimit(arg: None)¶

class ObservabilityPipelineQuotaProcessorLimit(arg: ModelComposed)

class ObservabilityPipelineQuotaProcessorLimit(*args, **kwargs)

Bases: ModelNormal

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

Parameters:

enforce (ObservabilityPipelineQuotaProcessorLimitEnforceType) – Unit for quota enforcement in bytes for data size or events for count.
limit (int) – The limit for quota enforcement.

datadog_api_client.v2.model.observability_pipeline_quota_processor_limit_enforce_type module¶

class ObservabilityPipelineQuotaProcessorLimitEnforceType(arg: None)¶

class ObservabilityPipelineQuotaProcessorLimitEnforceType(arg: ModelComposed)

class ObservabilityPipelineQuotaProcessorLimitEnforceType(*args, **kwargs)

Bases: ModelSimple

Unit for quota enforcement in bytes for data size or events for count.

Parameters:

value (str) – Must be one of [“bytes”, “events”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_quota_processor_overflow_action module¶

class ObservabilityPipelineQuotaProcessorOverflowAction(arg: None)¶

class ObservabilityPipelineQuotaProcessorOverflowAction(arg: ModelComposed)

class ObservabilityPipelineQuotaProcessorOverflowAction(*args, **kwargs)

Bases: ModelSimple

The action to take when the quota is exceeded. Options:

drop: Drop the event.
no_action: Let the event pass through.
overflow_routing: Route to an overflow destination.

Parameters:

value (str) – Must be one of [“drop”, “no_action”, “overflow_routing”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_quota_processor_override module¶

class ObservabilityPipelineQuotaProcessorOverride(arg: None)¶

class ObservabilityPipelineQuotaProcessorOverride(arg: ModelComposed)

class ObservabilityPipelineQuotaProcessorOverride(*args, **kwargs)

Bases: ModelNormal

Defines a custom quota limit that applies to specific log events based on matching field values.

Parameters:

fields ([ObservabilityPipelineFieldValue]) – A list of field matchers used to apply a specific override. If an event matches all listed key-value pairs, the corresponding override limit is enforced.
limit (ObservabilityPipelineQuotaProcessorLimit) – The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

datadog_api_client.v2.model.observability_pipeline_quota_processor_type module¶

class ObservabilityPipelineQuotaProcessorType(arg: None)¶

class ObservabilityPipelineQuotaProcessorType(arg: ModelComposed)

class ObservabilityPipelineQuotaProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be quota.

Parameters:

value (str) – If omitted defaults to “quota”. Must be one of [“quota”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_reduce_processor module¶

class ObservabilityPipelineReduceProcessor(arg: None)¶

class ObservabilityPipelineReduceProcessor(arg: ModelComposed)

class ObservabilityPipelineReduceProcessor(*args, **kwargs)

Bases: ModelNormal

The reduce processor aggregates and merges logs based on matching keys and merge strategies.

Parameters:

group_by ([str]) – A list of fields used to group log events for merging.
id (str) – The unique identifier for this processor.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
merge_strategies ([ObservabilityPipelineReduceProcessorMergeStrategy]) – List of merge strategies defining how values from grouped events should be combined.
type (ObservabilityPipelineReduceProcessorType) – The processor type. The value should always be reduce.

datadog_api_client.v2.model.observability_pipeline_reduce_processor_merge_strategy module¶

class ObservabilityPipelineReduceProcessorMergeStrategy(arg: None)¶

class ObservabilityPipelineReduceProcessorMergeStrategy(arg: ModelComposed)

class ObservabilityPipelineReduceProcessorMergeStrategy(*args, **kwargs)

Bases: ModelNormal

Defines how a specific field should be merged across grouped events.

Parameters:

path (str) – The field path in the log event.
strategy (ObservabilityPipelineReduceProcessorMergeStrategyStrategy) – The merge strategy to apply.

datadog_api_client.v2.model.observability_pipeline_reduce_processor_merge_strategy_strategy module¶

class ObservabilityPipelineReduceProcessorMergeStrategyStrategy(arg: None)¶

class ObservabilityPipelineReduceProcessorMergeStrategyStrategy(arg: ModelComposed)

class ObservabilityPipelineReduceProcessorMergeStrategyStrategy(*args, **kwargs)

Bases: ModelSimple

The merge strategy to apply.

Parameters:

value (str) – Must be one of [“discard”, “retain”, “sum”, “max”, “min”, “array”, “concat”, “concat_newline”, “concat_raw”, “shortest_array”, “longest_array”, “flat_unique”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_reduce_processor_type module¶

class ObservabilityPipelineReduceProcessorType(arg: None)¶

class ObservabilityPipelineReduceProcessorType(arg: ModelComposed)

class ObservabilityPipelineReduceProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be reduce.

Parameters:

value (str) – If omitted defaults to “reduce”. Must be one of [“reduce”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_remove_fields_processor module¶

class ObservabilityPipelineRemoveFieldsProcessor(arg: None)¶

class ObservabilityPipelineRemoveFieldsProcessor(arg: ModelComposed)

class ObservabilityPipelineRemoveFieldsProcessor(*args, **kwargs)

Bases: ModelNormal

The remove_fields processor deletes specified fields from logs.

Parameters:

fields ([str]) – A list of field names to be removed from each log event.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – The PipelineRemoveFieldsProcessor inputs.
type (ObservabilityPipelineRemoveFieldsProcessorType) – The processor type. The value should always be remove_fields.

datadog_api_client.v2.model.observability_pipeline_remove_fields_processor_type module¶

class ObservabilityPipelineRemoveFieldsProcessorType(arg: None)¶

class ObservabilityPipelineRemoveFieldsProcessorType(arg: ModelComposed)

class ObservabilityPipelineRemoveFieldsProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be remove_fields.

Parameters:

value (str) – If omitted defaults to “remove_fields”. Must be one of [“remove_fields”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_rename_fields_processor module¶

class ObservabilityPipelineRenameFieldsProcessor(arg: None)¶

class ObservabilityPipelineRenameFieldsProcessor(arg: ModelComposed)

class ObservabilityPipelineRenameFieldsProcessor(*args, **kwargs)

Bases: ModelNormal

The rename_fields processor changes field names.

Parameters:

fields ([ObservabilityPipelineRenameFieldsProcessorField]) – A list of rename rules specifying which fields to rename in the event, what to rename them to, and whether to preserve the original fields.
id (str) – A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineRenameFieldsProcessorType) – The processor type. The value should always be rename_fields.

datadog_api_client.v2.model.observability_pipeline_rename_fields_processor_field module¶

class ObservabilityPipelineRenameFieldsProcessorField(arg: None)¶

class ObservabilityPipelineRenameFieldsProcessorField(arg: ModelComposed)

class ObservabilityPipelineRenameFieldsProcessorField(*args, **kwargs)

Bases: ModelNormal

Defines how to rename a field in log events.

Parameters:

destination (str) – The field name to assign the renamed value to.
preserve_source (bool) – Indicates whether the original field, that is received from the source, should be kept ( true ) or removed ( false ) after renaming.
source (str) – The original field name in the log event that should be renamed.

datadog_api_client.v2.model.observability_pipeline_rename_fields_processor_type module¶

class ObservabilityPipelineRenameFieldsProcessorType(arg: None)¶

class ObservabilityPipelineRenameFieldsProcessorType(arg: ModelComposed)

class ObservabilityPipelineRenameFieldsProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be rename_fields.

Parameters:

value (str) – If omitted defaults to “rename_fields”. Must be one of [“rename_fields”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_rsyslog_destination module¶

class ObservabilityPipelineRsyslogDestination(arg: None)¶

class ObservabilityPipelineRsyslogDestination(arg: ModelComposed)

class ObservabilityPipelineRsyslogDestination(*args, **kwargs)

Bases: ModelNormal

The rsyslog destination forwards logs to an external rsyslog server over TCP or UDP using the syslog protocol.

Parameters:

id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
keepalive (int, optional) – Optional socket keepalive duration in milliseconds.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineRsyslogDestinationType) – The destination type. The value should always be rsyslog.

datadog_api_client.v2.model.observability_pipeline_rsyslog_destination_type module¶

class ObservabilityPipelineRsyslogDestinationType(arg: None)¶

class ObservabilityPipelineRsyslogDestinationType(arg: ModelComposed)

class ObservabilityPipelineRsyslogDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be rsyslog.

Parameters:

value (str) – If omitted defaults to “rsyslog”. Must be one of [“rsyslog”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_rsyslog_source module¶

class ObservabilityPipelineRsyslogSource(arg: None)¶

class ObservabilityPipelineRsyslogSource(arg: ModelComposed)

class ObservabilityPipelineRsyslogSource(*args, **kwargs)

Bases: ModelNormal

The rsyslog source listens for logs over TCP or UDP from an rsyslog server using the syslog protocol.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
mode (ObservabilityPipelineSyslogSourceMode) – Protocol used by the syslog source to receive messages.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineRsyslogSourceType) – The source type. The value should always be rsyslog.

datadog_api_client.v2.model.observability_pipeline_rsyslog_source_type module¶

class ObservabilityPipelineRsyslogSourceType(arg: None)¶

class ObservabilityPipelineRsyslogSourceType(arg: ModelComposed)

class ObservabilityPipelineRsyslogSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be rsyslog.

Parameters:

value (str) – If omitted defaults to “rsyslog”. Must be one of [“rsyslog”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sample_processor module¶

class ObservabilityPipelineSampleProcessor(arg: None)¶

class ObservabilityPipelineSampleProcessor(arg: ModelComposed)

class ObservabilityPipelineSampleProcessor(*args, **kwargs)

Bases: ModelNormal

The sample processor allows probabilistic sampling of logs at a fixed rate.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
percentage (float, optional) – The percentage of logs to sample.
rate (int, optional) – Number of events to sample (1 in N).
type (ObservabilityPipelineSampleProcessorType) – The processor type. The value should always be sample.

datadog_api_client.v2.model.observability_pipeline_sample_processor_type module¶

class ObservabilityPipelineSampleProcessorType(arg: None)¶

class ObservabilityPipelineSampleProcessorType(arg: ModelComposed)

class ObservabilityPipelineSampleProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be sample.

Parameters:

value (str) – If omitted defaults to “sample”. Must be one of [“sample”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor module¶

class ObservabilityPipelineSensitiveDataScannerProcessor(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessor(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessor(*args, **kwargs)

Bases: ModelNormal

The sensitive_data_scanner processor detects and optionally redacts sensitive data in log events.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
rules ([ObservabilityPipelineSensitiveDataScannerProcessorRule]) – A list of rules for identifying and acting on sensitive data patterns.
type (ObservabilityPipelineSensitiveDataScannerProcessorType) – The processor type. The value should always be sensitive_data_scanner.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action module¶

class ObservabilityPipelineSensitiveDataScannerProcessorAction(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorAction(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorAction(*args, **kwargs)

Bases: ModelComposed

Defines what action to take when sensitive data is matched.

Parameters:

action (ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction) – Action type that completely replaces the matched sensitive data with a fixed replacement string to remove all visibility.
options (ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions) – Configuration for fully redacting sensitive data.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_hash module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionHash(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionHash(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionHash(*args, **kwargs)

Bases: ModelNormal

Configuration for hashing matched sensitive values.

Parameters:

action (ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction) – Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content.
options (dict, optional) – The ObservabilityPipelineSensitiveDataScannerProcessorActionHash options.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_hash_action module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction(*args, **kwargs)

Bases: ModelSimple

Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content.

Parameters:

value (str) – If omitted defaults to “hash”. Must be one of [“hash”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_partial_redact module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact(*args, **kwargs)

Bases: ModelNormal

Configuration for partially redacting matched sensitive data.

Parameters:

action (ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction) – Action type that redacts part of the sensitive data while preserving a configurable number of characters, typically used for masking purposes (e.g., show last 4 digits of a credit card).
options (ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions) – Controls how partial redaction is applied, including character count and direction.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_partial_redact_action module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction(*args, **kwargs)

Bases: ModelSimple

Action type that redacts part of the sensitive data while preserving a configurable number of characters, typically used for masking purposes (e.g., show last 4 digits of a credit card).

Parameters:

value (str) – If omitted defaults to “partial_redact”. Must be one of [“partial_redact”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_partial_redact_options module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions(*args, **kwargs)

Bases: ModelNormal

Controls how partial redaction is applied, including character count and direction.

Parameters:

characters (int) – The ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions characters.
direction (ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection) – Indicates whether to redact characters from the first or last part of the matched value.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_partial_redact_options_direction module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection(*args, **kwargs)

Bases: ModelSimple

Indicates whether to redact characters from the first or last part of the matched value.

Parameters:

value (str) – Must be one of [“first”, “last”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_redact module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedact(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedact(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedact(*args, **kwargs)

Bases: ModelNormal

Configuration for completely redacting matched sensitive data.

Parameters:

action (ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction) – Action type that completely replaces the matched sensitive data with a fixed replacement string to remove all visibility.
options (ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions) – Configuration for fully redacting sensitive data.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_redact_action module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction(*args, **kwargs)

Bases: ModelSimple

Action type that completely replaces the matched sensitive data with a fixed replacement string to remove all visibility.

Parameters:

value (str) – If omitted defaults to “redact”. Must be one of [“redact”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_action_redact_options module¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions(*args, **kwargs)

Bases: ModelNormal

Configuration for fully redacting sensitive data.

Parameters:: replace (str) – The ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions replace.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_custom_pattern module¶

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern(*args, **kwargs)

Bases: ModelNormal

Defines a custom regex-based pattern for identifying sensitive data in logs.

Parameters:

options (ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions) – Options for defining a custom regex pattern.
type (ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType) – Indicates a custom regular expression is used for matching.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_custom_pattern_options module¶

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions(*args, **kwargs)

Bases: ModelNormal

Options for defining a custom regex pattern.

Parameters:: rule (str) – A regular expression used to detect sensitive values. Must be a valid regex.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_custom_pattern_type module¶

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType(*args, **kwargs)

Bases: ModelSimple

Indicates a custom regular expression is used for matching.

Parameters:

value (str) – If omitted defaults to “custom”. Must be one of [“custom”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_keyword_options module¶

class ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions(*args, **kwargs)

Bases: ModelNormal

Configuration for keywords used to reinforce sensitive data pattern detection.

Parameters:

keywords ([str]) – A list of keywords to match near the sensitive pattern.
proximity (int) – Maximum number of tokens between a keyword and a sensitive value match.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_library_pattern module¶

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern(*args, **kwargs)

Bases: ModelNormal

Specifies a pattern from Datadog’s sensitive data detection library to match known sensitive data types.

Parameters:

options (ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions) – Options for selecting a predefined library pattern and enabling keyword support.
type (ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType) – Indicates that a predefined library pattern is used.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_library_pattern_options module¶

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions(*args, **kwargs)

Bases: ModelNormal

Options for selecting a predefined library pattern and enabling keyword support.

Parameters:

id (str) – Identifier for a predefined pattern from the sensitive data scanner pattern library.
use_recommended_keywords (bool, optional) – Whether to augment the pattern with recommended keywords (optional).

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_library_pattern_type module¶

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType(*args, **kwargs)

Bases: ModelSimple

Indicates that a predefined library pattern is used.

Parameters:

value (str) – If omitted defaults to “library”. Must be one of [“library”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_pattern module¶

class ObservabilityPipelineSensitiveDataScannerProcessorPattern(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorPattern(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorPattern(*args, **kwargs)

Bases: ModelComposed

Pattern detection configuration for identifying sensitive data using either a custom regex or a library reference.

Parameters:

options (ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions) – Options for defining a custom regex pattern.
type (ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType) – Indicates a custom regular expression is used for matching.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_rule module¶

class ObservabilityPipelineSensitiveDataScannerProcessorRule(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorRule(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorRule(*args, **kwargs)

Bases: ModelNormal

Defines a rule for detecting sensitive data, including matching pattern, scope, and the action to take.

Parameters:

keyword_options (ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions, optional) – Configuration for keywords used to reinforce sensitive data pattern detection.
name (str) – A name identifying the rule.
on_match (ObservabilityPipelineSensitiveDataScannerProcessorAction) – Defines what action to take when sensitive data is matched.
pattern (ObservabilityPipelineSensitiveDataScannerProcessorPattern) – Pattern detection configuration for identifying sensitive data using either a custom regex or a library reference.
scope (ObservabilityPipelineSensitiveDataScannerProcessorScope) – Determines which parts of the log the pattern-matching rule should be applied to.
tags ([str]) – Tags assigned to this rule for filtering and classification.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScope(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScope(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScope(*args, **kwargs)

Bases: ModelComposed

Determines which parts of the log the pattern-matching rule should be applied to.

Parameters:

options (ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions) – Fields to which the scope rule applies.
target (ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget) – Applies the rule only to included fields.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_all module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeAll(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeAll(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeAll(*args, **kwargs)

Bases: ModelNormal

Applies scanning across all available fields.

Parameters:: target (ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget) – Applies the rule to all fields.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_all_target module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget(*args, **kwargs)

Bases: ModelSimple

Applies the rule to all fields.

Parameters:

value (str) – If omitted defaults to “all”. Must be one of [“all”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude(*args, **kwargs)

Bases: ModelNormal

Excludes specific fields from sensitive data scanning.

Parameters:

options (ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions) – Fields to which the scope rule applies.
target (ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget) – Excludes specific fields from processing.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_exclude_target module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget(*args, **kwargs)

Bases: ModelSimple

Excludes specific fields from processing.

Parameters:

value (str) – If omitted defaults to “exclude”. Must be one of [“exclude”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_include module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude(*args, **kwargs)

Bases: ModelNormal

Includes only specific fields for sensitive data scanning.

Parameters:

options (ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions) – Fields to which the scope rule applies.
target (ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget) – Applies the rule only to included fields.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_include_target module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget(*args, **kwargs)

Bases: ModelSimple

Applies the rule only to included fields.

Parameters:

value (str) – If omitted defaults to “include”. Must be one of [“include”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_scope_options module¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions(*args, **kwargs)

Bases: ModelNormal

Fields to which the scope rule applies.

Parameters:: fields ([str]) – The ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions fields.

datadog_api_client.v2.model.observability_pipeline_sensitive_data_scanner_processor_type module¶

class ObservabilityPipelineSensitiveDataScannerProcessorType(arg: None)¶

class ObservabilityPipelineSensitiveDataScannerProcessorType(arg: ModelComposed)

class ObservabilityPipelineSensitiveDataScannerProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be sensitive_data_scanner.

Parameters:

value (str) – If omitted defaults to “sensitive_data_scanner”. Must be one of [“sensitive_data_scanner”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sentinel_one_destination module¶

class ObservabilityPipelineSentinelOneDestination(arg: None)¶

class ObservabilityPipelineSentinelOneDestination(arg: ModelComposed)

class ObservabilityPipelineSentinelOneDestination(*args, **kwargs)

Bases: ModelNormal

The sentinel_one destination sends logs to SentinelOne.

Parameters:

id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
region (ObservabilityPipelineSentinelOneDestinationRegion) – The SentinelOne region to send logs to.
type (ObservabilityPipelineSentinelOneDestinationType) – The destination type. The value should always be sentinel_one.

datadog_api_client.v2.model.observability_pipeline_sentinel_one_destination_region module¶

class ObservabilityPipelineSentinelOneDestinationRegion(arg: None)¶

class ObservabilityPipelineSentinelOneDestinationRegion(arg: ModelComposed)

class ObservabilityPipelineSentinelOneDestinationRegion(*args, **kwargs)

Bases: ModelSimple

The SentinelOne region to send logs to.

Parameters:

value (str) – Must be one of [“us”, “eu”, “ca”, “data_set_us”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sentinel_one_destination_type module¶

class ObservabilityPipelineSentinelOneDestinationType(arg: None)¶

class ObservabilityPipelineSentinelOneDestinationType(arg: ModelComposed)

class ObservabilityPipelineSentinelOneDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be sentinel_one.

Parameters:

value (str) – If omitted defaults to “sentinel_one”. Must be one of [“sentinel_one”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_destination module¶

class ObservabilityPipelineSocketDestination(arg: None)¶

class ObservabilityPipelineSocketDestination(arg: ModelComposed)

class ObservabilityPipelineSocketDestination(*args, **kwargs)

Bases: ModelNormal

The socket destination sends logs over TCP or UDP to a remote server.

Parameters:

encoding (ObservabilityPipelineSocketDestinationEncoding) – Encoding format for log events.
framing (ObservabilityPipelineSocketDestinationFraming) – Framing method configuration.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
mode (ObservabilityPipelineSocketDestinationMode) – Protocol used to send logs.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineSocketDestinationType) – The destination type. The value should always be socket.

datadog_api_client.v2.model.observability_pipeline_socket_destination_encoding module¶

class ObservabilityPipelineSocketDestinationEncoding(arg: None)¶

class ObservabilityPipelineSocketDestinationEncoding(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationEncoding(*args, **kwargs)

Bases: ModelSimple

Encoding format for log events.

Parameters:

value (str) – Must be one of [“json”, “raw_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing module¶

class ObservabilityPipelineSocketDestinationFraming(arg: None)¶

class ObservabilityPipelineSocketDestinationFraming(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFraming(*args, **kwargs)

Bases: ModelComposed

Framing method configuration.

Parameters:

method (ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod) – The definition of ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod object.
delimiter (str) – A single ASCII character used as a delimiter.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing_bytes module¶

class ObservabilityPipelineSocketDestinationFramingBytes(arg: None)¶

class ObservabilityPipelineSocketDestinationFramingBytes(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFramingBytes(*args, **kwargs)

Bases: ModelNormal

Event data is not delimited at all.

Parameters:: method (ObservabilityPipelineSocketDestinationFramingBytesMethod) – The definition of ObservabilityPipelineSocketDestinationFramingBytesMethod object.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing_bytes_method module¶

class ObservabilityPipelineSocketDestinationFramingBytesMethod(arg: None)¶

class ObservabilityPipelineSocketDestinationFramingBytesMethod(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFramingBytesMethod(*args, **kwargs)

Bases: ModelSimple

The definition of ObservabilityPipelineSocketDestinationFramingBytesMethod object.

Parameters:

value (str) – If omitted defaults to “bytes”. Must be one of [“bytes”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing_character_delimited module¶

class ObservabilityPipelineSocketDestinationFramingCharacterDelimited(arg: None)¶

class ObservabilityPipelineSocketDestinationFramingCharacterDelimited(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFramingCharacterDelimited(*args, **kwargs)

Bases: ModelNormal

Each log event is separated using the specified delimiter character.

Parameters:

delimiter (str) – A single ASCII character used as a delimiter.
method (ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod) – The definition of ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod object.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing_character_delimited_method module¶

class ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod(arg: None)¶

class ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod(*args, **kwargs)

Bases: ModelSimple

The definition of ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod object.

Parameters:

value (str) – If omitted defaults to “character_delimited”. Must be one of [“character_delimited”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing_newline_delimited module¶

class ObservabilityPipelineSocketDestinationFramingNewlineDelimited(arg: None)¶

class ObservabilityPipelineSocketDestinationFramingNewlineDelimited(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFramingNewlineDelimited(*args, **kwargs)

Bases: ModelNormal

Each log event is delimited by a newline character.

Parameters:: method (ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod) – The definition of ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod object.

datadog_api_client.v2.model.observability_pipeline_socket_destination_framing_newline_delimited_method module¶

class ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod(arg: None)¶

class ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod(*args, **kwargs)

Bases: ModelSimple

The definition of ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod object.

Parameters:

value (str) – If omitted defaults to “newline_delimited”. Must be one of [“newline_delimited”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_destination_mode module¶

class ObservabilityPipelineSocketDestinationMode(arg: None)¶

class ObservabilityPipelineSocketDestinationMode(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationMode(*args, **kwargs)

Bases: ModelSimple

Protocol used to send logs.

Parameters:

value (str) – Must be one of [“tcp”, “udp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_destination_type module¶

class ObservabilityPipelineSocketDestinationType(arg: None)¶

class ObservabilityPipelineSocketDestinationType(arg: ModelComposed)

class ObservabilityPipelineSocketDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be socket.

Parameters:

value (str) – If omitted defaults to “socket”. Must be one of [“socket”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source module¶

class ObservabilityPipelineSocketSource(arg: None)¶

class ObservabilityPipelineSocketSource(arg: ModelComposed)

class ObservabilityPipelineSocketSource(*args, **kwargs)

Bases: ModelNormal

The socket source ingests logs over TCP or UDP.

Parameters:

framing (ObservabilityPipelineSocketSourceFraming) – Framing method configuration for the socket source.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
mode (ObservabilityPipelineSocketSourceMode) – Protocol used to receive logs.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineSocketSourceType) – The source type. The value should always be socket.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing module¶

class ObservabilityPipelineSocketSourceFraming(arg: None)¶

class ObservabilityPipelineSocketSourceFraming(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFraming(*args, **kwargs)

Bases: ModelComposed

Framing method configuration for the socket source.

Parameters:

method (ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod) – Byte frames which are delimited by a newline character.
delimiter (str) – A single ASCII character used to delimit events.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_bytes module¶

class ObservabilityPipelineSocketSourceFramingBytes(arg: None)¶

class ObservabilityPipelineSocketSourceFramingBytes(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingBytes(*args, **kwargs)

Bases: ModelNormal

Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).

Parameters:: method (ObservabilityPipelineSocketSourceFramingBytesMethod) – Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_bytes_method module¶

class ObservabilityPipelineSocketSourceFramingBytesMethod(arg: None)¶

class ObservabilityPipelineSocketSourceFramingBytesMethod(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingBytesMethod(*args, **kwargs)

Bases: ModelSimple

Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).

Parameters:

value (str) – If omitted defaults to “bytes”. Must be one of [“bytes”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_character_delimited module¶

class ObservabilityPipelineSocketSourceFramingCharacterDelimited(arg: None)¶

class ObservabilityPipelineSocketSourceFramingCharacterDelimited(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingCharacterDelimited(*args, **kwargs)

Bases: ModelNormal

Byte frames which are delimited by a chosen character.

Parameters:

delimiter (str) – A single ASCII character used to delimit events.
method (ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod) – Byte frames which are delimited by a chosen character.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_character_delimited_method module¶

class ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod(arg: None)¶

class ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod(*args, **kwargs)

Bases: ModelSimple

Byte frames which are delimited by a chosen character.

Parameters:

value (str) – If omitted defaults to “character_delimited”. Must be one of [“character_delimited”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_chunked_gelf module¶

class ObservabilityPipelineSocketSourceFramingChunkedGelf(arg: None)¶

class ObservabilityPipelineSocketSourceFramingChunkedGelf(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingChunkedGelf(*args, **kwargs)

Bases: ModelNormal

Byte frames which are chunked GELF messages.

Parameters:: method (ObservabilityPipelineSocketSourceFramingChunkedGelfMethod) – Byte frames which are chunked GELF messages.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_chunked_gelf_method module¶

class ObservabilityPipelineSocketSourceFramingChunkedGelfMethod(arg: None)¶

class ObservabilityPipelineSocketSourceFramingChunkedGelfMethod(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingChunkedGelfMethod(*args, **kwargs)

Bases: ModelSimple

Byte frames which are chunked GELF messages.

Parameters:

value (str) – If omitted defaults to “chunked_gelf”. Must be one of [“chunked_gelf”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_newline_delimited module¶

class ObservabilityPipelineSocketSourceFramingNewlineDelimited(arg: None)¶

class ObservabilityPipelineSocketSourceFramingNewlineDelimited(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingNewlineDelimited(*args, **kwargs)

Bases: ModelNormal

Byte frames which are delimited by a newline character.

Parameters:: method (ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod) – Byte frames which are delimited by a newline character.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_newline_delimited_method module¶

class ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod(arg: None)¶

class ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod(*args, **kwargs)

Bases: ModelSimple

Byte frames which are delimited by a newline character.

Parameters:

value (str) – If omitted defaults to “newline_delimited”. Must be one of [“newline_delimited”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_octet_counting module¶

class ObservabilityPipelineSocketSourceFramingOctetCounting(arg: None)¶

class ObservabilityPipelineSocketSourceFramingOctetCounting(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingOctetCounting(*args, **kwargs)

Bases: ModelNormal

Byte frames according to the octet counting format as per RFC6587.

Parameters:: method (ObservabilityPipelineSocketSourceFramingOctetCountingMethod) – Byte frames according to the octet counting format as per RFC6587.

datadog_api_client.v2.model.observability_pipeline_socket_source_framing_octet_counting_method module¶

class ObservabilityPipelineSocketSourceFramingOctetCountingMethod(arg: None)¶

class ObservabilityPipelineSocketSourceFramingOctetCountingMethod(arg: ModelComposed)

class ObservabilityPipelineSocketSourceFramingOctetCountingMethod(*args, **kwargs)

Bases: ModelSimple

Byte frames according to the octet counting format as per RFC6587.

Parameters:

value (str) – If omitted defaults to “octet_counting”. Must be one of [“octet_counting”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source_mode module¶

class ObservabilityPipelineSocketSourceMode(arg: None)¶

class ObservabilityPipelineSocketSourceMode(arg: ModelComposed)

class ObservabilityPipelineSocketSourceMode(*args, **kwargs)

Bases: ModelSimple

Protocol used to receive logs.

Parameters:

value (str) – Must be one of [“tcp”, “udp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_socket_source_type module¶

class ObservabilityPipelineSocketSourceType(arg: None)¶

class ObservabilityPipelineSocketSourceType(arg: ModelComposed)

class ObservabilityPipelineSocketSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be socket.

Parameters:

value (str) – If omitted defaults to “socket”. Must be one of [“socket”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_spec module¶

class ObservabilityPipelineSpec(arg: None)¶

class ObservabilityPipelineSpec(arg: ModelComposed)

class ObservabilityPipelineSpec(*args, **kwargs)

Bases: ModelNormal

Input schema representing an observability pipeline configuration. Used in create and validate requests.

Parameters:: data (ObservabilityPipelineSpecData) – Contains the the pipeline configuration.

datadog_api_client.v2.model.observability_pipeline_spec_data module¶

class ObservabilityPipelineSpecData(arg: None)¶

class ObservabilityPipelineSpecData(arg: ModelComposed)

class ObservabilityPipelineSpecData(*args, **kwargs)

Bases: ModelNormal

Contains the the pipeline configuration.

Parameters:

attributes (ObservabilityPipelineDataAttributes) – Defines the pipeline’s name and its components (sources, processors, and destinations).
type (str) – The resource type identifier. For pipeline resources, this should always be set to pipelines.

datadog_api_client.v2.model.observability_pipeline_splunk_hec_destination module¶

class ObservabilityPipelineSplunkHecDestination(arg: None)¶

class ObservabilityPipelineSplunkHecDestination(arg: ModelComposed)

class ObservabilityPipelineSplunkHecDestination(*args, **kwargs)

Bases: ModelNormal

The splunk_hec destination forwards logs to Splunk using the HTTP Event Collector (HEC).

Parameters:

auto_extract_timestamp (bool, optional) – If true , Splunk tries to extract timestamps from incoming log events. If false , Splunk assigns the time the event was received.
encoding (ObservabilityPipelineSplunkHecDestinationEncoding, optional) – Encoding format for log events.
id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
index (str, optional) – Optional name of the Splunk index where logs are written.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
sourcetype (str, optional) – The Splunk sourcetype to assign to log events.
type (ObservabilityPipelineSplunkHecDestinationType) – The destination type. Always splunk_hec.

datadog_api_client.v2.model.observability_pipeline_splunk_hec_destination_encoding module¶

class ObservabilityPipelineSplunkHecDestinationEncoding(arg: None)¶

class ObservabilityPipelineSplunkHecDestinationEncoding(arg: ModelComposed)

class ObservabilityPipelineSplunkHecDestinationEncoding(*args, **kwargs)

Bases: ModelSimple

Encoding format for log events.

Parameters:

value (str) – Must be one of [“json”, “raw_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_splunk_hec_destination_type module¶

class ObservabilityPipelineSplunkHecDestinationType(arg: None)¶

class ObservabilityPipelineSplunkHecDestinationType(arg: ModelComposed)

class ObservabilityPipelineSplunkHecDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. Always splunk_hec.

Parameters:

value (str) – If omitted defaults to “splunk_hec”. Must be one of [“splunk_hec”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_splunk_hec_source module¶

class ObservabilityPipelineSplunkHecSource(arg: None)¶

class ObservabilityPipelineSplunkHecSource(arg: ModelComposed)

class ObservabilityPipelineSplunkHecSource(*args, **kwargs)

Bases: ModelNormal

The splunk_hec source implements the Splunk HTTP Event Collector (HEC) API.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineSplunkHecSourceType) – The source type. Always splunk_hec.

datadog_api_client.v2.model.observability_pipeline_splunk_hec_source_type module¶

class ObservabilityPipelineSplunkHecSourceType(arg: None)¶

class ObservabilityPipelineSplunkHecSourceType(arg: ModelComposed)

class ObservabilityPipelineSplunkHecSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. Always splunk_hec.

Parameters:

value (str) – If omitted defaults to “splunk_hec”. Must be one of [“splunk_hec”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_splunk_tcp_source module¶

class ObservabilityPipelineSplunkTcpSource(arg: None)¶

class ObservabilityPipelineSplunkTcpSource(arg: ModelComposed)

class ObservabilityPipelineSplunkTcpSource(*args, **kwargs)

Bases: ModelNormal

The splunk_tcp source receives logs from a Splunk Universal Forwarder over TCP. TLS is supported for secure transmission.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineSplunkTcpSourceType) – The source type. Always splunk_tcp.

datadog_api_client.v2.model.observability_pipeline_splunk_tcp_source_type module¶

class ObservabilityPipelineSplunkTcpSourceType(arg: None)¶

class ObservabilityPipelineSplunkTcpSourceType(arg: ModelComposed)

class ObservabilityPipelineSplunkTcpSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. Always splunk_tcp.

Parameters:

value (str) – If omitted defaults to “splunk_tcp”. Must be one of [“splunk_tcp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sumo_logic_destination module¶

class ObservabilityPipelineSumoLogicDestination(arg: None)¶

class ObservabilityPipelineSumoLogicDestination(arg: ModelComposed)

class ObservabilityPipelineSumoLogicDestination(*args, **kwargs)

Bases: ModelNormal

The sumo_logic destination forwards logs to Sumo Logic.

Parameters:

encoding (ObservabilityPipelineSumoLogicDestinationEncoding, optional) – The output encoding format.
header_custom_fields ([ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem], optional) – A list of custom headers to include in the request to Sumo Logic.
header_host_name (str, optional) – Optional override for the host name header.
header_source_category (str, optional) – Optional override for the source category header.
header_source_name (str, optional) – Optional override for the source name header.
id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
type (ObservabilityPipelineSumoLogicDestinationType) – The destination type. The value should always be sumo_logic.

datadog_api_client.v2.model.observability_pipeline_sumo_logic_destination_encoding module¶

class ObservabilityPipelineSumoLogicDestinationEncoding(arg: None)¶

class ObservabilityPipelineSumoLogicDestinationEncoding(arg: ModelComposed)

class ObservabilityPipelineSumoLogicDestinationEncoding(*args, **kwargs)

Bases: ModelSimple

The output encoding format.

Parameters:

value (str) – Must be one of [“json”, “raw_message”, “logfmt”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sumo_logic_destination_header_custom_fields_item module¶

class ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem(arg: None)¶

class ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem(arg: ModelComposed)

class ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem(*args, **kwargs)

Bases: ModelNormal

Single key-value pair used as a custom log header for Sumo Logic.

Parameters:

name (str) – The header field name.
value (str) – The header field value.

datadog_api_client.v2.model.observability_pipeline_sumo_logic_destination_type module¶

class ObservabilityPipelineSumoLogicDestinationType(arg: None)¶

class ObservabilityPipelineSumoLogicDestinationType(arg: ModelComposed)

class ObservabilityPipelineSumoLogicDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be sumo_logic.

Parameters:

value (str) – If omitted defaults to “sumo_logic”. Must be one of [“sumo_logic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_sumo_logic_source module¶

class ObservabilityPipelineSumoLogicSource(arg: None)¶

class ObservabilityPipelineSumoLogicSource(arg: ModelComposed)

class ObservabilityPipelineSumoLogicSource(*args, **kwargs)

Bases: ModelNormal

The sumo_logic source receives logs from Sumo Logic collectors.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
type (ObservabilityPipelineSumoLogicSourceType) – The source type. The value should always be sumo_logic.

datadog_api_client.v2.model.observability_pipeline_sumo_logic_source_type module¶

class ObservabilityPipelineSumoLogicSourceType(arg: None)¶

class ObservabilityPipelineSumoLogicSourceType(arg: ModelComposed)

class ObservabilityPipelineSumoLogicSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be sumo_logic.

Parameters:

value (str) – If omitted defaults to “sumo_logic”. Must be one of [“sumo_logic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_syslog_ng_destination module¶

class ObservabilityPipelineSyslogNgDestination(arg: None)¶

class ObservabilityPipelineSyslogNgDestination(arg: ModelComposed)

class ObservabilityPipelineSyslogNgDestination(*args, **kwargs)

Bases: ModelNormal

The syslog_ng destination forwards logs to an external syslog-ng server over TCP or UDP using the syslog protocol.

Parameters:

id (str) – The unique identifier for this component.
inputs ([str]) – A list of component IDs whose output is used as the input for this component.
keepalive (int, optional) – Optional socket keepalive duration in milliseconds.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineSyslogNgDestinationType) – The destination type. The value should always be syslog_ng.

datadog_api_client.v2.model.observability_pipeline_syslog_ng_destination_type module¶

class ObservabilityPipelineSyslogNgDestinationType(arg: None)¶

class ObservabilityPipelineSyslogNgDestinationType(arg: ModelComposed)

class ObservabilityPipelineSyslogNgDestinationType(*args, **kwargs)

Bases: ModelSimple

The destination type. The value should always be syslog_ng.

Parameters:

value (str) – If omitted defaults to “syslog_ng”. Must be one of [“syslog_ng”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_syslog_ng_source module¶

class ObservabilityPipelineSyslogNgSource(arg: None)¶

class ObservabilityPipelineSyslogNgSource(arg: ModelComposed)

class ObservabilityPipelineSyslogNgSource(*args, **kwargs)

Bases: ModelNormal

The syslog_ng source listens for logs over TCP or UDP from a syslog-ng server using the syslog protocol.

Parameters:

id (str) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
mode (ObservabilityPipelineSyslogSourceMode) – Protocol used by the syslog source to receive messages.
tls (ObservabilityPipelineTls, optional) – Configuration for enabling TLS encryption between the pipeline component and external services.
type (ObservabilityPipelineSyslogNgSourceType) – The source type. The value should always be syslog_ng.

datadog_api_client.v2.model.observability_pipeline_syslog_ng_source_type module¶

class ObservabilityPipelineSyslogNgSourceType(arg: None)¶

class ObservabilityPipelineSyslogNgSourceType(arg: ModelComposed)

class ObservabilityPipelineSyslogNgSourceType(*args, **kwargs)

Bases: ModelSimple

The source type. The value should always be syslog_ng.

Parameters:

value (str) – If omitted defaults to “syslog_ng”. Must be one of [“syslog_ng”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_syslog_source_mode module¶

class ObservabilityPipelineSyslogSourceMode(arg: None)¶

class ObservabilityPipelineSyslogSourceMode(arg: ModelComposed)

class ObservabilityPipelineSyslogSourceMode(*args, **kwargs)

Bases: ModelSimple

Protocol used by the syslog source to receive messages.

Parameters:

value (str) – Must be one of [“tcp”, “udp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_throttle_processor module¶

class ObservabilityPipelineThrottleProcessor(arg: None)¶

class ObservabilityPipelineThrottleProcessor(arg: ModelComposed)

class ObservabilityPipelineThrottleProcessor(*args, **kwargs)

Bases: ModelNormal

The throttle processor limits the number of events that pass through over a given time window.

Parameters:

group_by ([str], optional) – Optional list of fields used to group events before the threshold has been reached.
id (str) – The unique identifier for this processor.
include (str) – A Datadog search query used to determine which logs this processor targets.
inputs ([str]) – A list of component IDs whose output is used as the input for this processor.
threshold (int) – the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.
type (ObservabilityPipelineThrottleProcessorType) – The processor type. The value should always be throttle.
window (float) – The time window in seconds over which the threshold applies.

datadog_api_client.v2.model.observability_pipeline_throttle_processor_type module¶

class ObservabilityPipelineThrottleProcessorType(arg: None)¶

class ObservabilityPipelineThrottleProcessorType(arg: ModelComposed)

class ObservabilityPipelineThrottleProcessorType(*args, **kwargs)

Bases: ModelSimple

The processor type. The value should always be throttle.

Parameters:

value (str) – If omitted defaults to “throttle”. Must be one of [“throttle”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.observability_pipeline_tls module¶

class ObservabilityPipelineTls(arg: None)¶

class ObservabilityPipelineTls(arg: ModelComposed)

class ObservabilityPipelineTls(*args, **kwargs)

Bases: ModelNormal

Configuration for enabling TLS encryption between the pipeline component and external services.

Parameters:

ca_file (str, optional) – Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.
crt_file (str) – Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.
key_file (str, optional) – Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

datadog_api_client.v2.model.okta_account module¶

class OktaAccount(arg: None)¶

class OktaAccount(arg: ModelComposed)

class OktaAccount(*args, **kwargs)

Bases: ModelNormal

Schema for an Okta account.

Parameters:

attributes (OktaAccountAttributes) – Attributes object for an Okta account.
id (str, optional) – The ID of the Okta account, a UUID hash of the account name.
type (OktaAccountType) – Account type for an Okta account.

datadog_api_client.v2.model.okta_account_attributes module¶

class OktaAccountAttributes(arg: None)¶

class OktaAccountAttributes(arg: ModelComposed)

class OktaAccountAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for an Okta account.

Parameters:

api_key (str, optional) – The API key of the Okta account.
auth_method (str) – The authorization method for an Okta account.
client_id (str, optional) – The Client ID of an Okta app integration.
client_secret (str, optional) – The client secret of an Okta app integration.
domain (str) – The domain of the Okta account.
name (str) – The name of the Okta account.

datadog_api_client.v2.model.okta_account_request module¶

class OktaAccountRequest(arg: None)¶

class OktaAccountRequest(arg: ModelComposed)

class OktaAccountRequest(*args, **kwargs)

Bases: ModelNormal

Request object for an Okta account.

Parameters:: data (OktaAccount) – Schema for an Okta account.

datadog_api_client.v2.model.okta_account_response module¶

class OktaAccountResponse(arg: None)¶

class OktaAccountResponse(arg: ModelComposed)

class OktaAccountResponse(*args, **kwargs)

Bases: ModelNormal

Response object for an Okta account.

Parameters:: data (OktaAccount, optional) – Schema for an Okta account.

datadog_api_client.v2.model.okta_account_response_data module¶

class OktaAccountResponseData(arg: None)¶

class OktaAccountResponseData(arg: ModelComposed)

class OktaAccountResponseData(*args, **kwargs)

Bases: ModelNormal

Data object of an Okta account

Parameters:

attributes (OktaAccountAttributes) – Attributes object for an Okta account.
id (str) – The ID of the Okta account, a UUID hash of the account name.
type (OktaAccountType) – Account type for an Okta account.

datadog_api_client.v2.model.okta_account_type module¶

class OktaAccountType(arg: None)¶

class OktaAccountType(arg: ModelComposed)

class OktaAccountType(*args, **kwargs)

Bases: ModelSimple

Account type for an Okta account.

Parameters:

value (str) – If omitted defaults to “okta-accounts”. Must be one of [“okta-accounts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.okta_account_update_request module¶

class OktaAccountUpdateRequest(arg: None)¶

class OktaAccountUpdateRequest(arg: ModelComposed)

class OktaAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when updating an Okta account.

Parameters:: data (OktaAccountUpdateRequestData) – Data object for updating an Okta account.

datadog_api_client.v2.model.okta_account_update_request_attributes module¶

class OktaAccountUpdateRequestAttributes(arg: None)¶

class OktaAccountUpdateRequestAttributes(arg: ModelComposed)

class OktaAccountUpdateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for updating an Okta account.

Parameters:

api_key (str, optional) – The API key of the Okta account.
auth_method (str) – The authorization method for an Okta account.
client_id (str, optional) – The Client ID of an Okta app integration.
client_secret (str, optional) – The client secret of an Okta app integration.
domain (str) – The domain associated with an Okta account.

datadog_api_client.v2.model.okta_account_update_request_data module¶

class OktaAccountUpdateRequestData(arg: None)¶

class OktaAccountUpdateRequestData(arg: ModelComposed)

class OktaAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating an Okta account.

Parameters:

attributes (OktaAccountUpdateRequestAttributes, optional) – Attributes object for updating an Okta account.
type (OktaAccountType, optional) – Account type for an Okta account.

datadog_api_client.v2.model.okta_accounts_response module¶

class OktaAccountsResponse(arg: None)¶

class OktaAccountsResponse(arg: ModelComposed)

class OktaAccountsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Okta accounts.

Parameters:: data ([OktaAccountResponseData], optional) – List of Okta accounts.

datadog_api_client.v2.model.okta_api_token module¶

class OktaAPIToken(arg: None)¶

class OktaAPIToken(arg: ModelComposed)

class OktaAPIToken(*args, **kwargs)

Bases: ModelNormal

The definition of the OktaAPIToken object.

Parameters:

api_token (str) – The OktaAPIToken api_token.
domain (str) – The OktaAPIToken domain.
type (OktaAPITokenType) – The definition of the OktaAPIToken object.

datadog_api_client.v2.model.okta_api_token_type module¶

class OktaAPITokenType(arg: None)¶

class OktaAPITokenType(arg: ModelComposed)

class OktaAPITokenType(*args, **kwargs)

Bases: ModelSimple

The definition of the OktaAPIToken object.

Parameters:

value (str) – If omitted defaults to “OktaAPIToken”. Must be one of [“OktaAPIToken”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.okta_api_token_update module¶

class OktaAPITokenUpdate(arg: None)¶

class OktaAPITokenUpdate(arg: ModelComposed)

class OktaAPITokenUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the OktaAPIToken object.

Parameters:

api_token (str, optional) – The OktaAPITokenUpdate api_token.
domain (str, optional) – The OktaAPITokenUpdate domain.
type (OktaAPITokenType) – The definition of the OktaAPIToken object.

datadog_api_client.v2.model.okta_credentials module¶

class OktaCredentials(arg: None)¶

class OktaCredentials(arg: ModelComposed)

class OktaCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the OktaCredentials object.

Parameters:

api_token (str) – The OktaAPIToken api_token.
domain (str) – The OktaAPIToken domain.
type (OktaAPITokenType) – The definition of the OktaAPIToken object.

datadog_api_client.v2.model.okta_credentials_update module¶

class OktaCredentialsUpdate(arg: None)¶

class OktaCredentialsUpdate(arg: ModelComposed)

class OktaCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the OktaCredentialsUpdate object.

Parameters:

api_token (str, optional) – The OktaAPITokenUpdate api_token.
domain (str, optional) – The OktaAPITokenUpdate domain.
type (OktaAPITokenType) – The definition of the OktaAPIToken object.

datadog_api_client.v2.model.okta_integration module¶

class OktaIntegration(arg: None)¶

class OktaIntegration(arg: ModelComposed)

class OktaIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the OktaIntegration object.

Parameters:

credentials (OktaCredentials) – The definition of the OktaCredentials object.
type (OktaIntegrationType) – The definition of the OktaIntegrationType object.

datadog_api_client.v2.model.okta_integration_type module¶

class OktaIntegrationType(arg: None)¶

class OktaIntegrationType(arg: ModelComposed)

class OktaIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the OktaIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Okta”. Must be one of [“Okta”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.okta_integration_update module¶

class OktaIntegrationUpdate(arg: None)¶

class OktaIntegrationUpdate(arg: ModelComposed)

class OktaIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the OktaIntegrationUpdate object.

Parameters:

credentials (OktaCredentialsUpdate, optional) – The definition of the OktaCredentialsUpdate object.
type (OktaIntegrationType) – The definition of the OktaIntegrationType object.

datadog_api_client.v2.model.on_call_page_target_type module¶

class OnCallPageTargetType(arg: None)¶

class OnCallPageTargetType(arg: ModelComposed)

class OnCallPageTargetType(*args, **kwargs)

Bases: ModelSimple

The kind of target, team_id | team_handle | user_id.

Parameters:

value (str) – Must be one of [“team_id”, “team_handle”, “user_id”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.on_demand_concurrency_cap module¶

class OnDemandConcurrencyCap(arg: None)¶

class OnDemandConcurrencyCap(arg: ModelComposed)

class OnDemandConcurrencyCap(*args, **kwargs)

Bases: ModelNormal

On-demand concurrency cap.

Parameters:

attributes (OnDemandConcurrencyCapAttributes, optional) – On-demand concurrency cap attributes.
type (OnDemandConcurrencyCapType, optional) – On-demand concurrency cap type.

datadog_api_client.v2.model.on_demand_concurrency_cap_attributes module¶

class OnDemandConcurrencyCapAttributes(arg: None)¶

class OnDemandConcurrencyCapAttributes(arg: ModelComposed)

class OnDemandConcurrencyCapAttributes(*args, **kwargs)

Bases: ModelNormal

On-demand concurrency cap attributes.

Parameters:: on_demand_concurrency_cap (float, optional) – Value of the on-demand concurrency cap.

datadog_api_client.v2.model.on_demand_concurrency_cap_response module¶

class OnDemandConcurrencyCapResponse(arg: None)¶

class OnDemandConcurrencyCapResponse(arg: ModelComposed)

class OnDemandConcurrencyCapResponse(*args, **kwargs)

Bases: ModelNormal

On-demand concurrency cap response.

Parameters:: data (OnDemandConcurrencyCap, optional) – On-demand concurrency cap.

datadog_api_client.v2.model.on_demand_concurrency_cap_type module¶

class OnDemandConcurrencyCapType(arg: None)¶

class OnDemandConcurrencyCapType(arg: ModelComposed)

class OnDemandConcurrencyCapType(*args, **kwargs)

Bases: ModelSimple

On-demand concurrency cap type.

Parameters:

value (str) – If omitted defaults to “on_demand_concurrency_cap”. Must be one of [“on_demand_concurrency_cap”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.open_ai_credentials module¶

class OpenAICredentials(arg: None)¶

class OpenAICredentials(arg: ModelComposed)

class OpenAICredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the OpenAICredentials object.

Parameters:

api_token (str) – The OpenAIAPIKey api_token.
type (OpenAIAPIKeyType) – The definition of the OpenAIAPIKey object.

datadog_api_client.v2.model.open_ai_credentials_update module¶

class OpenAICredentialsUpdate(arg: None)¶

class OpenAICredentialsUpdate(arg: ModelComposed)

class OpenAICredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the OpenAICredentialsUpdate object.

Parameters:

api_token (str, optional) – The OpenAIAPIKeyUpdate api_token.
type (OpenAIAPIKeyType) – The definition of the OpenAIAPIKey object.

datadog_api_client.v2.model.open_ai_integration module¶

class OpenAIIntegration(arg: None)¶

class OpenAIIntegration(arg: ModelComposed)

class OpenAIIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the OpenAIIntegration object.

Parameters:

credentials (OpenAICredentials) – The definition of the OpenAICredentials object.
type (OpenAIIntegrationType) – The definition of the OpenAIIntegrationType object.

datadog_api_client.v2.model.open_ai_integration_type module¶

class OpenAIIntegrationType(arg: None)¶

class OpenAIIntegrationType(arg: ModelComposed)

class OpenAIIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the OpenAIIntegrationType object.

Parameters:

value (str) – If omitted defaults to “OpenAI”. Must be one of [“OpenAI”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.open_ai_integration_update module¶

class OpenAIIntegrationUpdate(arg: None)¶

class OpenAIIntegrationUpdate(arg: ModelComposed)

class OpenAIIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the OpenAIIntegrationUpdate object.

Parameters:

credentials (OpenAICredentialsUpdate, optional) – The definition of the OpenAICredentialsUpdate object.
type (OpenAIIntegrationType) – The definition of the OpenAIIntegrationType object.

datadog_api_client.v2.model.open_aiapi_key module¶

class OpenAIAPIKey(arg: None)¶

class OpenAIAPIKey(arg: ModelComposed)

class OpenAIAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the OpenAIAPIKey object.

Parameters:

api_token (str) – The OpenAIAPIKey api_token.
type (OpenAIAPIKeyType) – The definition of the OpenAIAPIKey object.

datadog_api_client.v2.model.open_aiapi_key_type module¶

class OpenAIAPIKeyType(arg: None)¶

class OpenAIAPIKeyType(arg: ModelComposed)

class OpenAIAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the OpenAIAPIKey object.

Parameters:

value (str) – If omitted defaults to “OpenAIAPIKey”. Must be one of [“OpenAIAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.open_aiapi_key_update module¶

class OpenAIAPIKeyUpdate(arg: None)¶

class OpenAIAPIKeyUpdate(arg: ModelComposed)

class OpenAIAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the OpenAIAPIKey object.

Parameters:

api_token (str, optional) – The OpenAIAPIKeyUpdate api_token.
type (OpenAIAPIKeyType) – The definition of the OpenAIAPIKey object.

datadog_api_client.v2.model.open_api_endpoint module¶

class OpenAPIEndpoint(arg: None)¶

class OpenAPIEndpoint(arg: ModelComposed)

class OpenAPIEndpoint(*args, **kwargs)

Bases: ModelNormal

Endpoint info extracted from an OpenAPI specification.

Parameters:

method (str, optional) – The endpoint method.
path (str, optional) – The endpoint path.

datadog_api_client.v2.model.open_api_file module¶

class OpenAPIFile(arg: None)¶

class OpenAPIFile(arg: ModelComposed)

class OpenAPIFile(*args, **kwargs)

Bases: ModelNormal

Object for API data in an OpenAPI format as a file.

Parameters:: openapi_spec_file (file_type, optional) – Binary OpenAPI spec file

datadog_api_client.v2.model.opsgenie_service_create_attributes module¶

class OpsgenieServiceCreateAttributes(arg: None)¶

class OpsgenieServiceCreateAttributes(arg: ModelComposed)

class OpsgenieServiceCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The Opsgenie service attributes for a create request.

Parameters:

custom_url (str, optional) – The custom URL for a custom region.
name (str) – The name for the Opsgenie service.
opsgenie_api_key (str) – The Opsgenie API key for your Opsgenie service.
region (OpsgenieServiceRegionType) – The region for the Opsgenie service.

datadog_api_client.v2.model.opsgenie_service_create_data module¶

class OpsgenieServiceCreateData(arg: None)¶

class OpsgenieServiceCreateData(arg: ModelComposed)

class OpsgenieServiceCreateData(*args, **kwargs)

Bases: ModelNormal

Opsgenie service data for a create request.

Parameters:

attributes (OpsgenieServiceCreateAttributes) – The Opsgenie service attributes for a create request.
type (OpsgenieServiceType) – Opsgenie service resource type.

datadog_api_client.v2.model.opsgenie_service_create_request module¶

class OpsgenieServiceCreateRequest(arg: None)¶

class OpsgenieServiceCreateRequest(arg: ModelComposed)

class OpsgenieServiceCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an Opsgenie service.

Parameters:: data (OpsgenieServiceCreateData) – Opsgenie service data for a create request.

datadog_api_client.v2.model.opsgenie_service_region_type module¶

class OpsgenieServiceRegionType(arg: None)¶

class OpsgenieServiceRegionType(arg: ModelComposed)

class OpsgenieServiceRegionType(*args, **kwargs)

Bases: ModelSimple

The region for the Opsgenie service.

Parameters:

value (str) – Must be one of [“us”, “eu”, “custom”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.opsgenie_service_response module¶

class OpsgenieServiceResponse(arg: None)¶

class OpsgenieServiceResponse(arg: ModelComposed)

class OpsgenieServiceResponse(*args, **kwargs)

Bases: ModelNormal

Response of an Opsgenie service.

Parameters:: data (OpsgenieServiceResponseData) – Opsgenie service data from a response.

datadog_api_client.v2.model.opsgenie_service_response_attributes module¶

class OpsgenieServiceResponseAttributes(arg: None)¶

class OpsgenieServiceResponseAttributes(arg: ModelComposed)

class OpsgenieServiceResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes from an Opsgenie service response.

Parameters:

custom_url (str, none_type, optional) – The custom URL for a custom region.
name (str, optional) – The name for the Opsgenie service.
region (OpsgenieServiceRegionType, optional) – The region for the Opsgenie service.

datadog_api_client.v2.model.opsgenie_service_response_data module¶

class OpsgenieServiceResponseData(arg: None)¶

class OpsgenieServiceResponseData(arg: ModelComposed)

class OpsgenieServiceResponseData(*args, **kwargs)

Bases: ModelNormal

Opsgenie service data from a response.

Parameters:

attributes (OpsgenieServiceResponseAttributes) – The attributes from an Opsgenie service response.
id (str) – The ID of the Opsgenie service.
type (OpsgenieServiceType) – Opsgenie service resource type.

datadog_api_client.v2.model.opsgenie_service_type module¶

class OpsgenieServiceType(arg: None)¶

class OpsgenieServiceType(arg: ModelComposed)

class OpsgenieServiceType(*args, **kwargs)

Bases: ModelSimple

Opsgenie service resource type.

Parameters:

value (str) – If omitted defaults to “opsgenie-service”. Must be one of [“opsgenie-service”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.opsgenie_service_update_attributes module¶

class OpsgenieServiceUpdateAttributes(arg: None)¶

class OpsgenieServiceUpdateAttributes(arg: ModelComposed)

class OpsgenieServiceUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The Opsgenie service attributes for an update request.

Parameters:

custom_url (str, none_type, optional) – The custom URL for a custom region.
name (str, optional) – The name for the Opsgenie service.
opsgenie_api_key (str, optional) – The Opsgenie API key for your Opsgenie service.
region (OpsgenieServiceRegionType, optional) – The region for the Opsgenie service.

datadog_api_client.v2.model.opsgenie_service_update_data module¶

class OpsgenieServiceUpdateData(arg: None)¶

class OpsgenieServiceUpdateData(arg: ModelComposed)

class OpsgenieServiceUpdateData(*args, **kwargs)

Bases: ModelNormal

Opsgenie service for an update request.

Parameters:

attributes (OpsgenieServiceUpdateAttributes) – The Opsgenie service attributes for an update request.
id (str) – The ID of the Opsgenie service.
type (OpsgenieServiceType) – Opsgenie service resource type.

datadog_api_client.v2.model.opsgenie_service_update_request module¶

class OpsgenieServiceUpdateRequest(arg: None)¶

class OpsgenieServiceUpdateRequest(arg: ModelComposed)

class OpsgenieServiceUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for an Opsgenie service.

Parameters:: data (OpsgenieServiceUpdateData) – Opsgenie service for an update request.

datadog_api_client.v2.model.opsgenie_services_response module¶

class OpsgenieServicesResponse(arg: None)¶

class OpsgenieServicesResponse(arg: ModelComposed)

class OpsgenieServicesResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of Opsgenie services.

Parameters:: data ([OpsgenieServiceResponseData]) – An array of Opsgenie services.

datadog_api_client.v2.model.order_direction module¶

class OrderDirection(arg: None)¶

class OrderDirection(arg: ModelComposed)

class OrderDirection(*args, **kwargs)

Bases: ModelSimple

The sort direction for results.

Parameters:

value (str) – Must be one of [“asc”, “desc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.org_config_get_response module¶

class OrgConfigGetResponse(arg: None)¶

class OrgConfigGetResponse(arg: ModelComposed)

class OrgConfigGetResponse(*args, **kwargs)

Bases: ModelNormal

A response with a single Org Config.

Parameters:: data (OrgConfigRead) – A single Org Config.

datadog_api_client.v2.model.org_config_list_response module¶

class OrgConfigListResponse(arg: None)¶

class OrgConfigListResponse(arg: ModelComposed)

class OrgConfigListResponse(*args, **kwargs)

Bases: ModelNormal

A response with multiple Org Configs.

Parameters:: data ([OrgConfigRead]) – An array of Org Configs.

datadog_api_client.v2.model.org_config_read module¶

class OrgConfigRead(arg: None)¶

class OrgConfigRead(arg: ModelComposed)

class OrgConfigRead(*args, **kwargs)

Bases: ModelNormal

A single Org Config.

Parameters:

attributes (OrgConfigReadAttributes) – Readable attributes of an Org Config.
id (str) – A unique identifier for an Org Config.
type (OrgConfigType) – Data type of an Org Config.

datadog_api_client.v2.model.org_config_read_attributes module¶

class OrgConfigReadAttributes(arg: None)¶

class OrgConfigReadAttributes(arg: ModelComposed)

class OrgConfigReadAttributes(*args, **kwargs)

Bases: ModelNormal

Readable attributes of an Org Config.

Parameters:

description (str) – The description of an Org Config.
modified_at (datetime, none_type, optional) – The timestamp of the last Org Config update (if any).
name (str) – The machine-friendly name of an Org Config.
value (bool, date, datetime, dict, float, int, list, str, UUID, none_type) – The value of an Org Config.
value_type (str) – The type of an Org Config value.

datadog_api_client.v2.model.org_config_type module¶

class OrgConfigType(arg: None)¶

class OrgConfigType(arg: ModelComposed)

class OrgConfigType(*args, **kwargs)

Bases: ModelSimple

Data type of an Org Config.

Parameters:

value (str) – If omitted defaults to “org_configs”. Must be one of [“org_configs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.org_config_write module¶

class OrgConfigWrite(arg: None)¶

class OrgConfigWrite(arg: ModelComposed)

class OrgConfigWrite(*args, **kwargs)

Bases: ModelNormal

An Org Config write operation.

Parameters:

attributes (OrgConfigWriteAttributes) – Writable attributes of an Org Config.
type (OrgConfigType) – Data type of an Org Config.

datadog_api_client.v2.model.org_config_write_attributes module¶

class OrgConfigWriteAttributes(arg: None)¶

class OrgConfigWriteAttributes(arg: ModelComposed)

class OrgConfigWriteAttributes(*args, **kwargs)

Bases: ModelNormal

Writable attributes of an Org Config.

Parameters:: value (bool, date, datetime, dict, float, int, list, str, UUID, none_type) – The value of an Org Config.

datadog_api_client.v2.model.org_config_write_request module¶

class OrgConfigWriteRequest(arg: None)¶

class OrgConfigWriteRequest(arg: ModelComposed)

class OrgConfigWriteRequest(*args, **kwargs)

Bases: ModelNormal

A request to update an Org Config.

Parameters:: data (OrgConfigWrite) – An Org Config write operation.

datadog_api_client.v2.model.org_connection module¶

class OrgConnection(arg: None)¶

class OrgConnection(arg: ModelComposed)

class OrgConnection(*args, **kwargs)

Bases: ModelNormal

An org connection.

Parameters:

attributes (OrgConnectionAttributes) – Org connection attributes.
id (UUID) – The unique identifier of the org connection.
relationships (OrgConnectionRelationships) – Related organizations and user.
type (OrgConnectionType) – Org connection type.

datadog_api_client.v2.model.org_connection_attributes module¶

class OrgConnectionAttributes(arg: None)¶

class OrgConnectionAttributes(arg: ModelComposed)

class OrgConnectionAttributes(*args, **kwargs)

Bases: ModelNormal

Org connection attributes.

Parameters:

connection_types ([OrgConnectionTypeEnum]) – List of connection types.
created_at (datetime) – Timestamp when the connection was created.

datadog_api_client.v2.model.org_connection_create module¶

class OrgConnectionCreate(arg: None)¶

class OrgConnectionCreate(arg: ModelComposed)

class OrgConnectionCreate(*args, **kwargs)

Bases: ModelNormal

Org connection creation data.

Parameters:

attributes (OrgConnectionCreateAttributes) – Attributes for creating an org connection.
relationships (OrgConnectionCreateRelationships) – Relationships for org connection creation.
type (OrgConnectionType) – Org connection type.

datadog_api_client.v2.model.org_connection_create_attributes module¶

class OrgConnectionCreateAttributes(arg: None)¶

class OrgConnectionCreateAttributes(arg: ModelComposed)

class OrgConnectionCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for creating an org connection.

Parameters:: connection_types ([OrgConnectionTypeEnum]) – List of connection types to establish.

datadog_api_client.v2.model.org_connection_create_relationships module¶

class OrgConnectionCreateRelationships(arg: None)¶

class OrgConnectionCreateRelationships(arg: ModelComposed)

class OrgConnectionCreateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships for org connection creation.

Parameters:: sink_org (OrgConnectionOrgRelationship) – Org relationship.

datadog_api_client.v2.model.org_connection_create_request module¶

class OrgConnectionCreateRequest(arg: None)¶

class OrgConnectionCreateRequest(arg: ModelComposed)

class OrgConnectionCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request to create an org connection.

Parameters:: data (OrgConnectionCreate) – Org connection creation data.

datadog_api_client.v2.model.org_connection_list_response module¶

class OrgConnectionListResponse(arg: None)¶

class OrgConnectionListResponse(arg: ModelComposed)

class OrgConnectionListResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of org connections.

Parameters:

data ([OrgConnection]) – List of org connections.
meta (OrgConnectionListResponseMeta, optional) – Pagination metadata.

datadog_api_client.v2.model.org_connection_list_response_meta module¶

class OrgConnectionListResponseMeta(arg: None)¶

class OrgConnectionListResponseMeta(arg: ModelComposed)

class OrgConnectionListResponseMeta(*args, **kwargs)

Bases: ModelNormal

Pagination metadata.

Parameters:: page (OrgConnectionListResponseMetaPage, optional) – Page information.

datadog_api_client.v2.model.org_connection_list_response_meta_page module¶

class OrgConnectionListResponseMetaPage(arg: None)¶

class OrgConnectionListResponseMetaPage(arg: ModelComposed)

class OrgConnectionListResponseMetaPage(*args, **kwargs)

Bases: ModelNormal

Page information.

Parameters:

total_count (int, optional) – Total number of org connections.
total_filtered_count (int, optional) – Total number of org connections matching the filter.

datadog_api_client.v2.model.org_connection_org_relationship module¶

class OrgConnectionOrgRelationship(arg: None)¶

class OrgConnectionOrgRelationship(arg: ModelComposed)

class OrgConnectionOrgRelationship(*args, **kwargs)

Bases: ModelNormal

Org relationship.

Parameters:: data (OrgConnectionOrgRelationshipData, optional) – The definition of OrgConnectionOrgRelationshipData object.

datadog_api_client.v2.model.org_connection_org_relationship_data module¶

class OrgConnectionOrgRelationshipData(arg: None)¶

class OrgConnectionOrgRelationshipData(arg: ModelComposed)

class OrgConnectionOrgRelationshipData(*args, **kwargs)

Bases: ModelNormal

The definition of OrgConnectionOrgRelationshipData object.

Parameters:

id (str, optional) – Org UUID.
name (str, optional) – Org name.
type (OrgConnectionOrgRelationshipDataType, optional) – The type of the organization relationship.

datadog_api_client.v2.model.org_connection_org_relationship_data_type module¶

class OrgConnectionOrgRelationshipDataType(arg: None)¶

class OrgConnectionOrgRelationshipDataType(arg: ModelComposed)

class OrgConnectionOrgRelationshipDataType(*args, **kwargs)

Bases: ModelSimple

The type of the organization relationship.

Parameters:

value (str) – If omitted defaults to “orgs”. Must be one of [“orgs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.org_connection_relationships module¶

class OrgConnectionRelationships(arg: None)¶

class OrgConnectionRelationships(arg: ModelComposed)

class OrgConnectionRelationships(*args, **kwargs)

Bases: ModelNormal

Related organizations and user.

Parameters:

created_by (OrgConnectionUserRelationship, optional) – User relationship.
sink_org (OrgConnectionOrgRelationship, optional) – Org relationship.
source_org (OrgConnectionOrgRelationship, optional) – Org relationship.

datadog_api_client.v2.model.org_connection_response module¶

class OrgConnectionResponse(arg: None)¶

class OrgConnectionResponse(arg: ModelComposed)

class OrgConnectionResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a single org connection.

Parameters:: data (OrgConnection) – An org connection.

datadog_api_client.v2.model.org_connection_type module¶

class OrgConnectionType(arg: None)¶

class OrgConnectionType(arg: ModelComposed)

class OrgConnectionType(*args, **kwargs)

Bases: ModelSimple

Org connection type.

Parameters:

value (str) – If omitted defaults to “org_connection”. Must be one of [“org_connection”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.org_connection_type_enum module¶

class OrgConnectionTypeEnum(arg: None)¶

class OrgConnectionTypeEnum(arg: ModelComposed)

class OrgConnectionTypeEnum(*args, **kwargs)

Bases: ModelSimple

Available connection types between organizations.

Parameters:

value (str) – Must be one of [“logs”, “metrics”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.org_connection_update module¶

class OrgConnectionUpdate(arg: None)¶

class OrgConnectionUpdate(arg: ModelComposed)

class OrgConnectionUpdate(*args, **kwargs)

Bases: ModelNormal

Org connection update data.

Parameters:

attributes (OrgConnectionUpdateAttributes) – Attributes for updating an org connection.
id (UUID) – The unique identifier of the org connection.
type (OrgConnectionType) – Org connection type.

datadog_api_client.v2.model.org_connection_update_attributes module¶

class OrgConnectionUpdateAttributes(arg: None)¶

class OrgConnectionUpdateAttributes(arg: ModelComposed)

class OrgConnectionUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for updating an org connection.

Parameters:: connection_types ([OrgConnectionTypeEnum]) – Updated list of connection types.

datadog_api_client.v2.model.org_connection_update_request module¶

class OrgConnectionUpdateRequest(arg: None)¶

class OrgConnectionUpdateRequest(arg: ModelComposed)

class OrgConnectionUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request to update an org connection.

Parameters:: data (OrgConnectionUpdate) – Org connection update data.

datadog_api_client.v2.model.org_connection_user_relationship module¶

class OrgConnectionUserRelationship(arg: None)¶

class OrgConnectionUserRelationship(arg: ModelComposed)

class OrgConnectionUserRelationship(*args, **kwargs)

Bases: ModelNormal

User relationship.

Parameters:: data (OrgConnectionUserRelationshipData, optional) – The data for a user relationship.

datadog_api_client.v2.model.org_connection_user_relationship_data module¶

class OrgConnectionUserRelationshipData(arg: None)¶

class OrgConnectionUserRelationshipData(arg: ModelComposed)

class OrgConnectionUserRelationshipData(*args, **kwargs)

Bases: ModelNormal

The data for a user relationship.

Parameters:

id (str, optional) – User UUID.
name (str, optional) – User name.
type (OrgConnectionUserRelationshipDataType, optional) – The type of the user relationship.

datadog_api_client.v2.model.org_connection_user_relationship_data_type module¶

class OrgConnectionUserRelationshipDataType(arg: None)¶

class OrgConnectionUserRelationshipDataType(arg: ModelComposed)

class OrgConnectionUserRelationshipDataType(*args, **kwargs)

Bases: ModelSimple

The type of the user relationship.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.organization module¶

class Organization(arg: None)¶

class Organization(arg: ModelComposed)

class Organization(*args, **kwargs)

Bases: ModelNormal

Organization object.

Parameters:

attributes (OrganizationAttributes, optional) – Attributes of the organization.
id (str, optional) – ID of the organization.
type (OrganizationsType) – Organizations resource type.

datadog_api_client.v2.model.organization_attributes module¶

class OrganizationAttributes(arg: None)¶

class OrganizationAttributes(arg: ModelComposed)

class OrganizationAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the organization.

Parameters:

created_at (datetime, optional) – Creation time of the organization.
description (str, optional) – Description of the organization.
disabled (bool, optional) – Whether or not the organization is disabled.
modified_at (datetime, optional) – Time of last organization modification.
name (str, optional) – Name of the organization.
public_id (str, optional) – Public ID of the organization.
sharing (str, optional) – Sharing type of the organization.
url (str, optional) – URL of the site that this organization exists at.

datadog_api_client.v2.model.organizations_type module¶

class OrganizationsType(arg: None)¶

class OrganizationsType(arg: ModelComposed)

class OrganizationsType(*args, **kwargs)

Bases: ModelSimple

Organizations resource type.

Parameters:

value (str) – If omitted defaults to “orgs”. Must be one of [“orgs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.outbound_edge module¶

class OutboundEdge(arg: None)¶

class OutboundEdge(arg: ModelComposed)

class OutboundEdge(*args, **kwargs)

Bases: ModelNormal

The definition of OutboundEdge object.

Parameters:

branch_name (str) – The OutboundEdge branchName.
next_step_name (str) – The OutboundEdge nextStepName.

datadog_api_client.v2.model.outcome_type module¶

class OutcomeType(arg: None)¶

class OutcomeType(arg: ModelComposed)

class OutcomeType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for an outcome.

Parameters:

value (str) – If omitted defaults to “outcome”. Must be one of [“outcome”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.outcomes_batch_attributes module¶

class OutcomesBatchAttributes(arg: None)¶

class OutcomesBatchAttributes(arg: ModelComposed)

class OutcomesBatchAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes for a batched set of scorecard outcomes.

Parameters:: results ([OutcomesBatchRequestItem], optional) – Set of scorecard outcomes to update.

datadog_api_client.v2.model.outcomes_batch_request module¶

class OutcomesBatchRequest(arg: None)¶

class OutcomesBatchRequest(arg: ModelComposed)

class OutcomesBatchRequest(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request.

Parameters:: data (OutcomesBatchRequestData, optional) – Scorecard outcomes batch request data.

datadog_api_client.v2.model.outcomes_batch_request_data module¶

class OutcomesBatchRequestData(arg: None)¶

class OutcomesBatchRequestData(arg: ModelComposed)

class OutcomesBatchRequestData(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request data.

Parameters:

attributes (OutcomesBatchAttributes, optional) – The JSON:API attributes for a batched set of scorecard outcomes.
type (OutcomesBatchType, optional) – The JSON:API type for scorecard outcomes.

datadog_api_client.v2.model.outcomes_batch_request_item module¶

class OutcomesBatchRequestItem(arg: None)¶

class OutcomesBatchRequestItem(arg: ModelComposed)

class OutcomesBatchRequestItem(*args, **kwargs)

Bases: ModelNormal

Scorecard outcome for a specific rule, for a given service within a batched update.

Parameters:

remarks (str, optional) – Any remarks regarding the scorecard rule’s evaluation, and supports HTML hyperlinks.
rule_id (str) – The unique ID for a scorecard rule.
service_name (str) – The unique name for a service in the catalog.
state (State) – The state of the rule evaluation.

datadog_api_client.v2.model.outcomes_batch_response module¶

class OutcomesBatchResponse(arg: None)¶

class OutcomesBatchResponse(arg: ModelComposed)

class OutcomesBatchResponse(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch response.

Parameters:

data ([OutcomesResponseDataItem]) – List of rule outcomes which were affected during the bulk operation.
meta (OutcomesBatchResponseMeta) – Metadata pertaining to the bulk operation.

datadog_api_client.v2.model.outcomes_batch_response_attributes module¶

class OutcomesBatchResponseAttributes(arg: None)¶

class OutcomesBatchResponseAttributes(arg: ModelComposed)

class OutcomesBatchResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes for an outcome.

Parameters:

created_at (datetime, optional) – Creation time of the rule outcome.
modified_at (datetime, optional) – Time of last rule outcome modification.
remarks (str, optional) – Any remarks regarding the scorecard rule’s evaluation, and supports HTML hyperlinks.
service_name (str, optional) – The unique name for a service in the catalog.
state (State, optional) – The state of the rule evaluation.

datadog_api_client.v2.model.outcomes_batch_response_meta module¶

class OutcomesBatchResponseMeta(arg: None)¶

class OutcomesBatchResponseMeta(arg: ModelComposed)

class OutcomesBatchResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata pertaining to the bulk operation.

Parameters:

total_received (int, optional) – Total number of scorecard results received during the bulk operation.
total_updated (int, optional) – Total number of scorecard results modified during the bulk operation.

datadog_api_client.v2.model.outcomes_batch_type module¶

class OutcomesBatchType(arg: None)¶

class OutcomesBatchType(arg: ModelComposed)

class OutcomesBatchType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for scorecard outcomes.

Parameters:

value (str) – If omitted defaults to “batched-outcome”. Must be one of [“batched-outcome”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.outcomes_response module¶

class OutcomesResponse(arg: None)¶

class OutcomesResponse(arg: ModelComposed)

class OutcomesResponse(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes - the result of a rule for a service.

Parameters:

data ([OutcomesResponseDataItem], optional) – List of rule outcomes.
included ([OutcomesResponseIncludedItem], optional) – Array of rule details.
links (OutcomesResponseLinks, optional) – Links attributes.

datadog_api_client.v2.model.outcomes_response_data_item module¶

class OutcomesResponseDataItem(arg: None)¶

class OutcomesResponseDataItem(arg: ModelComposed)

class OutcomesResponseDataItem(*args, **kwargs)

Bases: ModelNormal

A single rule outcome.

Parameters:

attributes (OutcomesBatchResponseAttributes, optional) – The JSON:API attributes for an outcome.
id (str, optional) – The unique ID for a rule outcome.
relationships (RuleOutcomeRelationships, optional) – The JSON:API relationship to a scorecard rule.
type (OutcomeType, optional) – The JSON:API type for an outcome.

datadog_api_client.v2.model.outcomes_response_included_item module¶

class OutcomesResponseIncludedItem(arg: None)¶

class OutcomesResponseIncludedItem(arg: ModelComposed)

class OutcomesResponseIncludedItem(*args, **kwargs)

Bases: ModelNormal

Attributes of the included rule.

Parameters:

attributes (OutcomesResponseIncludedRuleAttributes, optional) – Details of a rule.
id (str, optional) – The unique ID for a scorecard rule.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.outcomes_response_included_rule_attributes module¶

class OutcomesResponseIncludedRuleAttributes(arg: None)¶

class OutcomesResponseIncludedRuleAttributes(arg: ModelComposed)

class OutcomesResponseIncludedRuleAttributes(*args, **kwargs)

Bases: ModelNormal

Details of a rule.

Parameters:

name (str, optional) – Name of the rule.
scorecard_name (str, optional) – The scorecard name to which this rule must belong.

datadog_api_client.v2.model.outcomes_response_links module¶

class OutcomesResponseLinks(arg: None)¶

class OutcomesResponseLinks(arg: ModelComposed)

class OutcomesResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results.

datadog_api_client.v2.model.output_schema module¶

class OutputSchema(arg: None)¶

class OutputSchema(arg: ModelComposed)

class OutputSchema(*args, **kwargs)

Bases: ModelNormal

A list of output parameters for the workflow.

Parameters:: parameters ([OutputSchemaParameters], optional) – The OutputSchema parameters.

datadog_api_client.v2.model.output_schema_parameters module¶

class OutputSchemaParameters(arg: None)¶

class OutputSchemaParameters(arg: ModelComposed)

class OutputSchemaParameters(*args, **kwargs)

Bases: ModelNormal

The definition of OutputSchemaParameters object.

Parameters:

default_value (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The OutputSchemaParameters defaultValue.
description (str, optional) – The OutputSchemaParameters description.
label (str, optional) – The OutputSchemaParameters label.
name (str) – The OutputSchemaParameters name.
type (OutputSchemaParametersType) – The definition of OutputSchemaParametersType object.
value (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The OutputSchemaParameters value.

datadog_api_client.v2.model.output_schema_parameters_type module¶

class OutputSchemaParametersType(arg: None)¶

class OutputSchemaParametersType(arg: ModelComposed)

class OutputSchemaParametersType(*args, **kwargs)

Bases: ModelSimple

The definition of OutputSchemaParametersType object.

Parameters:

value (str) – Must be one of [“STRING”, “NUMBER”, “BOOLEAN”, “OBJECT”, “ARRAY_STRING”, “ARRAY_NUMBER”, “ARRAY_BOOLEAN”, “ARRAY_OBJECT”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.page_urgency module¶

class PageUrgency(arg: None)¶

class PageUrgency(arg: ModelComposed)

class PageUrgency(*args, **kwargs)

Bases: ModelSimple

On-Call Page urgency level.

Parameters:

value (str) – If omitted defaults to “high”. Must be one of [“low”, “high”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.pagination module¶

class Pagination(arg: None)¶

class Pagination(arg: ModelComposed)

class Pagination(*args, **kwargs)

Bases: ModelNormal

Pagination object.

Parameters:

total_count (int, optional) – Total count.
total_filtered_count (int, optional) – Total count of elements matched by the filter.

datadog_api_client.v2.model.parameter module¶

class Parameter(arg: None)¶

class Parameter(arg: ModelComposed)

class Parameter(*args, **kwargs)

Bases: ModelNormal

The definition of Parameter object.

Parameters:

name (str) – The Parameter name.
value (bool, date, datetime, dict, float, int, list, str, UUID, none_type) – The Parameter value.

datadog_api_client.v2.model.partial_api_key module¶

class PartialAPIKey(arg: None)¶

class PartialAPIKey(arg: ModelComposed)

class PartialAPIKey(*args, **kwargs)

Bases: ModelNormal

Partial Datadog API key.

Parameters:

attributes (PartialAPIKeyAttributes, optional) – Attributes of a partial API key.
id (str, optional) – ID of the API key.
relationships (APIKeyRelationships, optional) – Resources related to the API key.
type (APIKeysType, optional) – API Keys resource type.

datadog_api_client.v2.model.partial_api_key_attributes module¶

class PartialAPIKeyAttributes(arg: None)¶

class PartialAPIKeyAttributes(arg: ModelComposed)

class PartialAPIKeyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a partial API key.

Parameters:

category (str, optional) – The category of the API key.
created_at (str, optional) – Creation date of the API key.
date_last_used (datetime, none_type, optional) – Date the API Key was last used.
last4 (str, optional) – The last four characters of the API key.
modified_at (str, optional) – Date the API key was last modified.
name (str, optional) – Name of the API key.
remote_config_read_enabled (bool, optional) – The remote config read enabled status.

datadog_api_client.v2.model.partial_application_key module¶

class PartialApplicationKey(arg: None)¶

class PartialApplicationKey(arg: ModelComposed)

class PartialApplicationKey(*args, **kwargs)

Bases: ModelNormal

Partial Datadog application key.

Parameters:

attributes (PartialApplicationKeyAttributes, optional) – Attributes of a partial application key.
id (str, optional) – ID of the application key.
relationships (ApplicationKeyRelationships, optional) – Resources related to the application key.
type (ApplicationKeysType, optional) – Application Keys resource type.

datadog_api_client.v2.model.partial_application_key_attributes module¶

class PartialApplicationKeyAttributes(arg: None)¶

class PartialApplicationKeyAttributes(arg: ModelComposed)

class PartialApplicationKeyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a partial application key.

Parameters:

created_at (str, optional) – Creation date of the application key.
last4 (str, optional) – The last four characters of the application key.
last_used_at (str, none_type, optional) – Last usage timestamp of the application key.
name (str, optional) – Name of the application key.
scopes ([str], none_type, optional) – Array of scopes to grant the application key.

datadog_api_client.v2.model.partial_application_key_response module¶

class PartialApplicationKeyResponse(arg: None)¶

class PartialApplicationKeyResponse(arg: ModelComposed)

class PartialApplicationKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving a partial application key.

Parameters:

data (PartialApplicationKey, optional) – Partial Datadog application key.
included ([ApplicationKeyResponseIncludedItem], optional) – Array of objects related to the application key.

datadog_api_client.v2.model.patch_incident_notification_template_request module¶

class PatchIncidentNotificationTemplateRequest(arg: None)¶

class PatchIncidentNotificationTemplateRequest(arg: ModelComposed)

class PatchIncidentNotificationTemplateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for a notification template.

Parameters:: data (IncidentNotificationTemplateUpdateData) – Notification template data for an update request.

datadog_api_client.v2.model.patch_notification_rule_parameters module¶

class PatchNotificationRuleParameters(arg: None)¶

class PatchNotificationRuleParameters(arg: ModelComposed)

class PatchNotificationRuleParameters(*args, **kwargs)

Bases: ModelNormal

Body of the notification rule patch request.

Parameters:: data (PatchNotificationRuleParametersData, optional) – Data of the notification rule patch request: the rule ID, the rule type, and the rule attributes. All fields are required.

datadog_api_client.v2.model.patch_notification_rule_parameters_data module¶

class PatchNotificationRuleParametersData(arg: None)¶

class PatchNotificationRuleParametersData(arg: ModelComposed)

class PatchNotificationRuleParametersData(*args, **kwargs)

Bases: ModelNormal

Data of the notification rule patch request: the rule ID, the rule type, and the rule attributes. All fields are required.

Parameters:

attributes (PatchNotificationRuleParametersDataAttributes) – Attributes of the notification rule patch request. It is required to update the version of the rule when patching it.
id (str) – The ID of a notification rule.
type (NotificationRulesType) – The rule type associated to notification rules.

datadog_api_client.v2.model.patch_notification_rule_parameters_data_attributes module¶

class PatchNotificationRuleParametersDataAttributes(arg: None)¶

class PatchNotificationRuleParametersDataAttributes(arg: ModelComposed)

class PatchNotificationRuleParametersDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the notification rule patch request. It is required to update the version of the rule when patching it.

Parameters:

enabled (bool, optional) – Field used to enable or disable the rule.
name (str, optional) – Name of the notification rule.
selectors (Selectors, optional) – Selectors are used to filter security issues for which notifications should be generated. Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source. Only the trigger_source field is required.
targets ([str], optional) – List of recipients to notify when a notification rule is triggered. Many different target types are supported, such as email addresses, Slack channels, and PagerDuty services. The appropriate integrations need to be properly configured to send notifications to the specified targets.
time_aggregation (int, optional) – Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation. Results are aggregated over a selected time frame using a rolling window, which updates with each new evaluation. Notifications are only sent for new issues discovered during the window. Time aggregation is only available for vulnerability-based notification rules. When omitted or set to 0, no aggregation is done.
version (int, optional) – Version of the notification rule. It is updated when the rule is modified.

datadog_api_client.v2.model.patch_table_request module¶

class PatchTableRequest(arg: None)¶

class PatchTableRequest(arg: ModelComposed)

class PatchTableRequest(*args, **kwargs)

Bases: ModelNormal

Request body for updating an existing reference table.

Parameters:: data (PatchTableRequestData, optional) – The data object containing the partial table definition updates.

datadog_api_client.v2.model.patch_table_request_data module¶

class PatchTableRequestData(arg: None)¶

class PatchTableRequestData(arg: ModelComposed)

class PatchTableRequestData(*args, **kwargs)

Bases: ModelNormal

The data object containing the partial table definition updates.

Parameters:

attributes (PatchTableRequestDataAttributes, optional) – Attributes that define the updates to the reference table’s configuration and properties.
type (PatchTableRequestDataType) – Reference table resource type.

additional_properties_type = None¶

datadog_api_client.v2.model.patch_table_request_data_attributes module¶

class PatchTableRequestDataAttributes(arg: None)¶

class PatchTableRequestDataAttributes(arg: ModelComposed)

class PatchTableRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes that define the updates to the reference table’s configuration and properties.

Parameters:

description (str, optional) – Optional text describing the purpose or contents of this reference table.
file_metadata (PatchTableRequestDataAttributesFileMetadata, optional) – Metadata specifying where and how to access the reference table’s data file.
schema (PatchTableRequestDataAttributesSchema, optional) – Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed.
sync_enabled (bool, optional) – Whether this table is synced automatically.
tags ([str], optional) – Tags for organizing and filtering reference tables.

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata module¶

class PatchTableRequestDataAttributesFileMetadata(arg: None)¶

class PatchTableRequestDataAttributesFileMetadata(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadata(*args, **kwargs)

Bases: ModelComposed

Metadata specifying where and how to access the reference table’s data file.

Parameters:

access_details (PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails, optional) – Cloud storage access configuration for the reference table data file.
sync_enabled (bool, optional) – Whether this table is synced automatically.
upload_id (str) – The upload ID.

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_cloud_storage module¶

class PatchTableRequestDataAttributesFileMetadataCloudStorage(arg: None)¶

class PatchTableRequestDataAttributesFileMetadataCloudStorage(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadataCloudStorage(*args, **kwargs)

Bases: ModelNormal

Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.

Parameters:

access_details (PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails, optional) – Cloud storage access configuration for the reference table data file.
sync_enabled (bool, optional) – Whether this table is synced automatically.

additional_properties_type = None¶

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_local_file module¶

class PatchTableRequestDataAttributesFileMetadataLocalFile(arg: None)¶

class PatchTableRequestDataAttributesFileMetadataLocalFile(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadataLocalFile(*args, **kwargs)

Bases: ModelNormal

Local file metadata for patch requests using upload ID.

Parameters:: upload_id (str) – The upload ID.

additional_properties_type = None¶

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_one_of_access_details module¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails(arg: None)¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails(*args, **kwargs)

Bases: ModelNormal

Cloud storage access configuration for the reference table data file.

Parameters:

aws_detail (PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail, optional) – Amazon Web Services S3 storage access configuration.
azure_detail (PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail, optional) – Azure Blob Storage access configuration.
gcp_detail (PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail, optional) – Google Cloud Platform storage access configuration.

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail module¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(arg: None)¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail(*args, **kwargs)

Bases: ModelNormal

Amazon Web Services S3 storage access configuration.

Parameters:

aws_account_id (str, optional) – AWS account ID where the S3 bucket is located.
aws_bucket_name (str, optional) – S3 bucket containing the CSV file.
file_path (str, optional) – The relative file path from the S3 bucket root to the CSV file.

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_one_of_access_details_azure_detail module¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail(arg: None)¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail(*args, **kwargs)

Bases: ModelNormal

Azure Blob Storage access configuration.

Parameters:

azure_client_id (str, optional) – Azure service principal (application) client ID with permissions to read from the container.
azure_container_name (str, optional) – Azure Blob Storage container containing the CSV file.
azure_storage_account_name (str, optional) – Azure storage account where the container is located.
azure_tenant_id (str, optional) – Azure Active Directory tenant ID.
file_path (str, optional) – The relative file path from the Azure container root to the CSV file.

datadog_api_client.v2.model.patch_table_request_data_attributes_file_metadata_one_of_access_details_gcp_detail module¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail(arg: None)¶

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail(arg: ModelComposed)

class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail(*args, **kwargs)

Bases: ModelNormal

Google Cloud Platform storage access configuration.

Parameters:

file_path (str, optional) – The relative file path from the GCS bucket root to the CSV file.
gcp_bucket_name (str, optional) – GCP bucket containing the CSV file.
gcp_project_id (str, optional) – GCP project ID where the bucket is located.
gcp_service_account_email (str, optional) – Service account email with read permissions for the GCS bucket.

datadog_api_client.v2.model.patch_table_request_data_attributes_schema module¶

class PatchTableRequestDataAttributesSchema(arg: None)¶

class PatchTableRequestDataAttributesSchema(arg: ModelComposed)

class PatchTableRequestDataAttributesSchema(*args, **kwargs)

Bases: ModelNormal

Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed.

Parameters:

fields ([PatchTableRequestDataAttributesSchemaFieldsItems]) – The schema fields.
primary_keys ([str]) – List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. Primary keys cannot be changed after table creation.

datadog_api_client.v2.model.patch_table_request_data_attributes_schema_fields_items module¶

class PatchTableRequestDataAttributesSchemaFieldsItems(arg: None)¶

class PatchTableRequestDataAttributesSchemaFieldsItems(arg: ModelComposed)

class PatchTableRequestDataAttributesSchemaFieldsItems(*args, **kwargs)

Bases: ModelNormal

A single field (column) in the reference table schema to be updated. Schema fields cannot be deleted or renamed.

Parameters:

name (str) – The field name.
type (ReferenceTableSchemaFieldType) – The field type for reference table schema fields.

datadog_api_client.v2.model.patch_table_request_data_type module¶

class PatchTableRequestDataType(arg: None)¶

class PatchTableRequestDataType(arg: ModelComposed)

class PatchTableRequestDataType(*args, **kwargs)

Bases: ModelSimple

Reference table resource type.

Parameters:

value (str) – If omitted defaults to “reference_table”. Must be one of [“reference_table”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.permission module¶

class Permission(arg: None)¶

class Permission(arg: ModelComposed)

class Permission(*args, **kwargs)

Bases: ModelNormal

Permission object.

Parameters:

attributes (PermissionAttributes, optional) – Attributes of a permission.
id (str, optional) – ID of the permission.
type (PermissionsType) – Permissions resource type.

datadog_api_client.v2.model.permission_attributes module¶

class PermissionAttributes(arg: None)¶

class PermissionAttributes(arg: ModelComposed)

class PermissionAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a permission.

Parameters:

created (datetime, optional) – Creation time of the permission.
description (str, optional) – Description of the permission.
display_name (str, optional) – Displayed name for the permission.
display_type (str, optional) – Display type.
group_name (str, optional) – Name of the permission group.
name (str, optional) – Name of the permission.
restricted (bool, optional) – Whether or not the permission is restricted.

datadog_api_client.v2.model.permissions_response module¶

class PermissionsResponse(arg: None)¶

class PermissionsResponse(arg: ModelComposed)

class PermissionsResponse(*args, **kwargs)

Bases: ModelNormal

Payload with API-returned permissions.

Parameters:: data ([Permission], optional) – Array of permissions.

datadog_api_client.v2.model.permissions_type module¶

class PermissionsType(arg: None)¶

class PermissionsType(arg: ModelComposed)

class PermissionsType(*args, **kwargs)

Bases: ModelSimple

Permissions resource type.

Parameters:

value (str) – If omitted defaults to “permissions”. Must be one of [“permissions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.powerpack module¶

class Powerpack(arg: None)¶

class Powerpack(arg: ModelComposed)

class Powerpack(*args, **kwargs)

Bases: ModelNormal

Powerpacks are templated groups of dashboard widgets you can save from an existing dashboard and turn into reusable packs in the widget tray.

Parameters:: data (PowerpackData, optional) – Powerpack data object.

datadog_api_client.v2.model.powerpack_attributes module¶

class PowerpackAttributes(arg: None)¶

class PowerpackAttributes(arg: ModelComposed)

class PowerpackAttributes(*args, **kwargs)

Bases: ModelNormal

Powerpack attribute object.

Parameters:

description (str, optional) – Description of this powerpack.
group_widget (PowerpackGroupWidget) – Powerpack group widget definition object.
name (str) – Name of the powerpack.
tags ([str], optional) – List of tags to identify this powerpack.
template_variables ([PowerpackTemplateVariable], optional) – List of template variables for this powerpack.

datadog_api_client.v2.model.powerpack_data module¶

class PowerpackData(arg: None)¶

class PowerpackData(arg: ModelComposed)

class PowerpackData(*args, **kwargs)

Bases: ModelNormal

Powerpack data object.

Parameters:

attributes (PowerpackAttributes, optional) – Powerpack attribute object.
id (str, optional) – ID of the powerpack.
relationships (PowerpackRelationships, optional) – Powerpack relationship object.
type (str, optional) – Type of widget, must be powerpack.

datadog_api_client.v2.model.powerpack_group_widget module¶

class PowerpackGroupWidget(arg: None)¶

class PowerpackGroupWidget(arg: ModelComposed)

class PowerpackGroupWidget(*args, **kwargs)

Bases: ModelNormal

Powerpack group widget definition object.

Parameters:

definition (PowerpackGroupWidgetDefinition) – Powerpack group widget object.
layout (PowerpackGroupWidgetLayout, optional) – Powerpack group widget layout.
live_span (WidgetLiveSpan, optional) – The available timeframes depend on the widget you are using.

datadog_api_client.v2.model.powerpack_group_widget_definition module¶

class PowerpackGroupWidgetDefinition(arg: None)¶

class PowerpackGroupWidgetDefinition(arg: ModelComposed)

class PowerpackGroupWidgetDefinition(*args, **kwargs)

Bases: ModelNormal

Powerpack group widget object.

Parameters:

layout_type (str) – Layout type of widgets.
show_title (bool, optional) – Boolean indicating whether powerpack group title should be visible or not.
title (str, optional) – Name for the group widget.
type (str) – Type of widget, must be group.
widgets ([PowerpackInnerWidgets]) – Widgets inside the powerpack.

datadog_api_client.v2.model.powerpack_group_widget_layout module¶

class PowerpackGroupWidgetLayout(arg: None)¶

class PowerpackGroupWidgetLayout(arg: ModelComposed)

class PowerpackGroupWidgetLayout(*args, **kwargs)

Bases: ModelNormal

Powerpack group widget layout.

Parameters:

height (int) – The height of the widget. Should be a non-negative integer.
width (int) – The width of the widget. Should be a non-negative integer.
x (int) – The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y (int) – The position of the widget on the y (vertical) axis. Should be a non-negative integer.

datadog_api_client.v2.model.powerpack_inner_widget_layout module¶

class PowerpackInnerWidgetLayout(arg: None)¶

class PowerpackInnerWidgetLayout(arg: ModelComposed)

class PowerpackInnerWidgetLayout(*args, **kwargs)

Bases: ModelNormal

Powerpack inner widget layout.

Parameters:

height (int) – The height of the widget. Should be a non-negative integer.
width (int) – The width of the widget. Should be a non-negative integer.
x (int) – The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y (int) – The position of the widget on the y (vertical) axis. Should be a non-negative integer.

datadog_api_client.v2.model.powerpack_inner_widgets module¶

class PowerpackInnerWidgets(arg: None)¶

class PowerpackInnerWidgets(arg: ModelComposed)

class PowerpackInnerWidgets(*args, **kwargs)

Bases: ModelNormal

Powerpack group widget definition of individual widgets.

Parameters:

definition ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}) – Information about widget.
layout (PowerpackInnerWidgetLayout, optional) – Powerpack inner widget layout.

datadog_api_client.v2.model.powerpack_relationships module¶

class PowerpackRelationships(arg: None)¶

class PowerpackRelationships(arg: ModelComposed)

class PowerpackRelationships(*args, **kwargs)

Bases: ModelNormal

Powerpack relationship object.

Parameters:: author (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.powerpack_response module¶

class PowerpackResponse(arg: None)¶

class PowerpackResponse(arg: ModelComposed)

class PowerpackResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes a single powerpack configuration.

Parameters:

data (PowerpackData, optional) – Powerpack data object.
included ([User], optional) – Array of objects related to the users.

datadog_api_client.v2.model.powerpack_response_links module¶

class PowerpackResponseLinks(arg: None)¶

class PowerpackResponseLinks(arg: ModelComposed)

class PowerpackResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

first (str, optional) – Link to last page.
last (str, none_type, optional) – Link to first page.
next (str, optional) – Link for the next set of results.
prev (str, none_type, optional) – Link for the previous set of results.
self (str, optional) – Link to current page.

datadog_api_client.v2.model.powerpack_template_variable module¶

class PowerpackTemplateVariable(arg: None)¶

class PowerpackTemplateVariable(arg: ModelComposed)

class PowerpackTemplateVariable(*args, **kwargs)

Bases: ModelNormal

Powerpack template variables.

Parameters:

available_values ([str], none_type, optional) – The list of values that the template variable drop-down is limited to.
defaults ([str], optional) – One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name (str) – The name of the variable.
prefix (str, none_type, optional) – The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

datadog_api_client.v2.model.powerpacks_response_meta module¶

class PowerpacksResponseMeta(arg: None)¶

class PowerpacksResponseMeta(arg: ModelComposed)

class PowerpacksResponseMeta(*args, **kwargs)

Bases: ModelNormal

Powerpack response metadata.

Parameters:: pagination (PowerpacksResponseMetaPagination, optional) – Powerpack response pagination metadata.

datadog_api_client.v2.model.powerpacks_response_meta_pagination module¶

class PowerpacksResponseMetaPagination(arg: None)¶

class PowerpacksResponseMetaPagination(arg: ModelComposed)

class PowerpacksResponseMetaPagination(*args, **kwargs)

Bases: ModelNormal

Powerpack response pagination metadata.

Parameters:

first_offset (int, optional) – The first offset.
last_offset (int, none_type, optional) – The last offset.
limit (int, optional) – Pagination limit.
next_offset (int, optional) – The next offset.
offset (int, optional) – The offset.
prev_offset (int, optional) – The previous offset.
total (int, optional) – Total results.
type (str, optional) – Offset type.

datadog_api_client.v2.model.preview_entity_response_data module¶

class PreviewEntityResponseData(arg: None)¶

class PreviewEntityResponseData(arg: ModelComposed)

class PreviewEntityResponseData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (EntityResponseDataAttributes, optional)
id (str, optional)
relationships (EntityResponseDataRelationships, optional)
type (EntityResponseDataType) – Entity resource type.

datadog_api_client.v2.model.process_summaries_meta module¶

class ProcessSummariesMeta(arg: None)¶

class ProcessSummariesMeta(arg: ModelComposed)

class ProcessSummariesMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:: page (ProcessSummariesMetaPage, optional) – Paging attributes.

datadog_api_client.v2.model.process_summaries_meta_page module¶

class ProcessSummariesMetaPage(arg: None)¶

class ProcessSummariesMetaPage(arg: ModelComposed)

class ProcessSummariesMetaPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:

after (str, optional) – The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].
size (int, optional) – Number of results returned.

datadog_api_client.v2.model.process_summaries_response module¶

class ProcessSummariesResponse(arg: None)¶

class ProcessSummariesResponse(arg: ModelComposed)

class ProcessSummariesResponse(*args, **kwargs)

Bases: ModelNormal

List of process summaries.

Parameters:

data ([ProcessSummary], optional) – Array of process summary objects.
meta (ProcessSummariesMeta, optional) – Response metadata object.

datadog_api_client.v2.model.process_summary module¶

class ProcessSummary(arg: None)¶

class ProcessSummary(arg: ModelComposed)

class ProcessSummary(*args, **kwargs)

Bases: ModelNormal

Process summary object.

Parameters:

attributes (ProcessSummaryAttributes, optional) – Attributes for a process summary.
id (str, optional) – Process ID.
type (ProcessSummaryType, optional) – Type of process summary.

datadog_api_client.v2.model.process_summary_attributes module¶

class ProcessSummaryAttributes(arg: None)¶

class ProcessSummaryAttributes(arg: ModelComposed)

class ProcessSummaryAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for a process summary.

Parameters:

cmdline (str, optional) – Process command line.
host (str, optional) – Host running the process.
pid (int, optional) – Process ID.
ppid (int, optional) – Parent process ID.
start (str, optional) – Time the process was started.
tags ([str], optional) – List of tags associated with the process.
timestamp (str, optional) – Time the process was seen.
user (str, optional) – Process owner.

datadog_api_client.v2.model.process_summary_type module¶

class ProcessSummaryType(arg: None)¶

class ProcessSummaryType(arg: ModelComposed)

class ProcessSummaryType(*args, **kwargs)

Bases: ModelSimple

Type of process summary.

Parameters:

value (str) – If omitted defaults to “process”. Must be one of [“process”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.project module¶

class Project(arg: None)¶

class Project(arg: ModelComposed)

class Project(*args, **kwargs)

Bases: ModelNormal

A Project

Parameters:

attributes (ProjectAttributes) – Project attributes
id (str) – The Project’s identifier
relationships (ProjectRelationships, optional) – Project relationships
type (ProjectResourceType) – Project resource type

datadog_api_client.v2.model.project_attributes module¶

class ProjectAttributes(arg: None)¶

class ProjectAttributes(arg: ModelComposed)

class ProjectAttributes(*args, **kwargs)

Bases: ModelNormal

Project attributes

Parameters:

key (str, optional) – The project’s key
name (str, optional) – Project’s name

datadog_api_client.v2.model.project_create module¶

class ProjectCreate(arg: None)¶

class ProjectCreate(arg: ModelComposed)

class ProjectCreate(*args, **kwargs)

Bases: ModelNormal

Project create

Parameters:

attributes (ProjectCreateAttributes) – Project creation attributes
type (ProjectResourceType) – Project resource type

datadog_api_client.v2.model.project_create_attributes module¶

class ProjectCreateAttributes(arg: None)¶

class ProjectCreateAttributes(arg: ModelComposed)

class ProjectCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Project creation attributes

Parameters:

key (str) – Project’s key. Cannot be “CASE”
name (str) – name

datadog_api_client.v2.model.project_create_request module¶

class ProjectCreateRequest(arg: None)¶

class ProjectCreateRequest(arg: ModelComposed)

class ProjectCreateRequest(*args, **kwargs)

Bases: ModelNormal

Project create request

Parameters:: data (ProjectCreate) – Project create

datadog_api_client.v2.model.project_relationship module¶

class ProjectRelationship(arg: None)¶

class ProjectRelationship(arg: ModelComposed)

class ProjectRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship to project

Parameters:: data (ProjectRelationshipData) – Relationship to project object

datadog_api_client.v2.model.project_relationship_data module¶

class ProjectRelationshipData(arg: None)¶

class ProjectRelationshipData(arg: ModelComposed)

class ProjectRelationshipData(*args, **kwargs)

Bases: ModelNormal

Relationship to project object

Parameters:

id (str) – A unique identifier that represents the project
type (ProjectResourceType) – Project resource type

datadog_api_client.v2.model.project_relationships module¶

class ProjectRelationships(arg: None)¶

class ProjectRelationships(arg: ModelComposed)

class ProjectRelationships(*args, **kwargs)

Bases: ModelNormal

Project relationships

Parameters:

member_team (RelationshipToTeamLinks, optional) – Relationship between a team and a team link
member_user (UsersRelationship, optional) – Relationship to users.

datadog_api_client.v2.model.project_resource_type module¶

class ProjectResourceType(arg: None)¶

class ProjectResourceType(arg: ModelComposed)

class ProjectResourceType(*args, **kwargs)

Bases: ModelSimple

Project resource type

Parameters:

value (str) – If omitted defaults to “project”. Must be one of [“project”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.project_response module¶

class ProjectResponse(arg: None)¶

class ProjectResponse(arg: ModelComposed)

class ProjectResponse(*args, **kwargs)

Bases: ModelNormal

Project response

Parameters:: data (Project, optional) – A Project

datadog_api_client.v2.model.projected_cost module¶

class ProjectedCost(arg: None)¶

class ProjectedCost(arg: ModelComposed)

class ProjectedCost(*args, **kwargs)

Bases: ModelNormal

Projected Cost data.

Parameters:

attributes (ProjectedCostAttributes, optional) – Projected Cost attributes data.
id (str, optional) – Unique ID of the response.
type (ProjectedCostType, optional) – Type of cost data.

datadog_api_client.v2.model.projected_cost_attributes module¶

class ProjectedCostAttributes(arg: None)¶

class ProjectedCostAttributes(arg: ModelComposed)

class ProjectedCostAttributes(*args, **kwargs)

Bases: ModelNormal

Projected Cost attributes data.

Parameters:

account_name (str, optional) – The account name.
account_public_id (str, optional) – The account public ID.
charges ([ChargebackBreakdown], optional) – List of charges data reported for the requested month.
date (datetime, optional) – The month requested.
org_name (str, optional) – The organization name.
projected_total_cost (float, optional) – The total projected cost of products for the month.
public_id (str, optional) – The organization public ID.
region (str, optional) – The region of the Datadog instance that the organization belongs to.

datadog_api_client.v2.model.projected_cost_response module¶

class ProjectedCostResponse(arg: None)¶

class ProjectedCostResponse(arg: ModelComposed)

class ProjectedCostResponse(*args, **kwargs)

Bases: ModelNormal

Projected Cost response.

Parameters:: data ([ProjectedCost], optional) – Response containing Projected Cost.

datadog_api_client.v2.model.projected_cost_type module¶

class ProjectedCostType(arg: None)¶

class ProjectedCostType(arg: ModelComposed)

class ProjectedCostType(*args, **kwargs)

Bases: ModelSimple

Type of cost data.

Parameters:

value (str) – If omitted defaults to “projected_cost”. Must be one of [“projected_cost”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.projects_response module¶

class ProjectsResponse(arg: None)¶

class ProjectsResponse(arg: ModelComposed)

class ProjectsResponse(*args, **kwargs)

Bases: ModelNormal

Response with projects

Parameters:: data ([Project], optional) – Projects response data

datadog_api_client.v2.model.publish_app_response module¶

class PublishAppResponse(arg: None)¶

class PublishAppResponse(arg: ModelComposed)

class PublishAppResponse(*args, **kwargs)

Bases: ModelNormal

The response object after an app is successfully published.

Parameters:: data (Deployment, optional) – The version of the app that was published.

datadog_api_client.v2.model.put_apps_datastore_item_response_array module¶

class PutAppsDatastoreItemResponseArray(arg: None)¶

class PutAppsDatastoreItemResponseArray(arg: ModelComposed)

class PutAppsDatastoreItemResponseArray(*args, **kwargs)

Bases: ModelNormal

Response after successfully inserting multiple items into a datastore, containing the identifiers of the created items.

Parameters:: data ([PutAppsDatastoreItemResponseData]) – An array of data objects containing the identifiers of the successfully inserted items.

datadog_api_client.v2.model.put_apps_datastore_item_response_data module¶

class PutAppsDatastoreItemResponseData(arg: None)¶

class PutAppsDatastoreItemResponseData(arg: ModelComposed)

class PutAppsDatastoreItemResponseData(*args, **kwargs)

Bases: ModelNormal

Data containing the identifier of a single item that was successfully inserted into the datastore.

Parameters:

id (str, optional) – The unique identifier assigned to the inserted item.
type (DatastoreItemsDataType) – The resource type for datastore items.

datadog_api_client.v2.model.put_incident_notification_rule_request module¶

class PutIncidentNotificationRuleRequest(arg: None)¶

class PutIncidentNotificationRuleRequest(arg: ModelComposed)

class PutIncidentNotificationRuleRequest(*args, **kwargs)

Bases: ModelNormal

Put request for a notification rule.

Parameters:: data (IncidentNotificationRuleUpdateData) – Notification rule data for an update request.

datadog_api_client.v2.model.query module¶

class Query(arg: None)¶

class Query(arg: ModelComposed)

class Query(*args, **kwargs)

Bases: ModelComposed

A data query used by an app. This can take the form of an external action, a data transformation, or a state variable.

Parameters:

events ([AppBuilderEvent], optional) – Events to listen for downstream of the action query.
id (UUID) – The ID of the action query.
name (str) – A unique identifier for this action query. This name is also used to access the query’s result throughout the app.
properties (ActionQueryProperties) – The properties of the action query.
type (ActionQueryType) – The action query type.

datadog_api_client.v2.model.query_account_request module¶

class QueryAccountRequest(arg: None)¶

class QueryAccountRequest(arg: ModelComposed)

class QueryAccountRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (QueryAccountRequestData, optional)

datadog_api_client.v2.model.query_account_request_data module¶

class QueryAccountRequestData(arg: None)¶

class QueryAccountRequestData(arg: ModelComposed)

class QueryAccountRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (QueryAccountRequestDataAttributes, optional)
id (str, optional)
type (QueryAccountRequestDataType) – Query account request resource type.

datadog_api_client.v2.model.query_account_request_data_attributes module¶

class QueryAccountRequestDataAttributes(arg: None)¶

class QueryAccountRequestDataAttributes(arg: ModelComposed)

class QueryAccountRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

limit (int, optional)
query (str, optional)
select_columns ([str], optional)
sort (QueryAccountRequestDataAttributesSort, optional)
wildcard_search_term (str, optional)

datadog_api_client.v2.model.query_account_request_data_attributes_sort module¶

class QueryAccountRequestDataAttributesSort(arg: None)¶

class QueryAccountRequestDataAttributesSort(arg: ModelComposed)

class QueryAccountRequestDataAttributesSort(*args, **kwargs)

Bases: ModelNormal

Parameters:

field (str, optional)
order (str, optional)

datadog_api_client.v2.model.query_account_request_data_type module¶

class QueryAccountRequestDataType(arg: None)¶

class QueryAccountRequestDataType(arg: ModelComposed)

class QueryAccountRequestDataType(*args, **kwargs)

Bases: ModelSimple

Query account request resource type.

Parameters:

value (str) – If omitted defaults to “query_account_request”. Must be one of [“query_account_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.query_event_filtered_users_request module¶

class QueryEventFilteredUsersRequest(arg: None)¶

class QueryEventFilteredUsersRequest(arg: ModelComposed)

class QueryEventFilteredUsersRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (QueryEventFilteredUsersRequestData, optional)

datadog_api_client.v2.model.query_event_filtered_users_request_data module¶

class QueryEventFilteredUsersRequestData(arg: None)¶

class QueryEventFilteredUsersRequestData(arg: ModelComposed)

class QueryEventFilteredUsersRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (QueryEventFilteredUsersRequestDataAttributes, optional)
id (str, optional)
type (QueryEventFilteredUsersRequestDataType) – Query event filtered users request resource type.

datadog_api_client.v2.model.query_event_filtered_users_request_data_attributes module¶

class QueryEventFilteredUsersRequestDataAttributes(arg: None)¶

class QueryEventFilteredUsersRequestDataAttributes(arg: ModelComposed)

class QueryEventFilteredUsersRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

event_query (QueryEventFilteredUsersRequestDataAttributesEventQuery, optional)
include_row_count (bool, optional)
limit (int, optional)
query (str, optional)
select_columns ([str], optional)

datadog_api_client.v2.model.query_event_filtered_users_request_data_attributes_event_query module¶

class QueryEventFilteredUsersRequestDataAttributesEventQuery(arg: None)¶

class QueryEventFilteredUsersRequestDataAttributesEventQuery(arg: ModelComposed)

class QueryEventFilteredUsersRequestDataAttributesEventQuery(*args, **kwargs)

Bases: ModelNormal

Parameters:

query (str, optional)
time_frame (QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame, optional)

datadog_api_client.v2.model.query_event_filtered_users_request_data_attributes_event_query_time_frame module¶

class QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame(arg: None)¶

class QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame(arg: ModelComposed)

class QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame(*args, **kwargs)

Bases: ModelNormal

Parameters:

end (int, optional)
start (int, optional)

datadog_api_client.v2.model.query_event_filtered_users_request_data_type module¶

class QueryEventFilteredUsersRequestDataType(arg: None)¶

class QueryEventFilteredUsersRequestDataType(arg: ModelComposed)

class QueryEventFilteredUsersRequestDataType(*args, **kwargs)

Bases: ModelSimple

Query event filtered users request resource type.

Parameters:

value (str) – If omitted defaults to “query_event_filtered_users_request”. Must be one of [“query_event_filtered_users_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.query_formula module¶

class QueryFormula(arg: None)¶

class QueryFormula(arg: ModelComposed)

class QueryFormula(*args, **kwargs)

Bases: ModelNormal

A formula for calculation based on one or more queries.

Parameters:

formula (str) – Formula string, referencing one or more queries with their name property.
limit (FormulaLimit, optional) – Message for specifying limits to the number of values returned by a query. This limit is only for scalar queries and has no effect on timeseries queries.

datadog_api_client.v2.model.query_response module¶

class QueryResponse(arg: None)¶

class QueryResponse(arg: ModelComposed)

class QueryResponse(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (QueryResponseData, optional)

datadog_api_client.v2.model.query_response_data module¶

class QueryResponseData(arg: None)¶

class QueryResponseData(arg: ModelComposed)

class QueryResponseData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (QueryResponseDataAttributes, optional)
id (str, optional)
type (QueryResponseDataType) – Query response resource type.

datadog_api_client.v2.model.query_response_data_attributes module¶

class QueryResponseDataAttributes(arg: None)¶

class QueryResponseDataAttributes(arg: ModelComposed)

class QueryResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

hits ([bool, date, datetime, dict, float, int, list, str, UUID, none_type], optional)
total (int, optional)

datadog_api_client.v2.model.query_response_data_type module¶

class QueryResponseDataType(arg: None)¶

class QueryResponseDataType(arg: ModelComposed)

class QueryResponseDataType(*args, **kwargs)

Bases: ModelSimple

Query response resource type.

Parameters:

value (str) – If omitted defaults to “query_response”. Must be one of [“query_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.query_sort_order module¶

class QuerySortOrder(arg: None)¶

class QuerySortOrder(arg: ModelComposed)

class QuerySortOrder(*args, **kwargs)

Bases: ModelSimple

Direction of sort.

Parameters:

value (str) – If omitted defaults to “desc”. Must be one of [“asc”, “desc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.query_users_request module¶

class QueryUsersRequest(arg: None)¶

class QueryUsersRequest(arg: ModelComposed)

class QueryUsersRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (QueryUsersRequestData, optional)

datadog_api_client.v2.model.query_users_request_data module¶

class QueryUsersRequestData(arg: None)¶

class QueryUsersRequestData(arg: ModelComposed)

class QueryUsersRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (QueryUsersRequestDataAttributes, optional)
id (str, optional)
type (QueryUsersRequestDataType) – Query users request resource type.

datadog_api_client.v2.model.query_users_request_data_attributes module¶

class QueryUsersRequestDataAttributes(arg: None)¶

class QueryUsersRequestDataAttributes(arg: ModelComposed)

class QueryUsersRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

limit (int, optional)
query (str, optional)
select_columns ([str], optional)
sort (QueryUsersRequestDataAttributesSort, optional)
wildcard_search_term (str, optional)

datadog_api_client.v2.model.query_users_request_data_attributes_sort module¶

class QueryUsersRequestDataAttributesSort(arg: None)¶

class QueryUsersRequestDataAttributesSort(arg: ModelComposed)

class QueryUsersRequestDataAttributesSort(*args, **kwargs)

Bases: ModelNormal

Parameters:

field (str, optional)
order (str, optional)

datadog_api_client.v2.model.query_users_request_data_type module¶

class QueryUsersRequestDataType(arg: None)¶

class QueryUsersRequestDataType(arg: ModelComposed)

class QueryUsersRequestDataType(*args, **kwargs)

Bases: ModelSimple

Query users request resource type.

Parameters:

value (str) – If omitted defaults to “query_users_request”. Must be one of [“query_users_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.readiness_gate module¶

class ReadinessGate(arg: None)¶

class ReadinessGate(arg: ModelComposed)

class ReadinessGate(*args, **kwargs)

Bases: ModelNormal

Used to merge multiple branches into a single branch.

Parameters:: threshold_type (ReadinessGateThresholdType) – The definition of ReadinessGateThresholdType object.

datadog_api_client.v2.model.readiness_gate_threshold_type module¶

class ReadinessGateThresholdType(arg: None)¶

class ReadinessGateThresholdType(arg: ModelComposed)

class ReadinessGateThresholdType(*args, **kwargs)

Bases: ModelSimple

The definition of ReadinessGateThresholdType object.

Parameters:

value (str) – Must be one of [“ANY”, “ALL”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.recommendation_attributes module¶

class RecommendationAttributes(arg: None)¶

class RecommendationAttributes(arg: ModelComposed)

class RecommendationAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components.

Parameters:

driver (ComponentRecommendation) – Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs.
executor (ComponentRecommendation) – Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs.

datadog_api_client.v2.model.recommendation_data module¶

class RecommendationData(arg: None)¶

class RecommendationData(arg: ModelComposed)

class RecommendationData(*args, **kwargs)

Bases: ModelNormal

JSON:API resource object for SPA Recommendation. Includes type, optional ID, and resource attributes with structured recommendations.

Parameters:

attributes (RecommendationAttributes) – Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components.
id (str, optional) – Resource identifier for the recommendation. Optional in responses.
type (RecommendationType) – JSON:API resource type for Spark Pod Autosizing recommendations. Identifies the Recommendation resource returned by SPA.

datadog_api_client.v2.model.recommendation_document module¶

class RecommendationDocument(arg: None)¶

class RecommendationDocument(arg: ModelComposed)

class RecommendationDocument(*args, **kwargs)

Bases: ModelNormal

JSON:API document containing a single Recommendation resource. Returned by SPA when the Spark Gateway requests recommendations.

Parameters:: data (RecommendationData) – JSON:API resource object for SPA Recommendation. Includes type, optional ID, and resource attributes with structured recommendations.

datadog_api_client.v2.model.recommendation_type module¶

class RecommendationType(arg: None)¶

class RecommendationType(arg: ModelComposed)

class RecommendationType(*args, **kwargs)

Bases: ModelSimple

JSON:API resource type for Spark Pod Autosizing recommendations. Identifies the Recommendation resource returned by SPA.

Parameters:

value (str) – If omitted defaults to “recommendation”. Must be one of [“recommendation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.reference_table_create_source_type module¶

class ReferenceTableCreateSourceType(arg: None)¶

class ReferenceTableCreateSourceType(arg: ModelComposed)

class ReferenceTableCreateSourceType(*args, **kwargs)

Bases: ModelSimple

The source type for creating reference table data. Only these source types can be created through this API.

Parameters:

value (str) – Must be one of [“LOCAL_FILE”, “S3”, “GCS”, “AZURE”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.reference_table_schema_field_type module¶

class ReferenceTableSchemaFieldType(arg: None)¶

class ReferenceTableSchemaFieldType(arg: ModelComposed)

class ReferenceTableSchemaFieldType(*args, **kwargs)

Bases: ModelSimple

The field type for reference table schema fields.

Parameters:

value (str) – Must be one of [“STRING”, “INT32”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.reference_table_sort_type module¶

class ReferenceTableSortType(arg: None)¶

class ReferenceTableSortType(arg: ModelComposed)

class ReferenceTableSortType(*args, **kwargs)

Bases: ModelSimple

Sort field and direction for reference tables. Use field name for ascending, prefix with “-” for descending.

Parameters:

value (str) – If omitted defaults to “-updated_at”. Must be one of [“updated_at”, “table_name”, “status”, “-updated_at”, “-table_name”, “-status”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.reference_table_source_type module¶

class ReferenceTableSourceType(arg: None)¶

class ReferenceTableSourceType(arg: ModelComposed)

class ReferenceTableSourceType(*args, **kwargs)

Bases: ModelSimple

The source type for reference table data. Includes all possible source types that can appear in responses.

Parameters:

value (str) – Must be one of [“LOCAL_FILE”, “S3”, “GCS”, “AZURE”, “SERVICENOW”, “SALESFORCE”, “DATABRICKS”, “SNOWFLAKE”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.register_app_key_response module¶

class RegisterAppKeyResponse(arg: None)¶

class RegisterAppKeyResponse(arg: ModelComposed)

class RegisterAppKeyResponse(*args, **kwargs)

Bases: ModelNormal

The response object after creating an app key registration.

Parameters:: data (AppKeyRegistrationData, optional) – Data related to the app key registration.

datadog_api_client.v2.model.relation_attributes module¶

class RelationAttributes(arg: None)¶

class RelationAttributes(arg: ModelComposed)

class RelationAttributes(*args, **kwargs)

Bases: ModelNormal

Relation attributes.

Parameters:

_from (RelationEntity, optional) – Relation entity reference.
to (RelationEntity, optional) – Relation entity reference.
type (RelationType, optional) – Supported relation types.

datadog_api_client.v2.model.relation_entity module¶

class RelationEntity(arg: None)¶

class RelationEntity(arg: ModelComposed)

class RelationEntity(*args, **kwargs)

Bases: ModelNormal

Relation entity reference.

Parameters:

kind (str, optional) – Entity kind.
name (str, optional) – Entity name.
namespace (str, optional) – Entity namespace.

datadog_api_client.v2.model.relation_include_type module¶

class RelationIncludeType(arg: None)¶

class RelationIncludeType(arg: ModelComposed)

class RelationIncludeType(*args, **kwargs)

Bases: ModelSimple

Supported include types for relations.

Parameters:

value (str) – Must be one of [“entity”, “schema”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.relation_meta module¶

class RelationMeta(arg: None)¶

class RelationMeta(arg: ModelComposed)

class RelationMeta(*args, **kwargs)

Bases: ModelNormal

Relation metadata.

Parameters:

created_at (datetime, optional) – Relation creation time.
defined_by (str, optional) – Relation defined by.
modified_at (datetime, optional) – Relation modification time.
source (str, optional) – Relation source.

datadog_api_client.v2.model.relation_relationships module¶

class RelationRelationships(arg: None)¶

class RelationRelationships(arg: ModelComposed)

class RelationRelationships(*args, **kwargs)

Bases: ModelNormal

Relation relationships.

Parameters:

from_entity (RelationToEntity, optional) – Relation to entity.
to_entity (RelationToEntity, optional) – Relation to entity.

datadog_api_client.v2.model.relation_response module¶

class RelationResponse(arg: None)¶

class RelationResponse(arg: ModelComposed)

class RelationResponse(*args, **kwargs)

Bases: ModelNormal

Relation response data.

Parameters:

attributes (RelationAttributes, optional) – Relation attributes.
id (str, optional) – Relation ID.
meta (RelationMeta, optional) – Relation metadata.
relationships (RelationRelationships, optional) – Relation relationships.
subtype (str, optional) – Relation subtype.
type (RelationResponseType, optional) – Relation type.

datadog_api_client.v2.model.relation_response_meta module¶

class RelationResponseMeta(arg: None)¶

class RelationResponseMeta(arg: ModelComposed)

class RelationResponseMeta(*args, **kwargs)

Bases: ModelNormal

Relation response metadata.

Parameters:

count (int, optional) – Total relations count.
include_count (int, optional) – Total included data count.

datadog_api_client.v2.model.relation_response_type module¶

class RelationResponseType(arg: None)¶

class RelationResponseType(arg: ModelComposed)

class RelationResponseType(*args, **kwargs)

Bases: ModelSimple

Relation type.

Parameters:

value (str) – If omitted defaults to “relation”. Must be one of [“relation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.relation_to_entity module¶

class RelationToEntity(arg: None)¶

class RelationToEntity(arg: ModelComposed)

class RelationToEntity(*args, **kwargs)

Bases: ModelNormal

Relation to entity.

Parameters:

data (RelationshipItem, optional) – Relationship entry.
meta (EntityMeta, optional) – Entity metadata.

datadog_api_client.v2.model.relation_type module¶

class RelationType(arg: None)¶

class RelationType(arg: ModelComposed)

class RelationType(*args, **kwargs)

Bases: ModelSimple

Supported relation types.

Parameters:

value (str) – Must be one of [“RelationTypeOwns”, “RelationTypeOwnedBy”, “RelationTypeDependsOn”, “RelationTypeDependencyOf”, “RelationTypePartsOf”, “RelationTypeHasPart”, “RelationTypeOtherOwns”, “RelationTypeOtherOwnedBy”, “RelationTypeImplementedBy”, “RelationTypeImplements”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.relationship_item module¶

class RelationshipItem(arg: None)¶

class RelationshipItem(arg: ModelComposed)

class RelationshipItem(*args, **kwargs)

Bases: ModelNormal

Relationship entry.

Parameters:

id (str, optional) – Associated data ID.
type (str, optional) – Relationship type.

datadog_api_client.v2.model.relationship_to_incident module¶

class RelationshipToIncident(arg: None)¶

class RelationshipToIncident(arg: ModelComposed)

class RelationshipToIncident(*args, **kwargs)

Bases: ModelNormal

Relationship to incident.

Parameters:: data (RelationshipToIncidentData) – Relationship to incident object.

datadog_api_client.v2.model.relationship_to_incident_attachment module¶

class RelationshipToIncidentAttachment(arg: None)¶

class RelationshipToIncidentAttachment(arg: ModelComposed)

class RelationshipToIncidentAttachment(*args, **kwargs)

Bases: ModelNormal

A relationship reference for attachments.

Parameters:: data ([RelationshipToIncidentAttachmentData]) – An array of incident attachments.

datadog_api_client.v2.model.relationship_to_incident_attachment_data module¶

class RelationshipToIncidentAttachmentData(arg: None)¶

class RelationshipToIncidentAttachmentData(arg: ModelComposed)

class RelationshipToIncidentAttachmentData(*args, **kwargs)

Bases: ModelNormal

The attachment relationship data.

Parameters:

id (str) – A unique identifier that represents the attachment.
type (IncidentAttachmentType) – The incident attachment resource type.

datadog_api_client.v2.model.relationship_to_incident_data module¶

class RelationshipToIncidentData(arg: None)¶

class RelationshipToIncidentData(arg: ModelComposed)

class RelationshipToIncidentData(*args, **kwargs)

Bases: ModelNormal

Relationship to incident object.

Parameters:

id (str) – A unique identifier that represents the incident.
type (IncidentType) – Incident resource type.

datadog_api_client.v2.model.relationship_to_incident_impact_data module¶

class RelationshipToIncidentImpactData(arg: None)¶

class RelationshipToIncidentImpactData(arg: ModelComposed)

class RelationshipToIncidentImpactData(*args, **kwargs)

Bases: ModelNormal

Relationship to impact object.

Parameters:

id (str) – A unique identifier that represents the impact.
type (IncidentImpactsType) – The incident impacts type.

datadog_api_client.v2.model.relationship_to_incident_impacts module¶

class RelationshipToIncidentImpacts(arg: None)¶

class RelationshipToIncidentImpacts(arg: ModelComposed)

class RelationshipToIncidentImpacts(*args, **kwargs)

Bases: ModelNormal

Relationship to impacts.

Parameters:: data ([RelationshipToIncidentImpactData]) – An array of incident impacts.

datadog_api_client.v2.model.relationship_to_incident_integration_metadata_data module¶

class RelationshipToIncidentIntegrationMetadataData(arg: None)¶

class RelationshipToIncidentIntegrationMetadataData(arg: ModelComposed)

class RelationshipToIncidentIntegrationMetadataData(*args, **kwargs)

Bases: ModelNormal

A relationship reference for an integration metadata object.

Parameters:

id (str) – A unique identifier that represents the integration metadata.
type (IncidentIntegrationMetadataType) – Integration metadata resource type.

datadog_api_client.v2.model.relationship_to_incident_integration_metadatas module¶

class RelationshipToIncidentIntegrationMetadatas(arg: None)¶

class RelationshipToIncidentIntegrationMetadatas(arg: ModelComposed)

class RelationshipToIncidentIntegrationMetadatas(*args, **kwargs)

Bases: ModelNormal

A relationship reference for multiple integration metadata objects.

Parameters:: data ([RelationshipToIncidentIntegrationMetadataData]) – Integration metadata relationship array

datadog_api_client.v2.model.relationship_to_incident_notification_template module¶

class RelationshipToIncidentNotificationTemplate(arg: None)¶

class RelationshipToIncidentNotificationTemplate(arg: ModelComposed)

class RelationshipToIncidentNotificationTemplate(*args, **kwargs)

Bases: ModelNormal

A relationship reference to a notification template.

Parameters:: data (RelationshipToIncidentNotificationTemplateData) – The notification template relationship data.

datadog_api_client.v2.model.relationship_to_incident_notification_template_data module¶

class RelationshipToIncidentNotificationTemplateData(arg: None)¶

class RelationshipToIncidentNotificationTemplateData(arg: ModelComposed)

class RelationshipToIncidentNotificationTemplateData(*args, **kwargs)

Bases: ModelNormal

The notification template relationship data.

Parameters:

id (UUID) – The unique identifier of the notification template.
type (IncidentNotificationTemplateType) – Notification templates resource type.

datadog_api_client.v2.model.relationship_to_incident_postmortem module¶

class RelationshipToIncidentPostmortem(arg: None)¶

class RelationshipToIncidentPostmortem(arg: ModelComposed)

class RelationshipToIncidentPostmortem(*args, **kwargs)

Bases: ModelNormal

A relationship reference for postmortems.

Parameters:: data (RelationshipToIncidentPostmortemData) – The postmortem relationship data.

datadog_api_client.v2.model.relationship_to_incident_postmortem_data module¶

class RelationshipToIncidentPostmortemData(arg: None)¶

class RelationshipToIncidentPostmortemData(arg: ModelComposed)

class RelationshipToIncidentPostmortemData(*args, **kwargs)

Bases: ModelNormal

The postmortem relationship data.

Parameters:

id (str) – A unique identifier that represents the postmortem.
type (IncidentPostmortemType) – Incident postmortem resource type.

datadog_api_client.v2.model.relationship_to_incident_responder_data module¶

class RelationshipToIncidentResponderData(arg: None)¶

class RelationshipToIncidentResponderData(arg: ModelComposed)

class RelationshipToIncidentResponderData(*args, **kwargs)

Bases: ModelNormal

Relationship to impact object.

Parameters:

id (str) – A unique identifier that represents the responder.
type (IncidentRespondersType) – The incident responders type.

datadog_api_client.v2.model.relationship_to_incident_responders module¶

class RelationshipToIncidentResponders(arg: None)¶

class RelationshipToIncidentResponders(arg: ModelComposed)

class RelationshipToIncidentResponders(*args, **kwargs)

Bases: ModelNormal

Relationship to incident responders.

Parameters:: data ([RelationshipToIncidentResponderData]) – An array of incident responders.

datadog_api_client.v2.model.relationship_to_incident_type module¶

class RelationshipToIncidentType(arg: None)¶

class RelationshipToIncidentType(arg: ModelComposed)

class RelationshipToIncidentType(*args, **kwargs)

Bases: ModelNormal

Relationship to an incident type.

Parameters:: data (RelationshipToIncidentTypeData) – Relationship to incident type object.

datadog_api_client.v2.model.relationship_to_incident_type_data module¶

class RelationshipToIncidentTypeData(arg: None)¶

class RelationshipToIncidentTypeData(arg: ModelComposed)

class RelationshipToIncidentTypeData(*args, **kwargs)

Bases: ModelNormal

Relationship to incident type object.

Parameters:

id (str) – The incident type’s ID.
type (IncidentTypeType) – Incident type resource type.

datadog_api_client.v2.model.relationship_to_incident_user_defined_field_data module¶

class RelationshipToIncidentUserDefinedFieldData(arg: None)¶

class RelationshipToIncidentUserDefinedFieldData(arg: ModelComposed)

class RelationshipToIncidentUserDefinedFieldData(*args, **kwargs)

Bases: ModelNormal

Relationship to impact object.

Parameters:

id (str) – A unique identifier that represents the responder.
type (IncidentUserDefinedFieldType) – The incident user defined fields type.

datadog_api_client.v2.model.relationship_to_incident_user_defined_fields module¶

class RelationshipToIncidentUserDefinedFields(arg: None)¶

class RelationshipToIncidentUserDefinedFields(arg: ModelComposed)

class RelationshipToIncidentUserDefinedFields(*args, **kwargs)

Bases: ModelNormal

Relationship to incident user defined fields.

Parameters:: data ([RelationshipToIncidentUserDefinedFieldData]) – An array of user defined fields.

datadog_api_client.v2.model.relationship_to_organization module¶

class RelationshipToOrganization(arg: None)¶

class RelationshipToOrganization(arg: ModelComposed)

class RelationshipToOrganization(*args, **kwargs)

Bases: ModelNormal

Relationship to an organization.

Parameters:: data (RelationshipToOrganizationData) – Relationship to organization object.

datadog_api_client.v2.model.relationship_to_organization_data module¶

class RelationshipToOrganizationData(arg: None)¶

class RelationshipToOrganizationData(arg: ModelComposed)

class RelationshipToOrganizationData(*args, **kwargs)

Bases: ModelNormal

Relationship to organization object.

Parameters:

id (str) – ID of the organization.
type (OrganizationsType) – Organizations resource type.

datadog_api_client.v2.model.relationship_to_organizations module¶

class RelationshipToOrganizations(arg: None)¶

class RelationshipToOrganizations(arg: ModelComposed)

class RelationshipToOrganizations(*args, **kwargs)

Bases: ModelNormal

Relationship to organizations.

Parameters:: data ([RelationshipToOrganizationData]) – Relationships to organization objects.

datadog_api_client.v2.model.relationship_to_outcome module¶

class RelationshipToOutcome(arg: None)¶

class RelationshipToOutcome(arg: ModelComposed)

class RelationshipToOutcome(*args, **kwargs)

Bases: ModelNormal

The JSON:API relationship to a scorecard outcome.

Parameters:: data (RelationshipToOutcomeData, optional) – The JSON:API relationship to an outcome, which returns the related rule id.

datadog_api_client.v2.model.relationship_to_outcome_data module¶

class RelationshipToOutcomeData(arg: None)¶

class RelationshipToOutcomeData(arg: ModelComposed)

class RelationshipToOutcomeData(*args, **kwargs)

Bases: ModelNormal

The JSON:API relationship to an outcome, which returns the related rule id.

Parameters:

id (str, optional) – The unique ID for a scorecard rule.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.relationship_to_permission module¶

class RelationshipToPermission(arg: None)¶

class RelationshipToPermission(arg: ModelComposed)

class RelationshipToPermission(*args, **kwargs)

Bases: ModelNormal

Relationship to a permissions object.

Parameters:: data (RelationshipToPermissionData, optional) – Relationship to permission object.

datadog_api_client.v2.model.relationship_to_permission_data module¶

class RelationshipToPermissionData(arg: None)¶

class RelationshipToPermissionData(arg: ModelComposed)

class RelationshipToPermissionData(*args, **kwargs)

Bases: ModelNormal

Relationship to permission object.

Parameters:

id (str, optional) – ID of the permission.
type (PermissionsType, optional) – Permissions resource type.

datadog_api_client.v2.model.relationship_to_permissions module¶

class RelationshipToPermissions(arg: None)¶

class RelationshipToPermissions(arg: ModelComposed)

class RelationshipToPermissions(*args, **kwargs)

Bases: ModelNormal

Relationship to multiple permissions objects.

Parameters:: data ([RelationshipToPermissionData], optional) – Relationships to permission objects.

datadog_api_client.v2.model.relationship_to_role module¶

class RelationshipToRole(arg: None)¶

class RelationshipToRole(arg: ModelComposed)

class RelationshipToRole(*args, **kwargs)

Bases: ModelNormal

Relationship to role.

Parameters:: data (RelationshipToRoleData, optional) – Relationship to role object.

datadog_api_client.v2.model.relationship_to_role_data module¶

class RelationshipToRoleData(arg: None)¶

class RelationshipToRoleData(arg: ModelComposed)

class RelationshipToRoleData(*args, **kwargs)

Bases: ModelNormal

Relationship to role object.

Parameters:

id (str, optional) – The unique identifier of the role.
type (RolesType, optional) – Roles type.

datadog_api_client.v2.model.relationship_to_roles module¶

class RelationshipToRoles(arg: None)¶

class RelationshipToRoles(arg: ModelComposed)

class RelationshipToRoles(*args, **kwargs)

Bases: ModelNormal

Relationship to roles.

Parameters:: data ([RelationshipToRoleData], optional) – An array containing type and the unique identifier of a role.

datadog_api_client.v2.model.relationship_to_rule module¶

class RelationshipToRule(arg: None)¶

class RelationshipToRule(arg: ModelComposed)

class RelationshipToRule(*args, **kwargs)

Bases: ModelNormal

Scorecard create rule response relationship.

Parameters:: scorecard (RelationshipToRuleData, optional) – Relationship data for a rule.

datadog_api_client.v2.model.relationship_to_rule_data module¶

class RelationshipToRuleData(arg: None)¶

class RelationshipToRuleData(arg: ModelComposed)

class RelationshipToRuleData(*args, **kwargs)

Bases: ModelNormal

Relationship data for a rule.

Parameters:: data (RelationshipToRuleDataObject, optional) – Rule relationship data.

datadog_api_client.v2.model.relationship_to_rule_data_object module¶

class RelationshipToRuleDataObject(arg: None)¶

class RelationshipToRuleDataObject(arg: ModelComposed)

class RelationshipToRuleDataObject(*args, **kwargs)

Bases: ModelNormal

Rule relationship data.

Parameters:

id (str, optional) – The unique ID for a scorecard.
type (ScorecardType, optional) – The JSON:API type for scorecard.

datadog_api_client.v2.model.relationship_to_saml_assertion_attribute module¶

class RelationshipToSAMLAssertionAttribute(arg: None)¶

class RelationshipToSAMLAssertionAttribute(arg: ModelComposed)

class RelationshipToSAMLAssertionAttribute(*args, **kwargs)

Bases: ModelNormal

AuthN Mapping relationship to SAML Assertion Attribute.

Parameters:: data (RelationshipToSAMLAssertionAttributeData) – Data of AuthN Mapping relationship to SAML Assertion Attribute.

datadog_api_client.v2.model.relationship_to_saml_assertion_attribute_data module¶

class RelationshipToSAMLAssertionAttributeData(arg: None)¶

class RelationshipToSAMLAssertionAttributeData(arg: ModelComposed)

class RelationshipToSAMLAssertionAttributeData(*args, **kwargs)

Bases: ModelNormal

Data of AuthN Mapping relationship to SAML Assertion Attribute.

Parameters:

id (str) – The ID of the SAML assertion attribute.
type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.

datadog_api_client.v2.model.relationship_to_team module¶

class RelationshipToTeam(arg: None)¶

class RelationshipToTeam(arg: ModelComposed)

class RelationshipToTeam(*args, **kwargs)

Bases: ModelNormal

Relationship to team.

Parameters:: data (RelationshipToTeamData, optional) – Relationship to Team object.

datadog_api_client.v2.model.relationship_to_team_data module¶

class RelationshipToTeamData(arg: None)¶

class RelationshipToTeamData(arg: ModelComposed)

class RelationshipToTeamData(*args, **kwargs)

Bases: ModelNormal

Relationship to Team object.

Parameters:

id (str, optional) – The unique identifier of the team.
type (TeamType, optional) – Team type

datadog_api_client.v2.model.relationship_to_team_link_data module¶

class RelationshipToTeamLinkData(arg: None)¶

class RelationshipToTeamLinkData(arg: ModelComposed)

class RelationshipToTeamLinkData(*args, **kwargs)

Bases: ModelNormal

Relationship between a link and a team

Parameters:

id (str) – The team link’s identifier
type (TeamLinkType) – Team link type

datadog_api_client.v2.model.relationship_to_team_links module¶

class RelationshipToTeamLinks(arg: None)¶

class RelationshipToTeamLinks(arg: ModelComposed)

class RelationshipToTeamLinks(*args, **kwargs)

Bases: ModelNormal

Relationship between a team and a team link

Parameters:

data ([RelationshipToTeamLinkData], optional) – Related team links
links (TeamRelationshipsLinks, optional) – Links attributes.

datadog_api_client.v2.model.relationship_to_user module¶

class RelationshipToUser(arg: None)¶

class RelationshipToUser(arg: ModelComposed)

class RelationshipToUser(*args, **kwargs)

Bases: ModelNormal

Relationship to user.

Parameters:: data (RelationshipToUserData) – Relationship to user object.

datadog_api_client.v2.model.relationship_to_user_data module¶

class RelationshipToUserData(arg: None)¶

class RelationshipToUserData(arg: ModelComposed)

class RelationshipToUserData(*args, **kwargs)

Bases: ModelNormal

Relationship to user object.

Parameters:

id (str) – A unique identifier that represents the user.
type (UsersType) – Users resource type.

datadog_api_client.v2.model.relationship_to_user_team_permission module¶

class RelationshipToUserTeamPermission(arg: None)¶

class RelationshipToUserTeamPermission(arg: ModelComposed)

class RelationshipToUserTeamPermission(*args, **kwargs)

Bases: ModelNormal

Relationship between a user team permission and a team

Parameters:

data (RelationshipToUserTeamPermissionData, optional) – Related user team permission data
links (TeamRelationshipsLinks, optional) – Links attributes.

datadog_api_client.v2.model.relationship_to_user_team_permission_data module¶

class RelationshipToUserTeamPermissionData(arg: None)¶

class RelationshipToUserTeamPermissionData(arg: ModelComposed)

class RelationshipToUserTeamPermissionData(*args, **kwargs)

Bases: ModelNormal

Related user team permission data

Parameters:

id (str) – The ID of the user team permission
type (UserTeamPermissionType) – User team permission type

datadog_api_client.v2.model.relationship_to_user_team_team module¶

class RelationshipToUserTeamTeam(arg: None)¶

class RelationshipToUserTeamTeam(arg: ModelComposed)

class RelationshipToUserTeamTeam(*args, **kwargs)

Bases: ModelNormal

Relationship between team membership and team

Parameters:: data (RelationshipToUserTeamTeamData) – The team associated with the membership

datadog_api_client.v2.model.relationship_to_user_team_team_data module¶

class RelationshipToUserTeamTeamData(arg: None)¶

class RelationshipToUserTeamTeamData(arg: ModelComposed)

class RelationshipToUserTeamTeamData(*args, **kwargs)

Bases: ModelNormal

The team associated with the membership

Parameters:

id (str) – The ID of the team associated with the membership
type (UserTeamTeamType) – User team team type

datadog_api_client.v2.model.relationship_to_user_team_user module¶

class RelationshipToUserTeamUser(arg: None)¶

class RelationshipToUserTeamUser(arg: ModelComposed)

class RelationshipToUserTeamUser(*args, **kwargs)

Bases: ModelNormal

Relationship between team membership and user

Parameters:: data (RelationshipToUserTeamUserData) – A user’s relationship with a team

datadog_api_client.v2.model.relationship_to_user_team_user_data module¶

class RelationshipToUserTeamUserData(arg: None)¶

class RelationshipToUserTeamUserData(arg: ModelComposed)

class RelationshipToUserTeamUserData(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

id (str) – The ID of the user associated with the team
type (UserTeamUserType) – User team user type

datadog_api_client.v2.model.relationship_to_users module¶

class RelationshipToUsers(arg: None)¶

class RelationshipToUsers(arg: ModelComposed)

class RelationshipToUsers(*args, **kwargs)

Bases: ModelNormal

Relationship to users.

Parameters:: data ([RelationshipToUserData]) – Relationships to user objects.

datadog_api_client.v2.model.remediation module¶

class Remediation(arg: None)¶

class Remediation(arg: ModelComposed)

class Remediation(*args, **kwargs)

Bases: ModelNormal

Vulnerability remediation.

Parameters:

auto_solvable (bool) – Whether the vulnerability can be resolved when recompiling the package or not.
avoided_advisories ([Advisory]) – Avoided advisories.
fixed_advisories ([Advisory]) – Remediation fixed advisories.
library_name (str) – Library name remediating the vulnerability.
library_version (str) – Library version remediating the vulnerability.
new_advisories ([Advisory]) – New advisories.
remaining_advisories ([Advisory]) – Remaining advisories.
type (str) – Remediation type.

datadog_api_client.v2.model.reorder_retention_filters_request module¶

class ReorderRetentionFiltersRequest(arg: None)¶

class ReorderRetentionFiltersRequest(arg: ModelComposed)

class ReorderRetentionFiltersRequest(*args, **kwargs)

Bases: ModelNormal

A list of retention filters to reorder.

Parameters:: data ([RetentionFilterWithoutAttributes]) – A list of retention filters objects.

datadog_api_client.v2.model.reorder_rule_resource_array module¶

class ReorderRuleResourceArray(arg: None)¶

class ReorderRuleResourceArray(arg: ModelComposed)

class ReorderRuleResourceArray(*args, **kwargs)

Bases: ModelNormal

The definition of ReorderRuleResourceArray object.

Parameters:: data ([ReorderRuleResourceData]) – The ReorderRuleResourceArray data.

datadog_api_client.v2.model.reorder_rule_resource_data module¶

class ReorderRuleResourceData(arg: None)¶

class ReorderRuleResourceData(arg: ModelComposed)

class ReorderRuleResourceData(*args, **kwargs)

Bases: ModelNormal

The definition of ReorderRuleResourceData object.

Parameters:

id (str, optional) – The ReorderRuleResourceData id.
type (ReorderRuleResourceDataType) – Arbitrary rule resource type.

datadog_api_client.v2.model.reorder_rule_resource_data_type module¶

class ReorderRuleResourceDataType(arg: None)¶

class ReorderRuleResourceDataType(arg: ModelComposed)

class ReorderRuleResourceDataType(*args, **kwargs)

Bases: ModelSimple

Arbitrary rule resource type.

Parameters:

value (str) – If omitted defaults to “arbitrary_rule”. Must be one of [“arbitrary_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.reorder_ruleset_resource_array module¶

class ReorderRulesetResourceArray(arg: None)¶

class ReorderRulesetResourceArray(arg: ModelComposed)

class ReorderRulesetResourceArray(*args, **kwargs)

Bases: ModelNormal

The definition of ReorderRulesetResourceArray object.

Parameters:: data ([ReorderRulesetResourceData]) – The ReorderRulesetResourceArray data.

datadog_api_client.v2.model.reorder_ruleset_resource_data module¶

class ReorderRulesetResourceData(arg: None)¶

class ReorderRulesetResourceData(arg: ModelComposed)

class ReorderRulesetResourceData(*args, **kwargs)

Bases: ModelNormal

The definition of ReorderRulesetResourceData object.

Parameters:

id (str, optional) – The ReorderRulesetResourceData id.
type (ReorderRulesetResourceDataType) – Ruleset resource type.

datadog_api_client.v2.model.reorder_ruleset_resource_data_type module¶

class ReorderRulesetResourceDataType(arg: None)¶

class ReorderRulesetResourceDataType(arg: ModelComposed)

class ReorderRulesetResourceDataType(*args, **kwargs)

Bases: ModelSimple

Ruleset resource type.

Parameters:

value (str) – If omitted defaults to “ruleset”. Must be one of [“ruleset”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.resolve_vulnerable_symbols_request module¶

class ResolveVulnerableSymbolsRequest(arg: None)¶

class ResolveVulnerableSymbolsRequest(arg: ModelComposed)

class ResolveVulnerableSymbolsRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (ResolveVulnerableSymbolsRequestData, optional)

datadog_api_client.v2.model.resolve_vulnerable_symbols_request_data module¶

class ResolveVulnerableSymbolsRequestData(arg: None)¶

class ResolveVulnerableSymbolsRequestData(arg: ModelComposed)

class ResolveVulnerableSymbolsRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (ResolveVulnerableSymbolsRequestDataAttributes, optional)
id (str, optional)
type (ResolveVulnerableSymbolsRequestDataType)

datadog_api_client.v2.model.resolve_vulnerable_symbols_request_data_attributes module¶

class ResolveVulnerableSymbolsRequestDataAttributes(arg: None)¶

class ResolveVulnerableSymbolsRequestDataAttributes(arg: ModelComposed)

class ResolveVulnerableSymbolsRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:: purls ([str], optional)

datadog_api_client.v2.model.resolve_vulnerable_symbols_request_data_type module¶

class ResolveVulnerableSymbolsRequestDataType(arg: None)¶

class ResolveVulnerableSymbolsRequestDataType(arg: ModelComposed)

class ResolveVulnerableSymbolsRequestDataType(*args, **kwargs)

Bases: ModelSimple

Parameters:

value (str) – If omitted defaults to “resolve-vulnerable-symbols-request”. Must be one of [“resolve-vulnerable-symbols-request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.resolve_vulnerable_symbols_response module¶

class ResolveVulnerableSymbolsResponse(arg: None)¶

class ResolveVulnerableSymbolsResponse(arg: ModelComposed)

class ResolveVulnerableSymbolsResponse(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (ResolveVulnerableSymbolsResponseData, optional)

datadog_api_client.v2.model.resolve_vulnerable_symbols_response_data module¶

class ResolveVulnerableSymbolsResponseData(arg: None)¶

class ResolveVulnerableSymbolsResponseData(arg: ModelComposed)

class ResolveVulnerableSymbolsResponseData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (ResolveVulnerableSymbolsResponseDataAttributes, optional)
id (str, optional)
type (ResolveVulnerableSymbolsResponseDataType)

datadog_api_client.v2.model.resolve_vulnerable_symbols_response_data_attributes module¶

class ResolveVulnerableSymbolsResponseDataAttributes(arg: None)¶

class ResolveVulnerableSymbolsResponseDataAttributes(arg: ModelComposed)

class ResolveVulnerableSymbolsResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:: results ([ResolveVulnerableSymbolsResponseResults], optional)

datadog_api_client.v2.model.resolve_vulnerable_symbols_response_data_type module¶

class ResolveVulnerableSymbolsResponseDataType(arg: None)¶

class ResolveVulnerableSymbolsResponseDataType(arg: ModelComposed)

class ResolveVulnerableSymbolsResponseDataType(*args, **kwargs)

Bases: ModelSimple

Parameters:

value (str) – If omitted defaults to “resolve-vulnerable-symbols-response”. Must be one of [“resolve-vulnerable-symbols-response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.resolve_vulnerable_symbols_response_results module¶

class ResolveVulnerableSymbolsResponseResults(arg: None)¶

class ResolveVulnerableSymbolsResponseResults(arg: ModelComposed)

class ResolveVulnerableSymbolsResponseResults(*args, **kwargs)

Bases: ModelNormal

Parameters:

purl (str, optional)
vulnerable_symbols ([ResolveVulnerableSymbolsResponseResultsVulnerableSymbols], optional)

datadog_api_client.v2.model.resolve_vulnerable_symbols_response_results_vulnerable_symbols module¶

class ResolveVulnerableSymbolsResponseResultsVulnerableSymbols(arg: None)¶

class ResolveVulnerableSymbolsResponseResultsVulnerableSymbols(arg: ModelComposed)

class ResolveVulnerableSymbolsResponseResultsVulnerableSymbols(*args, **kwargs)

Bases: ModelNormal

Parameters:

advisory_id (str, optional)
symbols ([ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols], optional)

datadog_api_client.v2.model.resolve_vulnerable_symbols_response_results_vulnerable_symbols_symbols module¶

class ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols(arg: None)¶

class ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols(arg: ModelComposed)

class ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols(*args, **kwargs)

Bases: ModelNormal

Parameters:

name (str, optional)
type (str, optional)
value (str, optional)

datadog_api_client.v2.model.resource_filter_attributes module¶

class ResourceFilterAttributes(arg: None)¶

class ResourceFilterAttributes(arg: ModelComposed)

class ResourceFilterAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a resource filter.

Parameters:

cloud_provider ({str: ({str: ([str],)},)}) – A map of cloud provider names (e.g., “aws”, “gcp”, “azure”) to a map of account/resource IDs and their associated tag filters.
uuid (str, optional) – The UUID of the resource filter.

datadog_api_client.v2.model.resource_filter_request_type module¶

class ResourceFilterRequestType(arg: None)¶

class ResourceFilterRequestType(arg: ModelComposed)

class ResourceFilterRequestType(*args, **kwargs)

Bases: ModelSimple

Constant string to identify the request type.

Parameters:

value (str) – If omitted defaults to “csm_resource_filter”. Must be one of [“csm_resource_filter”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.response_meta_attributes module¶

class ResponseMetaAttributes(arg: None)¶

class ResponseMetaAttributes(arg: ModelComposed)

class ResponseMetaAttributes(*args, **kwargs)

Bases: ModelNormal

Object describing meta attributes of response.

Parameters:: page (Pagination, optional) – Pagination object.

datadog_api_client.v2.model.restriction_policy module¶

class RestrictionPolicy(arg: None)¶

class RestrictionPolicy(arg: ModelComposed)

class RestrictionPolicy(*args, **kwargs)

Bases: ModelNormal

Restriction policy object.

Parameters:

attributes (RestrictionPolicyAttributes) – Restriction policy attributes.
id (str) – The identifier, always equivalent to the value specified in the resource_id path parameter.
type (RestrictionPolicyType) – Restriction policy type.

datadog_api_client.v2.model.restriction_policy_attributes module¶

class RestrictionPolicyAttributes(arg: None)¶

class RestrictionPolicyAttributes(arg: ModelComposed)

class RestrictionPolicyAttributes(*args, **kwargs)

Bases: ModelNormal

Restriction policy attributes.

Parameters:: bindings ([RestrictionPolicyBinding]) – An array of bindings.

datadog_api_client.v2.model.restriction_policy_binding module¶

class RestrictionPolicyBinding(arg: None)¶

class RestrictionPolicyBinding(arg: ModelComposed)

class RestrictionPolicyBinding(*args, **kwargs)

Bases: ModelNormal

Specifies which principals are associated with a relation.

Parameters:

principals ([str]) – An array of principals. A principal is a subject or group of subjects. Each principal is formatted as type:id. Supported types: role , team , user , and org. The org ID can be obtained through the api/v2/current_user API. The user principal type accepts service account IDs.
relation (str) – The role/level of access.

datadog_api_client.v2.model.restriction_policy_response module¶

class RestrictionPolicyResponse(arg: None)¶

class RestrictionPolicyResponse(arg: ModelComposed)

class RestrictionPolicyResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a single restriction policy.

Parameters:: data (RestrictionPolicy) – Restriction policy object.

datadog_api_client.v2.model.restriction_policy_type module¶

class RestrictionPolicyType(arg: None)¶

class RestrictionPolicyType(arg: ModelComposed)

class RestrictionPolicyType(*args, **kwargs)

Bases: ModelSimple

Restriction policy type.

Parameters:

value (str) – If omitted defaults to “restriction_policy”. Must be one of [“restriction_policy”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.restriction_policy_update_request module¶

class RestrictionPolicyUpdateRequest(arg: None)¶

class RestrictionPolicyUpdateRequest(arg: ModelComposed)

class RestrictionPolicyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for a restriction policy.

Parameters:: data (RestrictionPolicy) – Restriction policy object.

datadog_api_client.v2.model.retention_filter module¶

class RetentionFilter(arg: None)¶

class RetentionFilter(arg: ModelComposed)

class RetentionFilter(*args, **kwargs)

Bases: ModelNormal

The definition of the retention filter.

Parameters:

attributes (RetentionFilterAttributes) – The attributes of the retention filter.
id (str) – The ID of the retention filter.
type (ApmRetentionFilterType) – The type of the resource.

datadog_api_client.v2.model.retention_filter_all module¶

class RetentionFilterAll(arg: None)¶

class RetentionFilterAll(arg: ModelComposed)

class RetentionFilterAll(*args, **kwargs)

Bases: ModelNormal

The definition of the retention filter.

Parameters:

attributes (RetentionFilterAllAttributes) – The attributes of the retention filter.
id (str) – The ID of the retention filter.
type (ApmRetentionFilterType) – The type of the resource.

datadog_api_client.v2.model.retention_filter_all_attributes module¶

class RetentionFilterAllAttributes(arg: None)¶

class RetentionFilterAllAttributes(arg: ModelComposed)

class RetentionFilterAllAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the retention filter.

Parameters:

created_at (int, optional) – The creation timestamp of the retention filter.
created_by (str, optional) – The creator of the retention filter.
editable (bool, optional) – Shows whether the filter can be edited.
enabled (bool, optional) – The status of the retention filter (Enabled/Disabled).
execution_order (int, optional) – The execution order of the retention filter.
filter (SpansFilter, optional) – The spans filter used to index spans.
filter_type (RetentionFilterAllType, optional) – The type of retention filter.
modified_at (int, optional) – The modification timestamp of the retention filter.
modified_by (str, optional) – The modifier of the retention filter.
name (str, optional) – The name of the retention filter.
rate (float, optional) – Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.
trace_rate (float, optional) – Sample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.

datadog_api_client.v2.model.retention_filter_all_type module¶

class RetentionFilterAllType(arg: None)¶

class RetentionFilterAllType(arg: ModelComposed)

class RetentionFilterAllType(*args, **kwargs)

Bases: ModelSimple

The type of retention filter.

Parameters:

value (str) – If omitted defaults to “spans-sampling-processor”. Must be one of [“spans-sampling-processor”, “spans-errors-sampling-processor”, “spans-appsec-sampling-processor”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.retention_filter_attributes module¶

class RetentionFilterAttributes(arg: None)¶

class RetentionFilterAttributes(arg: ModelComposed)

class RetentionFilterAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the retention filter.

Parameters:

created_at (int, optional) – The creation timestamp of the retention filter.
created_by (str, optional) – The creator of the retention filter.
editable (bool, optional) – Shows whether the filter can be edited.
enabled (bool, optional) – The status of the retention filter (Enabled/Disabled).
execution_order (int, optional) – The execution order of the retention filter.
filter (SpansFilter, optional) – The spans filter used to index spans.
filter_type (RetentionFilterType, optional) – The type of retention filter. The value should always be spans-sampling-processor.
modified_at (int, optional) – The modification timestamp of the retention filter.
modified_by (str, optional) – The modifier of the retention filter.
name (str, optional) – The name of the retention filter.
rate (float, optional) – Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.
trace_rate (float, optional) – Sample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.

datadog_api_client.v2.model.retention_filter_create_attributes module¶

class RetentionFilterCreateAttributes(arg: None)¶

class RetentionFilterCreateAttributes(arg: ModelComposed)

class RetentionFilterCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing the configuration of the retention filter to create/update.

Parameters:

enabled (bool) – Enable/Disable the retention filter.
filter (SpansFilterCreate) – The spans filter. Spans matching this filter will be indexed and stored.
filter_type (RetentionFilterType) – The type of retention filter. The value should always be spans-sampling-processor.
name (str) – The name of the retention filter.
rate (float) – Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.
trace_rate (float, optional) – Sample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.

datadog_api_client.v2.model.retention_filter_create_data module¶

class RetentionFilterCreateData(arg: None)¶

class RetentionFilterCreateData(arg: ModelComposed)

class RetentionFilterCreateData(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be created.

Parameters:

attributes (RetentionFilterCreateAttributes) – The object describing the configuration of the retention filter to create/update.
type (ApmRetentionFilterType) – The type of the resource.

datadog_api_client.v2.model.retention_filter_create_request module¶

class RetentionFilterCreateRequest(arg: None)¶

class RetentionFilterCreateRequest(arg: ModelComposed)

class RetentionFilterCreateRequest(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be created.

Parameters:: data (RetentionFilterCreateData) – The body of the retention filter to be created.

datadog_api_client.v2.model.retention_filter_create_response module¶

class RetentionFilterCreateResponse(arg: None)¶

class RetentionFilterCreateResponse(arg: ModelComposed)

class RetentionFilterCreateResponse(*args, **kwargs)

Bases: ModelNormal

The retention filters definition.

Parameters:: data (RetentionFilter, optional) – The definition of the retention filter.

datadog_api_client.v2.model.retention_filter_response module¶

class RetentionFilterResponse(arg: None)¶

class RetentionFilterResponse(arg: ModelComposed)

class RetentionFilterResponse(*args, **kwargs)

Bases: ModelNormal

The retention filters definition.

Parameters:: data (RetentionFilterAll, optional) – The definition of the retention filter.

datadog_api_client.v2.model.retention_filter_type module¶

class RetentionFilterType(arg: None)¶

class RetentionFilterType(arg: ModelComposed)

class RetentionFilterType(*args, **kwargs)

Bases: ModelSimple

The type of retention filter. The value should always be spans-sampling-processor.

Parameters:

value (str) – If omitted defaults to “spans-sampling-processor”. Must be one of [“spans-sampling-processor”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.retention_filter_update_attributes module¶

class RetentionFilterUpdateAttributes(arg: None)¶

class RetentionFilterUpdateAttributes(arg: ModelComposed)

class RetentionFilterUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing the configuration of the retention filter to create/update.

Parameters:

enabled (bool) – Enable/Disable the retention filter.
filter (SpansFilterCreate) – The spans filter. Spans matching this filter will be indexed and stored.
filter_type (RetentionFilterAllType) – The type of retention filter.
name (str) – The name of the retention filter.
rate (float) – Sample rate to apply to spans going through this retention filter. A value of 1.0 keeps all spans matching the query.
trace_rate (float, optional) – Sample rate to apply to traces containing spans going through this retention filter. A value of 1.0 keeps all traces with spans matching the query.

datadog_api_client.v2.model.retention_filter_update_data module¶

class RetentionFilterUpdateData(arg: None)¶

class RetentionFilterUpdateData(arg: ModelComposed)

class RetentionFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be updated.

Parameters:

attributes (RetentionFilterUpdateAttributes) – The object describing the configuration of the retention filter to create/update.
id (str) – The ID of the retention filter.
type (ApmRetentionFilterType) – The type of the resource.

datadog_api_client.v2.model.retention_filter_update_request module¶

class RetentionFilterUpdateRequest(arg: None)¶

class RetentionFilterUpdateRequest(arg: ModelComposed)

class RetentionFilterUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be updated.

Parameters:: data (RetentionFilterUpdateData) – The body of the retention filter to be updated.

datadog_api_client.v2.model.retention_filter_without_attributes module¶

class RetentionFilterWithoutAttributes(arg: None)¶

class RetentionFilterWithoutAttributes(arg: ModelComposed)

class RetentionFilterWithoutAttributes(*args, **kwargs)

Bases: ModelNormal

The retention filter object .

Parameters:

id (str) – The ID of the retention filter.
type (ApmRetentionFilterType) – The type of the resource.

datadog_api_client.v2.model.retention_filters_response module¶

class RetentionFiltersResponse(arg: None)¶

class RetentionFiltersResponse(arg: ModelComposed)

class RetentionFiltersResponse(*args, **kwargs)

Bases: ModelNormal

An ordered list of retention filters.

Parameters:: data ([RetentionFilterAll]) – A list of retention filters objects.

datadog_api_client.v2.model.retry_strategy module¶

class RetryStrategy(arg: None)¶

class RetryStrategy(arg: ModelComposed)

class RetryStrategy(*args, **kwargs)

Bases: ModelNormal

The definition of RetryStrategy object.

Parameters:

kind (RetryStrategyKind) – The definition of RetryStrategyKind object.
linear (RetryStrategyLinear, optional) – The definition of RetryStrategyLinear object.

datadog_api_client.v2.model.retry_strategy_kind module¶

class RetryStrategyKind(arg: None)¶

class RetryStrategyKind(arg: ModelComposed)

class RetryStrategyKind(*args, **kwargs)

Bases: ModelSimple

The definition of RetryStrategyKind object.

Parameters:

value (str) – If omitted defaults to “RETRY_STRATEGY_LINEAR”. Must be one of [“RETRY_STRATEGY_LINEAR”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.retry_strategy_linear module¶

class RetryStrategyLinear(arg: None)¶

class RetryStrategyLinear(arg: ModelComposed)

class RetryStrategyLinear(*args, **kwargs)

Bases: ModelNormal

The definition of RetryStrategyLinear object.

Parameters:

interval (str) – The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
max_retries (float) – The RetryStrategyLinear maxRetries.

datadog_api_client.v2.model.role module¶

class Role(arg: None)¶

class Role(arg: ModelComposed)

class Role(*args, **kwargs)

Bases: ModelNormal

Role object returned by the API.

Parameters:

attributes (RoleAttributes, optional) – Attributes of the role.
id (str, optional) – The unique identifier of the role.
relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.
type (RolesType) – Roles type.

datadog_api_client.v2.model.role_attributes module¶

class RoleAttributes(arg: None)¶

class RoleAttributes(arg: ModelComposed)

class RoleAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the role.

Parameters:

created_at (datetime, optional) – Creation time of the role.
modified_at (datetime, optional) – Time of last role modification.
name (str, optional) – The name of the role. The name is neither unique nor a stable identifier of the role.
user_count (int, optional) – Number of users with that role.

datadog_api_client.v2.model.role_clone module¶

class RoleClone(arg: None)¶

class RoleClone(arg: ModelComposed)

class RoleClone(*args, **kwargs)

Bases: ModelNormal

Data for the clone role request.

Parameters:

attributes (RoleCloneAttributes) – Attributes required to create a new role by cloning an existing one.
type (RolesType) – Roles type.

datadog_api_client.v2.model.role_clone_attributes module¶

class RoleCloneAttributes(arg: None)¶

class RoleCloneAttributes(arg: ModelComposed)

class RoleCloneAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes required to create a new role by cloning an existing one.

Parameters:: name (str) – Name of the new role that is cloned.

datadog_api_client.v2.model.role_clone_request module¶

class RoleCloneRequest(arg: None)¶

class RoleCloneRequest(arg: ModelComposed)

class RoleCloneRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a role by cloning an existing role.

Parameters:: data (RoleClone) – Data for the clone role request.

datadog_api_client.v2.model.role_create_attributes module¶

class RoleCreateAttributes(arg: None)¶

class RoleCreateAttributes(arg: ModelComposed)

class RoleCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the created role.

Parameters:

created_at (datetime, optional) – Creation time of the role.
modified_at (datetime, optional) – Time of last role modification.
name (str) – Name of the role.

datadog_api_client.v2.model.role_create_data module¶

class RoleCreateData(arg: None)¶

class RoleCreateData(arg: ModelComposed)

class RoleCreateData(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a role.

Parameters:

attributes (RoleCreateAttributes) – Attributes of the created role.
relationships (RoleRelationships, optional) – Relationships of the role object.
type (RolesType, optional) – Roles type.

datadog_api_client.v2.model.role_create_request module¶

class RoleCreateRequest(arg: None)¶

class RoleCreateRequest(arg: ModelComposed)

class RoleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create a role.

Parameters:: data (RoleCreateData) – Data related to the creation of a role.

datadog_api_client.v2.model.role_create_response module¶

class RoleCreateResponse(arg: None)¶

class RoleCreateResponse(arg: ModelComposed)

class RoleCreateResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a created role.

Parameters:: data (RoleCreateResponseData, optional) – Role object returned by the API.

datadog_api_client.v2.model.role_create_response_data module¶

class RoleCreateResponseData(arg: None)¶

class RoleCreateResponseData(arg: ModelComposed)

class RoleCreateResponseData(*args, **kwargs)

Bases: ModelNormal

Role object returned by the API.

Parameters:

attributes (RoleCreateAttributes, optional) – Attributes of the created role.
id (str, optional) – The unique identifier of the role.
relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.
type (RolesType) – Roles type.

datadog_api_client.v2.model.role_relationships module¶

class RoleRelationships(arg: None)¶

class RoleRelationships(arg: ModelComposed)

class RoleRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the role object.

Parameters:: permissions (RelationshipToPermissions, optional) – Relationship to multiple permissions objects.

datadog_api_client.v2.model.role_response module¶

class RoleResponse(arg: None)¶

class RoleResponse(arg: ModelComposed)

class RoleResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a single role.

Parameters:: data (Role, optional) – Role object returned by the API.

datadog_api_client.v2.model.role_response_relationships module¶

class RoleResponseRelationships(arg: None)¶

class RoleResponseRelationships(arg: ModelComposed)

class RoleResponseRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the role object returned by the API.

Parameters:: permissions (RelationshipToPermissions, optional) – Relationship to multiple permissions objects.

datadog_api_client.v2.model.role_template_array module¶

class RoleTemplateArray(arg: None)¶

class RoleTemplateArray(arg: ModelComposed)

class RoleTemplateArray(*args, **kwargs)

Bases: ModelNormal

The definition of RoleTemplateArray object.

Parameters:: data ([RoleTemplateData]) – The RoleTemplateArray data.

datadog_api_client.v2.model.role_template_data module¶

class RoleTemplateData(arg: None)¶

class RoleTemplateData(arg: ModelComposed)

class RoleTemplateData(*args, **kwargs)

Bases: ModelNormal

The definition of RoleTemplateData object.

Parameters:

attributes (RoleTemplateDataAttributes, optional) – The definition of RoleTemplateDataAttributes object.
id (str, optional) – The RoleTemplateData id.
type (RoleTemplateDataType) – Roles resource type.

datadog_api_client.v2.model.role_template_data_attributes module¶

class RoleTemplateDataAttributes(arg: None)¶

class RoleTemplateDataAttributes(arg: ModelComposed)

class RoleTemplateDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of RoleTemplateDataAttributes object.

Parameters:

description (str, optional) – The attributes description.
name (str, optional) – The attributes name.

datadog_api_client.v2.model.role_template_data_type module¶

class RoleTemplateDataType(arg: None)¶

class RoleTemplateDataType(arg: ModelComposed)

class RoleTemplateDataType(*args, **kwargs)

Bases: ModelSimple

Roles resource type.

Parameters:

value (str) – If omitted defaults to “roles”. Must be one of [“roles”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.role_update_attributes module¶

class RoleUpdateAttributes(arg: None)¶

class RoleUpdateAttributes(arg: ModelComposed)

class RoleUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the role.

Parameters:

created_at (datetime, optional) – Creation time of the role.
modified_at (datetime, optional) – Time of last role modification.
name (str, optional) – Name of the role.
user_count (int, optional) – The user count.

datadog_api_client.v2.model.role_update_data module¶

class RoleUpdateData(arg: None)¶

class RoleUpdateData(arg: ModelComposed)

class RoleUpdateData(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a role.

Parameters:

attributes (RoleUpdateAttributes) – Attributes of the role.
id (str) – The unique identifier of the role.
relationships (RoleRelationships, optional) – Relationships of the role object.
type (RolesType) – Roles type.

datadog_api_client.v2.model.role_update_request module¶

class RoleUpdateRequest(arg: None)¶

class RoleUpdateRequest(arg: ModelComposed)

class RoleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update a role.

Parameters:: data (RoleUpdateData) – Data related to the update of a role.

datadog_api_client.v2.model.role_update_response module¶

class RoleUpdateResponse(arg: None)¶

class RoleUpdateResponse(arg: ModelComposed)

class RoleUpdateResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about an updated role.

Parameters:: data (RoleUpdateResponseData, optional) – Role object returned by the API.

datadog_api_client.v2.model.role_update_response_data module¶

class RoleUpdateResponseData(arg: None)¶

class RoleUpdateResponseData(arg: ModelComposed)

class RoleUpdateResponseData(*args, **kwargs)

Bases: ModelNormal

Role object returned by the API.

Parameters:

attributes (RoleUpdateAttributes, optional) – Attributes of the role.
id (str, optional) – The unique identifier of the role.
relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.
type (RolesType) – Roles type.

datadog_api_client.v2.model.roles_response module¶

class RolesResponse(arg: None)¶

class RolesResponse(arg: ModelComposed)

class RolesResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about multiple roles.

Parameters:

data ([Role], optional) – Array of returned roles.
meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

datadog_api_client.v2.model.roles_sort module¶

class RolesSort(arg: None)¶

class RolesSort(arg: ModelComposed)

class RolesSort(*args, **kwargs)

Bases: ModelSimple

Sorting options for roles.

Parameters:

value (str) – If omitted defaults to “name”. Must be one of [“name”, “-name”, “modified_at”, “-modified_at”, “user_count”, “-user_count”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.roles_type module¶

class RolesType(arg: None)¶

class RolesType(arg: ModelComposed)

class RolesType(*args, **kwargs)

Bases: ModelSimple

Roles type.

Parameters:

value (str) – If omitted defaults to “roles”. Must be one of [“roles”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.routing_rule module¶

class RoutingRule(arg: None)¶

class RoutingRule(arg: ModelComposed)

class RoutingRule(*args, **kwargs)

Bases: ModelNormal

Represents a routing rule, including its attributes, relationships, and unique identifier.

Parameters:

attributes (RoutingRuleAttributes, optional) – Defines the configurable attributes of a routing rule, such as actions, query, time restriction, and urgency.
id (str, optional) – Specifies the unique identifier of this routing rule.
relationships (RoutingRuleRelationships, optional) – Specifies relationships for a routing rule, linking to associated policy resources.
type (RoutingRuleType) – Team routing rules resource type.

datadog_api_client.v2.model.routing_rule_action module¶

class RoutingRuleAction(arg: None)¶

class RoutingRuleAction(arg: ModelComposed)

class RoutingRuleAction(*args, **kwargs)

Bases: ModelComposed

Defines an action that is executed when a routing rule matches certain criteria.

Parameters:

channel (str) – The channel ID.
type (SendSlackMessageActionType) – Indicates that the action is a send Slack message action.
workspace (str) – The workspace ID.
team (str) – The team ID.
tenant (str) – The tenant ID.

datadog_api_client.v2.model.routing_rule_attributes module¶

class RoutingRuleAttributes(arg: None)¶

class RoutingRuleAttributes(arg: ModelComposed)

class RoutingRuleAttributes(*args, **kwargs)

Bases: ModelNormal

Defines the configurable attributes of a routing rule, such as actions, query, time restriction, and urgency.

Parameters:

actions ([RoutingRuleAction], optional) – Specifies the list of actions to perform when the routing rule matches.
query (str, optional) – Defines the query or condition that triggers this routing rule.
time_restriction (TimeRestrictions, optional) – Holds time zone information and a list of time restrictions for a routing rule.
urgency (Urgency, optional) – Specifies the level of urgency for a routing rule (low, high, or dynamic).

datadog_api_client.v2.model.routing_rule_relationships module¶

class RoutingRuleRelationships(arg: None)¶

class RoutingRuleRelationships(arg: ModelComposed)

class RoutingRuleRelationships(*args, **kwargs)

Bases: ModelNormal

Specifies relationships for a routing rule, linking to associated policy resources.

Parameters:: policy (RoutingRuleRelationshipsPolicy, optional) – Defines the relationship that links a routing rule to a policy.

datadog_api_client.v2.model.routing_rule_relationships_policy module¶

class RoutingRuleRelationshipsPolicy(arg: None)¶

class RoutingRuleRelationshipsPolicy(arg: ModelComposed)

class RoutingRuleRelationshipsPolicy(*args, **kwargs)

Bases: ModelNormal

Defines the relationship that links a routing rule to a policy.

Parameters:: data (RoutingRuleRelationshipsPolicyData, optional) – Represents the policy data reference, containing the policy’s ID and resource type.

datadog_api_client.v2.model.routing_rule_relationships_policy_data module¶

class RoutingRuleRelationshipsPolicyData(arg: None)¶

class RoutingRuleRelationshipsPolicyData(arg: ModelComposed)

class RoutingRuleRelationshipsPolicyData(*args, **kwargs)

Bases: ModelNormal

Represents the policy data reference, containing the policy’s ID and resource type.

Parameters:

id (str) – Specifies the unique identifier of the policy.
type (RoutingRuleRelationshipsPolicyDataType) – Indicates that the resource is of type ‘policies’.

datadog_api_client.v2.model.routing_rule_relationships_policy_data_type module¶

class RoutingRuleRelationshipsPolicyDataType(arg: None)¶

class RoutingRuleRelationshipsPolicyDataType(arg: ModelComposed)

class RoutingRuleRelationshipsPolicyDataType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type ‘policies’.

Parameters:

value (str) – If omitted defaults to “policies”. Must be one of [“policies”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.routing_rule_type module¶

class RoutingRuleType(arg: None)¶

class RoutingRuleType(arg: ModelComposed)

class RoutingRuleType(*args, **kwargs)

Bases: ModelSimple

Team routing rules resource type.

Parameters:

value (str) – If omitted defaults to “team_routing_rules”. Must be one of [“team_routing_rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rule_attributes module¶

class RuleAttributes(arg: None)¶

class RuleAttributes(arg: ModelComposed)

class RuleAttributes(*args, **kwargs)

Bases: ModelNormal

Details of a rule.

Parameters:

category (str, optional) – The scorecard name to which this rule must belong. Deprecated.
created_at (datetime, optional) – Creation time of the rule outcome.
custom (bool, optional) – Defines if the rule is a custom rule.
description (str, optional) – Explanation of the rule.
enabled (bool, optional) – If enabled, the rule is calculated as part of the score.
level (int, optional) – The maturity level of the rule (1, 2, or 3).
modified_at (datetime, optional) – Time of the last rule outcome modification.
name (str, optional) – Name of the rule.
owner (str, optional) – Owner of the rule.
scorecard_name (str, optional) – The scorecard name to which this rule must belong.

datadog_api_client.v2.model.rule_outcome_relationships module¶

class RuleOutcomeRelationships(arg: None)¶

class RuleOutcomeRelationships(arg: ModelComposed)

class RuleOutcomeRelationships(*args, **kwargs)

Bases: ModelNormal

The JSON:API relationship to a scorecard rule.

Parameters:: rule (RelationshipToOutcome, optional) – The JSON:API relationship to a scorecard outcome.

datadog_api_client.v2.model.rule_severity module¶

class RuleSeverity(arg: None)¶

class RuleSeverity(arg: ModelComposed)

class RuleSeverity(*args, **kwargs)

Bases: ModelSimple

Severity of a security rule.

Parameters:

value (str) – Must be one of [“critical”, “high”, “medium”, “low”, “unknown”, “info”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rule_type module¶

class RuleType(arg: None)¶

class RuleType(arg: ModelComposed)

class RuleType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for scorecard rules.

Parameters:

value (str) – If omitted defaults to “rule”. Must be one of [“rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rule_types_items module¶

class RuleTypesItems(arg: None)¶

class RuleTypesItems(arg: ModelComposed)

class RuleTypesItems(*args, **kwargs)

Bases: ModelSimple

Security rule type which can be used in security rules.: Signal-based notification rules can filter signals based on rule types application_security, log_detection, workload_security, signal_correlation, cloud_configuration and infrastructure_configuration. Vulnerability-based notification rules can filter vulnerabilities based on rule types application_code_vulnerability, application_library_vulnerability, attack_path, container_image_vulnerability, identity_risk, misconfiguration, api_security, host_vulnerability and iac_misconfiguration.

Parameters:

value (str) – Must be one of [“application_security”, “log_detection”, “workload_security”, “signal_correlation”, “cloud_configuration”, “infrastructure_configuration”, “application_code_vulnerability”, “application_library_vulnerability”, “attack_path”, “container_image_vulnerability”, “identity_risk”, “misconfiguration”, “api_security”, “host_vulnerability”, “iac_misconfiguration”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rule_user module¶

class RuleUser(arg: None)¶

class RuleUser(arg: ModelComposed)

class RuleUser(*args, **kwargs)

Bases: ModelNormal

User creating or modifying a rule.

Parameters:

handle (str, optional) – The user handle.
name (str, optional) – The user name.

datadog_api_client.v2.model.rule_version_history module¶

class RuleVersionHistory(arg: None)¶

class RuleVersionHistory(arg: ModelComposed)

class RuleVersionHistory(*args, **kwargs)

Bases: ModelNormal

Response object containing the version history of a rule.

Parameters:

count (int, optional) – The number of rule versions.
data ({str: (RuleVersions,)}, optional) – The RuleVersionHistory data.

datadog_api_client.v2.model.rule_version_update module¶

class RuleVersionUpdate(arg: None)¶

class RuleVersionUpdate(arg: ModelComposed)

class RuleVersionUpdate(*args, **kwargs)

Bases: ModelNormal

A change in a rule version.

Parameters:

change (str, optional) – The new value of the field.
field (str, optional) – The field that was changed.
type (RuleVersionUpdateType, optional) – The type of change.

datadog_api_client.v2.model.rule_version_update_type module¶

class RuleVersionUpdateType(arg: None)¶

class RuleVersionUpdateType(arg: ModelComposed)

class RuleVersionUpdateType(*args, **kwargs)

Bases: ModelSimple

The type of change.

Parameters:

value (str) – Must be one of [“create”, “update”, “delete”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rule_versions module¶

class RuleVersions(arg: None)¶

class RuleVersions(arg: ModelComposed)

class RuleVersions(*args, **kwargs)

Bases: ModelNormal

A rule version with a list of updates.

Parameters:

changes ([RuleVersionUpdate], optional) – A list of changes.
rule (SecurityMonitoringRuleResponse, optional) – Create a new rule.

datadog_api_client.v2.model.rules_validate_query_request module¶

class RulesValidateQueryRequest(arg: None)¶

class RulesValidateQueryRequest(arg: ModelComposed)

class RulesValidateQueryRequest(*args, **kwargs)

Bases: ModelNormal

The definition of RulesValidateQueryRequest object.

Parameters:: data (RulesValidateQueryRequestData, optional) – The definition of RulesValidateQueryRequestData object.

datadog_api_client.v2.model.rules_validate_query_request_data module¶

class RulesValidateQueryRequestData(arg: None)¶

class RulesValidateQueryRequestData(arg: ModelComposed)

class RulesValidateQueryRequestData(*args, **kwargs)

Bases: ModelNormal

The definition of RulesValidateQueryRequestData object.

Parameters:

attributes (RulesValidateQueryRequestDataAttributes, optional) – The definition of RulesValidateQueryRequestDataAttributes object.
id (str, optional) – The RulesValidateQueryRequestData id.
type (RulesValidateQueryRequestDataType) – Validate query resource type.

datadog_api_client.v2.model.rules_validate_query_request_data_attributes module¶

class RulesValidateQueryRequestDataAttributes(arg: None)¶

class RulesValidateQueryRequestDataAttributes(arg: ModelComposed)

class RulesValidateQueryRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of RulesValidateQueryRequestDataAttributes object.

Parameters:: query (str) – The attributes Query.

datadog_api_client.v2.model.rules_validate_query_request_data_type module¶

class RulesValidateQueryRequestDataType(arg: None)¶

class RulesValidateQueryRequestDataType(arg: ModelComposed)

class RulesValidateQueryRequestDataType(*args, **kwargs)

Bases: ModelSimple

Validate query resource type.

Parameters:

value (str) – If omitted defaults to “validate_query”. Must be one of [“validate_query”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rules_validate_query_response module¶

class RulesValidateQueryResponse(arg: None)¶

class RulesValidateQueryResponse(arg: ModelComposed)

class RulesValidateQueryResponse(*args, **kwargs)

Bases: ModelNormal

The definition of RulesValidateQueryResponse object.

Parameters:: data (RulesValidateQueryResponseData, optional) – The definition of RulesValidateQueryResponseData object.

datadog_api_client.v2.model.rules_validate_query_response_data module¶

class RulesValidateQueryResponseData(arg: None)¶

class RulesValidateQueryResponseData(arg: ModelComposed)

class RulesValidateQueryResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of RulesValidateQueryResponseData object.

Parameters:

attributes (RulesValidateQueryResponseDataAttributes, optional) – The definition of RulesValidateQueryResponseDataAttributes object.
id (str, optional) – The RulesValidateQueryResponseData id.
type (RulesValidateQueryResponseDataType) – Validate response resource type.

datadog_api_client.v2.model.rules_validate_query_response_data_attributes module¶

class RulesValidateQueryResponseDataAttributes(arg: None)¶

class RulesValidateQueryResponseDataAttributes(arg: ModelComposed)

class RulesValidateQueryResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of RulesValidateQueryResponseDataAttributes object.

Parameters:: canonical (str) – The attributes Canonical.

datadog_api_client.v2.model.rules_validate_query_response_data_type module¶

class RulesValidateQueryResponseDataType(arg: None)¶

class RulesValidateQueryResponseDataType(arg: ModelComposed)

class RulesValidateQueryResponseDataType(*args, **kwargs)

Bases: ModelSimple

Validate response resource type.

Parameters:

value (str) – If omitted defaults to “validate_response”. Must be one of [“validate_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.ruleset_item_metadata module¶

class RulesetItemMetadata(arg: None)¶

class RulesetItemMetadata(arg: ModelComposed)

class RulesetItemMetadata(*args, **kwargs)

Bases: ModelNormal

The items metadata.

datadog_api_client.v2.model.ruleset_resp module¶

class RulesetResp(arg: None)¶

class RulesetResp(arg: ModelComposed)

class RulesetResp(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetResp object.

Parameters:: data (RulesetRespData, optional) – The definition of RulesetRespData object.

datadog_api_client.v2.model.ruleset_resp_array module¶

class RulesetRespArray(arg: None)¶

class RulesetRespArray(arg: ModelComposed)

class RulesetRespArray(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespArray object.

Parameters:: data ([RulesetRespData]) – The RulesetRespArray data.

datadog_api_client.v2.model.ruleset_resp_data module¶

class RulesetRespData(arg: None)¶

class RulesetRespData(arg: ModelComposed)

class RulesetRespData(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespData object.

Parameters:

attributes (RulesetRespDataAttributes, optional) – The definition of RulesetRespDataAttributes object.
id (str, optional) – The RulesetRespData id.
type (RulesetRespDataType) – Ruleset resource type.

datadog_api_client.v2.model.ruleset_resp_data_attributes module¶

class RulesetRespDataAttributes(arg: None)¶

class RulesetRespDataAttributes(arg: ModelComposed)

class RulesetRespDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributes object.

Parameters:

created (RulesetRespDataAttributesCreated) – The definition of RulesetRespDataAttributesCreated object.
enabled (bool) – The attributes enabled.
last_modified_user_uuid (str) – The attributes last_modified_user_uuid.
modified (RulesetRespDataAttributesModified) – The definition of RulesetRespDataAttributesModified object.
name (str) – The attributes name.
position (int) – The attributes position.
processing_status (str, optional) – The attributes processing_status.
rules ([RulesetRespDataAttributesRulesItems]) – The attributes rules.
version (int) – The attributes version.

datadog_api_client.v2.model.ruleset_resp_data_attributes_created module¶

class RulesetRespDataAttributesCreated(arg: None)¶

class RulesetRespDataAttributesCreated(arg: ModelComposed)

class RulesetRespDataAttributesCreated(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesCreated object.

Parameters:

nanos (int, optional) – The created nanos.
seconds (int, optional) – The created seconds.

datadog_api_client.v2.model.ruleset_resp_data_attributes_modified module¶

class RulesetRespDataAttributesModified(arg: None)¶

class RulesetRespDataAttributesModified(arg: ModelComposed)

class RulesetRespDataAttributesModified(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesModified object.

Parameters:

nanos (int, optional) – The modified nanos.
seconds (int, optional) – The modified seconds.

datadog_api_client.v2.model.ruleset_resp_data_attributes_rules_items module¶

class RulesetRespDataAttributesRulesItems(arg: None)¶

class RulesetRespDataAttributesRulesItems(arg: ModelComposed)

class RulesetRespDataAttributesRulesItems(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesRulesItems object.

Parameters:

enabled (bool) – The items enabled.
mapping (RulesetRespDataAttributesRulesItemsMapping, none_type, optional) – The definition of RulesetRespDataAttributesRulesItemsMapping object.
metadata (RulesetItemMetadata, none_type, optional) – The items metadata.
name (str) – The items name.
query (RulesetRespDataAttributesRulesItemsQuery, none_type, optional) – The definition of RulesetRespDataAttributesRulesItemsQuery object.
reference_table (RulesetRespDataAttributesRulesItemsReferenceTable, none_type, optional) – The definition of RulesetRespDataAttributesRulesItemsReferenceTable object.

datadog_api_client.v2.model.ruleset_resp_data_attributes_rules_items_mapping module¶

class RulesetRespDataAttributesRulesItemsMapping(arg: None)¶

class RulesetRespDataAttributesRulesItemsMapping(arg: ModelComposed)

class RulesetRespDataAttributesRulesItemsMapping(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesRulesItemsMapping object.

Parameters:

destination_key (str) – The mapping destination_key.
if_not_exists (bool) – The mapping if_not_exists.
source_keys ([str]) – The mapping source_keys.

datadog_api_client.v2.model.ruleset_resp_data_attributes_rules_items_query module¶

class RulesetRespDataAttributesRulesItemsQuery(arg: None)¶

class RulesetRespDataAttributesRulesItemsQuery(arg: ModelComposed)

class RulesetRespDataAttributesRulesItemsQuery(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesRulesItemsQuery object.

Parameters:

addition (RulesetRespDataAttributesRulesItemsQueryAddition, none_type) – The definition of RulesetRespDataAttributesRulesItemsQueryAddition object.
case_insensitivity (bool, optional) – The query case_insensitivity.
if_not_exists (bool) – The query if_not_exists.
query (str) – The query query.

datadog_api_client.v2.model.ruleset_resp_data_attributes_rules_items_query_addition module¶

class RulesetRespDataAttributesRulesItemsQueryAddition(arg: None)¶

class RulesetRespDataAttributesRulesItemsQueryAddition(arg: ModelComposed)

class RulesetRespDataAttributesRulesItemsQueryAddition(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesRulesItemsQueryAddition object.

Parameters:

key (str) – The addition key.
value (str) – The addition value.

datadog_api_client.v2.model.ruleset_resp_data_attributes_rules_items_reference_table module¶

class RulesetRespDataAttributesRulesItemsReferenceTable(arg: None)¶

class RulesetRespDataAttributesRulesItemsReferenceTable(arg: ModelComposed)

class RulesetRespDataAttributesRulesItemsReferenceTable(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesRulesItemsReferenceTable object.

Parameters:

case_insensitivity (bool, optional) – The reference_table case_insensitivity.
field_pairs ([RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems]) – The reference_table field_pairs.
if_not_exists (bool, optional) – The reference_table if_not_exists.
source_keys ([str]) – The reference_table source_keys.
table_name (str) – The reference_table table_name.

datadog_api_client.v2.model.ruleset_resp_data_attributes_rules_items_reference_table_field_pairs_items module¶

class RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems(arg: None)¶

class RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems(arg: ModelComposed)

class RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems(*args, **kwargs)

Bases: ModelNormal

The definition of RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems object.

Parameters:

input_column (str) – The items input_column.
output_key (str) – The items output_key.

datadog_api_client.v2.model.ruleset_resp_data_type module¶

class RulesetRespDataType(arg: None)¶

class RulesetRespDataType(arg: ModelComposed)

class RulesetRespDataType(*args, **kwargs)

Bases: ModelSimple

Ruleset resource type.

Parameters:

value (str) – If omitted defaults to “ruleset”. Must be one of [“ruleset”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_aggregate_bucket_value module¶

class RUMAggregateBucketValue(arg: None)¶

class RUMAggregateBucketValue(arg: ModelComposed)

class RUMAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

A bucket value, can be either a timeseries or a single value.

datadog_api_client.v2.model.rum_aggregate_bucket_value_timeseries module¶

class RUMAggregateBucketValueTimeseries(arg: None)¶

class RUMAggregateBucketValueTimeseries(arg: ModelComposed)

class RUMAggregateBucketValueTimeseries(*args, **kwargs)

Bases: ModelSimple

A timeseries array.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_aggregate_bucket_value_timeseries_point module¶

class RUMAggregateBucketValueTimeseriesPoint(arg: None)¶

class RUMAggregateBucketValueTimeseriesPoint(arg: ModelComposed)

class RUMAggregateBucketValueTimeseriesPoint(*args, **kwargs)

Bases: ModelNormal

A timeseries point.

Parameters:

time (datetime, optional) – The time value for this point.
value (float, optional) – The value for this point.

datadog_api_client.v2.model.rum_aggregate_request module¶

class RUMAggregateRequest(arg: None)¶

class RUMAggregateRequest(arg: ModelComposed)

class RUMAggregateRequest(*args, **kwargs)

Bases: ModelNormal

The object sent with the request to retrieve aggregation buckets of RUM events from your organization.

Parameters:

compute ([RUMCompute], optional) – The list of metrics or timeseries to compute for the retrieved buckets.
filter (RUMQueryFilter, optional) – The search and filter query settings.
group_by ([RUMGroupBy], optional) – The rules for the group by.
options (RUMQueryOptions, optional) – Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
page (RUMQueryPageOptions, optional) – Paging attributes for listing events.

datadog_api_client.v2.model.rum_aggregate_sort module¶

class RUMAggregateSort(arg: None)¶

class RUMAggregateSort(arg: ModelComposed)

class RUMAggregateSort(*args, **kwargs)

Bases: ModelNormal

A sort rule.

Parameters:

aggregation (RUMAggregationFunction, optional) – An aggregation function.
metric (str, optional) – The metric to sort by (only used for type=measure ).
order (RUMSortOrder, optional) – The order to use, ascending or descending.
type (RUMAggregateSortType, optional) – The type of sorting algorithm.

datadog_api_client.v2.model.rum_aggregate_sort_type module¶

class RUMAggregateSortType(arg: None)¶

class RUMAggregateSortType(arg: ModelComposed)

class RUMAggregateSortType(*args, **kwargs)

Bases: ModelSimple

The type of sorting algorithm.

Parameters:

value (str) – If omitted defaults to “alphabetical”. Must be one of [“alphabetical”, “measure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_aggregation_buckets_response module¶

class RUMAggregationBucketsResponse(arg: None)¶

class RUMAggregationBucketsResponse(arg: ModelComposed)

class RUMAggregationBucketsResponse(*args, **kwargs)

Bases: ModelNormal

The query results.

Parameters:: buckets ([RUMBucketResponse], optional) – The list of matching buckets, one item per bucket.

datadog_api_client.v2.model.rum_aggregation_function module¶

class RUMAggregationFunction(arg: None)¶

class RUMAggregationFunction(arg: ModelComposed)

class RUMAggregationFunction(*args, **kwargs)

Bases: ModelSimple

An aggregation function.

Parameters:

value (str) – Must be one of [“count”, “cardinality”, “pc75”, “pc90”, “pc95”, “pc98”, “pc99”, “sum”, “min”, “max”, “avg”, “median”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_analytics_aggregate_response module¶

class RUMAnalyticsAggregateResponse(arg: None)¶

class RUMAnalyticsAggregateResponse(arg: ModelComposed)

class RUMAnalyticsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the RUM events aggregate API endpoint.

Parameters:

data (RUMAggregationBucketsResponse, optional) – The query results.
links (RUMResponseLinks, optional) – Links attributes.
meta (RUMResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.rum_application module¶

class RUMApplication(arg: None)¶

class RUMApplication(arg: ModelComposed)

class RUMApplication(*args, **kwargs)

Bases: ModelNormal

RUM application.

Parameters:

attributes (RUMApplicationAttributes) – RUM application attributes.
id (str) – RUM application ID.
type (RUMApplicationType) – RUM application response type.

datadog_api_client.v2.model.rum_application_attributes module¶

class RUMApplicationAttributes(arg: None)¶

class RUMApplicationAttributes(arg: ModelComposed)

class RUMApplicationAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application attributes.

Parameters:

api_key_id (int, optional) – ID of the API key associated with the application.
application_id (str) – ID of the RUM application.
client_token (str) – Client token of the RUM application.
created_at (int) – Timestamp in ms of the creation date.
created_by_handle (str) – Handle of the creator user.
hash (str, optional) – Hash of the RUM application. Optional.
is_active (bool, optional) – Indicates if the RUM application is active.
name (str) – Name of the RUM application.
org_id (int) – Org ID of the RUM application.
product_scales (RUMProductScales, optional) – Product Scales configuration for the RUM application.
type (str) – Type of the RUM application. Supported values are browser , ios , android , react-native , flutter , roku , electron , unity , kotlin-multiplatform.
updated_at (int) – Timestamp in ms of the last update date.
updated_by_handle (str) – Handle of the updater user.

datadog_api_client.v2.model.rum_application_create module¶

class RUMApplicationCreate(arg: None)¶

class RUMApplicationCreate(arg: ModelComposed)

class RUMApplicationCreate(*args, **kwargs)

Bases: ModelNormal

RUM application creation.

Parameters:

attributes (RUMApplicationCreateAttributes) – RUM application creation attributes.
type (RUMApplicationCreateType) – RUM application creation type.

datadog_api_client.v2.model.rum_application_create_attributes module¶

class RUMApplicationCreateAttributes(arg: None)¶

class RUMApplicationCreateAttributes(arg: ModelComposed)

class RUMApplicationCreateAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application creation attributes.

Parameters:

name (str) – Name of the RUM application.
product_analytics_retention_state (RUMProductAnalyticsRetentionState, optional) – Controls the retention policy for Product Analytics data derived from RUM events.
rum_event_processing_state (RUMEventProcessingState, optional) – Configures which RUM events are processed and stored for the application.
type (str, optional) – Type of the RUM application. Supported values are browser , ios , android , react-native , flutter , roku , electron , unity , kotlin-multiplatform.

datadog_api_client.v2.model.rum_application_create_request module¶

class RUMApplicationCreateRequest(arg: None)¶

class RUMApplicationCreateRequest(arg: ModelComposed)

class RUMApplicationCreateRequest(*args, **kwargs)

Bases: ModelNormal

RUM application creation request attributes.

Parameters:: data (RUMApplicationCreate) – RUM application creation.

datadog_api_client.v2.model.rum_application_create_type module¶

class RUMApplicationCreateType(arg: None)¶

class RUMApplicationCreateType(arg: ModelComposed)

class RUMApplicationCreateType(*args, **kwargs)

Bases: ModelSimple

RUM application creation type.

Parameters:

value (str) – If omitted defaults to “rum_application_create”. Must be one of [“rum_application_create”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_application_list module¶

class RUMApplicationList(arg: None)¶

class RUMApplicationList(arg: ModelComposed)

class RUMApplicationList(*args, **kwargs)

Bases: ModelNormal

RUM application list.

Parameters:

attributes (RUMApplicationListAttributes) – RUM application list attributes.
id (str, optional) – RUM application ID.
type (RUMApplicationListType) – RUM application list type.

datadog_api_client.v2.model.rum_application_list_attributes module¶

class RUMApplicationListAttributes(arg: None)¶

class RUMApplicationListAttributes(arg: ModelComposed)

class RUMApplicationListAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application list attributes.

Parameters:

application_id (str) – ID of the RUM application.
created_at (int) – Timestamp in ms of the creation date.
created_by_handle (str) – Handle of the creator user.
hash (str, optional) – Hash of the RUM application. Optional.
is_active (bool, optional) – Indicates if the RUM application is active.
name (str) – Name of the RUM application.
org_id (int) – Org ID of the RUM application.
product_scales (RUMProductScales, optional) – Product Scales configuration for the RUM application.
type (str) – Type of the RUM application. Supported values are browser , ios , android , react-native , flutter , roku , electron , unity , kotlin-multiplatform.
updated_at (int) – Timestamp in ms of the last update date.
updated_by_handle (str) – Handle of the updater user.

datadog_api_client.v2.model.rum_application_list_type module¶

class RUMApplicationListType(arg: None)¶

class RUMApplicationListType(arg: ModelComposed)

class RUMApplicationListType(*args, **kwargs)

Bases: ModelSimple

RUM application list type.

Parameters:

value (str) – If omitted defaults to “rum_application”. Must be one of [“rum_application”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_application_response module¶

class RUMApplicationResponse(arg: None)¶

class RUMApplicationResponse(arg: ModelComposed)

class RUMApplicationResponse(*args, **kwargs)

Bases: ModelNormal

RUM application response.

Parameters:: data (RUMApplication, optional) – RUM application.

datadog_api_client.v2.model.rum_application_type module¶

class RUMApplicationType(arg: None)¶

class RUMApplicationType(arg: ModelComposed)

class RUMApplicationType(*args, **kwargs)

Bases: ModelSimple

RUM application response type.

Parameters:

value (str) – If omitted defaults to “rum_application”. Must be one of [“rum_application”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_application_update module¶

class RUMApplicationUpdate(arg: None)¶

class RUMApplicationUpdate(arg: ModelComposed)

class RUMApplicationUpdate(*args, **kwargs)

Bases: ModelNormal

RUM application update.

Parameters:

attributes (RUMApplicationUpdateAttributes, optional) – RUM application update attributes.
id (str) – RUM application ID.
type (RUMApplicationUpdateType) – RUM application update type.

datadog_api_client.v2.model.rum_application_update_attributes module¶

class RUMApplicationUpdateAttributes(arg: None)¶

class RUMApplicationUpdateAttributes(arg: ModelComposed)

class RUMApplicationUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application update attributes.

Parameters:

name (str, optional) – Name of the RUM application.
product_analytics_retention_state (RUMProductAnalyticsRetentionState, optional) – Controls the retention policy for Product Analytics data derived from RUM events.
rum_event_processing_state (RUMEventProcessingState, optional) – Configures which RUM events are processed and stored for the application.
type (str, optional) – Type of the RUM application. Supported values are browser , ios , android , react-native , flutter , roku , electron , unity , kotlin-multiplatform.

datadog_api_client.v2.model.rum_application_update_request module¶

class RUMApplicationUpdateRequest(arg: None)¶

class RUMApplicationUpdateRequest(arg: ModelComposed)

class RUMApplicationUpdateRequest(*args, **kwargs)

Bases: ModelNormal

RUM application update request.

Parameters:: data (RUMApplicationUpdate) – RUM application update.

datadog_api_client.v2.model.rum_application_update_type module¶

class RUMApplicationUpdateType(arg: None)¶

class RUMApplicationUpdateType(arg: ModelComposed)

class RUMApplicationUpdateType(*args, **kwargs)

Bases: ModelSimple

RUM application update type.

Parameters:

value (str) – If omitted defaults to “rum_application_update”. Must be one of [“rum_application_update”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_applications_response module¶

class RUMApplicationsResponse(arg: None)¶

class RUMApplicationsResponse(arg: ModelComposed)

class RUMApplicationsResponse(*args, **kwargs)

Bases: ModelNormal

RUM applications response.

Parameters:: data ([RUMApplicationList], optional) – RUM applications array response.

datadog_api_client.v2.model.rum_bucket_response module¶

class RUMBucketResponse(arg: None)¶

class RUMBucketResponse(arg: ModelComposed)

class RUMBucketResponse(*args, **kwargs)

Bases: ModelNormal

Bucket values.

Parameters:

by ({str: (str,)}, optional) – The key-value pairs for each group-by.
computes ({str: (RUMAggregateBucketValue,)}, optional) – A map of the metric name to value for regular compute, or a list of values for a timeseries.

datadog_api_client.v2.model.rum_compute module¶

class RUMCompute(arg: None)¶

class RUMCompute(arg: ModelComposed)

class RUMCompute(*args, **kwargs)

Bases: ModelNormal

A compute rule to compute metrics or timeseries.

Parameters:

aggregation (RUMAggregationFunction) – An aggregation function.
interval (str, optional) – The time buckets’ size (only used for type=timeseries) Defaults to a resolution of 150 points.
metric (str, optional) – The metric to use.
type (RUMComputeType, optional) – The type of compute.

datadog_api_client.v2.model.rum_compute_type module¶

class RUMComputeType(arg: None)¶

class RUMComputeType(arg: ModelComposed)

class RUMComputeType(*args, **kwargs)

Bases: ModelSimple

The type of compute.

Parameters:

value (str) – If omitted defaults to “total”. Must be one of [“timeseries”, “total”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_event module¶

class RUMEvent(arg: None)¶

class RUMEvent(arg: ModelComposed)

class RUMEvent(*args, **kwargs)

Bases: ModelNormal

Object description of a RUM event after being processed and stored by Datadog.

Parameters:

attributes (RUMEventAttributes, optional) – JSON object containing all event attributes and their associated values.
id (str, optional) – Unique ID of the event.
type (RUMEventType, optional) – Type of the event.

datadog_api_client.v2.model.rum_event_attributes module¶

class RUMEventAttributes(arg: None)¶

class RUMEventAttributes(arg: ModelComposed)

class RUMEventAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all event attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of attributes from RUM events.
service (str, optional) – The name of the application or service generating RUM events. It is used to switch from RUM to APM, so make sure you define the same value when you use both products.
tags ([str], optional) – Array of tags associated with your event.
timestamp (datetime, optional) – Timestamp of your event.

datadog_api_client.v2.model.rum_event_processing_scale module¶

class RUMEventProcessingScale(arg: None)¶

class RUMEventProcessingScale(arg: ModelComposed)

class RUMEventProcessingScale(*args, **kwargs)

Bases: ModelNormal

RUM event processing scale configuration.

Parameters:

last_modified_at (int, optional) – Timestamp in milliseconds when this scale was last modified.
state (RUMEventProcessingState, optional) – Configures which RUM events are processed and stored for the application.

datadog_api_client.v2.model.rum_event_processing_state module¶

class RUMEventProcessingState(arg: None)¶

class RUMEventProcessingState(arg: ModelComposed)

class RUMEventProcessingState(*args, **kwargs)

Bases: ModelSimple

Configures which RUM events are processed and stored for the application.

Parameters:

value (str) – Must be one of [“ALL”, “ERROR_FOCUSED_MODE”, “NONE”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_event_type module¶

class RUMEventType(arg: None)¶

class RUMEventType(arg: ModelComposed)

class RUMEventType(*args, **kwargs)

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “rum”. Must be one of [“rum”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_events_response module¶

class RUMEventsResponse(arg: None)¶

class RUMEventsResponse(arg: ModelComposed)

class RUMEventsResponse(*args, **kwargs)

Bases: ModelNormal

Response object with all events matching the request and pagination information.

Parameters:

data ([RUMEvent], optional) – Array of events matching the request.
links (RUMResponseLinks, optional) – Links attributes.
meta (RUMResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.rum_group_by module¶

class RUMGroupBy(arg: None)¶

class RUMGroupBy(arg: ModelComposed)

class RUMGroupBy(*args, **kwargs)

Bases: ModelNormal

A group-by rule.

Parameters:

facet (str) – The name of the facet to use (required).
histogram (RUMGroupByHistogram, optional) – Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
limit (int, optional) – The maximum buckets to return for this group-by.
missing (RUMGroupByMissing, optional) – The value to use for logs that don’t have the facet used to group by.
sort (RUMAggregateSort, optional) – A sort rule.
total (RUMGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.rum_group_by_histogram module¶

class RUMGroupByHistogram(arg: None)¶

class RUMGroupByHistogram(arg: ModelComposed)

class RUMGroupByHistogram(*args, **kwargs)

Bases: ModelNormal

Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.

Parameters:

interval (float) – The bin size of the histogram buckets.
max (float) – The maximum value for the measure used in the histogram (values greater than this one are filtered out).
min (float) – The minimum value for the measure used in the histogram (values smaller than this one are filtered out).

datadog_api_client.v2.model.rum_group_by_missing module¶

class RUMGroupByMissing(arg: None)¶

class RUMGroupByMissing(arg: ModelComposed)

class RUMGroupByMissing(*args, **kwargs)

Bases: ModelComposed

The value to use for logs that don’t have the facet used to group by.

datadog_api_client.v2.model.rum_group_by_total module¶

class RUMGroupByTotal(arg: None)¶

class RUMGroupByTotal(arg: ModelComposed)

class RUMGroupByTotal(*args, **kwargs)

Bases: ModelComposed

A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.rum_metric_compute module¶

class RumMetricCompute(arg: None)¶

class RumMetricCompute(arg: ModelComposed)

class RumMetricCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the rum-based metric.

Parameters:

aggregation_type (RumMetricComputeAggregationType) – The type of aggregation to use.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when aggregation_type is distribution.
path (str, optional) – The path to the value the rum-based metric will aggregate on. Only present when aggregation_type is distribution.

datadog_api_client.v2.model.rum_metric_compute_aggregation_type module¶

class RumMetricComputeAggregationType(arg: None)¶

class RumMetricComputeAggregationType(arg: ModelComposed)

class RumMetricComputeAggregationType(*args, **kwargs)

Bases: ModelSimple

The type of aggregation to use.

Parameters:

value (str) – Must be one of [“count”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_metric_create_attributes module¶

class RumMetricCreateAttributes(arg: None)¶

class RumMetricCreateAttributes(arg: ModelComposed)

class RumMetricCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing the Datadog rum-based metric to create.

Parameters:

compute (RumMetricCompute) – The compute rule to compute the rum-based metric.
event_type (RumMetricEventType) – The type of RUM events to filter on.
filter (RumMetricFilter, optional) – The rum-based metric filter. Events matching this filter will be aggregated in this metric.
group_by ([RumMetricGroupBy], optional) – The rules for the group by.
uniqueness (RumMetricUniqueness, optional) – The rule to count updatable events. Is only set if event_type is sessions or views.

datadog_api_client.v2.model.rum_metric_create_data module¶

class RumMetricCreateData(arg: None)¶

class RumMetricCreateData(arg: ModelComposed)

class RumMetricCreateData(*args, **kwargs)

Bases: ModelNormal

The new rum-based metric properties.

Parameters:

attributes (RumMetricCreateAttributes) – The object describing the Datadog rum-based metric to create.
id (str) – The name of the rum-based metric.
type (RumMetricType) – The type of the resource. The value should always be rum_metrics.

datadog_api_client.v2.model.rum_metric_create_request module¶

class RumMetricCreateRequest(arg: None)¶

class RumMetricCreateRequest(arg: ModelComposed)

class RumMetricCreateRequest(*args, **kwargs)

Bases: ModelNormal

The new rum-based metric body.

Parameters:: data (RumMetricCreateData) – The new rum-based metric properties.

datadog_api_client.v2.model.rum_metric_event_type module¶

class RumMetricEventType(arg: None)¶

class RumMetricEventType(arg: ModelComposed)

class RumMetricEventType(*args, **kwargs)

Bases: ModelSimple

The type of RUM events to filter on.

Parameters:

value (str) – Must be one of [“session”, “view”, “action”, “error”, “resource”, “long_task”, “vital”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_metric_filter module¶

class RumMetricFilter(arg: None)¶

class RumMetricFilter(arg: ModelComposed)

class RumMetricFilter(*args, **kwargs)

Bases: ModelNormal

The rum-based metric filter. Events matching this filter will be aggregated in this metric.

Parameters:: query (str) – The search query - following the RUM search syntax.

datadog_api_client.v2.model.rum_metric_group_by module¶

class RumMetricGroupBy(arg: None)¶

class RumMetricGroupBy(arg: ModelComposed)

class RumMetricGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

path (str) – The path to the value the rum-based metric will be aggregated over.
tag_name (str, optional) – Eventual name of the tag that gets created. By default, path is used as the tag name.

datadog_api_client.v2.model.rum_metric_response module¶

class RumMetricResponse(arg: None)¶

class RumMetricResponse(arg: ModelComposed)

class RumMetricResponse(*args, **kwargs)

Bases: ModelNormal

The rum-based metric object.

Parameters:: data (RumMetricResponseData, optional) – The rum-based metric properties.

datadog_api_client.v2.model.rum_metric_response_attributes module¶

class RumMetricResponseAttributes(arg: None)¶

class RumMetricResponseAttributes(arg: ModelComposed)

class RumMetricResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog rum-based metric.

Parameters:

compute (RumMetricResponseCompute, optional) – The compute rule to compute the rum-based metric.
event_type (RumMetricEventType, optional) – The type of RUM events to filter on.
filter (RumMetricResponseFilter, optional) – The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
group_by ([RumMetricResponseGroupBy], optional) – The rules for the group by.
uniqueness (RumMetricResponseUniqueness, optional) – The rule to count updatable events. Is only set if event_type is session or view.

datadog_api_client.v2.model.rum_metric_response_compute module¶

class RumMetricResponseCompute(arg: None)¶

class RumMetricResponseCompute(arg: ModelComposed)

class RumMetricResponseCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the rum-based metric.

Parameters:

aggregation_type (RumMetricComputeAggregationType, optional) – The type of aggregation to use.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when aggregation_type is distribution.
path (str, optional) – The path to the value the rum-based metric will aggregate on. Only present when aggregation_type is distribution.

datadog_api_client.v2.model.rum_metric_response_data module¶

class RumMetricResponseData(arg: None)¶

class RumMetricResponseData(arg: ModelComposed)

class RumMetricResponseData(*args, **kwargs)

Bases: ModelNormal

The rum-based metric properties.

Parameters:

attributes (RumMetricResponseAttributes, optional) – The object describing a Datadog rum-based metric.
id (str, optional) – The name of the rum-based metric.
type (RumMetricType, optional) – The type of the resource. The value should always be rum_metrics.

datadog_api_client.v2.model.rum_metric_response_filter module¶

class RumMetricResponseFilter(arg: None)¶

class RumMetricResponseFilter(arg: ModelComposed)

class RumMetricResponseFilter(*args, **kwargs)

Bases: ModelNormal

The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.

Parameters:: query (str, optional) – The search query - following the RUM search syntax.

datadog_api_client.v2.model.rum_metric_response_group_by module¶

class RumMetricResponseGroupBy(arg: None)¶

class RumMetricResponseGroupBy(arg: ModelComposed)

class RumMetricResponseGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

path (str, optional) – The path to the value the rum-based metric will be aggregated over.
tag_name (str, optional) – Eventual name of the tag that gets created. By default, path is used as the tag name.

datadog_api_client.v2.model.rum_metric_response_uniqueness module¶

class RumMetricResponseUniqueness(arg: None)¶

class RumMetricResponseUniqueness(arg: ModelComposed)

class RumMetricResponseUniqueness(*args, **kwargs)

Bases: ModelNormal

The rule to count updatable events. Is only set if event_type is session or view.

Parameters:: when (RumMetricUniquenessWhen, optional) – When to count updatable events. match when the event is first seen, or end when the event is complete.

datadog_api_client.v2.model.rum_metric_type module¶

class RumMetricType(arg: None)¶

class RumMetricType(arg: ModelComposed)

class RumMetricType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be rum_metrics.

Parameters:

value (str) – If omitted defaults to “rum_metrics”. Must be one of [“rum_metrics”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_metric_uniqueness module¶

class RumMetricUniqueness(arg: None)¶

class RumMetricUniqueness(arg: ModelComposed)

class RumMetricUniqueness(*args, **kwargs)

Bases: ModelNormal

The rule to count updatable events. Is only set if event_type is sessions or views.

Parameters:: when (RumMetricUniquenessWhen) – When to count updatable events. match when the event is first seen, or end when the event is complete.

datadog_api_client.v2.model.rum_metric_uniqueness_when module¶

class RumMetricUniquenessWhen(arg: None)¶

class RumMetricUniquenessWhen(arg: ModelComposed)

class RumMetricUniquenessWhen(*args, **kwargs)

Bases: ModelSimple

When to count updatable events. match when the event is first seen, or end when the event is complete.

Parameters:

value (str) – Must be one of [“match”, “end”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_metric_update_attributes module¶

class RumMetricUpdateAttributes(arg: None)¶

class RumMetricUpdateAttributes(arg: ModelComposed)

class RumMetricUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The rum-based metric properties that will be updated.

Parameters:

compute (RumMetricUpdateCompute, optional) – The compute rule to compute the rum-based metric.
filter (RumMetricFilter, optional) – The rum-based metric filter. Events matching this filter will be aggregated in this metric.
group_by ([RumMetricGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.rum_metric_update_compute module¶

class RumMetricUpdateCompute(arg: None)¶

class RumMetricUpdateCompute(arg: ModelComposed)

class RumMetricUpdateCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the rum-based metric.

Parameters:: include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when aggregation_type is distribution.

datadog_api_client.v2.model.rum_metric_update_data module¶

class RumMetricUpdateData(arg: None)¶

class RumMetricUpdateData(arg: ModelComposed)

class RumMetricUpdateData(*args, **kwargs)

Bases: ModelNormal

The new rum-based metric properties.

Parameters:

attributes (RumMetricUpdateAttributes) – The rum-based metric properties that will be updated.
id (str, optional) – The name of the rum-based metric.
type (RumMetricType) – The type of the resource. The value should always be rum_metrics.

datadog_api_client.v2.model.rum_metric_update_request module¶

class RumMetricUpdateRequest(arg: None)¶

class RumMetricUpdateRequest(arg: ModelComposed)

class RumMetricUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new rum-based metric body.

Parameters:: data (RumMetricUpdateData) – The new rum-based metric properties.

datadog_api_client.v2.model.rum_metrics_response module¶

class RumMetricsResponse(arg: None)¶

class RumMetricsResponse(arg: ModelComposed)

class RumMetricsResponse(*args, **kwargs)

Bases: ModelNormal

All the available rum-based metric objects.

Parameters:: data ([RumMetricResponseData], optional) – A list of rum-based metric objects.

datadog_api_client.v2.model.rum_product_analytics_retention_scale module¶

class RUMProductAnalyticsRetentionScale(arg: None)¶

class RUMProductAnalyticsRetentionScale(arg: ModelComposed)

class RUMProductAnalyticsRetentionScale(*args, **kwargs)

Bases: ModelNormal

Product Analytics retention scale configuration.

Parameters:

last_modified_at (int, optional) – Timestamp in milliseconds when this scale was last modified.
state (RUMProductAnalyticsRetentionState, optional) – Controls the retention policy for Product Analytics data derived from RUM events.

datadog_api_client.v2.model.rum_product_analytics_retention_state module¶

class RUMProductAnalyticsRetentionState(arg: None)¶

class RUMProductAnalyticsRetentionState(arg: ModelComposed)

class RUMProductAnalyticsRetentionState(*args, **kwargs)

Bases: ModelSimple

Controls the retention policy for Product Analytics data derived from RUM events.

Parameters:

value (str) – Must be one of [“MAX”, “NONE”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_product_scales module¶

class RUMProductScales(arg: None)¶

class RUMProductScales(arg: ModelComposed)

class RUMProductScales(*args, **kwargs)

Bases: ModelNormal

Product Scales configuration for the RUM application.

Parameters:

product_analytics_retention_scale (RUMProductAnalyticsRetentionScale, optional) – Product Analytics retention scale configuration.
rum_event_processing_scale (RUMEventProcessingScale, optional) – RUM event processing scale configuration.

datadog_api_client.v2.model.rum_query_filter module¶

class RUMQueryFilter(arg: None)¶

class RUMQueryFilter(arg: ModelComposed)

class RUMQueryFilter(*args, **kwargs)

Bases: ModelNormal

The search and filter query settings.

Parameters:

_from (str, optional) –
The minimum time for the requested events; supports date (in ISO 8601 format with full date, hours, minutes, and the Z UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds).
query (str, optional) – The search query following the RUM search syntax.
to (str, optional) –
The maximum time for the requested events; supports date (in ISO 8601 format with full date, hours, minutes, and the Z UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds).

datadog_api_client.v2.model.rum_query_options module¶

class RUMQueryOptions(arg: None)¶

class RUMQueryOptions(arg: ModelComposed)

class RUMQueryOptions(*args, **kwargs)

Bases: ModelNormal

Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.

Parameters:

time_offset (int, optional) – The time offset (in seconds) to apply to the query.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

datadog_api_client.v2.model.rum_query_page_options module¶

class RUMQueryPageOptions(arg: None)¶

class RUMQueryPageOptions(arg: ModelComposed)

class RUMQueryPageOptions(*args, **kwargs)

Bases: ModelNormal

Paging attributes for listing events.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous query.
limit (int, optional) – Maximum number of events in the response.

datadog_api_client.v2.model.rum_response_links module¶

class RUMResponseLinks(arg: None)¶

class RUMResponseLinks(arg: ModelComposed)

class RUMResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. Note that the request can also be made using the POST endpoint.

datadog_api_client.v2.model.rum_response_metadata module¶

class RUMResponseMetadata(arg: None)¶

class RUMResponseMetadata(arg: ModelComposed)

class RUMResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds.
page (RUMResponsePage, optional) – Paging attributes.
request_id (str, optional) – The identifier of the request.
status (RUMResponseStatus, optional) – The status of the response.
warnings ([RUMWarning], optional) – A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.

datadog_api_client.v2.model.rum_response_page module¶

class RUMResponsePage(arg: None)¶

class RUMResponsePage(arg: ModelComposed)

class RUMResponsePage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor].

datadog_api_client.v2.model.rum_response_status module¶

class RUMResponseStatus(arg: None)¶

class RUMResponseStatus(arg: ModelComposed)

class RUMResponseStatus(*args, **kwargs)

Bases: ModelSimple

The status of the response.

Parameters:

value (str) – Must be one of [“done”, “timeout”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_retention_filter_attributes module¶

class RumRetentionFilterAttributes(arg: None)¶

class RumRetentionFilterAttributes(arg: ModelComposed)

class RumRetentionFilterAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing attributes of a RUM retention filter.

Parameters:

enabled (bool, optional) – Whether the retention filter is enabled.
event_type (RumRetentionFilterEventType, optional) – The type of RUM events to filter on.
name (str, optional) – The name of a RUM retention filter.
query (str, optional) – The query string for a RUM retention filter.
sample_rate (int, optional) – The sample rate for a RUM retention filter, between 0 and 100.

datadog_api_client.v2.model.rum_retention_filter_create_attributes module¶

class RumRetentionFilterCreateAttributes(arg: None)¶

class RumRetentionFilterCreateAttributes(arg: ModelComposed)

class RumRetentionFilterCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing attributes of a RUM retention filter to create.

Parameters:

enabled (bool, optional) – Whether the retention filter is enabled.
event_type (RumRetentionFilterEventType) – The type of RUM events to filter on.
name (str) – The name of a RUM retention filter.
query (str, optional) – The query string for a RUM retention filter.
sample_rate (int) – The sample rate for a RUM retention filter, between 0 and 100.

datadog_api_client.v2.model.rum_retention_filter_create_data module¶

class RumRetentionFilterCreateData(arg: None)¶

class RumRetentionFilterCreateData(arg: ModelComposed)

class RumRetentionFilterCreateData(*args, **kwargs)

Bases: ModelNormal

The new RUM retention filter properties to create.

Parameters:

attributes (RumRetentionFilterCreateAttributes) – The object describing attributes of a RUM retention filter to create.
type (RumRetentionFilterType) – The type of the resource. The value should always be retention_filters.

datadog_api_client.v2.model.rum_retention_filter_create_request module¶

class RumRetentionFilterCreateRequest(arg: None)¶

class RumRetentionFilterCreateRequest(arg: ModelComposed)

class RumRetentionFilterCreateRequest(*args, **kwargs)

Bases: ModelNormal

The RUM retention filter body to create.

Parameters:: data (RumRetentionFilterCreateData) – The new RUM retention filter properties to create.

datadog_api_client.v2.model.rum_retention_filter_data module¶

class RumRetentionFilterData(arg: None)¶

class RumRetentionFilterData(arg: ModelComposed)

class RumRetentionFilterData(*args, **kwargs)

Bases: ModelNormal

The RUM retention filter.

Parameters:

attributes (RumRetentionFilterAttributes, optional) – The object describing attributes of a RUM retention filter.
id (str, optional) – ID of retention filter in UUID.
type (RumRetentionFilterType, optional) – The type of the resource. The value should always be retention_filters.

datadog_api_client.v2.model.rum_retention_filter_event_type module¶

class RumRetentionFilterEventType(arg: None)¶

class RumRetentionFilterEventType(arg: ModelComposed)

class RumRetentionFilterEventType(*args, **kwargs)

Bases: ModelSimple

The type of RUM events to filter on.

Parameters:

value (str) – Must be one of [“session”, “view”, “action”, “error”, “resource”, “long_task”, “vital”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_retention_filter_response module¶

class RumRetentionFilterResponse(arg: None)¶

class RumRetentionFilterResponse(arg: ModelComposed)

class RumRetentionFilterResponse(*args, **kwargs)

Bases: ModelNormal

The RUM retention filter object.

Parameters:: data (RumRetentionFilterData, optional) – The RUM retention filter.

datadog_api_client.v2.model.rum_retention_filter_type module¶

class RumRetentionFilterType(arg: None)¶

class RumRetentionFilterType(arg: ModelComposed)

class RumRetentionFilterType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be retention_filters.

Parameters:

value (str) – If omitted defaults to “retention_filters”. Must be one of [“retention_filters”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_retention_filter_update_attributes module¶

class RumRetentionFilterUpdateAttributes(arg: None)¶

class RumRetentionFilterUpdateAttributes(arg: ModelComposed)

class RumRetentionFilterUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing attributes of a RUM retention filter to update.

Parameters:

enabled (bool, optional) – Whether the retention filter is enabled.
event_type (RumRetentionFilterEventType, optional) – The type of RUM events to filter on.
name (str, optional) – The name of a RUM retention filter.
query (str, optional) – The query string for a RUM retention filter.
sample_rate (int, optional) – The sample rate for a RUM retention filter, between 0 and 100.

datadog_api_client.v2.model.rum_retention_filter_update_data module¶

class RumRetentionFilterUpdateData(arg: None)¶

class RumRetentionFilterUpdateData(arg: ModelComposed)

class RumRetentionFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

The new RUM retention filter properties to update.

Parameters:

attributes (RumRetentionFilterUpdateAttributes) – The object describing attributes of a RUM retention filter to update.
id (str) – ID of retention filter in UUID.
type (RumRetentionFilterType) – The type of the resource. The value should always be retention_filters.

datadog_api_client.v2.model.rum_retention_filter_update_request module¶

class RumRetentionFilterUpdateRequest(arg: None)¶

class RumRetentionFilterUpdateRequest(arg: ModelComposed)

class RumRetentionFilterUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The RUM retention filter body to update.

Parameters:: data (RumRetentionFilterUpdateData) – The new RUM retention filter properties to update.

datadog_api_client.v2.model.rum_retention_filters_order_data module¶

class RumRetentionFiltersOrderData(arg: None)¶

class RumRetentionFiltersOrderData(arg: ModelComposed)

class RumRetentionFiltersOrderData(*args, **kwargs)

Bases: ModelNormal

The RUM retention filter data for ordering.

Parameters:

id (str) – ID of retention filter in UUID.
type (RumRetentionFilterType) – The type of the resource. The value should always be retention_filters.

datadog_api_client.v2.model.rum_retention_filters_order_request module¶

class RumRetentionFiltersOrderRequest(arg: None)¶

class RumRetentionFiltersOrderRequest(arg: ModelComposed)

class RumRetentionFiltersOrderRequest(*args, **kwargs)

Bases: ModelNormal

The list of RUM retention filter IDs along with their corresponding type to reorder. All retention filter IDs should be included in the list created for a RUM application.

Parameters:: data ([RumRetentionFiltersOrderData], optional) – A list of RUM retention filter IDs along with type.

datadog_api_client.v2.model.rum_retention_filters_order_response module¶

class RumRetentionFiltersOrderResponse(arg: None)¶

class RumRetentionFiltersOrderResponse(arg: ModelComposed)

class RumRetentionFiltersOrderResponse(*args, **kwargs)

Bases: ModelNormal

The list of RUM retention filter IDs along with type.

Parameters:: data ([RumRetentionFiltersOrderData], optional) – A list of RUM retention filter IDs along with type.

datadog_api_client.v2.model.rum_retention_filters_response module¶

class RumRetentionFiltersResponse(arg: None)¶

class RumRetentionFiltersResponse(arg: ModelComposed)

class RumRetentionFiltersResponse(*args, **kwargs)

Bases: ModelNormal

All RUM retention filters for a RUM application.

Parameters:: data ([RumRetentionFilterData], optional) – A list of RUM retention filters.

datadog_api_client.v2.model.rum_search_events_request module¶

class RUMSearchEventsRequest(arg: None)¶

class RUMSearchEventsRequest(arg: ModelComposed)

class RUMSearchEventsRequest(*args, **kwargs)

Bases: ModelNormal

The request for a RUM events list.

Parameters:

filter (RUMQueryFilter, optional) – The search and filter query settings.
options (RUMQueryOptions, optional) – Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
page (RUMQueryPageOptions, optional) – Paging attributes for listing events.
sort (RUMSort, optional) – Sort parameters when querying events.

datadog_api_client.v2.model.rum_sort module¶

class RUMSort(arg: None)¶

class RUMSort(arg: ModelComposed)

class RUMSort(*args, **kwargs)

Bases: ModelSimple

Sort parameters when querying events.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_sort_order module¶

class RUMSortOrder(arg: None)¶

class RUMSortOrder(arg: ModelComposed)

class RUMSortOrder(*args, **kwargs)

Bases: ModelSimple

The order to use, ascending or descending.

Parameters:

value (str) – Must be one of [“asc”, “desc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.rum_warning module¶

class RUMWarning(arg: None)¶

class RUMWarning(arg: ModelComposed)

class RUMWarning(*args, **kwargs)

Bases: ModelNormal

A warning message indicating something that went wrong with the query.

Parameters:

code (str, optional) – A unique code for this type of warning.
detail (str, optional) – A detailed explanation of this specific warning.
title (str, optional) – A short human-readable summary of the warning.

datadog_api_client.v2.model.run_threat_hunting_job_request module¶

class RunThreatHuntingJobRequest(arg: None)¶

class RunThreatHuntingJobRequest(arg: ModelComposed)

class RunThreatHuntingJobRequest(*args, **kwargs)

Bases: ModelNormal

Run a threat hunting job request.

Parameters:: data (RunThreatHuntingJobRequestData, optional) – Data for running a threat hunting job request.

datadog_api_client.v2.model.run_threat_hunting_job_request_attributes module¶

class RunThreatHuntingJobRequestAttributes(arg: None)¶

class RunThreatHuntingJobRequestAttributes(arg: ModelComposed)

class RunThreatHuntingJobRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Run a threat hunting job request.

Parameters:

from_rule (JobDefinitionFromRule, optional) – Definition of a threat hunting job based on a security monitoring rule.
id (str, optional) – Request ID.
job_definition (JobDefinition, optional) – Definition of a threat hunting job.

datadog_api_client.v2.model.run_threat_hunting_job_request_data module¶

class RunThreatHuntingJobRequestData(arg: None)¶

class RunThreatHuntingJobRequestData(arg: ModelComposed)

class RunThreatHuntingJobRequestData(*args, **kwargs)

Bases: ModelNormal

Data for running a threat hunting job request.

Parameters:

attributes (RunThreatHuntingJobRequestAttributes, optional) – Run a threat hunting job request.
type (RunThreatHuntingJobRequestDataType, optional) – Type of data.

datadog_api_client.v2.model.run_threat_hunting_job_request_data_type module¶

class RunThreatHuntingJobRequestDataType(arg: None)¶

class RunThreatHuntingJobRequestDataType(arg: ModelComposed)

class RunThreatHuntingJobRequestDataType(*args, **kwargs)

Bases: ModelSimple

Type of data.

Parameters:

value (str) – If omitted defaults to “historicalDetectionsJobCreate”. Must be one of [“historicalDetectionsJobCreate”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.saml_assertion_attribute module¶

class SAMLAssertionAttribute(arg: None)¶

class SAMLAssertionAttribute(arg: ModelComposed)

class SAMLAssertionAttribute(*args, **kwargs)

Bases: ModelNormal

SAML assertion attribute.

Parameters:

attributes (SAMLAssertionAttributeAttributes, optional) – Key/Value pair of attributes used in SAML assertion attributes.
id (str) – The ID of the SAML assertion attribute.
type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.

datadog_api_client.v2.model.saml_assertion_attribute_attributes module¶

class SAMLAssertionAttributeAttributes(arg: None)¶

class SAMLAssertionAttributeAttributes(arg: ModelComposed)

class SAMLAssertionAttributeAttributes(*args, **kwargs)

Bases: ModelNormal

Key/Value pair of attributes used in SAML assertion attributes.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.

datadog_api_client.v2.model.saml_assertion_attributes_type module¶

class SAMLAssertionAttributesType(arg: None)¶

class SAMLAssertionAttributesType(arg: ModelComposed)

class SAMLAssertionAttributesType(*args, **kwargs)

Bases: ModelSimple

SAML assertion attributes resource type.

Parameters:

value (str) – If omitted defaults to “saml_assertion_attributes”. Must be one of [“saml_assertion_attributes”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sbom module¶

class SBOM(arg: None)¶

class SBOM(arg: ModelComposed)

class SBOM(*args, **kwargs)

Bases: ModelNormal

A single SBOM

Parameters:

attributes (SBOMAttributes, optional) – The JSON:API attributes of the SBOM.
id (str, optional) – The unique ID for this SBOM (it is equivalent to the asset_name or asset_name@repo_digest (Image)
type (SBOMType, optional) – The JSON:API type.

datadog_api_client.v2.model.sbom_attributes module¶

class SBOMAttributes(arg: None)¶

class SBOMAttributes(arg: ModelComposed)

class SBOMAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes of the SBOM.

Parameters:

bom_format (str) – Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOM do not have a filename convention nor does JSON schema support namespaces. This value MUST be CycloneDX.
components ([SBOMComponent]) – A list of software and hardware components.
dependencies ([SBOMComponentDependency]) – List of dependencies between components of the SBOM.
metadata (SBOMMetadata) – Provides additional information about a BOM.
serial_number (str) – Every BOM generated has a unique serial number, even if the contents of the BOM have not changed overt time. The serial number follows RFC-4122
spec_version (SpecVersion) – The version of the CycloneDX specification a BOM conforms to.
version (int) – It increments when a BOM is modified. The default value is 1.

datadog_api_client.v2.model.sbom_component module¶

class SBOMComponent(arg: None)¶

class SBOMComponent(arg: ModelComposed)

class SBOMComponent(*args, **kwargs)

Bases: ModelNormal

Software or hardware component.

Parameters:

bom_ref (str, optional) – An optional identifier that can be used to reference the component elsewhere in the BOM.
licenses ([SBOMComponentLicense], optional) – The software licenses of the SBOM component.
name (str) – The name of the component. This will often be a shortened, single name of the component.
properties ([SBOMComponentProperty], optional) – The custom properties of the component of the SBOM.
purl (str, optional) – Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification.
supplier (SBOMComponentSupplier) – The supplier of the component.
type (SBOMComponentType) – The SBOM component type
version (str) – The component version.

datadog_api_client.v2.model.sbom_component_dependency module¶

class SBOMComponentDependency(arg: None)¶

class SBOMComponentDependency(arg: ModelComposed)

class SBOMComponentDependency(*args, **kwargs)

Bases: ModelNormal

The dependencies of a component of the SBOM.

Parameters:

depends_on ([str], optional) – The components that are dependencies of the ref component.
ref (str, optional) – The identifier for the related component.

datadog_api_client.v2.model.sbom_component_license module¶

class SBOMComponentLicense(arg: None)¶

class SBOMComponentLicense(arg: ModelComposed)

class SBOMComponentLicense(*args, **kwargs)

Bases: ModelNormal

The software license of the component of the SBOM.

Parameters:: license (SBOMComponentLicenseLicense) – The software license of the component of the SBOM.

datadog_api_client.v2.model.sbom_component_license_license module¶

class SBOMComponentLicenseLicense(arg: None)¶

class SBOMComponentLicenseLicense(arg: ModelComposed)

class SBOMComponentLicenseLicense(*args, **kwargs)

Bases: ModelNormal

The software license of the component of the SBOM.

Parameters:: name (str) – The name of the software license of the component of the SBOM.

datadog_api_client.v2.model.sbom_component_license_type module¶

class SBOMComponentLicenseType(arg: None)¶

class SBOMComponentLicenseType(arg: ModelComposed)

class SBOMComponentLicenseType(*args, **kwargs)

Bases: ModelSimple

The SBOM component license type.

Parameters:

value (str) – Must be one of [“network_strong_copyleft”, “non_standard_copyleft”, “other_non_free”, “other_non_standard”, “permissive”, “public_domain”, “strong_copyleft”, “weak_copyleft”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sbom_component_property module¶

class SBOMComponentProperty(arg: None)¶

class SBOMComponentProperty(arg: ModelComposed)

class SBOMComponentProperty(*args, **kwargs)

Bases: ModelNormal

The custom property of the component of the SBOM.

Parameters:

name (str) – The name of the custom property of the component of the SBOM.
value (str) – The value of the custom property of the component of the SBOM.

datadog_api_client.v2.model.sbom_component_supplier module¶

class SBOMComponentSupplier(arg: None)¶

class SBOMComponentSupplier(arg: ModelComposed)

class SBOMComponentSupplier(*args, **kwargs)

Bases: ModelNormal

The supplier of the component.

Parameters:: name (str) – Identifier of the supplier of the component.

datadog_api_client.v2.model.sbom_component_type module¶

class SBOMComponentType(arg: None)¶

class SBOMComponentType(arg: ModelComposed)

class SBOMComponentType(*args, **kwargs)

Bases: ModelSimple

The SBOM component type

Parameters:

value (str) – Must be one of [“application”, “container”, “data”, “device”, “device-driver”, “file”, “firmware”, “framework”, “library”, “machine-learning-model”, “operating-system”, “platform”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sbom_format module¶

class SBOMFormat(arg: None)¶

class SBOMFormat(arg: ModelComposed)

class SBOMFormat(*args, **kwargs)

Bases: ModelSimple

The SBOM standard

Parameters:

value (str) – Must be one of [“CycloneDX”, “SPDX”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sbom_metadata module¶

class SBOMMetadata(arg: None)¶

class SBOMMetadata(arg: ModelComposed)

class SBOMMetadata(*args, **kwargs)

Bases: ModelNormal

Provides additional information about a BOM.

Parameters:

authors ([SBOMMetadataAuthor], optional) – List of authors of the SBOM.
component (SBOMMetadataComponent, optional) – The component that the BOM describes.
timestamp (str, optional) – The timestamp of the SBOM creation.

datadog_api_client.v2.model.sbom_metadata_author module¶

class SBOMMetadataAuthor(arg: None)¶

class SBOMMetadataAuthor(arg: ModelComposed)

class SBOMMetadataAuthor(*args, **kwargs)

Bases: ModelNormal

Author of the SBOM.

Parameters:: name (str, optional) – The identifier of the Author of the SBOM.

datadog_api_client.v2.model.sbom_metadata_component module¶

class SBOMMetadataComponent(arg: None)¶

class SBOMMetadataComponent(arg: ModelComposed)

class SBOMMetadataComponent(*args, **kwargs)

Bases: ModelNormal

The component that the BOM describes.

Parameters:

name (str, optional) – The name of the component. This will often be a shortened, single name of the component.
type (str, optional) – Specifies the type of the component.

datadog_api_client.v2.model.sbom_type module¶

class SBOMType(arg: None)¶

class SBOMType(arg: ModelComposed)

class SBOMType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type.

Parameters:

value (str) – If omitted defaults to “sboms”. Must be one of [“sboms”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sca_request module¶

class ScaRequest(arg: None)¶

class ScaRequest(arg: ModelComposed)

class ScaRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (ScaRequestData, optional)

datadog_api_client.v2.model.sca_request_data module¶

class ScaRequestData(arg: None)¶

class ScaRequestData(arg: ModelComposed)

class ScaRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (ScaRequestDataAttributes, optional)
id (str, optional)
type (ScaRequestDataType)

datadog_api_client.v2.model.sca_request_data_attributes module¶

class ScaRequestDataAttributes(arg: None)¶

class ScaRequestDataAttributes(arg: ModelComposed)

class ScaRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

commit (ScaRequestDataAttributesCommit, optional)
dependencies ([ScaRequestDataAttributesDependenciesItems], optional)
env (str, optional)
files ([ScaRequestDataAttributesFilesItems], optional)
relations ([ScaRequestDataAttributesRelationsItems], optional)
repository (ScaRequestDataAttributesRepository, optional)
service (str, optional)
tags ({str: (str,)}, optional)
vulnerabilities ([ScaRequestDataAttributesVulnerabilitiesItems], optional)

datadog_api_client.v2.model.sca_request_data_attributes_commit module¶

class ScaRequestDataAttributesCommit(arg: None)¶

class ScaRequestDataAttributesCommit(arg: ModelComposed)

class ScaRequestDataAttributesCommit(*args, **kwargs)

Bases: ModelNormal

Parameters:

author_date (str, optional)
author_email (str, optional)
author_name (str, optional)
branch (str, optional)
committer_email (str, optional)
committer_name (str, optional)
sha (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_dependencies_items module¶

class ScaRequestDataAttributesDependenciesItems(arg: None)¶

class ScaRequestDataAttributesDependenciesItems(arg: ModelComposed)

class ScaRequestDataAttributesDependenciesItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

exclusions ([str], optional)
group (str, optional)
is_dev (bool, optional)
is_direct (bool, optional)
language (str, optional)
locations ([ScaRequestDataAttributesDependenciesItemsLocationsItems], optional)
name (str, optional)
package_manager (str, optional)
purl (str, optional)
reachable_symbol_properties ([ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems], optional)
version (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_dependencies_items_locations_items module¶

class ScaRequestDataAttributesDependenciesItemsLocationsItems(arg: None)¶

class ScaRequestDataAttributesDependenciesItemsLocationsItems(arg: ModelComposed)

class ScaRequestDataAttributesDependenciesItemsLocationsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

block (ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional)
name (ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional)
namespace (ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional)
version (ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition, optional)

datadog_api_client.v2.model.sca_request_data_attributes_dependencies_items_locations_items_file_position module¶

class ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition(arg: None)¶

class ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition(arg: ModelComposed)

class ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition(*args, **kwargs)

Bases: ModelNormal

Parameters:

end (ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition, optional)
file_name (str, optional)
start (ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition, optional)

datadog_api_client.v2.model.sca_request_data_attributes_dependencies_items_locations_items_position module¶

class ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition(arg: None)¶

class ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition(arg: ModelComposed)

class ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition(*args, **kwargs)

Bases: ModelNormal

Parameters:

col (int, optional)
line (int, optional)

datadog_api_client.v2.model.sca_request_data_attributes_dependencies_items_reachable_symbol_properties_items module¶

class ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems(arg: None)¶

class ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems(arg: ModelComposed)

class ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

name (str, optional)
value (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_files_items module¶

class ScaRequestDataAttributesFilesItems(arg: None)¶

class ScaRequestDataAttributesFilesItems(arg: ModelComposed)

class ScaRequestDataAttributesFilesItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

name (str, optional)
purl (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_relations_items module¶

class ScaRequestDataAttributesRelationsItems(arg: None)¶

class ScaRequestDataAttributesRelationsItems(arg: ModelComposed)

class ScaRequestDataAttributesRelationsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

depends_on ([str], optional)
ref (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_repository module¶

class ScaRequestDataAttributesRepository(arg: None)¶

class ScaRequestDataAttributesRepository(arg: ModelComposed)

class ScaRequestDataAttributesRepository(*args, **kwargs)

Bases: ModelNormal

Parameters:: url (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_vulnerabilities_items module¶

class ScaRequestDataAttributesVulnerabilitiesItems(arg: None)¶

class ScaRequestDataAttributesVulnerabilitiesItems(arg: ModelComposed)

class ScaRequestDataAttributesVulnerabilitiesItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

affects ([ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems], optional)
bom_ref (str, optional)
id (str, optional)

datadog_api_client.v2.model.sca_request_data_attributes_vulnerabilities_items_affects_items module¶

class ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems(arg: None)¶

class ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems(arg: ModelComposed)

class ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems(*args, **kwargs)

Bases: ModelNormal

Parameters:: ref (str, optional)

datadog_api_client.v2.model.sca_request_data_type module¶

class ScaRequestDataType(arg: None)¶

class ScaRequestDataType(arg: ModelComposed)

class ScaRequestDataType(*args, **kwargs)

Bases: ModelSimple

Parameters:

value (str) – If omitted defaults to “scarequests”. Must be one of [“scarequests”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scalar_column module¶

class ScalarColumn(arg: None)¶

class ScalarColumn(arg: ModelComposed)

class ScalarColumn(*args, **kwargs)

Bases: ModelComposed

A single column in a scalar query response.

Parameters:

name (str, optional) – The name of the tag key or group.
type (ScalarColumnTypeGroup, optional) – The type of column present for groups.
values ([[str]], optional) – The array of tag values for each group found for the results of the formulas or queries.
meta (ScalarMeta, optional) – Metadata for the resulting numerical values.

datadog_api_client.v2.model.scalar_column_type_group module¶

class ScalarColumnTypeGroup(arg: None)¶

class ScalarColumnTypeGroup(arg: ModelComposed)

class ScalarColumnTypeGroup(*args, **kwargs)

Bases: ModelSimple

The type of column present for groups.

Parameters:

value (str) – If omitted defaults to “group”. Must be one of [“group”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scalar_column_type_number module¶

class ScalarColumnTypeNumber(arg: None)¶

class ScalarColumnTypeNumber(arg: ModelComposed)

class ScalarColumnTypeNumber(*args, **kwargs)

Bases: ModelSimple

The type of column present for numbers.

Parameters:

value (str) – If omitted defaults to “number”. Must be one of [“number”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scalar_formula_query_request module¶

class ScalarFormulaQueryRequest(arg: None)¶

class ScalarFormulaQueryRequest(arg: ModelComposed)

class ScalarFormulaQueryRequest(*args, **kwargs)

Bases: ModelNormal

A wrapper request around one scalar query to be executed.

Parameters:: data (ScalarFormulaRequest) – A single scalar query to be executed.

datadog_api_client.v2.model.scalar_formula_query_response module¶

class ScalarFormulaQueryResponse(arg: None)¶

class ScalarFormulaQueryResponse(arg: ModelComposed)

class ScalarFormulaQueryResponse(*args, **kwargs)

Bases: ModelNormal

A message containing one or more responses to scalar queries.

Parameters:

data (ScalarResponse, optional) – A message containing the response to a scalar query.
errors (str, optional) – An error generated when processing a request.

datadog_api_client.v2.model.scalar_formula_request module¶

class ScalarFormulaRequest(arg: None)¶

class ScalarFormulaRequest(arg: ModelComposed)

class ScalarFormulaRequest(*args, **kwargs)

Bases: ModelNormal

A single scalar query to be executed.

Parameters:

attributes (ScalarFormulaRequestAttributes) – The object describing a scalar formula request.
type (ScalarFormulaRequestType) – The type of the resource. The value should always be scalar_request.

datadog_api_client.v2.model.scalar_formula_request_attributes module¶

class ScalarFormulaRequestAttributes(arg: None)¶

class ScalarFormulaRequestAttributes(arg: ModelComposed)

class ScalarFormulaRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a scalar formula request.

Parameters:

formulas ([QueryFormula], optional) – List of formulas to be calculated and returned as responses.
_from (int) – Start date (inclusive) of the query in milliseconds since the Unix epoch.
queries (ScalarFormulaRequestQueries) – List of queries to be run and used as inputs to the formulas.
to (int) – End date (exclusive) of the query in milliseconds since the Unix epoch.

datadog_api_client.v2.model.scalar_formula_request_queries module¶

class ScalarFormulaRequestQueries(arg: None)¶

class ScalarFormulaRequestQueries(arg: ModelComposed)

class ScalarFormulaRequestQueries(*args, **kwargs)

Bases: ModelSimple

List of queries to be run and used as inputs to the formulas.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scalar_formula_request_type module¶

class ScalarFormulaRequestType(arg: None)¶

class ScalarFormulaRequestType(arg: ModelComposed)

class ScalarFormulaRequestType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be scalar_request.

Parameters:

value (str) – If omitted defaults to “scalar_request”. Must be one of [“scalar_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scalar_formula_response_atrributes module¶

class ScalarFormulaResponseAtrributes(arg: None)¶

class ScalarFormulaResponseAtrributes(arg: ModelComposed)

class ScalarFormulaResponseAtrributes(*args, **kwargs)

Bases: ModelNormal

The object describing a scalar response.

Parameters:: columns ([ScalarColumn], optional) – List of response columns, each corresponding to an individual formula or query in the request and with values in parallel arrays matching the series list.

datadog_api_client.v2.model.scalar_formula_response_type module¶

class ScalarFormulaResponseType(arg: None)¶

class ScalarFormulaResponseType(arg: ModelComposed)

class ScalarFormulaResponseType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be scalar_response.

Parameters:

value (str) – If omitted defaults to “scalar_response”. Must be one of [“scalar_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scalar_meta module¶

class ScalarMeta(arg: None)¶

class ScalarMeta(arg: ModelComposed)

class ScalarMeta(*args, **kwargs)

Bases: ModelNormal

Metadata for the resulting numerical values.

Parameters:: unit ([Unit, none_type], none_type, optional) – Detailed information about the unit. First element describes the “primary unit” (for example, bytes in bytes per second ). The second element describes the “per unit” (for example, second in bytes per second ). If the second element is not present, the API returns null.

datadog_api_client.v2.model.scalar_query module¶

class ScalarQuery(arg: None)¶

class ScalarQuery(arg: ModelComposed)

class ScalarQuery(*args, **kwargs)

Bases: ModelComposed

An individual scalar query to one of the basic Datadog data sources.

Parameters:

aggregator (MetricsAggregator) – The type of aggregation that can be performed on metrics-based queries.
data_source (MetricsDataSource) – A data source that is powered by the Metrics platform.
name (str, optional) – The variable name for use in formulas.
query (str) – A classic metrics query string.
compute (EventsCompute) – The instructions for what to compute for this query.
group_by (EventsQueryGroupBys, optional) – The list of facets on which to split results.
indexes ([str], optional) – The indexes in which to search.
search (EventsSearch, optional) – Configuration of the search/filter for an events query.

datadog_api_client.v2.model.scalar_response module¶

class ScalarResponse(arg: None)¶

class ScalarResponse(arg: ModelComposed)

class ScalarResponse(*args, **kwargs)

Bases: ModelNormal

A message containing the response to a scalar query.

Parameters:

attributes (ScalarFormulaResponseAtrributes, optional) – The object describing a scalar response.
type (ScalarFormulaResponseType, optional) – The type of the resource. The value should always be scalar_response.

datadog_api_client.v2.model.scanned_asset_metadata module¶

class ScannedAssetMetadata(arg: None)¶

class ScannedAssetMetadata(arg: ModelComposed)

class ScannedAssetMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata of a scanned asset.

Parameters:

attributes (ScannedAssetMetadataAttributes) – The attributes of a scanned asset metadata.
id (str) – The ID of the scanned asset metadata.

datadog_api_client.v2.model.scanned_asset_metadata_asset module¶

class ScannedAssetMetadataAsset(arg: None)¶

class ScannedAssetMetadataAsset(arg: ModelComposed)

class ScannedAssetMetadataAsset(*args, **kwargs)

Bases: ModelNormal

The asset of a scanned asset metadata.

Parameters:

name (str) – The name of the asset.
type (CloudAssetType) – The cloud asset type

datadog_api_client.v2.model.scanned_asset_metadata_attributes module¶

class ScannedAssetMetadataAttributes(arg: None)¶

class ScannedAssetMetadataAttributes(arg: ModelComposed)

class ScannedAssetMetadataAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of a scanned asset metadata.

Parameters:

asset (ScannedAssetMetadataAsset) – The asset of a scanned asset metadata.
first_success_timestamp (str) – The timestamp when the scan of the asset was performed for the first time.
last_success (ScannedAssetMetadataLastSuccess) – Metadata for the last successful scan of an asset.

datadog_api_client.v2.model.scanned_asset_metadata_last_success module¶

class ScannedAssetMetadataLastSuccess(arg: None)¶

class ScannedAssetMetadataLastSuccess(arg: ModelComposed)

class ScannedAssetMetadataLastSuccess(*args, **kwargs)

Bases: ModelNormal

Metadata for the last successful scan of an asset.

Parameters:

env (str, optional) – The environment of the last success scan of the asset.
origin ([str], optional) – The list of origins of the last success scan of the asset.
timestamp (str) – The timestamp of the last success scan of the asset.

datadog_api_client.v2.model.scanned_assets_metadata module¶

class ScannedAssetsMetadata(arg: None)¶

class ScannedAssetsMetadata(arg: ModelComposed)

class ScannedAssetsMetadata(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing scanned assets metadata.

Parameters:

data ([ScannedAssetMetadata]) – List of scanned assets metadata.
links (Links, optional) – The JSON:API links related to pagination.
meta (Metadata, optional) – The metadata related to this request.

datadog_api_client.v2.model.schedule module¶

class Schedule(arg: None)¶

class Schedule(arg: ModelComposed)

class Schedule(*args, **kwargs)

Bases: ModelNormal

Top-level container for a schedule object, including both the data payload and any related included resources (such as teams, layers, or members).

Parameters:

data (ScheduleData, optional) – Represents the primary data object for a schedule, linking attributes and relationships.
included ([ScheduleDataIncludedItem], optional) – Any additional resources related to this schedule, such as teams and layers.

datadog_api_client.v2.model.schedule_create_request module¶

class ScheduleCreateRequest(arg: None)¶

class ScheduleCreateRequest(arg: ModelComposed)

class ScheduleCreateRequest(*args, **kwargs)

Bases: ModelNormal

The top-level request body for schedule creation, wrapping a data object.

Parameters:: data (ScheduleCreateRequestData) – The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.

datadog_api_client.v2.model.schedule_create_request_data module¶

class ScheduleCreateRequestData(arg: None)¶

class ScheduleCreateRequestData(arg: ModelComposed)

class ScheduleCreateRequestData(*args, **kwargs)

Bases: ModelNormal

The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.

Parameters:

attributes (ScheduleCreateRequestDataAttributes) – Describes the main attributes for creating a new schedule, including name, layers, and time zone.
relationships (ScheduleCreateRequestDataRelationships, optional) – Gathers relationship objects for the schedule creation request, including the teams to associate.
type (ScheduleCreateRequestDataType) – Schedules resource type.

datadog_api_client.v2.model.schedule_create_request_data_attributes module¶

class ScheduleCreateRequestDataAttributes(arg: None)¶

class ScheduleCreateRequestDataAttributes(arg: ModelComposed)

class ScheduleCreateRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Describes the main attributes for creating a new schedule, including name, layers, and time zone.

Parameters:

layers ([ScheduleCreateRequestDataAttributesLayersItems]) – The layers of On-Call coverage that define rotation intervals and restrictions.
name (str) – A human-readable name for the new schedule.
time_zone (str) – The time zone in which the schedule is defined.

datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items module¶

class ScheduleCreateRequestDataAttributesLayersItems(arg: None)¶

class ScheduleCreateRequestDataAttributesLayersItems(arg: ModelComposed)

class ScheduleCreateRequestDataAttributesLayersItems(*args, **kwargs)

Bases: ModelNormal

Describes a schedule layer, including rotation intervals, members, restrictions, and timeline settings.

Parameters:

effective_date (datetime) – The date/time when this layer becomes active (in ISO 8601).
end_date (datetime, optional) – The date/time after which this layer no longer applies (in ISO 8601).
interval (LayerAttributesInterval) – Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
members ([ScheduleRequestDataAttributesLayersItemsMembersItems]) – A list of members who participate in this layer’s rotation.
name (str) – The name of this layer.
restrictions ([TimeRestriction], optional) – Zero or more time-based restrictions (for example, only weekdays, during business hours).
rotation_start (datetime) – The date/time when the rotation for this layer starts (in ISO 8601).
time_zone (str, optional) – The time zone for this layer.

datadog_api_client.v2.model.schedule_create_request_data_relationships module¶

class ScheduleCreateRequestDataRelationships(arg: None)¶

class ScheduleCreateRequestDataRelationships(arg: ModelComposed)

class ScheduleCreateRequestDataRelationships(*args, **kwargs)

Bases: ModelNormal

Gathers relationship objects for the schedule creation request, including the teams to associate.

Parameters:: teams (DataRelationshipsTeams, optional) – Associates teams with this schedule in a data structure.

datadog_api_client.v2.model.schedule_create_request_data_type module¶

class ScheduleCreateRequestDataType(arg: None)¶

class ScheduleCreateRequestDataType(arg: ModelComposed)

class ScheduleCreateRequestDataType(*args, **kwargs)

Bases: ModelSimple

Schedules resource type.

Parameters:

value (str) – If omitted defaults to “schedules”. Must be one of [“schedules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_data module¶

class ScheduleData(arg: None)¶

class ScheduleData(arg: ModelComposed)

class ScheduleData(*args, **kwargs)

Bases: ModelNormal

Represents the primary data object for a schedule, linking attributes and relationships.

Parameters:

attributes (ScheduleDataAttributes, optional) – Provides core properties of a schedule object such as its name and time zone.
id (str, optional) – The schedule’s unique identifier.
relationships (ScheduleDataRelationships, optional) – Groups the relationships for a schedule object, referencing layers and teams.
type (ScheduleDataType) – Schedules resource type.

datadog_api_client.v2.model.schedule_data_attributes module¶

class ScheduleDataAttributes(arg: None)¶

class ScheduleDataAttributes(arg: ModelComposed)

class ScheduleDataAttributes(*args, **kwargs)

Bases: ModelNormal

Provides core properties of a schedule object such as its name and time zone.

Parameters:

name (str, optional) – A short name for the schedule.
time_zone (str, optional) – The time zone in which this schedule operates.

datadog_api_client.v2.model.schedule_data_included_item module¶

class ScheduleDataIncludedItem(arg: None)¶

class ScheduleDataIncludedItem(arg: ModelComposed)

class ScheduleDataIncludedItem(*args, **kwargs)

Bases: ModelComposed

Any additional resources related to this schedule, such as teams and layers.

Parameters:

attributes (TeamReferenceAttributes, optional) – Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
id (str, optional) – The team’s unique identifier.
type (TeamReferenceType) – Teams resource type.
relationships (LayerRelationships, optional) – Holds references to objects related to the Layer entity, such as its members.

datadog_api_client.v2.model.schedule_data_relationships module¶

class ScheduleDataRelationships(arg: None)¶

class ScheduleDataRelationships(arg: ModelComposed)

class ScheduleDataRelationships(*args, **kwargs)

Bases: ModelNormal

Groups the relationships for a schedule object, referencing layers and teams.

Parameters:

layers (ScheduleDataRelationshipsLayers, optional) – Associates layers with this schedule in a data structure.
teams (DataRelationshipsTeams, optional) – Associates teams with this schedule in a data structure.

datadog_api_client.v2.model.schedule_data_relationships_layers module¶

class ScheduleDataRelationshipsLayers(arg: None)¶

class ScheduleDataRelationshipsLayers(arg: ModelComposed)

class ScheduleDataRelationshipsLayers(*args, **kwargs)

Bases: ModelNormal

Associates layers with this schedule in a data structure.

Parameters:: data ([ScheduleDataRelationshipsLayersDataItems], optional) – An array of layer references for this schedule.

datadog_api_client.v2.model.schedule_data_relationships_layers_data_items module¶

class ScheduleDataRelationshipsLayersDataItems(arg: None)¶

class ScheduleDataRelationshipsLayersDataItems(arg: ModelComposed)

class ScheduleDataRelationshipsLayersDataItems(*args, **kwargs)

Bases: ModelNormal

Relates a layer to this schedule, identified by id and type (must be layers ).

Parameters:

id (str) – The unique identifier of the layer in this relationship.
type (ScheduleDataRelationshipsLayersDataItemsType) – Layers resource type.

datadog_api_client.v2.model.schedule_data_relationships_layers_data_items_type module¶

class ScheduleDataRelationshipsLayersDataItemsType(arg: None)¶

class ScheduleDataRelationshipsLayersDataItemsType(arg: ModelComposed)

class ScheduleDataRelationshipsLayersDataItemsType(*args, **kwargs)

Bases: ModelSimple

Layers resource type.

Parameters:

value (str) – If omitted defaults to “layers”. Must be one of [“layers”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_data_type module¶

class ScheduleDataType(arg: None)¶

class ScheduleDataType(arg: ModelComposed)

class ScheduleDataType(*args, **kwargs)

Bases: ModelSimple

Schedules resource type.

Parameters:

value (str) – If omitted defaults to “schedules”. Must be one of [“schedules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_member module¶

class ScheduleMember(arg: None)¶

class ScheduleMember(arg: ModelComposed)

class ScheduleMember(*args, **kwargs)

Bases: ModelNormal

Represents a single member entry in a schedule, referencing a specific user.

Parameters:

id (str, optional) – The unique identifier for this schedule member.
relationships (ScheduleMemberRelationships, optional) – Defines relationships for a schedule member, primarily referencing a single user.
type (ScheduleMemberType) – Schedule Members resource type.

datadog_api_client.v2.model.schedule_member_relationships module¶

class ScheduleMemberRelationships(arg: None)¶

class ScheduleMemberRelationships(arg: ModelComposed)

class ScheduleMemberRelationships(*args, **kwargs)

Bases: ModelNormal

Defines relationships for a schedule member, primarily referencing a single user.

Parameters:: user (ScheduleMemberRelationshipsUser, optional) – Wraps the user data reference for a schedule member.

datadog_api_client.v2.model.schedule_member_relationships_user module¶

class ScheduleMemberRelationshipsUser(arg: None)¶

class ScheduleMemberRelationshipsUser(arg: ModelComposed)

class ScheduleMemberRelationshipsUser(*args, **kwargs)

Bases: ModelNormal

Wraps the user data reference for a schedule member.

Parameters:: data (ScheduleMemberRelationshipsUserData) – Points to the user data associated with this schedule member, including an ID and type.

datadog_api_client.v2.model.schedule_member_relationships_user_data module¶

class ScheduleMemberRelationshipsUserData(arg: None)¶

class ScheduleMemberRelationshipsUserData(arg: ModelComposed)

class ScheduleMemberRelationshipsUserData(*args, **kwargs)

Bases: ModelNormal

Points to the user data associated with this schedule member, including an ID and type.

Parameters:

id (str) – The user’s unique identifier.
type (ScheduleMemberRelationshipsUserDataType) – Users resource type.

datadog_api_client.v2.model.schedule_member_relationships_user_data_type module¶

class ScheduleMemberRelationshipsUserDataType(arg: None)¶

class ScheduleMemberRelationshipsUserDataType(arg: ModelComposed)

class ScheduleMemberRelationshipsUserDataType(*args, **kwargs)

Bases: ModelSimple

Users resource type.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_member_type module¶

class ScheduleMemberType(arg: None)¶

class ScheduleMemberType(arg: ModelComposed)

class ScheduleMemberType(*args, **kwargs)

Bases: ModelSimple

Schedule Members resource type.

Parameters:

value (str) – If omitted defaults to “members”. Must be one of [“members”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_request_data_attributes_layers_items_members_items module¶

class ScheduleRequestDataAttributesLayersItemsMembersItems(arg: None)¶

class ScheduleRequestDataAttributesLayersItemsMembersItems(arg: ModelComposed)

class ScheduleRequestDataAttributesLayersItemsMembersItems(*args, **kwargs)

Bases: ModelNormal

Defines a single member within a schedule layer, including the reference to the underlying user.

Parameters:: user (ScheduleRequestDataAttributesLayersItemsMembersItemsUser, optional) – Identifies the user participating in this layer as a single object with an id.

datadog_api_client.v2.model.schedule_request_data_attributes_layers_items_members_items_user module¶

class ScheduleRequestDataAttributesLayersItemsMembersItemsUser(arg: None)¶

class ScheduleRequestDataAttributesLayersItemsMembersItemsUser(arg: ModelComposed)

class ScheduleRequestDataAttributesLayersItemsMembersItemsUser(*args, **kwargs)

Bases: ModelNormal

Identifies the user participating in this layer as a single object with an id.

Parameters:: id (str, optional) – The user’s ID.

datadog_api_client.v2.model.schedule_target module¶

class ScheduleTarget(arg: None)¶

class ScheduleTarget(arg: ModelComposed)

class ScheduleTarget(*args, **kwargs)

Bases: ModelNormal

Represents a schedule target for an escalation policy step, including its ID and resource type.

Parameters:

id (str) – Specifies the unique identifier of the schedule resource.
type (ScheduleTargetType) – Indicates that the resource is of type schedules.

datadog_api_client.v2.model.schedule_target_type module¶

class ScheduleTargetType(arg: None)¶

class ScheduleTargetType(arg: ModelComposed)

class ScheduleTargetType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type schedules.

Parameters:

value (str) – If omitted defaults to “schedules”. Must be one of [“schedules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_trigger module¶

class ScheduleTrigger(arg: None)¶

class ScheduleTrigger(arg: ModelComposed)

class ScheduleTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from a Schedule. The workflow must be published.

Parameters:: rrule_expression (str) – Recurrence rule expression for scheduling.

datadog_api_client.v2.model.schedule_trigger_wrapper module¶

class ScheduleTriggerWrapper(arg: None)¶

class ScheduleTriggerWrapper(arg: ModelComposed)

class ScheduleTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Schedule-based trigger.

Parameters:

schedule_trigger (ScheduleTrigger) – Trigger a workflow from a Schedule. The workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.schedule_update_request module¶

class ScheduleUpdateRequest(arg: None)¶

class ScheduleUpdateRequest(arg: ModelComposed)

class ScheduleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

A top-level wrapper for a schedule update request, referring to the data object with the new details.

Parameters:: data (ScheduleUpdateRequestData) – Contains all data needed to update an existing schedule, including its attributes (such as name and time zone) and any relationships to teams.

datadog_api_client.v2.model.schedule_update_request_data module¶

class ScheduleUpdateRequestData(arg: None)¶

class ScheduleUpdateRequestData(arg: ModelComposed)

class ScheduleUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Contains all data needed to update an existing schedule, including its attributes (such as name and time zone) and any relationships to teams.

Parameters:

attributes (ScheduleUpdateRequestDataAttributes) – Defines the updatable attributes for a schedule, such as name, time zone, and layers.
id (str) – The ID of the schedule to be updated.
relationships (ScheduleUpdateRequestDataRelationships, optional) – Houses relationships for the schedule update, typically referencing teams.
type (ScheduleUpdateRequestDataType) – Schedules resource type.

datadog_api_client.v2.model.schedule_update_request_data_attributes module¶

class ScheduleUpdateRequestDataAttributes(arg: None)¶

class ScheduleUpdateRequestDataAttributes(arg: ModelComposed)

class ScheduleUpdateRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Defines the updatable attributes for a schedule, such as name, time zone, and layers.

Parameters:

layers ([ScheduleUpdateRequestDataAttributesLayersItems]) – The updated list of layers (rotations) for this schedule.
name (str) – A short name for the schedule.
time_zone (str) – The time zone used when interpreting rotation times.

datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items module¶

class ScheduleUpdateRequestDataAttributesLayersItems(arg: None)¶

class ScheduleUpdateRequestDataAttributesLayersItems(arg: ModelComposed)

class ScheduleUpdateRequestDataAttributesLayersItems(*args, **kwargs)

Bases: ModelNormal

Represents a layer within a schedule update, including rotation details, members, and optional restrictions.

Parameters:

effective_date (datetime) – When this updated layer takes effect (ISO 8601 format).
end_date (datetime, optional) – When this updated layer should stop being active (ISO 8601 format).
id (str, optional) – A unique identifier for the layer being updated.
interval (LayerAttributesInterval) – Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
members ([ScheduleRequestDataAttributesLayersItemsMembersItems]) – The members assigned to this layer.
name (str) – The name for this layer (for example, “Secondary Coverage”).
restrictions ([TimeRestriction], optional) – Any time restrictions that define when this layer is active.
rotation_start (datetime) – The date/time at which the rotation begins (ISO 8601 format).
time_zone (str, optional) – The time zone for this layer.

datadog_api_client.v2.model.schedule_update_request_data_relationships module¶

class ScheduleUpdateRequestDataRelationships(arg: None)¶

class ScheduleUpdateRequestDataRelationships(arg: ModelComposed)

class ScheduleUpdateRequestDataRelationships(*args, **kwargs)

Bases: ModelNormal

Houses relationships for the schedule update, typically referencing teams.

Parameters:: teams (DataRelationshipsTeams, optional) – Associates teams with this schedule in a data structure.

datadog_api_client.v2.model.schedule_update_request_data_type module¶

class ScheduleUpdateRequestDataType(arg: None)¶

class ScheduleUpdateRequestDataType(arg: ModelComposed)

class ScheduleUpdateRequestDataType(*args, **kwargs)

Bases: ModelSimple

Schedules resource type.

Parameters:

value (str) – If omitted defaults to “schedules”. Must be one of [“schedules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.schedule_user module¶

class ScheduleUser(arg: None)¶

class ScheduleUser(arg: ModelComposed)

class ScheduleUser(*args, **kwargs)

Bases: ModelNormal

Represents a user object in the context of a schedule, including their id , type, and basic attributes.

Parameters:

attributes (ScheduleUserAttributes, optional) – Provides basic user information for a schedule, including a name and email address.
id (str, optional) – The unique user identifier.
type (ScheduleUserType) – Users resource type.

datadog_api_client.v2.model.schedule_user_attributes module¶

class ScheduleUserAttributes(arg: None)¶

class ScheduleUserAttributes(arg: ModelComposed)

class ScheduleUserAttributes(*args, **kwargs)

Bases: ModelNormal

Provides basic user information for a schedule, including a name and email address.

Parameters:

email (str, optional) – The user’s email address.
name (str, optional) – The user’s name.
status (UserAttributesStatus, optional) – The user’s status.

datadog_api_client.v2.model.schedule_user_type module¶

class ScheduleUserType(arg: None)¶

class ScheduleUserType(arg: ModelComposed)

class ScheduleUserType(*args, **kwargs)

Bases: ModelSimple

Users resource type.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.scorecard_type module¶

class ScorecardType(arg: None)¶

class ScorecardType(arg: ModelComposed)

class ScorecardType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for scorecard.

Parameters:

value (str) – If omitted defaults to “scorecard”. Must be one of [“scorecard”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.search_issues_include_query_parameter_item module¶

class SearchIssuesIncludeQueryParameterItem(arg: None)¶

class SearchIssuesIncludeQueryParameterItem(arg: ModelComposed)

class SearchIssuesIncludeQueryParameterItem(*args, **kwargs)

Bases: ModelSimple

Relationship object that should be included in the search response.

Parameters:

value (str) – Must be one of [“issue”, “issue.assignee”, “issue.case”, “issue.team_owners”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.secret_rule_array module¶

class SecretRuleArray(arg: None)¶

class SecretRuleArray(arg: ModelComposed)

class SecretRuleArray(*args, **kwargs)

Bases: ModelNormal

Parameters:: data ([SecretRuleData])

datadog_api_client.v2.model.secret_rule_data module¶

class SecretRuleData(arg: None)¶

class SecretRuleData(arg: ModelComposed)

class SecretRuleData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (SecretRuleDataAttributes, optional)
id (str, optional)
type (SecretRuleDataType) – Secret rule resource type.

datadog_api_client.v2.model.secret_rule_data_attributes module¶

class SecretRuleDataAttributes(arg: None)¶

class SecretRuleDataAttributes(arg: ModelComposed)

class SecretRuleDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

default_included_keywords ([str], optional)
description (str, optional)
license (str, optional)
match_validation (SecretRuleDataAttributesMatchValidation, optional)
name (str, optional)
pattern (str, optional)
priority (str, optional)
sds_id (str, optional)
validators ([str], optional)

datadog_api_client.v2.model.secret_rule_data_attributes_match_validation module¶

class SecretRuleDataAttributesMatchValidation(arg: None)¶

class SecretRuleDataAttributesMatchValidation(arg: ModelComposed)

class SecretRuleDataAttributesMatchValidation(*args, **kwargs)

Bases: ModelNormal

Parameters:

endpoint (str, optional)
hosts ([str], optional)
http_method (str, optional)
invalid_http_status_code ([SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems], optional)
request_headers ({str: (str,)}, optional)
timeout_seconds (int, optional)
type (str, optional)
valid_http_status_code ([SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems], optional)

datadog_api_client.v2.model.secret_rule_data_attributes_match_validation_invalid_http_status_code_items module¶

class SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems(arg: None)¶

class SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems(arg: ModelComposed)

class SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

end (int, optional)
start (int, optional)

datadog_api_client.v2.model.secret_rule_data_attributes_match_validation_valid_http_status_code_items module¶

class SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems(arg: None)¶

class SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems(arg: ModelComposed)

class SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

end (int, optional)
start (int, optional)

datadog_api_client.v2.model.secret_rule_data_type module¶

class SecretRuleDataType(arg: None)¶

class SecretRuleDataType(arg: ModelComposed)

class SecretRuleDataType(*args, **kwargs)

Bases: ModelSimple

Secret rule resource type.

Parameters:

value (str) – If omitted defaults to “secret_rule”. Must be one of [“secret_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_filter module¶

class SecurityFilter(arg: None)¶

class SecurityFilter(arg: ModelComposed)

class SecurityFilter(*args, **kwargs)

Bases: ModelNormal

The security filter’s properties.

Parameters:

attributes (SecurityFilterAttributes, optional) – The object describing a security filter.
id (str, optional) – The ID of the security filter.
type (SecurityFilterType, optional) – The type of the resource. The value should always be security_filters.

datadog_api_client.v2.model.security_filter_attributes module¶

class SecurityFilterAttributes(arg: None)¶

class SecurityFilterAttributes(arg: ModelComposed)

class SecurityFilterAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a security filter.

Parameters:

exclusion_filters ([SecurityFilterExclusionFilterResponse], optional) – The list of exclusion filters applied in this security filter.
filtered_data_type (SecurityFilterFilteredDataType, optional) – The filtered data type.
is_builtin (bool, optional) – Whether the security filter is the built-in filter.
is_enabled (bool, optional) – Whether the security filter is enabled.
name (str, optional) – The security filter name.
query (str, optional) – The security filter query. Logs accepted by this query will be accepted by this filter.
version (int, optional) – The version of the security filter.

datadog_api_client.v2.model.security_filter_create_attributes module¶

class SecurityFilterCreateAttributes(arg: None)¶

class SecurityFilterCreateAttributes(arg: ModelComposed)

class SecurityFilterCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the attributes of the security filter to be created.

Parameters:

exclusion_filters ([SecurityFilterExclusionFilter]) – Exclusion filters to exclude some logs from the security filter.
filtered_data_type (SecurityFilterFilteredDataType) – The filtered data type.
is_enabled (bool) – Whether the security filter is enabled.
name (str) – The name of the security filter.
query (str) – The query of the security filter.

datadog_api_client.v2.model.security_filter_create_data module¶

class SecurityFilterCreateData(arg: None)¶

class SecurityFilterCreateData(arg: ModelComposed)

class SecurityFilterCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single security filter.

Parameters:

attributes (SecurityFilterCreateAttributes) – Object containing the attributes of the security filter to be created.
type (SecurityFilterType) – The type of the resource. The value should always be security_filters.

datadog_api_client.v2.model.security_filter_create_request module¶

class SecurityFilterCreateRequest(arg: None)¶

class SecurityFilterCreateRequest(arg: ModelComposed)

class SecurityFilterCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the security filter that you would like to create.

Parameters:: data (SecurityFilterCreateData) – Object for a single security filter.

datadog_api_client.v2.model.security_filter_exclusion_filter module¶

class SecurityFilterExclusionFilter(arg: None)¶

class SecurityFilterExclusionFilter(arg: ModelComposed)

class SecurityFilterExclusionFilter(*args, **kwargs)

Bases: ModelNormal

Exclusion filter for the security filter.

Parameters:

name (str) – Exclusion filter name.
query (str) – Exclusion filter query. Logs that match this query are excluded from the security filter.

datadog_api_client.v2.model.security_filter_exclusion_filter_response module¶

class SecurityFilterExclusionFilterResponse(arg: None)¶

class SecurityFilterExclusionFilterResponse(arg: ModelComposed)

class SecurityFilterExclusionFilterResponse(*args, **kwargs)

Bases: ModelNormal

A single exclusion filter.

Parameters:

name (str, optional) – The exclusion filter name.
query (str, optional) – The exclusion filter query.

datadog_api_client.v2.model.security_filter_filtered_data_type module¶

class SecurityFilterFilteredDataType(arg: None)¶

class SecurityFilterFilteredDataType(arg: ModelComposed)

class SecurityFilterFilteredDataType(*args, **kwargs)

Bases: ModelSimple

The filtered data type.

Parameters:

value (str) – If omitted defaults to “logs”. Must be one of [“logs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_filter_meta module¶

class SecurityFilterMeta(arg: None)¶

class SecurityFilterMeta(arg: ModelComposed)

class SecurityFilterMeta(*args, **kwargs)

Bases: ModelNormal

Optional metadata associated to the response.

Parameters:: warning (str, optional) – A warning message.

datadog_api_client.v2.model.security_filter_response module¶

class SecurityFilterResponse(arg: None)¶

class SecurityFilterResponse(arg: ModelComposed)

class SecurityFilterResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes a single security filter.

Parameters:

data (SecurityFilter, optional) – The security filter’s properties.
meta (SecurityFilterMeta, optional) – Optional metadata associated to the response.

datadog_api_client.v2.model.security_filter_type module¶

class SecurityFilterType(arg: None)¶

class SecurityFilterType(arg: ModelComposed)

class SecurityFilterType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be security_filters.

Parameters:

value (str) – If omitted defaults to “security_filters”. Must be one of [“security_filters”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_filter_update_attributes module¶

class SecurityFilterUpdateAttributes(arg: None)¶

class SecurityFilterUpdateAttributes(arg: ModelComposed)

class SecurityFilterUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The security filters properties to be updated.

Parameters:

exclusion_filters ([SecurityFilterExclusionFilter], optional) – Exclusion filters to exclude some logs from the security filter.
filtered_data_type (SecurityFilterFilteredDataType, optional) – The filtered data type.
is_enabled (bool, optional) – Whether the security filter is enabled.
name (str, optional) – The name of the security filter.
query (str, optional) – The query of the security filter.
version (int, optional) – The version of the security filter to update.

datadog_api_client.v2.model.security_filter_update_data module¶

class SecurityFilterUpdateData(arg: None)¶

class SecurityFilterUpdateData(arg: ModelComposed)

class SecurityFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

The new security filter properties.

Parameters:

attributes (SecurityFilterUpdateAttributes) – The security filters properties to be updated.
type (SecurityFilterType) – The type of the resource. The value should always be security_filters.

datadog_api_client.v2.model.security_filter_update_request module¶

class SecurityFilterUpdateRequest(arg: None)¶

class SecurityFilterUpdateRequest(arg: ModelComposed)

class SecurityFilterUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new security filter body.

Parameters:: data (SecurityFilterUpdateData) – The new security filter properties.

datadog_api_client.v2.model.security_filters_response module¶

class SecurityFiltersResponse(arg: None)¶

class SecurityFiltersResponse(arg: ModelComposed)

class SecurityFiltersResponse(*args, **kwargs)

Bases: ModelNormal

All the available security filters objects.

Parameters:

data ([SecurityFilter], optional) – A list of security filters objects.
meta (SecurityFilterMeta, optional) – Optional metadata associated to the response.

datadog_api_client.v2.model.security_monitoring_filter module¶

class SecurityMonitoringFilter(arg: None)¶

class SecurityMonitoringFilter(arg: ModelComposed)

class SecurityMonitoringFilter(*args, **kwargs)

Bases: ModelNormal

The rule’s suppression filter.

Parameters:

action (SecurityMonitoringFilterAction, optional) – The type of filtering action.
query (str, optional) – Query for selecting logs to apply the filtering action.

datadog_api_client.v2.model.security_monitoring_filter_action module¶

class SecurityMonitoringFilterAction(arg: None)¶

class SecurityMonitoringFilterAction(arg: ModelComposed)

class SecurityMonitoringFilterAction(*args, **kwargs)

Bases: ModelSimple

The type of filtering action.

Parameters:

value (str) – Must be one of [“require”, “suppress”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_list_rules_response module¶

class SecurityMonitoringListRulesResponse(arg: None)¶

class SecurityMonitoringListRulesResponse(arg: ModelComposed)

class SecurityMonitoringListRulesResponse(*args, **kwargs)

Bases: ModelNormal

List of rules.

Parameters:

data ([SecurityMonitoringRuleResponse], optional) – Array containing the list of rules.
meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

datadog_api_client.v2.model.security_monitoring_reference_table module¶

class SecurityMonitoringReferenceTable(arg: None)¶

class SecurityMonitoringReferenceTable(arg: ModelComposed)

class SecurityMonitoringReferenceTable(*args, **kwargs)

Bases: ModelNormal

Reference tables used in the queries.

Parameters:

check_presence (bool, optional) – Whether to include or exclude the matched values.
column_name (str, optional) – The name of the column in the reference table.
log_field_path (str, optional) – The field in the log to match against the reference table.
rule_query_name (str, optional) – The name of the query to apply the reference table to.
table_name (str, optional) – The name of the reference table.

datadog_api_client.v2.model.security_monitoring_rule_case module¶

class SecurityMonitoringRuleCase(arg: None)¶

class SecurityMonitoringRuleCase(arg: ModelComposed)

class SecurityMonitoringRuleCase(*args, **kwargs)

Bases: ModelNormal

Case when signal is generated.

Parameters:

actions ([SecurityMonitoringRuleCaseAction], optional) – Action to perform for each rule case.
condition (str, optional) – A rule case contains logical operations ( > , >= , && , || ) to determine if a signal should be generated based on the event counts in the previously defined queries.
custom_status (SecurityMonitoringRuleSeverity, optional) – Severity of the Security Signal.
name (str, optional) – Name of the case.
notifications ([str], optional) – Notification targets for each rule case.
status (SecurityMonitoringRuleSeverity, optional) – Severity of the Security Signal.

datadog_api_client.v2.model.security_monitoring_rule_case_action module¶

class SecurityMonitoringRuleCaseAction(arg: None)¶

class SecurityMonitoringRuleCaseAction(arg: ModelComposed)

class SecurityMonitoringRuleCaseAction(*args, **kwargs)

Bases: ModelNormal

Action to perform when a signal is triggered. Only available for Application Security rule type.

Parameters:

options (SecurityMonitoringRuleCaseActionOptions, optional) – Options for the rule action
type (SecurityMonitoringRuleCaseActionType, optional) – The action type.

datadog_api_client.v2.model.security_monitoring_rule_case_action_options module¶

class SecurityMonitoringRuleCaseActionOptions(arg: None)¶

class SecurityMonitoringRuleCaseActionOptions(arg: ModelComposed)

class SecurityMonitoringRuleCaseActionOptions(*args, **kwargs)

Bases: ModelNormal

Options for the rule action

Parameters:

duration (int, optional) – Duration of the action in seconds. 0 indicates no expiration.
flagged_ip_type (SecurityMonitoringRuleCaseActionOptionsFlaggedIPType, optional) – Used with the case action of type ‘flag_ip’. The value specified in this field is applied as a flag to the IP addresses.
user_behavior_name (str, optional) – Used with the case action of type ‘user_behavior’. The value specified in this field is applied as a risk tag to all users affected by the rule.

datadog_api_client.v2.model.security_monitoring_rule_case_action_options_flagged_ip_type module¶

class SecurityMonitoringRuleCaseActionOptionsFlaggedIPType(arg: None)¶

class SecurityMonitoringRuleCaseActionOptionsFlaggedIPType(arg: ModelComposed)

class SecurityMonitoringRuleCaseActionOptionsFlaggedIPType(*args, **kwargs)

Bases: ModelSimple

Used with the case action of type ‘flag_ip’. The value specified in this field is applied as a flag to the IP addresses.

Parameters:

value (str) – Must be one of [“SUSPICIOUS”, “FLAGGED”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_case_action_type module¶

class SecurityMonitoringRuleCaseActionType(arg: None)¶

class SecurityMonitoringRuleCaseActionType(arg: ModelComposed)

class SecurityMonitoringRuleCaseActionType(*args, **kwargs)

Bases: ModelSimple

The action type.

Parameters:

value (str) – Must be one of [“block_ip”, “block_user”, “user_behavior”, “flag_ip”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_case_create module¶

class SecurityMonitoringRuleCaseCreate(arg: None)¶

class SecurityMonitoringRuleCaseCreate(arg: ModelComposed)

class SecurityMonitoringRuleCaseCreate(*args, **kwargs)

Bases: ModelNormal

Case when signal is generated.

Parameters:

actions ([SecurityMonitoringRuleCaseAction], optional) – Action to perform for each rule case.
condition (str, optional) – A case contains logical operations ( > , >= , && , || ) to determine if a signal should be generated based on the event counts in the previously defined queries.
name (str, optional) – Name of the case.
notifications ([str], optional) – Notification targets.
status (SecurityMonitoringRuleSeverity) – Severity of the Security Signal.

datadog_api_client.v2.model.security_monitoring_rule_convert_payload module¶

class SecurityMonitoringRuleConvertPayload(arg: None)¶

class SecurityMonitoringRuleConvertPayload(arg: ModelComposed)

class SecurityMonitoringRuleConvertPayload(*args, **kwargs)

Bases: ModelComposed

Convert a rule from JSON to Terraform.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_rule_convert_response module¶

class SecurityMonitoringRuleConvertResponse(arg: None)¶

class SecurityMonitoringRuleConvertResponse(arg: ModelComposed)

class SecurityMonitoringRuleConvertResponse(*args, **kwargs)

Bases: ModelNormal

Result of the convert rule request containing Terraform content.

Parameters:

rule_id (str, optional) – the ID of the rule.
terraform_content (str, optional) – Terraform string as a result of converting the rule from JSON.

datadog_api_client.v2.model.security_monitoring_rule_create_payload module¶

class SecurityMonitoringRuleCreatePayload(arg: None)¶

class SecurityMonitoringRuleCreatePayload(arg: ModelComposed)

class SecurityMonitoringRuleCreatePayload(*args, **kwargs)

Bases: ModelComposed

Create a new rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions) – How to generate compliance signals. Useful for cloud_configuration rules only.

datadog_api_client.v2.model.security_monitoring_rule_detection_method module¶

class SecurityMonitoringRuleDetectionMethod(arg: None)¶

class SecurityMonitoringRuleDetectionMethod(arg: ModelComposed)

class SecurityMonitoringRuleDetectionMethod(*args, **kwargs)

Bases: ModelSimple

The detection method.

Parameters:

value (str) – Must be one of [“threshold”, “new_value”, “anomaly_detection”, “impossible_travel”, “hardcoded”, “third_party”, “anomaly_threshold”, “sequence_detection”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_evaluation_window module¶

class SecurityMonitoringRuleEvaluationWindow(arg: None)¶

class SecurityMonitoringRuleEvaluationWindow(arg: ModelComposed)

class SecurityMonitoringRuleEvaluationWindow(*args, **kwargs)

Bases: ModelSimple

A time window is specified to match when at least one of the cases matches true. This is a sliding window: and evaluates in real time. For third party detection method, this field is not used.

Parameters:

value (int) – Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_hardcoded_evaluator_type module¶

class SecurityMonitoringRuleHardcodedEvaluatorType(arg: None)¶

class SecurityMonitoringRuleHardcodedEvaluatorType(arg: ModelComposed)

class SecurityMonitoringRuleHardcodedEvaluatorType(*args, **kwargs)

Bases: ModelSimple

Hardcoded evaluator type.

Parameters:

value (str) – If omitted defaults to “log4shell”. Must be one of [“log4shell”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_impossible_travel_options module¶

class SecurityMonitoringRuleImpossibleTravelOptions(arg: None)¶

class SecurityMonitoringRuleImpossibleTravelOptions(arg: ModelComposed)

class SecurityMonitoringRuleImpossibleTravelOptions(*args, **kwargs)

Bases: ModelNormal

Options on impossible travel detection method.

Parameters:: baseline_user_locations (bool, optional) – If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user’s regular access locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.

datadog_api_client.v2.model.security_monitoring_rule_keep_alive module¶

class SecurityMonitoringRuleKeepAlive(arg: None)¶

class SecurityMonitoringRuleKeepAlive(arg: ModelComposed)

class SecurityMonitoringRuleKeepAlive(*args, **kwargs)

Bases: ModelSimple

Once a signal is generated, the signal will remain “open” if a case is matched at least once within: this keep alive window. For third party detection method, this field is not used.

Parameters:

value (int) – Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_max_signal_duration module¶

class SecurityMonitoringRuleMaxSignalDuration(arg: None)¶

class SecurityMonitoringRuleMaxSignalDuration(arg: ModelComposed)

class SecurityMonitoringRuleMaxSignalDuration(*args, **kwargs)

Bases: ModelSimple

A signal will “close” regardless of the query being matched once the time exceeds the maximum duration.: This time is calculated from the first seen timestamp.

Parameters:

value (int) – Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_new_value_options module¶

class SecurityMonitoringRuleNewValueOptions(arg: None)¶

class SecurityMonitoringRuleNewValueOptions(arg: ModelComposed)

class SecurityMonitoringRuleNewValueOptions(*args, **kwargs)

Bases: ModelNormal

Options on new value detection method.

Parameters:

forget_after (SecurityMonitoringRuleNewValueOptionsForgetAfter, optional) – The duration in days after which a learned value is forgotten.
learning_duration (SecurityMonitoringRuleNewValueOptionsLearningDuration, optional) – The duration in days during which values are learned, and after which signals will be generated for values that weren’t learned. If set to 0, a signal will be generated for all new values after the first value is learned.
learning_method (SecurityMonitoringRuleNewValueOptionsLearningMethod, optional) – The learning method used to determine when signals should be generated for values that weren’t learned.
learning_threshold (SecurityMonitoringRuleNewValueOptionsLearningThreshold, optional) – A number of occurrences after which signals will be generated for values that weren’t learned.

datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after module¶

class SecurityMonitoringRuleNewValueOptionsForgetAfter(arg: None)¶

class SecurityMonitoringRuleNewValueOptionsForgetAfter(arg: ModelComposed)

class SecurityMonitoringRuleNewValueOptionsForgetAfter(*args, **kwargs)

Bases: ModelSimple

The duration in days after which a learned value is forgotten.

Parameters:

value (int) – Must be one of [1, 2, 7, 14, 21, 28].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_duration module¶

class SecurityMonitoringRuleNewValueOptionsLearningDuration(arg: None)¶

class SecurityMonitoringRuleNewValueOptionsLearningDuration(arg: ModelComposed)

class SecurityMonitoringRuleNewValueOptionsLearningDuration(*args, **kwargs)

Bases: ModelSimple

The duration in days during which values are learned, and after which signals will be generated for values that: weren’t learned. If set to 0, a signal will be generated for all new values after the first value is learned.

Parameters:

value (int) – If omitted defaults to 0. Must be one of [0, 1, 7].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_method module¶

class SecurityMonitoringRuleNewValueOptionsLearningMethod(arg: None)¶

class SecurityMonitoringRuleNewValueOptionsLearningMethod(arg: ModelComposed)

class SecurityMonitoringRuleNewValueOptionsLearningMethod(*args, **kwargs)

Bases: ModelSimple

The learning method used to determine when signals should be generated for values that weren’t learned.

Parameters:

value (str) – If omitted defaults to “duration”. Must be one of [“duration”, “threshold”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_new_value_options_learning_threshold module¶

class SecurityMonitoringRuleNewValueOptionsLearningThreshold(arg: None)¶

class SecurityMonitoringRuleNewValueOptionsLearningThreshold(arg: ModelComposed)

class SecurityMonitoringRuleNewValueOptionsLearningThreshold(*args, **kwargs)

Bases: ModelSimple

A number of occurrences after which signals will be generated for values that weren’t learned.

Parameters:

value (int) – If omitted defaults to 0. Must be one of [0, 1].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_options module¶

class SecurityMonitoringRuleOptions(arg: None)¶

class SecurityMonitoringRuleOptions(arg: ModelComposed)

class SecurityMonitoringRuleOptions(*args, **kwargs)

Bases: ModelNormal

Options.

Parameters:

compliance_rule_options (CloudConfigurationComplianceRuleOptions, optional) – Options for cloud_configuration rules. Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.
decrease_criticality_based_on_env (bool, optional) – If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise. The severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO. The decrement is applied when the environment tag of the signal starts with staging , test or dev.
detection_method (SecurityMonitoringRuleDetectionMethod, optional) – The detection method.
evaluation_window (SecurityMonitoringRuleEvaluationWindow, optional) – A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
hardcoded_evaluator_type (SecurityMonitoringRuleHardcodedEvaluatorType, optional) – Hardcoded evaluator type.
impossible_travel_options (SecurityMonitoringRuleImpossibleTravelOptions, optional) – Options on impossible travel detection method.
keep_alive (SecurityMonitoringRuleKeepAlive, optional) – Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window. For third party detection method, this field is not used.
max_signal_duration (SecurityMonitoringRuleMaxSignalDuration, optional) – A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.
new_value_options (SecurityMonitoringRuleNewValueOptions, optional) – Options on new value detection method.
sequence_detection_options (SecurityMonitoringRuleSequenceDetectionOptions, optional) – Options on sequence detection method.
third_party_rule_options (SecurityMonitoringRuleThirdPartyOptions, optional) – Options on third party detection method.

datadog_api_client.v2.model.security_monitoring_rule_query module¶

class SecurityMonitoringRuleQuery(arg: None)¶

class SecurityMonitoringRuleQuery(arg: ModelComposed)

class SecurityMonitoringRuleQuery(*args, **kwargs)

Bases: ModelComposed

Query for matching rule.

Parameters:

aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.
custom_query_extension (str, optional) – Query extension to append to the logs query.
data_source (SecurityMonitoringStandardDataSource, optional) – Source of events, either logs, audit trail, or Datadog events.
distinct_fields ([str], optional) – Field for which the cardinality is measured. Sent as an array.
group_by_fields ([str], optional) – Fields to group by.
has_optional_group_by_fields (bool, optional) – When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.
index (str, optional) – This field is currently unstable and might be removed in a minor version upgrade. The index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.
indexes ([str], optional) – List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.
metric (str, optional) – (Deprecated) The target field to aggregate over when using the sum or max aggregations. metrics field should be used instead.
metrics ([str], optional) – Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
name (str, optional) – Name of the query.
query (str, optional) – Query to run on logs.
correlated_by_fields ([str], optional) – Fields to group by.
correlated_query_index (int, optional) – Index of the rule query used to retrieve the correlated field.
rule_id (str) – Rule ID to match on signals.

datadog_api_client.v2.model.security_monitoring_rule_query_aggregation module¶

class SecurityMonitoringRuleQueryAggregation(arg: None)¶

class SecurityMonitoringRuleQueryAggregation(arg: ModelComposed)

class SecurityMonitoringRuleQueryAggregation(*args, **kwargs)

Bases: ModelSimple

The aggregation type.

Parameters:

value (str) – Must be one of [“count”, “cardinality”, “sum”, “max”, “new_value”, “geo_data”, “event_count”, “none”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_query_payload module¶

class SecurityMonitoringRuleQueryPayload(arg: None)¶

class SecurityMonitoringRuleQueryPayload(arg: ModelComposed)

class SecurityMonitoringRuleQueryPayload(*args, **kwargs)

Bases: ModelNormal

Payload to test a rule query with the expected result.

Parameters:

expected_result (bool, optional) – Expected result of the test.
index (int, optional) – Index of the query under test.
payload (SecurityMonitoringRuleQueryPayloadData, optional) – Payload used to test the rule query.

datadog_api_client.v2.model.security_monitoring_rule_query_payload_data module¶

class SecurityMonitoringRuleQueryPayloadData(arg: None)¶

class SecurityMonitoringRuleQueryPayloadData(arg: ModelComposed)

class SecurityMonitoringRuleQueryPayloadData(*args, **kwargs)

Bases: ModelNormal

Payload used to test the rule query.

Parameters:

ddsource (str, optional) – Source of the payload.
ddtags (str, optional) – Tags associated with your data.
hostname (str, optional) – The name of the originating host of the log.
message (str, optional) – The message of the payload.
service (str, optional) – The name of the application or service generating the data.

datadog_api_client.v2.model.security_monitoring_rule_response module¶

class SecurityMonitoringRuleResponse(arg: None)¶

class SecurityMonitoringRuleResponse(arg: ModelComposed)

class SecurityMonitoringRuleResponse(*args, **kwargs)

Bases: ModelComposed

Create a new rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCase], optional) – Cases for generating signals.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions, optional) – How to generate compliance signals. Useful for cloud_configuration rules only.
created_at (int, optional) – When the rule was created, timestamp in milliseconds.
creation_author_id (int, optional) – User ID of the user who created the rule.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
default_tags ([str], optional) – Default Tags for default rules (included in tags)
deprecation_date (int, optional) – When the rule will be deprecated, timestamp in milliseconds.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
id (str, optional) – The ID of the rule.
is_default (bool, optional) – Whether the rule is included by default.
is_deleted (bool, optional) – Whether the rule has been deleted.
is_enabled (bool, optional) – Whether the rule is enabled.
message (str, optional) – Message for generated signals.
name (str, optional) – The name of the rule.
options (SecurityMonitoringRuleOptions, optional) – Options.
queries ([SecurityMonitoringStandardRuleQuery], optional) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCase], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeRead, optional) – The rule type.
update_author_id (int, optional) – User ID of the user who updated the rule.
updated_at (int, optional) – The date the rule was last updated, in milliseconds.
version (int, optional) – The version of the rule.

datadog_api_client.v2.model.security_monitoring_rule_sequence_detection_options module¶

class SecurityMonitoringRuleSequenceDetectionOptions(arg: None)¶

class SecurityMonitoringRuleSequenceDetectionOptions(arg: ModelComposed)

class SecurityMonitoringRuleSequenceDetectionOptions(*args, **kwargs)

Bases: ModelNormal

Options on sequence detection method.

Parameters:

step_transitions ([SecurityMonitoringRuleSequenceDetectionStepTransition], optional) – Transitions defining the allowed order of steps and their evaluation windows.
steps ([SecurityMonitoringRuleSequenceDetectionStep], optional) – Steps that define the conditions to be matched in sequence.

datadog_api_client.v2.model.security_monitoring_rule_sequence_detection_step module¶

class SecurityMonitoringRuleSequenceDetectionStep(arg: None)¶

class SecurityMonitoringRuleSequenceDetectionStep(arg: ModelComposed)

class SecurityMonitoringRuleSequenceDetectionStep(*args, **kwargs)

Bases: ModelNormal

Step definition for sequence detection containing the step name, condition, and evaluation window.

Parameters:

condition (str, optional) – Condition referencing rule queries (e.g., a > 0 ).
evaluation_window (SecurityMonitoringRuleEvaluationWindow, optional) – A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
name (str, optional) – Unique name identifying the step.

datadog_api_client.v2.model.security_monitoring_rule_sequence_detection_step_transition module¶

class SecurityMonitoringRuleSequenceDetectionStepTransition(arg: None)¶

class SecurityMonitoringRuleSequenceDetectionStepTransition(arg: ModelComposed)

class SecurityMonitoringRuleSequenceDetectionStepTransition(*args, **kwargs)

Bases: ModelNormal

Transition from a parent step to a child step within a sequence detection rule.

Parameters:

child (str, optional) – Name of the child step.
evaluation_window (SecurityMonitoringRuleEvaluationWindow, optional) – A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
parent (str, optional) – Name of the parent step.

datadog_api_client.v2.model.security_monitoring_rule_severity module¶

class SecurityMonitoringRuleSeverity(arg: None)¶

class SecurityMonitoringRuleSeverity(arg: ModelComposed)

class SecurityMonitoringRuleSeverity(*args, **kwargs)

Bases: ModelSimple

Severity of the Security Signal.

Parameters:

value (str) – Must be one of [“info”, “low”, “medium”, “high”, “critical”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_test_payload module¶

class SecurityMonitoringRuleTestPayload(arg: None)¶

class SecurityMonitoringRuleTestPayload(arg: ModelComposed)

class SecurityMonitoringRuleTestPayload(*args, **kwargs)

Bases: ModelComposed

Test a rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeTest, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_rule_test_request module¶

class SecurityMonitoringRuleTestRequest(arg: None)¶

class SecurityMonitoringRuleTestRequest(arg: ModelComposed)

class SecurityMonitoringRuleTestRequest(*args, **kwargs)

Bases: ModelNormal

Test the rule queries of a rule (rule property is ignored when applied to an existing rule)

Parameters:

rule (SecurityMonitoringRuleTestPayload, optional) – Test a rule.
rule_query_payloads ([SecurityMonitoringRuleQueryPayload], optional) – Data payloads used to test rules query with the expected result.

datadog_api_client.v2.model.security_monitoring_rule_test_response module¶

class SecurityMonitoringRuleTestResponse(arg: None)¶

class SecurityMonitoringRuleTestResponse(arg: ModelComposed)

class SecurityMonitoringRuleTestResponse(*args, **kwargs)

Bases: ModelNormal

Result of the test of the rule queries.

Parameters:: results ([bool], optional) – Assert results are returned in the same order as the rule query payloads. For each payload, it returns True if the result matched the expected result, False otherwise.

datadog_api_client.v2.model.security_monitoring_rule_third_party_options module¶

class SecurityMonitoringRuleThirdPartyOptions(arg: None)¶

class SecurityMonitoringRuleThirdPartyOptions(arg: ModelComposed)

class SecurityMonitoringRuleThirdPartyOptions(*args, **kwargs)

Bases: ModelNormal

Options on third party detection method.

Parameters:

default_notifications ([str], optional) – Notification targets for the logs that do not correspond to any of the cases.
default_status (SecurityMonitoringRuleSeverity, optional) – Severity of the Security Signal.
root_queries ([SecurityMonitoringThirdPartyRootQuery], optional) – Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.
signal_title_template (str, optional) – A template for the signal title; if omitted, the title is generated based on the case name.

datadog_api_client.v2.model.security_monitoring_rule_type_create module¶

class SecurityMonitoringRuleTypeCreate(arg: None)¶

class SecurityMonitoringRuleTypeCreate(arg: ModelComposed)

class SecurityMonitoringRuleTypeCreate(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

value (str) – Must be one of [“api_security”, “application_security”, “log_detection”, “workload_security”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_type_read module¶

class SecurityMonitoringRuleTypeRead(arg: None)¶

class SecurityMonitoringRuleTypeRead(arg: ModelComposed)

class SecurityMonitoringRuleTypeRead(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

value (str) – Must be one of [“log_detection”, “infrastructure_configuration”, “workload_security”, “cloud_configuration”, “application_security”, “api_security”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_type_test module¶

class SecurityMonitoringRuleTypeTest(arg: None)¶

class SecurityMonitoringRuleTypeTest(arg: ModelComposed)

class SecurityMonitoringRuleTypeTest(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

value (str) – If omitted defaults to “log_detection”. Must be one of [“log_detection”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_rule_update_payload module¶

class SecurityMonitoringRuleUpdatePayload(arg: None)¶

class SecurityMonitoringRuleUpdatePayload(arg: ModelComposed)

class SecurityMonitoringRuleUpdatePayload(*args, **kwargs)

Bases: ModelNormal

Update an existing rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCase], optional) – Cases for generating signals.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions, optional) – How to generate compliance signals. Useful for cloud_configuration rules only.
custom_message (str, optional) – Custom/Overridden Message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name (used in case of Default rule update).
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool, optional) – Whether the rule is enabled.
message (str, optional) – Message for generated signals.
name (str, optional) – Name of the rule.
options (SecurityMonitoringRuleOptions, optional) – Options.
queries ([SecurityMonitoringRuleQuery], optional) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCase], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
version (int, optional) – The version of the rule being updated.

datadog_api_client.v2.model.security_monitoring_rule_validate_payload module¶

class SecurityMonitoringRuleValidatePayload(arg: None)¶

class SecurityMonitoringRuleValidatePayload(arg: ModelComposed)

class SecurityMonitoringRuleValidatePayload(*args, **kwargs)

Bases: ModelComposed

Validate a rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions) – How to generate compliance signals. Useful for cloud_configuration rules only.

datadog_api_client.v2.model.security_monitoring_scheduling_options module¶

class SecurityMonitoringSchedulingOptions(arg: None)¶

class SecurityMonitoringSchedulingOptions(arg: ModelComposed)

class SecurityMonitoringSchedulingOptions(*args, **kwargs)

Bases: ModelNormal

Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.

Parameters:

rrule (str, optional) – Schedule for the rule queries, written in RRULE syntax. See RFC for syntax reference.
start (str, optional) – Start date for the schedule, in ISO 8601 format without timezone.
timezone (str, optional) – Time zone of the start date, in the tz database format.

datadog_api_client.v2.model.security_monitoring_signal module¶

class SecurityMonitoringSignal(arg: None)¶

class SecurityMonitoringSignal(arg: ModelComposed)

class SecurityMonitoringSignal(*args, **kwargs)

Bases: ModelNormal

Object description of a security signal.

Parameters:

attributes (SecurityMonitoringSignalAttributes, optional) – The object containing all signal attributes and their associated values.
id (str, optional) – The unique ID of the security signal.
type (SecurityMonitoringSignalType, optional) – The type of event.

datadog_api_client.v2.model.security_monitoring_signal_archive_reason module¶

class SecurityMonitoringSignalArchiveReason(arg: None)¶

class SecurityMonitoringSignalArchiveReason(arg: ModelComposed)

class SecurityMonitoringSignalArchiveReason(*args, **kwargs)

Bases: ModelSimple

Reason a signal is archived.

Parameters:

value (str) – Must be one of [“none”, “false_positive”, “testing_or_maintenance”, “investigated_case_opened”, “true_positive_benign”, “true_positive_malicious”, “other”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_signal_assignee_update_attributes module¶

class SecurityMonitoringSignalAssigneeUpdateAttributes(arg: None)¶

class SecurityMonitoringSignalAssigneeUpdateAttributes(arg: ModelComposed)

class SecurityMonitoringSignalAssigneeUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes describing the new assignee of a security signal.

Parameters:

assignee (SecurityMonitoringTriageUser) – Object representing a given user entity.
version (int, optional) – Version of the updated signal. If server side version is higher, update will be rejected.

datadog_api_client.v2.model.security_monitoring_signal_assignee_update_data module¶

class SecurityMonitoringSignalAssigneeUpdateData(arg: None)¶

class SecurityMonitoringSignalAssigneeUpdateData(arg: ModelComposed)

class SecurityMonitoringSignalAssigneeUpdateData(*args, **kwargs)

Bases: ModelNormal

Data containing the patch for changing the assignee of a signal.

Parameters:: attributes (SecurityMonitoringSignalAssigneeUpdateAttributes) – Attributes describing the new assignee of a security signal.

datadog_api_client.v2.model.security_monitoring_signal_assignee_update_request module¶

class SecurityMonitoringSignalAssigneeUpdateRequest(arg: None)¶

class SecurityMonitoringSignalAssigneeUpdateRequest(arg: ModelComposed)

class SecurityMonitoringSignalAssigneeUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request body for changing the assignee of a given security monitoring signal.

Parameters:: data (SecurityMonitoringSignalAssigneeUpdateData) – Data containing the patch for changing the assignee of a signal.

datadog_api_client.v2.model.security_monitoring_signal_attributes module¶

class SecurityMonitoringSignalAttributes(arg: None)¶

class SecurityMonitoringSignalAttributes(arg: ModelComposed)

class SecurityMonitoringSignalAttributes(*args, **kwargs)

Bases: ModelNormal

The object containing all signal attributes and their associated values.

Parameters:

custom ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – A JSON object of attributes in the security signal.
message (str, optional) – The message in the security signal defined by the rule that generated the signal.
tags ([str], optional) – An array of tags associated with the security signal.
timestamp (datetime, optional) – The timestamp of the security signal.

datadog_api_client.v2.model.security_monitoring_signal_incident_ids module¶

class SecurityMonitoringSignalIncidentIds(arg: None)¶

class SecurityMonitoringSignalIncidentIds(arg: ModelComposed)

class SecurityMonitoringSignalIncidentIds(*args, **kwargs)

Bases: ModelSimple

Array of incidents that are associated with this signal.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_signal_incidents_update_attributes module¶

class SecurityMonitoringSignalIncidentsUpdateAttributes(arg: None)¶

class SecurityMonitoringSignalIncidentsUpdateAttributes(arg: ModelComposed)

class SecurityMonitoringSignalIncidentsUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes describing the new list of related signals for a security signal.

Parameters:

incident_ids (SecurityMonitoringSignalIncidentIds) – Array of incidents that are associated with this signal.
version (int, optional) – Version of the updated signal. If server side version is higher, update will be rejected.

datadog_api_client.v2.model.security_monitoring_signal_incidents_update_data module¶

class SecurityMonitoringSignalIncidentsUpdateData(arg: None)¶

class SecurityMonitoringSignalIncidentsUpdateData(arg: ModelComposed)

class SecurityMonitoringSignalIncidentsUpdateData(*args, **kwargs)

Bases: ModelNormal

Data containing the patch for changing the related incidents of a signal.

Parameters:: attributes (SecurityMonitoringSignalIncidentsUpdateAttributes) – Attributes describing the new list of related signals for a security signal.

datadog_api_client.v2.model.security_monitoring_signal_incidents_update_request module¶

class SecurityMonitoringSignalIncidentsUpdateRequest(arg: None)¶

class SecurityMonitoringSignalIncidentsUpdateRequest(arg: ModelComposed)

class SecurityMonitoringSignalIncidentsUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request body for changing the related incidents of a given security monitoring signal.

Parameters:: data (SecurityMonitoringSignalIncidentsUpdateData) – Data containing the patch for changing the related incidents of a signal.

datadog_api_client.v2.model.security_monitoring_signal_list_request module¶

class SecurityMonitoringSignalListRequest(arg: None)¶

class SecurityMonitoringSignalListRequest(arg: ModelComposed)

class SecurityMonitoringSignalListRequest(*args, **kwargs)

Bases: ModelNormal

The request for a security signal list.

Parameters:

filter (SecurityMonitoringSignalListRequestFilter, optional) – Search filters for listing security signals.
page (SecurityMonitoringSignalListRequestPage, optional) – The paging attributes for listing security signals.
sort (SecurityMonitoringSignalsSort, optional) – The sort parameters used for querying security signals.

datadog_api_client.v2.model.security_monitoring_signal_list_request_filter module¶

class SecurityMonitoringSignalListRequestFilter(arg: None)¶

class SecurityMonitoringSignalListRequestFilter(arg: ModelComposed)

class SecurityMonitoringSignalListRequestFilter(*args, **kwargs)

Bases: ModelNormal

Search filters for listing security signals.

Parameters:

_from (datetime, optional) – The minimum timestamp for requested security signals.
query (str, optional) – Search query for listing security signals.
to (datetime, optional) – The maximum timestamp for requested security signals.

datadog_api_client.v2.model.security_monitoring_signal_list_request_page module¶

class SecurityMonitoringSignalListRequestPage(arg: None)¶

class SecurityMonitoringSignalListRequestPage(arg: ModelComposed)

class SecurityMonitoringSignalListRequestPage(*args, **kwargs)

Bases: ModelNormal

The paging attributes for listing security signals.

Parameters:

cursor (str, optional) – A list of results using the cursor provided in the previous query.
limit (int, optional) – The maximum number of security signals in the response.

datadog_api_client.v2.model.security_monitoring_signal_metadata_type module¶

class SecurityMonitoringSignalMetadataType(arg: None)¶

class SecurityMonitoringSignalMetadataType(arg: ModelComposed)

class SecurityMonitoringSignalMetadataType(*args, **kwargs)

Bases: ModelSimple

The type of event.

Parameters:

value (str) – If omitted defaults to “signal_metadata”. Must be one of [“signal_metadata”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_signal_response module¶

class SecurityMonitoringSignalResponse(arg: None)¶

class SecurityMonitoringSignalResponse(arg: ModelComposed)

class SecurityMonitoringSignalResponse(*args, **kwargs)

Bases: ModelNormal

Security Signal response data object.

Parameters:: data (SecurityMonitoringSignal, optional) – Object description of a security signal.

datadog_api_client.v2.model.security_monitoring_signal_rule_create_payload module¶

class SecurityMonitoringSignalRuleCreatePayload(arg: None)¶

class SecurityMonitoringSignalRuleCreatePayload(arg: ModelComposed)

class SecurityMonitoringSignalRuleCreatePayload(*args, **kwargs)

Bases: ModelNormal

Create a new signal correlation rule.

Parameters:

cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringSignalRuleQuery]) – Queries for selecting signals which are part of the rule.
tags ([str], optional) – Tags for generated signals.
type (SecurityMonitoringSignalRuleType, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_signal_rule_payload module¶

class SecurityMonitoringSignalRulePayload(arg: None)¶

class SecurityMonitoringSignalRulePayload(arg: ModelComposed)

class SecurityMonitoringSignalRulePayload(*args, **kwargs)

Bases: ModelNormal

The payload of a signal correlation rule.

Parameters:

cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringSignalRuleQuery]) – Queries for selecting signals which are part of the rule.
tags ([str], optional) – Tags for generated signals.
type (SecurityMonitoringSignalRuleType, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_signal_rule_query module¶

class SecurityMonitoringSignalRuleQuery(arg: None)¶

class SecurityMonitoringSignalRuleQuery(arg: ModelComposed)

class SecurityMonitoringSignalRuleQuery(*args, **kwargs)

Bases: ModelNormal

Query for matching rule on signals.

Parameters:

aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.
correlated_by_fields ([str], optional) – Fields to group by.
correlated_query_index (int, optional) – Index of the rule query used to retrieve the correlated field.
metrics ([str], optional) – Group of target fields to aggregate over.
name (str, optional) – Name of the query.
rule_id (str) – Rule ID to match on signals.

datadog_api_client.v2.model.security_monitoring_signal_rule_response module¶

class SecurityMonitoringSignalRuleResponse(arg: None)¶

class SecurityMonitoringSignalRuleResponse(arg: ModelComposed)

class SecurityMonitoringSignalRuleResponse(*args, **kwargs)

Bases: ModelNormal

Rule.

Parameters:

cases ([SecurityMonitoringRuleCase], optional) – Cases for generating signals.
created_at (int, optional) – When the rule was created, timestamp in milliseconds.
creation_author_id (int, optional) – User ID of the user who created the rule.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
deprecation_date (int, optional) – When the rule will be deprecated, timestamp in milliseconds.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
id (str, optional) – The ID of the rule.
is_default (bool, optional) – Whether the rule is included by default.
is_deleted (bool, optional) – Whether the rule has been deleted.
is_enabled (bool, optional) – Whether the rule is enabled.
message (str, optional) – Message for generated signals.
name (str, optional) – The name of the rule.
options (SecurityMonitoringRuleOptions, optional) – Options.
queries ([SecurityMonitoringSignalRuleResponseQuery], optional) – Queries for selecting logs which are part of the rule.
tags ([str], optional) – Tags for generated signals.
type (SecurityMonitoringSignalRuleType, optional) – The rule type.
update_author_id (int, optional) – User ID of the user who updated the rule.
version (int, optional) – The version of the rule.

datadog_api_client.v2.model.security_monitoring_signal_rule_response_query module¶

class SecurityMonitoringSignalRuleResponseQuery(arg: None)¶

class SecurityMonitoringSignalRuleResponseQuery(arg: ModelComposed)

class SecurityMonitoringSignalRuleResponseQuery(*args, **kwargs)

Bases: ModelNormal

Query for matching rule on signals.

Parameters:

aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.
correlated_by_fields ([str], optional) – Fields to correlate by.
correlated_query_index (int, optional) – Index of the rule query used to retrieve the correlated field.
default_rule_id (str, optional) – Default Rule ID to match on signals.
distinct_fields ([str], optional) – Field for which the cardinality is measured. Sent as an array.
group_by_fields ([str], optional) – Fields to group by.
metrics ([str], optional) – Group of target fields to aggregate over.
name (str, optional) – Name of the query.
rule_id (str, optional) – Rule ID to match on signals.

datadog_api_client.v2.model.security_monitoring_signal_rule_type module¶

class SecurityMonitoringSignalRuleType(arg: None)¶

class SecurityMonitoringSignalRuleType(arg: ModelComposed)

class SecurityMonitoringSignalRuleType(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

value (str) – If omitted defaults to “signal_correlation”. Must be one of [“signal_correlation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_signal_state module¶

class SecurityMonitoringSignalState(arg: None)¶

class SecurityMonitoringSignalState(arg: ModelComposed)

class SecurityMonitoringSignalState(*args, **kwargs)

Bases: ModelSimple

The new triage state of the signal.

Parameters:

value (str) – Must be one of [“open”, “archived”, “under_review”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_signal_state_update_attributes module¶

class SecurityMonitoringSignalStateUpdateAttributes(arg: None)¶

class SecurityMonitoringSignalStateUpdateAttributes(arg: ModelComposed)

class SecurityMonitoringSignalStateUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes describing the change of state of a security signal.

Parameters:

archive_comment (str, optional) – Optional comment to display on archived signals.
archive_reason (SecurityMonitoringSignalArchiveReason, optional) – Reason a signal is archived.
state (SecurityMonitoringSignalState) – The new triage state of the signal.
version (int, optional) – Version of the updated signal. If server side version is higher, update will be rejected.

datadog_api_client.v2.model.security_monitoring_signal_state_update_data module¶

class SecurityMonitoringSignalStateUpdateData(arg: None)¶

class SecurityMonitoringSignalStateUpdateData(arg: ModelComposed)

class SecurityMonitoringSignalStateUpdateData(*args, **kwargs)

Bases: ModelNormal

Data containing the patch for changing the state of a signal.

Parameters:

attributes (SecurityMonitoringSignalStateUpdateAttributes) – Attributes describing the change of state of a security signal.
id (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The unique ID of the security signal.
type (SecurityMonitoringSignalMetadataType, optional) – The type of event.

datadog_api_client.v2.model.security_monitoring_signal_state_update_request module¶

class SecurityMonitoringSignalStateUpdateRequest(arg: None)¶

class SecurityMonitoringSignalStateUpdateRequest(arg: ModelComposed)

class SecurityMonitoringSignalStateUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request body for changing the state of a given security monitoring signal.

Parameters:: data (SecurityMonitoringSignalStateUpdateData) – Data containing the patch for changing the state of a signal.

datadog_api_client.v2.model.security_monitoring_signal_triage_attributes module¶

class SecurityMonitoringSignalTriageAttributes(arg: None)¶

class SecurityMonitoringSignalTriageAttributes(arg: ModelComposed)

class SecurityMonitoringSignalTriageAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes describing a triage state update operation over a security signal.

Parameters:

archive_comment (str, optional) – Optional comment to display on archived signals.
archive_comment_timestamp (int, optional) – Timestamp of the last edit to the comment.
archive_comment_user (SecurityMonitoringTriageUser, optional) – Object representing a given user entity.
archive_reason (SecurityMonitoringSignalArchiveReason, optional) – Reason a signal is archived.
assignee (SecurityMonitoringTriageUser) – Object representing a given user entity.
incident_ids (SecurityMonitoringSignalIncidentIds) – Array of incidents that are associated with this signal.
state (SecurityMonitoringSignalState) – The new triage state of the signal.
state_update_timestamp (int, optional) – Timestamp of the last update to the signal state.
state_update_user (SecurityMonitoringTriageUser, optional) – Object representing a given user entity.

datadog_api_client.v2.model.security_monitoring_signal_triage_update_data module¶

class SecurityMonitoringSignalTriageUpdateData(arg: None)¶

class SecurityMonitoringSignalTriageUpdateData(arg: ModelComposed)

class SecurityMonitoringSignalTriageUpdateData(*args, **kwargs)

Bases: ModelNormal

Data containing the updated triage attributes of the signal.

Parameters:

attributes (SecurityMonitoringSignalTriageAttributes, optional) – Attributes describing a triage state update operation over a security signal.
id (str, optional) – The unique ID of the security signal.
type (SecurityMonitoringSignalMetadataType, optional) – The type of event.

datadog_api_client.v2.model.security_monitoring_signal_triage_update_response module¶

class SecurityMonitoringSignalTriageUpdateResponse(arg: None)¶

class SecurityMonitoringSignalTriageUpdateResponse(arg: ModelComposed)

class SecurityMonitoringSignalTriageUpdateResponse(*args, **kwargs)

Bases: ModelNormal

The response returned after all triage operations, containing the updated signal triage data.

Parameters:: data (SecurityMonitoringSignalTriageUpdateData) – Data containing the updated triage attributes of the signal.

datadog_api_client.v2.model.security_monitoring_signal_type module¶

class SecurityMonitoringSignalType(arg: None)¶

class SecurityMonitoringSignalType(arg: ModelComposed)

class SecurityMonitoringSignalType(*args, **kwargs)

Bases: ModelSimple

The type of event.

Parameters:

value (str) – If omitted defaults to “signal”. Must be one of [“signal”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_signals_list_response module¶

class SecurityMonitoringSignalsListResponse(arg: None)¶

class SecurityMonitoringSignalsListResponse(arg: ModelComposed)

class SecurityMonitoringSignalsListResponse(*args, **kwargs)

Bases: ModelNormal

The response object with all security signals matching the request and pagination information.

Parameters:

data ([SecurityMonitoringSignal], optional) – An array of security signals matching the request.
links (SecurityMonitoringSignalsListResponseLinks, optional) – Links attributes.
meta (SecurityMonitoringSignalsListResponseMeta, optional) – Meta attributes.

datadog_api_client.v2.model.security_monitoring_signals_list_response_links module¶

class SecurityMonitoringSignalsListResponseLinks(arg: None)¶

class SecurityMonitoringSignalsListResponseLinks(arg: ModelComposed)

class SecurityMonitoringSignalsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – The link for the next set of results. Note : The request can also be made using the POST endpoint.

datadog_api_client.v2.model.security_monitoring_signals_list_response_meta module¶

class SecurityMonitoringSignalsListResponseMeta(arg: None)¶

class SecurityMonitoringSignalsListResponseMeta(arg: ModelComposed)

class SecurityMonitoringSignalsListResponseMeta(*args, **kwargs)

Bases: ModelNormal

Meta attributes.

Parameters:: page (SecurityMonitoringSignalsListResponseMetaPage, optional) – Paging attributes.

datadog_api_client.v2.model.security_monitoring_signals_list_response_meta_page module¶

class SecurityMonitoringSignalsListResponseMetaPage(arg: None)¶

class SecurityMonitoringSignalsListResponseMetaPage(arg: ModelComposed)

class SecurityMonitoringSignalsListResponseMetaPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

datadog_api_client.v2.model.security_monitoring_signals_sort module¶

class SecurityMonitoringSignalsSort(arg: None)¶

class SecurityMonitoringSignalsSort(arg: ModelComposed)

class SecurityMonitoringSignalsSort(*args, **kwargs)

Bases: ModelSimple

The sort parameters used for querying security signals.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_standard_data_source module¶

class SecurityMonitoringStandardDataSource(arg: None)¶

class SecurityMonitoringStandardDataSource(arg: ModelComposed)

class SecurityMonitoringStandardDataSource(*args, **kwargs)

Bases: ModelSimple

Source of events, either logs, audit trail, or Datadog events.

Parameters:

value (str) – If omitted defaults to “logs”. Must be one of [“logs”, “audit”, “app_sec_spans”, “spans”, “security_runtime”, “network”, “events”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_standard_rule_create_payload module¶

class SecurityMonitoringStandardRuleCreatePayload(arg: None)¶

class SecurityMonitoringStandardRuleCreatePayload(arg: ModelComposed)

class SecurityMonitoringStandardRuleCreatePayload(*args, **kwargs)

Bases: ModelNormal

Create a new rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_standard_rule_payload module¶

class SecurityMonitoringStandardRulePayload(arg: None)¶

class SecurityMonitoringStandardRulePayload(arg: ModelComposed)

class SecurityMonitoringStandardRulePayload(*args, **kwargs)

Bases: ModelNormal

The payload of a rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_standard_rule_query module¶

class SecurityMonitoringStandardRuleQuery(arg: None)¶

class SecurityMonitoringStandardRuleQuery(arg: ModelComposed)

class SecurityMonitoringStandardRuleQuery(*args, **kwargs)

Bases: ModelNormal

Query for matching rule.

Parameters:

aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.
custom_query_extension (str, optional) – Query extension to append to the logs query.
data_source (SecurityMonitoringStandardDataSource, optional) – Source of events, either logs, audit trail, or Datadog events.
distinct_fields ([str], optional) – Field for which the cardinality is measured. Sent as an array.
group_by_fields ([str], optional) – Fields to group by.
has_optional_group_by_fields (bool, optional) – When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A , replacing the missing values.
index (str, optional) – This field is currently unstable and might be removed in a minor version upgrade. The index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.
indexes ([str], optional) – List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.
metric (str, optional) – (Deprecated) The target field to aggregate over when using the sum or max aggregations. metrics field should be used instead. Deprecated.
metrics ([str], optional) – Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
name (str, optional) – Name of the query.
query (str, optional) – Query to run on logs.

datadog_api_client.v2.model.security_monitoring_standard_rule_response module¶

class SecurityMonitoringStandardRuleResponse(arg: None)¶

class SecurityMonitoringStandardRuleResponse(arg: ModelComposed)

class SecurityMonitoringStandardRuleResponse(*args, **kwargs)

Bases: ModelNormal

Rule.

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCase], optional) – Cases for generating signals.
compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions, optional) – How to generate compliance signals. Useful for cloud_configuration rules only.
created_at (int, optional) – When the rule was created, timestamp in milliseconds.
creation_author_id (int, optional) – User ID of the user who created the rule.
custom_message (str, optional) – Custom/Overridden message for generated signals (used in case of Default rule update).
custom_name (str, optional) – Custom/Overridden name of the rule (used in case of Default rule update).
default_tags ([str], optional) – Default Tags for default rules (included in tags)
deprecation_date (int, optional) – When the rule will be deprecated, timestamp in milliseconds.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
id (str, optional) – The ID of the rule.
is_default (bool, optional) – Whether the rule is included by default.
is_deleted (bool, optional) – Whether the rule has been deleted.
is_enabled (bool, optional) – Whether the rule is enabled.
message (str, optional) – Message for generated signals.
name (str, optional) – The name of the rule.
options (SecurityMonitoringRuleOptions, optional) – Options.
queries ([SecurityMonitoringStandardRuleQuery], optional) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCase], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeRead, optional) – The rule type.
update_author_id (int, optional) – User ID of the user who updated the rule.
updated_at (int, optional) – The date the rule was last updated, in milliseconds.
version (int, optional) – The version of the rule.

datadog_api_client.v2.model.security_monitoring_standard_rule_test_payload module¶

class SecurityMonitoringStandardRuleTestPayload(arg: None)¶

class SecurityMonitoringStandardRuleTestPayload(arg: ModelComposed)

class SecurityMonitoringStandardRuleTestPayload(*args, **kwargs)

Bases: ModelNormal

The payload of a rule to test

Parameters:

calculated_fields ([CalculatedField], optional) – Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.
filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
group_signals_by ([str], optional) – Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
has_extended_title (bool, optional) – Whether the notifications include the triggering group-by values in their title.
is_enabled (bool) – Whether the rule is enabled.
message (str) – Message for generated signals.
name (str) – The name of the rule.
options (SecurityMonitoringRuleOptions) – Options.
queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.
reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.
scheduling_options (SecurityMonitoringSchedulingOptions, none_type, optional) – Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
tags ([str], optional) – Tags for generated signals.
third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating signals from third-party rules. Only available for third-party rules.
type (SecurityMonitoringRuleTypeTest, optional) – The rule type.

datadog_api_client.v2.model.security_monitoring_suppression module¶

class SecurityMonitoringSuppression(arg: None)¶

class SecurityMonitoringSuppression(arg: ModelComposed)

class SecurityMonitoringSuppression(*args, **kwargs)

Bases: ModelNormal

The suppression rule’s properties.

Parameters:

attributes (SecurityMonitoringSuppressionAttributes, optional) – The attributes of the suppression rule.
id (str, optional) – The ID of the suppression rule.
type (SecurityMonitoringSuppressionType, optional) – The type of the resource. The value should always be suppressions.

datadog_api_client.v2.model.security_monitoring_suppression_attributes module¶

class SecurityMonitoringSuppressionAttributes(arg: None)¶

class SecurityMonitoringSuppressionAttributes(arg: ModelComposed)

class SecurityMonitoringSuppressionAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the suppression rule.

Parameters:

creation_date (int, optional) – A Unix millisecond timestamp given the creation date of the suppression rule.
creator (SecurityMonitoringUser, optional) – A user.
data_exclusion_query (str, optional) – An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description (str, optional) – A description for the suppression rule.
editable (bool, optional) – Whether the suppression rule is editable.
enabled (bool, optional) – Whether the suppression rule is enabled.
expiration_date (int, optional) – A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won’t suppress signals anymore.
name (str, optional) – The name of the suppression rule.
rule_query (str, optional) – The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date (int, optional) – A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query (str, optional) – The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
tags ([str], optional) – List of tags associated with the suppression rule.
update_date (int, optional) – A Unix millisecond timestamp given the update date of the suppression rule.
updater (SecurityMonitoringUser, optional) – A user.
version (int, optional) – The version of the suppression rule; it starts at 1, and is incremented at each update.

datadog_api_client.v2.model.security_monitoring_suppression_create_attributes module¶

class SecurityMonitoringSuppressionCreateAttributes(arg: None)¶

class SecurityMonitoringSuppressionCreateAttributes(arg: ModelComposed)

class SecurityMonitoringSuppressionCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the attributes of the suppression rule to be created.

Parameters:

data_exclusion_query (str, optional) – An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description (str, optional) – A description for the suppression rule.
enabled (bool) – Whether the suppression rule is enabled.
expiration_date (int, optional) – A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won’t suppress signals anymore.
name (str) – The name of the suppression rule.
rule_query (str) – The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date (int, optional) – A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
suppression_query (str, optional) – The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.
tags ([str], optional) – List of tags associated with the suppression rule.

datadog_api_client.v2.model.security_monitoring_suppression_create_data module¶

class SecurityMonitoringSuppressionCreateData(arg: None)¶

class SecurityMonitoringSuppressionCreateData(arg: ModelComposed)

class SecurityMonitoringSuppressionCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single suppression rule.

Parameters:

attributes (SecurityMonitoringSuppressionCreateAttributes) – Object containing the attributes of the suppression rule to be created.
type (SecurityMonitoringSuppressionType) – The type of the resource. The value should always be suppressions.

datadog_api_client.v2.model.security_monitoring_suppression_create_request module¶

class SecurityMonitoringSuppressionCreateRequest(arg: None)¶

class SecurityMonitoringSuppressionCreateRequest(arg: ModelComposed)

class SecurityMonitoringSuppressionCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the suppression rule that you would like to create.

Parameters:: data (SecurityMonitoringSuppressionCreateData) – Object for a single suppression rule.

datadog_api_client.v2.model.security_monitoring_suppression_response module¶

class SecurityMonitoringSuppressionResponse(arg: None)¶

class SecurityMonitoringSuppressionResponse(arg: ModelComposed)

class SecurityMonitoringSuppressionResponse(*args, **kwargs)

Bases: ModelNormal

Response object containing a single suppression rule.

Parameters:: data (SecurityMonitoringSuppression, optional) – The suppression rule’s properties.

datadog_api_client.v2.model.security_monitoring_suppression_type module¶

class SecurityMonitoringSuppressionType(arg: None)¶

class SecurityMonitoringSuppressionType(arg: ModelComposed)

class SecurityMonitoringSuppressionType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be suppressions.

Parameters:

value (str) – If omitted defaults to “suppressions”. Must be one of [“suppressions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.security_monitoring_suppression_update_attributes module¶

class SecurityMonitoringSuppressionUpdateAttributes(arg: None)¶

class SecurityMonitoringSuppressionUpdateAttributes(arg: ModelComposed)

class SecurityMonitoringSuppressionUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The suppression rule properties to be updated.

Parameters:

data_exclusion_query (str, optional) – An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
description (str, optional) – A description for the suppression rule.
enabled (bool, optional) – Whether the suppression rule is enabled.
expiration_date (int, none_type, optional) – A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won’t suppress signals anymore. If unset, the expiration date of the suppression rule is left untouched. If set to null , the expiration date is removed.
name (str, optional) – The name of the suppression rule.
rule_query (str, optional) – The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
start_date (int, none_type, optional) – A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to null , the start date is removed.
suppression_query (str, optional) – The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
tags ([str], optional) – List of tags associated with the suppression rule.
version (int, optional) – The current version of the suppression. This is optional, but it can help prevent concurrent modifications.

datadog_api_client.v2.model.security_monitoring_suppression_update_data module¶

class SecurityMonitoringSuppressionUpdateData(arg: None)¶

class SecurityMonitoringSuppressionUpdateData(arg: ModelComposed)

class SecurityMonitoringSuppressionUpdateData(*args, **kwargs)

Bases: ModelNormal

The new suppression properties; partial updates are supported.

Parameters:

attributes (SecurityMonitoringSuppressionUpdateAttributes) – The suppression rule properties to be updated.
type (SecurityMonitoringSuppressionType) – The type of the resource. The value should always be suppressions.

datadog_api_client.v2.model.security_monitoring_suppression_update_request module¶

class SecurityMonitoringSuppressionUpdateRequest(arg: None)¶

class SecurityMonitoringSuppressionUpdateRequest(arg: ModelComposed)

class SecurityMonitoringSuppressionUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request object containing the fields to update on the suppression rule.

Parameters:: data (SecurityMonitoringSuppressionUpdateData) – The new suppression properties; partial updates are supported.

datadog_api_client.v2.model.security_monitoring_suppressions_response module¶

class SecurityMonitoringSuppressionsResponse(arg: None)¶

class SecurityMonitoringSuppressionsResponse(arg: ModelComposed)

class SecurityMonitoringSuppressionsResponse(*args, **kwargs)

Bases: ModelNormal

Response object containing the available suppression rules.

Parameters:: data ([SecurityMonitoringSuppression], optional) – A list of suppressions objects.

datadog_api_client.v2.model.security_monitoring_third_party_root_query module¶

class SecurityMonitoringThirdPartyRootQuery(arg: None)¶

class SecurityMonitoringThirdPartyRootQuery(arg: ModelComposed)

class SecurityMonitoringThirdPartyRootQuery(*args, **kwargs)

Bases: ModelNormal

A query to be combined with the third party case query.

Parameters:

group_by_fields ([str], optional) – Fields to group by.
query (str, optional) – Query to run on logs.

datadog_api_client.v2.model.security_monitoring_third_party_rule_case module¶

class SecurityMonitoringThirdPartyRuleCase(arg: None)¶

class SecurityMonitoringThirdPartyRuleCase(arg: ModelComposed)

class SecurityMonitoringThirdPartyRuleCase(*args, **kwargs)

Bases: ModelNormal

Case when signal is generated by a third party rule.

Parameters:

custom_status (SecurityMonitoringRuleSeverity, optional) – Severity of the Security Signal.
name (str, optional) – Name of the case.
notifications ([str], optional) – Notification targets for each rule case.
query (str, optional) – A query to map a third party event to this case.
status (SecurityMonitoringRuleSeverity, optional) – Severity of the Security Signal.

datadog_api_client.v2.model.security_monitoring_third_party_rule_case_create module¶

class SecurityMonitoringThirdPartyRuleCaseCreate(arg: None)¶

class SecurityMonitoringThirdPartyRuleCaseCreate(arg: ModelComposed)

class SecurityMonitoringThirdPartyRuleCaseCreate(*args, **kwargs)

Bases: ModelNormal

Case when a signal is generated by a third party rule.

Parameters:

name (str, optional) – Name of the case.
notifications ([str], optional) – Notification targets for each case.
query (str, optional) – A query to map a third party event to this case.
status (SecurityMonitoringRuleSeverity) – Severity of the Security Signal.

datadog_api_client.v2.model.security_monitoring_triage_user module¶

class SecurityMonitoringTriageUser(arg: None)¶

class SecurityMonitoringTriageUser(arg: ModelComposed)

class SecurityMonitoringTriageUser(*args, **kwargs)

Bases: ModelNormal

Object representing a given user entity.

Parameters:

handle (str, optional) – The handle for this user account.
icon (str, optional) – Gravatar icon associated to the user.
id (int, optional) – Numerical ID assigned by Datadog to this user account.
name (str, none_type, optional) – The name for this user account.
uuid (str) – UUID assigned by Datadog to this user account.

datadog_api_client.v2.model.security_monitoring_user module¶

class SecurityMonitoringUser(arg: None)¶

class SecurityMonitoringUser(arg: ModelComposed)

class SecurityMonitoringUser(*args, **kwargs)

Bases: ModelNormal

A user.

Parameters:

handle (str, optional) – The handle of the user.
name (str, none_type, optional) – The name of the user.

datadog_api_client.v2.model.security_trigger module¶

class SecurityTrigger(arg: None)¶

class SecurityTrigger(arg: ModelComposed)

class SecurityTrigger(*args, **kwargs)

Bases: ModelNormal

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

Parameters:: rate_limit (TriggerRateLimit, optional) – Defines a rate limit for a trigger.

datadog_api_client.v2.model.security_trigger_wrapper module¶

class SecurityTriggerWrapper(arg: None)¶

class SecurityTriggerWrapper(arg: ModelComposed)

class SecurityTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Security-based trigger.

Parameters:

security_trigger (SecurityTrigger) – Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.selectors module¶

class Selectors(arg: None)¶

class Selectors(arg: ModelComposed)

class Selectors(*args, **kwargs)

Bases: ModelNormal

Selectors are used to filter security issues for which notifications should be generated. Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source. Only the trigger_source field is required.

Parameters:

query (str, optional) – The query is composed of one or several key:value pairs, which can be used to filter security issues on tags and attributes.
rule_types ([RuleTypesItems], optional) – Security rule types used as filters in security rules.
severities ([RuleSeverity], optional) – The security rules severities to consider.
trigger_source (TriggerSource) – The type of security issues on which the rule applies. Notification rules based on security signals need to use the trigger source “security_signals”, while notification rules based on security vulnerabilities need to use the trigger source “security_findings”.

datadog_api_client.v2.model.self_service_trigger_wrapper module¶

class SelfServiceTriggerWrapper(arg: None)¶

class SelfServiceTriggerWrapper(arg: ModelComposed)

class SelfServiceTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Self Service-based trigger.

Parameters:

self_service_trigger (dict) – Trigger a workflow from Self Service.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.send_slack_message_action module¶

class SendSlackMessageAction(arg: None)¶

class SendSlackMessageAction(arg: ModelComposed)

class SendSlackMessageAction(*args, **kwargs)

Bases: ModelNormal

Sends a message to a Slack channel.

Parameters:

channel (str) – The channel ID.
type (SendSlackMessageActionType) – Indicates that the action is a send Slack message action.
workspace (str) – The workspace ID.

datadog_api_client.v2.model.send_slack_message_action_type module¶

class SendSlackMessageActionType(arg: None)¶

class SendSlackMessageActionType(arg: ModelComposed)

class SendSlackMessageActionType(*args, **kwargs)

Bases: ModelSimple

Indicates that the action is a send Slack message action.

Parameters:

value (str) – If omitted defaults to “send_slack_message”. Must be one of [“send_slack_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.send_teams_message_action module¶

class SendTeamsMessageAction(arg: None)¶

class SendTeamsMessageAction(arg: ModelComposed)

class SendTeamsMessageAction(*args, **kwargs)

Bases: ModelNormal

Sends a message to a Microsoft Teams channel.

Parameters:

channel (str) – The channel ID.
team (str) – The team ID.
tenant (str) – The tenant ID.
type (SendTeamsMessageActionType) – Indicates that the action is a send Microsoft Teams message action.

datadog_api_client.v2.model.send_teams_message_action_type module¶

class SendTeamsMessageActionType(arg: None)¶

class SendTeamsMessageActionType(arg: ModelComposed)

class SendTeamsMessageActionType(*args, **kwargs)

Bases: ModelSimple

Indicates that the action is a send Microsoft Teams message action.

Parameters:

value (str) – If omitted defaults to “send_teams_message”. Must be one of [“send_teams_message”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_config_request module¶

class SensitiveDataScannerConfigRequest(arg: None)¶

class SensitiveDataScannerConfigRequest(arg: ModelComposed)

class SensitiveDataScannerConfigRequest(*args, **kwargs)

Bases: ModelNormal

Group reorder request.

Parameters:

data (SensitiveDataScannerReorderConfig) – Data related to the reordering of scanning groups.
meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_configuration module¶

class SensitiveDataScannerConfiguration(arg: None)¶

class SensitiveDataScannerConfiguration(arg: ModelComposed)

class SensitiveDataScannerConfiguration(*args, **kwargs)

Bases: ModelNormal

A Sensitive Data Scanner configuration.

Parameters:

id (str, optional) – ID of the configuration.
type (SensitiveDataScannerConfigurationType, optional) – Sensitive Data Scanner configuration type.

datadog_api_client.v2.model.sensitive_data_scanner_configuration_data module¶

class SensitiveDataScannerConfigurationData(arg: None)¶

class SensitiveDataScannerConfigurationData(arg: ModelComposed)

class SensitiveDataScannerConfigurationData(*args, **kwargs)

Bases: ModelNormal

A Sensitive Data Scanner configuration data.

Parameters:: data (SensitiveDataScannerConfiguration, optional) – A Sensitive Data Scanner configuration.

datadog_api_client.v2.model.sensitive_data_scanner_configuration_relationships module¶

class SensitiveDataScannerConfigurationRelationships(arg: None)¶

class SensitiveDataScannerConfigurationRelationships(arg: ModelComposed)

class SensitiveDataScannerConfigurationRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the configuration.

Parameters:: groups (SensitiveDataScannerGroupList, optional) – List of groups, ordered.

datadog_api_client.v2.model.sensitive_data_scanner_configuration_type module¶

class SensitiveDataScannerConfigurationType(arg: None)¶

class SensitiveDataScannerConfigurationType(arg: ModelComposed)

class SensitiveDataScannerConfigurationType(*args, **kwargs)

Bases: ModelSimple

Sensitive Data Scanner configuration type.

Parameters:

value (str) – If omitted defaults to “sensitive_data_scanner_configuration”. Must be one of [“sensitive_data_scanner_configuration”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_create_group_response module¶

class SensitiveDataScannerCreateGroupResponse(arg: None)¶

class SensitiveDataScannerCreateGroupResponse(arg: ModelComposed)

class SensitiveDataScannerCreateGroupResponse(*args, **kwargs)

Bases: ModelNormal

Create group response.

Parameters:

data (SensitiveDataScannerGroupResponse, optional) – Response data related to the creation of a group.
meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_create_rule_response module¶

class SensitiveDataScannerCreateRuleResponse(arg: None)¶

class SensitiveDataScannerCreateRuleResponse(arg: ModelComposed)

class SensitiveDataScannerCreateRuleResponse(*args, **kwargs)

Bases: ModelNormal

Create rule response.

Parameters:

data (SensitiveDataScannerRuleResponse, optional) – Response data related to the creation of a rule.
meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_filter module¶

class SensitiveDataScannerFilter(arg: None)¶

class SensitiveDataScannerFilter(arg: ModelComposed)

class SensitiveDataScannerFilter(*args, **kwargs)

Bases: ModelNormal

Filter for the Scanning Group.

Parameters:: query (str, optional) – Query to filter the events.

datadog_api_client.v2.model.sensitive_data_scanner_get_config_included_array module¶

class SensitiveDataScannerGetConfigIncludedArray(arg: None)¶

class SensitiveDataScannerGetConfigIncludedArray(arg: ModelComposed)

class SensitiveDataScannerGetConfigIncludedArray(*args, **kwargs)

Bases: ModelSimple

Included objects from relationships.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_get_config_included_item module¶

class SensitiveDataScannerGetConfigIncludedItem(arg: None)¶

class SensitiveDataScannerGetConfigIncludedItem(arg: ModelComposed)

class SensitiveDataScannerGetConfigIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to the configuration.

Parameters:

attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.
id (str, optional) – ID of the rule.
relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.
type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

datadog_api_client.v2.model.sensitive_data_scanner_get_config_response module¶

class SensitiveDataScannerGetConfigResponse(arg: None)¶

class SensitiveDataScannerGetConfigResponse(arg: ModelComposed)

class SensitiveDataScannerGetConfigResponse(*args, **kwargs)

Bases: ModelNormal

Get all groups response.

Parameters:

data (SensitiveDataScannerGetConfigResponseData, optional) – Response data related to the scanning groups.
included (SensitiveDataScannerGetConfigIncludedArray, optional) – Included objects from relationships.
meta (SensitiveDataScannerMeta, optional) – Meta response containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_get_config_response_data module¶

class SensitiveDataScannerGetConfigResponseData(arg: None)¶

class SensitiveDataScannerGetConfigResponseData(arg: ModelComposed)

class SensitiveDataScannerGetConfigResponseData(*args, **kwargs)

Bases: ModelNormal

Response data related to the scanning groups.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Attributes of the Sensitive Data configuration.
id (str, optional) – ID of the configuration.
relationships (SensitiveDataScannerConfigurationRelationships, optional) – Relationships of the configuration.
type (SensitiveDataScannerConfigurationType, optional) – Sensitive Data Scanner configuration type.

datadog_api_client.v2.model.sensitive_data_scanner_group module¶

class SensitiveDataScannerGroup(arg: None)¶

class SensitiveDataScannerGroup(arg: ModelComposed)

class SensitiveDataScannerGroup(*args, **kwargs)

Bases: ModelNormal

A scanning group.

Parameters:

id (str, optional) – ID of the group.
type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

datadog_api_client.v2.model.sensitive_data_scanner_group_attributes module¶

class SensitiveDataScannerGroupAttributes(arg: None)¶

class SensitiveDataScannerGroupAttributes(arg: ModelComposed)

class SensitiveDataScannerGroupAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the Sensitive Data Scanner group.

Parameters:

description (str, optional) – Description of the group.
filter (SensitiveDataScannerFilter, optional) – Filter for the Scanning Group.
is_enabled (bool, optional) – Whether or not the group is enabled.
name (str, optional) – Name of the group.
product_list ([SensitiveDataScannerProduct], optional) – List of products the scanning group applies.
samplings ([SensitiveDataScannerSamplings], optional) – List of sampling rates per product type.

datadog_api_client.v2.model.sensitive_data_scanner_group_create module¶

class SensitiveDataScannerGroupCreate(arg: None)¶

class SensitiveDataScannerGroupCreate(arg: ModelComposed)

class SensitiveDataScannerGroupCreate(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a group.

Parameters:

attributes (SensitiveDataScannerGroupAttributes) – Attributes of the Sensitive Data Scanner group.
relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.
type (SensitiveDataScannerGroupType) – Sensitive Data Scanner group type.

datadog_api_client.v2.model.sensitive_data_scanner_group_create_request module¶

class SensitiveDataScannerGroupCreateRequest(arg: None)¶

class SensitiveDataScannerGroupCreateRequest(arg: ModelComposed)

class SensitiveDataScannerGroupCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create group request.

Parameters:

data (SensitiveDataScannerGroupCreate, optional) – Data related to the creation of a group.
meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_group_data module¶

class SensitiveDataScannerGroupData(arg: None)¶

class SensitiveDataScannerGroupData(arg: ModelComposed)

class SensitiveDataScannerGroupData(*args, **kwargs)

Bases: ModelNormal

A scanning group data.

Parameters:: data (SensitiveDataScannerGroup, optional) – A scanning group.

datadog_api_client.v2.model.sensitive_data_scanner_group_delete_request module¶

class SensitiveDataScannerGroupDeleteRequest(arg: None)¶

class SensitiveDataScannerGroupDeleteRequest(arg: ModelComposed)

class SensitiveDataScannerGroupDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Delete group request.

Parameters:: meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_group_delete_response module¶

class SensitiveDataScannerGroupDeleteResponse(arg: None)¶

class SensitiveDataScannerGroupDeleteResponse(arg: ModelComposed)

class SensitiveDataScannerGroupDeleteResponse(*args, **kwargs)

Bases: ModelNormal

Delete group response.

Parameters:: meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_group_included_item module¶

class SensitiveDataScannerGroupIncludedItem(arg: None)¶

class SensitiveDataScannerGroupIncludedItem(arg: ModelComposed)

class SensitiveDataScannerGroupIncludedItem(*args, **kwargs)

Bases: ModelNormal

A Scanning Group included item.

Parameters:

attributes (SensitiveDataScannerGroupAttributes, optional) – Attributes of the Sensitive Data Scanner group.
id (str, optional) – ID of the group.
relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.
type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

datadog_api_client.v2.model.sensitive_data_scanner_group_item module¶

class SensitiveDataScannerGroupItem(arg: None)¶

class SensitiveDataScannerGroupItem(arg: ModelComposed)

class SensitiveDataScannerGroupItem(*args, **kwargs)

Bases: ModelNormal

Data related to a Sensitive Data Scanner Group.

Parameters:

id (str, optional) – ID of the group.
type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

datadog_api_client.v2.model.sensitive_data_scanner_group_list module¶

class SensitiveDataScannerGroupList(arg: None)¶

class SensitiveDataScannerGroupList(arg: ModelComposed)

class SensitiveDataScannerGroupList(*args, **kwargs)

Bases: ModelNormal

List of groups, ordered.

Parameters:: data ([SensitiveDataScannerGroupItem], optional) – List of groups. The order is important.

datadog_api_client.v2.model.sensitive_data_scanner_group_relationships module¶

class SensitiveDataScannerGroupRelationships(arg: None)¶

class SensitiveDataScannerGroupRelationships(arg: ModelComposed)

class SensitiveDataScannerGroupRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the group.

Parameters:

configuration (SensitiveDataScannerConfigurationData, optional) – A Sensitive Data Scanner configuration data.
rules (SensitiveDataScannerRuleData, optional) – Rules included in the group.

datadog_api_client.v2.model.sensitive_data_scanner_group_response module¶

class SensitiveDataScannerGroupResponse(arg: None)¶

class SensitiveDataScannerGroupResponse(arg: ModelComposed)

class SensitiveDataScannerGroupResponse(*args, **kwargs)

Bases: ModelNormal

Response data related to the creation of a group.

Parameters:

attributes (SensitiveDataScannerGroupAttributes, optional) – Attributes of the Sensitive Data Scanner group.
id (str, optional) – ID of the group.
relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.
type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

datadog_api_client.v2.model.sensitive_data_scanner_group_type module¶

class SensitiveDataScannerGroupType(arg: None)¶

class SensitiveDataScannerGroupType(arg: ModelComposed)

class SensitiveDataScannerGroupType(*args, **kwargs)

Bases: ModelSimple

Sensitive Data Scanner group type.

Parameters:

value (str) – If omitted defaults to “sensitive_data_scanner_group”. Must be one of [“sensitive_data_scanner_group”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_group_update module¶

class SensitiveDataScannerGroupUpdate(arg: None)¶

class SensitiveDataScannerGroupUpdate(arg: ModelComposed)

class SensitiveDataScannerGroupUpdate(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a group.

Parameters:

attributes (SensitiveDataScannerGroupAttributes, optional) – Attributes of the Sensitive Data Scanner group.
id (str, optional) – ID of the group.
relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.
type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

datadog_api_client.v2.model.sensitive_data_scanner_group_update_request module¶

class SensitiveDataScannerGroupUpdateRequest(arg: None)¶

class SensitiveDataScannerGroupUpdateRequest(arg: ModelComposed)

class SensitiveDataScannerGroupUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update group request.

Parameters:

data (SensitiveDataScannerGroupUpdate) – Data related to the update of a group.
meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_group_update_response module¶

class SensitiveDataScannerGroupUpdateResponse(arg: None)¶

class SensitiveDataScannerGroupUpdateResponse(arg: ModelComposed)

class SensitiveDataScannerGroupUpdateResponse(*args, **kwargs)

Bases: ModelNormal

Update group response.

Parameters:: meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_included_keyword_configuration module¶

class SensitiveDataScannerIncludedKeywordConfiguration(arg: None)¶

class SensitiveDataScannerIncludedKeywordConfiguration(arg: ModelComposed)

class SensitiveDataScannerIncludedKeywordConfiguration(*args, **kwargs)

Bases: ModelNormal

Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check, the match is kept. If none are found, the match is discarded.

Parameters:

character_count (int) – The number of characters behind a match detected by Sensitive Data Scanner to look for the keywords defined. character_count should be greater than the maximum length of a keyword defined for a rule.
keywords ([str]) – Keyword list that will be checked during scanning in order to validate a match. The number of keywords in the list must be less than or equal to 30.
use_recommended_keywords (bool, optional) – Should the rule use the underlying standard pattern keyword configuration. If set to true , the rule must be tied to a standard pattern. If set to false , the specified keywords and character_count are applied.

datadog_api_client.v2.model.sensitive_data_scanner_meta module¶

class SensitiveDataScannerMeta(arg: None)¶

class SensitiveDataScannerMeta(arg: ModelComposed)

class SensitiveDataScannerMeta(*args, **kwargs)

Bases: ModelNormal

Meta response containing information about the API.

Parameters:

count_limit (int, optional) – Maximum number of scanning rules allowed for the org.
group_count_limit (int, optional) – Maximum number of scanning groups allowed for the org.
has_highlight_enabled (bool, optional) – (Deprecated) Whether or not scanned events are highlighted in Logs or RUM for the org. Deprecated.
has_multi_pass_enabled (bool, optional) – (Deprecated) Whether or not scanned events have multi-pass enabled. Deprecated.
is_pci_compliant (bool, optional) – Whether or not the org is compliant to the payment card industry standard.
version (int, optional) – Version of the API.

datadog_api_client.v2.model.sensitive_data_scanner_meta_version_only module¶

class SensitiveDataScannerMetaVersionOnly(arg: None)¶

class SensitiveDataScannerMetaVersionOnly(arg: ModelComposed)

class SensitiveDataScannerMetaVersionOnly(*args, **kwargs)

Bases: ModelNormal

Meta payload containing information about the API.

Parameters:: version (int, optional) – Version of the API (optional).

datadog_api_client.v2.model.sensitive_data_scanner_product module¶

class SensitiveDataScannerProduct(arg: None)¶

class SensitiveDataScannerProduct(arg: ModelComposed)

class SensitiveDataScannerProduct(*args, **kwargs)

Bases: ModelSimple

Datadog product onto which Sensitive Data Scanner can be activated.

Parameters:

value (str) – If omitted defaults to “logs”. Must be one of [“logs”, “rum”, “events”, “apm”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_reorder_config module¶

class SensitiveDataScannerReorderConfig(arg: None)¶

class SensitiveDataScannerReorderConfig(arg: ModelComposed)

class SensitiveDataScannerReorderConfig(*args, **kwargs)

Bases: ModelNormal

Data related to the reordering of scanning groups.

Parameters:

id (str, optional) – ID of the configuration.
relationships (SensitiveDataScannerConfigurationRelationships, optional) – Relationships of the configuration.
type (SensitiveDataScannerConfigurationType, optional) – Sensitive Data Scanner configuration type.

datadog_api_client.v2.model.sensitive_data_scanner_reorder_groups_response module¶

class SensitiveDataScannerReorderGroupsResponse(arg: None)¶

class SensitiveDataScannerReorderGroupsResponse(arg: ModelComposed)

class SensitiveDataScannerReorderGroupsResponse(*args, **kwargs)

Bases: ModelNormal

Group reorder response.

Parameters:: meta (SensitiveDataScannerMeta, optional) – Meta response containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_rule module¶

class SensitiveDataScannerRule(arg: None)¶

class SensitiveDataScannerRule(arg: ModelComposed)

class SensitiveDataScannerRule(*args, **kwargs)

Bases: ModelNormal

Rule item included in the group.

Parameters:

id (str, optional) – ID of the rule.
type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

datadog_api_client.v2.model.sensitive_data_scanner_rule_attributes module¶

class SensitiveDataScannerRuleAttributes(arg: None)¶

class SensitiveDataScannerRuleAttributes(arg: ModelComposed)

class SensitiveDataScannerRuleAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the Sensitive Data Scanner rule.

Parameters:

description (str, optional) – Description of the rule.
excluded_namespaces ([str], optional) – Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.
included_keyword_configuration (SensitiveDataScannerIncludedKeywordConfiguration, optional) – Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check, the match is kept. If none are found, the match is discarded.
is_enabled (bool, optional) – Whether or not the rule is enabled.
name (str, optional) – Name of the rule.
namespaces ([str], optional) – Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.
pattern (str, optional) – Not included if there is a relationship to a standard pattern.
priority (int, optional) – Integer from 1 (high) to 5 (low) indicating rule issue severity.
tags ([str], optional) – List of tags.
text_replacement (SensitiveDataScannerTextReplacement, optional) – Object describing how the scanned event will be replaced.

datadog_api_client.v2.model.sensitive_data_scanner_rule_create module¶

class SensitiveDataScannerRuleCreate(arg: None)¶

class SensitiveDataScannerRuleCreate(arg: ModelComposed)

class SensitiveDataScannerRuleCreate(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a rule.

Parameters:

attributes (SensitiveDataScannerRuleAttributes) – Attributes of the Sensitive Data Scanner rule.
relationships (SensitiveDataScannerRuleRelationships) – Relationships of a scanning rule.
type (SensitiveDataScannerRuleType) – Sensitive Data Scanner rule type.

datadog_api_client.v2.model.sensitive_data_scanner_rule_create_request module¶

class SensitiveDataScannerRuleCreateRequest(arg: None)¶

class SensitiveDataScannerRuleCreateRequest(arg: ModelComposed)

class SensitiveDataScannerRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create rule request.

Parameters:

data (SensitiveDataScannerRuleCreate) – Data related to the creation of a rule.
meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_rule_data module¶

class SensitiveDataScannerRuleData(arg: None)¶

class SensitiveDataScannerRuleData(arg: ModelComposed)

class SensitiveDataScannerRuleData(*args, **kwargs)

Bases: ModelNormal

Rules included in the group.

Parameters:: data ([SensitiveDataScannerRule], optional) – Rules included in the group. The order is important.

datadog_api_client.v2.model.sensitive_data_scanner_rule_delete_request module¶

class SensitiveDataScannerRuleDeleteRequest(arg: None)¶

class SensitiveDataScannerRuleDeleteRequest(arg: ModelComposed)

class SensitiveDataScannerRuleDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Delete rule request.

Parameters:: meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_rule_delete_response module¶

class SensitiveDataScannerRuleDeleteResponse(arg: None)¶

class SensitiveDataScannerRuleDeleteResponse(arg: ModelComposed)

class SensitiveDataScannerRuleDeleteResponse(*args, **kwargs)

Bases: ModelNormal

Delete rule response.

Parameters:: meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_rule_included_item module¶

class SensitiveDataScannerRuleIncludedItem(arg: None)¶

class SensitiveDataScannerRuleIncludedItem(arg: ModelComposed)

class SensitiveDataScannerRuleIncludedItem(*args, **kwargs)

Bases: ModelNormal

A Scanning Rule included item.

Parameters:

attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.
id (str, optional) – ID of the rule.
relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.
type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

datadog_api_client.v2.model.sensitive_data_scanner_rule_relationships module¶

class SensitiveDataScannerRuleRelationships(arg: None)¶

class SensitiveDataScannerRuleRelationships(arg: ModelComposed)

class SensitiveDataScannerRuleRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of a scanning rule.

Parameters:

group (SensitiveDataScannerGroupData, optional) – A scanning group data.
standard_pattern (SensitiveDataScannerStandardPatternData, optional) – A standard pattern.

datadog_api_client.v2.model.sensitive_data_scanner_rule_response module¶

class SensitiveDataScannerRuleResponse(arg: None)¶

class SensitiveDataScannerRuleResponse(arg: ModelComposed)

class SensitiveDataScannerRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response data related to the creation of a rule.

Parameters:

attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.
id (str, optional) – ID of the rule.
relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.
type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

datadog_api_client.v2.model.sensitive_data_scanner_rule_type module¶

class SensitiveDataScannerRuleType(arg: None)¶

class SensitiveDataScannerRuleType(arg: ModelComposed)

class SensitiveDataScannerRuleType(*args, **kwargs)

Bases: ModelSimple

Sensitive Data Scanner rule type.

Parameters:

value (str) – If omitted defaults to “sensitive_data_scanner_rule”. Must be one of [“sensitive_data_scanner_rule”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_rule_update module¶

class SensitiveDataScannerRuleUpdate(arg: None)¶

class SensitiveDataScannerRuleUpdate(arg: ModelComposed)

class SensitiveDataScannerRuleUpdate(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a rule.

Parameters:

attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.
id (str, optional) – ID of the rule.
relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.
type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

datadog_api_client.v2.model.sensitive_data_scanner_rule_update_request module¶

class SensitiveDataScannerRuleUpdateRequest(arg: None)¶

class SensitiveDataScannerRuleUpdateRequest(arg: ModelComposed)

class SensitiveDataScannerRuleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update rule request.

Parameters:

data (SensitiveDataScannerRuleUpdate) – Data related to the update of a rule.
meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_rule_update_response module¶

class SensitiveDataScannerRuleUpdateResponse(arg: None)¶

class SensitiveDataScannerRuleUpdateResponse(arg: ModelComposed)

class SensitiveDataScannerRuleUpdateResponse(*args, **kwargs)

Bases: ModelNormal

Update rule response.

Parameters:: meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

datadog_api_client.v2.model.sensitive_data_scanner_samplings module¶

class SensitiveDataScannerSamplings(arg: None)¶

class SensitiveDataScannerSamplings(arg: ModelComposed)

class SensitiveDataScannerSamplings(*args, **kwargs)

Bases: ModelNormal

Sampling configurations for the Scanning Group.

Parameters:

product (SensitiveDataScannerProduct, optional) – Datadog product onto which Sensitive Data Scanner can be activated.
rate (float, optional) – Rate at which data in product type will be scanned, as a percentage.

datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern module¶

class SensitiveDataScannerStandardPattern(arg: None)¶

class SensitiveDataScannerStandardPattern(arg: ModelComposed)

class SensitiveDataScannerStandardPattern(*args, **kwargs)

Bases: ModelNormal

Data containing the standard pattern id.

Parameters:

id (str, optional) – ID of the standard pattern.
type (SensitiveDataScannerStandardPatternType, optional) – Sensitive Data Scanner standard pattern type.

datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern_attributes module¶

class SensitiveDataScannerStandardPatternAttributes(arg: None)¶

class SensitiveDataScannerStandardPatternAttributes(arg: ModelComposed)

class SensitiveDataScannerStandardPatternAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the Sensitive Data Scanner standard pattern.

Parameters:

description (str, optional) – Description of the standard pattern.
included_keywords ([str], optional) – List of included keywords.
name (str, optional) – Name of the standard pattern.
pattern (str, optional) – (Deprecated) Regex to match, optionally documented for older standard rules. Refer to the description field to understand what the rule does. Deprecated.
priority (int, optional) – Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.
tags ([str], optional) – List of tags.

datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern_data module¶

class SensitiveDataScannerStandardPatternData(arg: None)¶

class SensitiveDataScannerStandardPatternData(arg: ModelComposed)

class SensitiveDataScannerStandardPatternData(*args, **kwargs)

Bases: ModelNormal

A standard pattern.

Parameters:: data (SensitiveDataScannerStandardPattern, optional) – Data containing the standard pattern id.

datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern_type module¶

class SensitiveDataScannerStandardPatternType(arg: None)¶

class SensitiveDataScannerStandardPatternType(arg: ModelComposed)

class SensitiveDataScannerStandardPatternType(*args, **kwargs)

Bases: ModelSimple

Sensitive Data Scanner standard pattern type.

Parameters:

value (str) – If omitted defaults to “sensitive_data_scanner_standard_pattern”. Must be one of [“sensitive_data_scanner_standard_pattern”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response module¶

class SensitiveDataScannerStandardPatternsResponse(arg: None)¶

class SensitiveDataScannerStandardPatternsResponse(arg: ModelComposed)

class SensitiveDataScannerStandardPatternsResponse(*args, **kwargs)

Bases: ModelSimple

List Standard patterns response.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_data module¶

class SensitiveDataScannerStandardPatternsResponseData(arg: None)¶

class SensitiveDataScannerStandardPatternsResponseData(arg: ModelComposed)

class SensitiveDataScannerStandardPatternsResponseData(*args, **kwargs)

Bases: ModelNormal

List Standard patterns response data.

Parameters:: data (SensitiveDataScannerStandardPatternsResponse, optional) – List Standard patterns response.

datadog_api_client.v2.model.sensitive_data_scanner_standard_patterns_response_item module¶

class SensitiveDataScannerStandardPatternsResponseItem(arg: None)¶

class SensitiveDataScannerStandardPatternsResponseItem(arg: ModelComposed)

class SensitiveDataScannerStandardPatternsResponseItem(*args, **kwargs)

Bases: ModelNormal

Standard pattern item.

Parameters:

attributes (SensitiveDataScannerStandardPatternAttributes, optional) – Attributes of the Sensitive Data Scanner standard pattern.
id (str, optional) – ID of the standard pattern.
type (SensitiveDataScannerStandardPatternType, optional) – Sensitive Data Scanner standard pattern type.

datadog_api_client.v2.model.sensitive_data_scanner_text_replacement module¶

class SensitiveDataScannerTextReplacement(arg: None)¶

class SensitiveDataScannerTextReplacement(arg: ModelComposed)

class SensitiveDataScannerTextReplacement(*args, **kwargs)

Bases: ModelNormal

Object describing how the scanned event will be replaced.

Parameters:

number_of_chars (int, optional) – Required if type == ‘partial_replacement_from_beginning’ or ‘partial_replacement_from_end’. It must be > 0.
replacement_string (str, optional) – Required if type == ‘replacement_string’.
should_save_match (bool, optional) – Only valid when type == replacement_string. When enabled, matches can be unmasked in logs by users with ‘Data Scanner Unmask’ permission. As a security best practice, avoid masking for highly-sensitive, long-lived data.
type (SensitiveDataScannerTextReplacementType, optional) – Type of the replacement text. None means no replacement. hash means the data will be stubbed. replacement_string means that one can chose a text to replace the data. partial_replacement_from_beginning allows a user to partially replace the data from the beginning, and partial_replacement_from_end on the other hand, allows to replace data from the end.

datadog_api_client.v2.model.sensitive_data_scanner_text_replacement_type module¶

class SensitiveDataScannerTextReplacementType(arg: None)¶

class SensitiveDataScannerTextReplacementType(arg: ModelComposed)

class SensitiveDataScannerTextReplacementType(*args, **kwargs)

Bases: ModelSimple

Type of the replacement text. None means no replacement.: hash means the data will be stubbed. replacement_string means that one can chose a text to replace the data. partial_replacement_from_beginning allows a user to partially replace the data from the beginning, and partial_replacement_from_end on the other hand, allows to replace data from the end.

Parameters:

value (str) – If omitted defaults to “none”. Must be one of [“none”, “hash”, “replacement_string”, “partial_replacement_from_beginning”, “partial_replacement_from_end”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_account_create_attributes module¶

class ServiceAccountCreateAttributes(arg: None)¶

class ServiceAccountCreateAttributes(arg: ModelComposed)

class ServiceAccountCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the created user.

Parameters:

email (str) – The email of the user.
name (str, optional) – The name of the user.
service_account (bool) – Whether the user is a service account. Must be true.
title (str, optional) – The title of the user.

datadog_api_client.v2.model.service_account_create_data module¶

class ServiceAccountCreateData(arg: None)¶

class ServiceAccountCreateData(arg: ModelComposed)

class ServiceAccountCreateData(*args, **kwargs)

Bases: ModelNormal

Object to create a service account User.

Parameters:

attributes (ServiceAccountCreateAttributes) – Attributes of the created user.
relationships (UserRelationships, optional) – Relationships of the user object.
type (UsersType) – Users resource type.

datadog_api_client.v2.model.service_account_create_request module¶

class ServiceAccountCreateRequest(arg: None)¶

class ServiceAccountCreateRequest(arg: ModelComposed)

class ServiceAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create a service account.

Parameters:: data (ServiceAccountCreateData) – Object to create a service account User.

datadog_api_client.v2.model.service_definition_create_response module¶

class ServiceDefinitionCreateResponse(arg: None)¶

class ServiceDefinitionCreateResponse(arg: ModelComposed)

class ServiceDefinitionCreateResponse(*args, **kwargs)

Bases: ModelNormal

Create service definitions response.

Parameters:: data ([ServiceDefinitionData], optional) – Create service definitions response payload.

datadog_api_client.v2.model.service_definition_data module¶

class ServiceDefinitionData(arg: None)¶

class ServiceDefinitionData(arg: ModelComposed)

class ServiceDefinitionData(*args, **kwargs)

Bases: ModelNormal

Service definition data.

Parameters:

attributes (ServiceDefinitionDataAttributes, optional) – Service definition attributes.
id (str, optional) – Service definition id.
type (str, optional) – Service definition type.

datadog_api_client.v2.model.service_definition_data_attributes module¶

class ServiceDefinitionDataAttributes(arg: None)¶

class ServiceDefinitionDataAttributes(arg: ModelComposed)

class ServiceDefinitionDataAttributes(*args, **kwargs)

Bases: ModelNormal

Service definition attributes.

Parameters:

meta (ServiceDefinitionMeta, optional) – Metadata about a service definition.
schema (ServiceDefinitionSchema, optional) – Service definition schema.

datadog_api_client.v2.model.service_definition_get_response module¶

class ServiceDefinitionGetResponse(arg: None)¶

class ServiceDefinitionGetResponse(arg: ModelComposed)

class ServiceDefinitionGetResponse(*args, **kwargs)

Bases: ModelNormal

Get service definition response.

Parameters:: data (ServiceDefinitionData, optional) – Service definition data.

datadog_api_client.v2.model.service_definition_meta module¶

class ServiceDefinitionMeta(arg: None)¶

class ServiceDefinitionMeta(arg: ModelComposed)

class ServiceDefinitionMeta(*args, **kwargs)

Bases: ModelNormal

Metadata about a service definition.

Parameters:

github_html_url (str, optional) – GitHub HTML URL.
ingested_schema_version (str, optional) – Ingestion schema version.
ingestion_source (str, optional) – Ingestion source of the service definition.
last_modified_time (str, optional) – Last modified time of the service definition.
origin (str, optional) – User defined origin of the service definition.
origin_detail (str, optional) – User defined origin’s detail of the service definition.
warnings ([ServiceDefinitionMetaWarnings], optional) – A list of schema validation warnings.

datadog_api_client.v2.model.service_definition_meta_warnings module¶

class ServiceDefinitionMetaWarnings(arg: None)¶

class ServiceDefinitionMetaWarnings(arg: ModelComposed)

class ServiceDefinitionMetaWarnings(*args, **kwargs)

Bases: ModelNormal

Schema validation warnings.

Parameters:

instance_location (str, optional) – The warning instance location.
keyword_location (str, optional) – The warning keyword location.
message (str, optional) – The warning message.

datadog_api_client.v2.model.service_definition_schema module¶

class ServiceDefinitionSchema(arg: None)¶

class ServiceDefinitionSchema(arg: ModelComposed)

class ServiceDefinitionSchema(*args, **kwargs)

Bases: ModelComposed

Service definition schema.

Parameters:

contact (ServiceDefinitionV1Contact, optional) – Contact information about the service.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Extensions to V1 schema.
external_resources ([ServiceDefinitionV1Resource], optional) – A list of external links related to the services.
info (ServiceDefinitionV1Info) – Basic information about a service.
integrations (ServiceDefinitionV1Integrations, optional) – Third party integrations that Datadog supports.
org (ServiceDefinitionV1Org, optional) – Org related information about the service.
schema_version (ServiceDefinitionV1Version) – Schema version being used.
tags ([str], optional) – A set of custom tags.
contacts ([ServiceDefinitionV2Contact], optional) – A list of contacts related to the services.
dd_service (str) – Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
dd_team (str, optional) – Experimental feature. A Team handle that matches a Team in the Datadog Teams product.
docs ([ServiceDefinitionV2Doc], optional) – A list of documentation related to the services.
links ([ServiceDefinitionV2Link], optional) – A list of links related to the services.
repos ([ServiceDefinitionV2Repo], optional) – A list of code repositories related to the services.
team (str, optional) – Team that owns the service.
application (str, optional) – Identifier for a group of related services serving a product feature, which the service is a part of.
description (str, optional) – A short description of the service.
lifecycle (str, optional) – The current life cycle phase of the service.
tier (str, optional) – Importance of the service.
ci_pipeline_fingerprints ([str], optional) – A set of CI fingerprints.
languages ([str], optional) – The service’s programming language. Datadog recognizes the following languages: dotnet, go, java, js, php, python, ruby, and c++.
type (str, optional) – The type of service.

datadog_api_client.v2.model.service_definition_schema_versions module¶

class ServiceDefinitionSchemaVersions(arg: None)¶

class ServiceDefinitionSchemaVersions(arg: ModelComposed)

class ServiceDefinitionSchemaVersions(*args, **kwargs)

Bases: ModelSimple

Schema versions

Parameters:

value (str) – Must be one of [“v1”, “v2”, “v2.1”, “v2.2”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v1 module¶

class ServiceDefinitionV1(arg: None)¶

class ServiceDefinitionV1(arg: ModelComposed)

class ServiceDefinitionV1(*args, **kwargs)

Bases: ModelNormal

Deprecated - Service definition V1 for providing additional service metadata and integrations.

Parameters:

contact (ServiceDefinitionV1Contact, optional) – Contact information about the service.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Extensions to V1 schema.
external_resources ([ServiceDefinitionV1Resource], optional) – A list of external links related to the services.
info (ServiceDefinitionV1Info) – Basic information about a service.
integrations (ServiceDefinitionV1Integrations, optional) – Third party integrations that Datadog supports.
org (ServiceDefinitionV1Org, optional) – Org related information about the service.
schema_version (ServiceDefinitionV1Version) – Schema version being used.
tags ([str], optional) – A set of custom tags.

datadog_api_client.v2.model.service_definition_v1_contact module¶

class ServiceDefinitionV1Contact(arg: None)¶

class ServiceDefinitionV1Contact(arg: ModelComposed)

class ServiceDefinitionV1Contact(*args, **kwargs)

Bases: ModelNormal

Contact information about the service.

Parameters:

email (str, optional) – Service owner’s email.
slack (str, optional) – Service owner’s Slack channel.

datadog_api_client.v2.model.service_definition_v1_info module¶

class ServiceDefinitionV1Info(arg: None)¶

class ServiceDefinitionV1Info(arg: ModelComposed)

class ServiceDefinitionV1Info(*args, **kwargs)

Bases: ModelNormal

Basic information about a service.

Parameters:

dd_service (str) – Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
description (str, optional) – A short description of the service.
display_name (str, optional) – A friendly name of the service.
service_tier (str, optional) – Service tier.

datadog_api_client.v2.model.service_definition_v1_integrations module¶

class ServiceDefinitionV1Integrations(arg: None)¶

class ServiceDefinitionV1Integrations(arg: ModelComposed)

class ServiceDefinitionV1Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:: pagerduty (str, optional) – PagerDuty service URL for the service.

datadog_api_client.v2.model.service_definition_v1_org module¶

class ServiceDefinitionV1Org(arg: None)¶

class ServiceDefinitionV1Org(arg: ModelComposed)

class ServiceDefinitionV1Org(*args, **kwargs)

Bases: ModelNormal

Org related information about the service.

Parameters:

application (str, optional) – App feature this service supports.
team (str, optional) – Team that owns the service.

datadog_api_client.v2.model.service_definition_v1_resource module¶

class ServiceDefinitionV1Resource(arg: None)¶

class ServiceDefinitionV1Resource(arg: ModelComposed)

class ServiceDefinitionV1Resource(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

name (str) – Link name.
type (ServiceDefinitionV1ResourceType) – Link type.
url (str) – Link URL.

datadog_api_client.v2.model.service_definition_v1_resource_type module¶

class ServiceDefinitionV1ResourceType(arg: None)¶

class ServiceDefinitionV1ResourceType(arg: ModelComposed)

class ServiceDefinitionV1ResourceType(*args, **kwargs)

Bases: ModelSimple

Link type.

Parameters:

value (str) – Must be one of [“doc”, “wiki”, “runbook”, “url”, “repo”, “dashboard”, “oncall”, “code”, “link”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2 module¶

class ServiceDefinitionV2(arg: None)¶

class ServiceDefinitionV2(arg: ModelComposed)

class ServiceDefinitionV2(*args, **kwargs)

Bases: ModelNormal

Service definition V2 for providing service metadata and integrations.

Parameters:

contacts ([ServiceDefinitionV2Contact], optional) – A list of contacts related to the services.
dd_service (str) – Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
dd_team (str, optional) – Experimental feature. A Team handle that matches a Team in the Datadog Teams product.
docs ([ServiceDefinitionV2Doc], optional) – A list of documentation related to the services.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Extensions to V2 schema.
integrations (ServiceDefinitionV2Integrations, optional) – Third party integrations that Datadog supports.
links ([ServiceDefinitionV2Link], optional) – A list of links related to the services.
repos ([ServiceDefinitionV2Repo], optional) – A list of code repositories related to the services.
schema_version (ServiceDefinitionV2Version) – Schema version being used.
tags ([str], optional) – A set of custom tags.
team (str, optional) – Team that owns the service.

datadog_api_client.v2.model.service_definition_v2_contact module¶

class ServiceDefinitionV2Contact(arg: None)¶

class ServiceDefinitionV2Contact(arg: ModelComposed)

class ServiceDefinitionV2Contact(*args, **kwargs)

Bases: ModelComposed

Service owner’s contacts information.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact email.
type (ServiceDefinitionV2EmailType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_doc module¶

class ServiceDefinitionV2Doc(arg: None)¶

class ServiceDefinitionV2Doc(arg: ModelComposed)

class ServiceDefinitionV2Doc(*args, **kwargs)

Bases: ModelNormal

Service documents.

Parameters:

name (str) – Document name.
provider (str, optional) – Document provider.
url (str) – Document URL.

datadog_api_client.v2.model.service_definition_v2_dot1 module¶

class ServiceDefinitionV2Dot1(arg: None)¶

class ServiceDefinitionV2Dot1(arg: ModelComposed)

class ServiceDefinitionV2Dot1(*args, **kwargs)

Bases: ModelNormal

Service definition v2.1 for providing service metadata and integrations.

Parameters:

application (str, optional) – Identifier for a group of related services serving a product feature, which the service is a part of.
contacts ([ServiceDefinitionV2Dot1Contact], optional) – A list of contacts related to the services.
dd_service (str) – Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
description (str, optional) – A short description of the service.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Extensions to v2.1 schema.
integrations (ServiceDefinitionV2Dot1Integrations, optional) – Third party integrations that Datadog supports.
lifecycle (str, optional) – The current life cycle phase of the service.
links ([ServiceDefinitionV2Dot1Link], optional) – A list of links related to the services.
schema_version (ServiceDefinitionV2Dot1Version) – Schema version being used.
tags ([str], optional) – A set of custom tags.
team (str, optional) – Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.
tier (str, optional) – Importance of the service.

datadog_api_client.v2.model.service_definition_v2_dot1_contact module¶

class ServiceDefinitionV2Dot1Contact(arg: None)¶

class ServiceDefinitionV2Dot1Contact(arg: ModelComposed)

class ServiceDefinitionV2Dot1Contact(*args, **kwargs)

Bases: ModelComposed

Service owner’s contacts information.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact email.
type (ServiceDefinitionV2Dot1EmailType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_dot1_email module¶

class ServiceDefinitionV2Dot1Email(arg: None)¶

class ServiceDefinitionV2Dot1Email(arg: ModelComposed)

class ServiceDefinitionV2Dot1Email(*args, **kwargs)

Bases: ModelNormal

Service owner’s email.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact email.
type (ServiceDefinitionV2Dot1EmailType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_dot1_email_type module¶

class ServiceDefinitionV2Dot1EmailType(arg: None)¶

class ServiceDefinitionV2Dot1EmailType(arg: ModelComposed)

class ServiceDefinitionV2Dot1EmailType(*args, **kwargs)

Bases: ModelSimple

Contact type.

Parameters:

value (str) – If omitted defaults to “email”. Must be one of [“email”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_dot1_integrations module¶

class ServiceDefinitionV2Dot1Integrations(arg: None)¶

class ServiceDefinitionV2Dot1Integrations(arg: ModelComposed)

class ServiceDefinitionV2Dot1Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

opsgenie (ServiceDefinitionV2Dot1Opsgenie, optional) – Opsgenie integration for the service.
pagerduty (ServiceDefinitionV2Dot1Pagerduty, optional) – PagerDuty integration for the service.

datadog_api_client.v2.model.service_definition_v2_dot1_link module¶

class ServiceDefinitionV2Dot1Link(arg: None)¶

class ServiceDefinitionV2Dot1Link(arg: ModelComposed)

class ServiceDefinitionV2Dot1Link(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

name (str) – Link name.
provider (str, optional) – Link provider.
type (ServiceDefinitionV2Dot1LinkType) – Link type.
url (str) – Link URL.

datadog_api_client.v2.model.service_definition_v2_dot1_link_type module¶

class ServiceDefinitionV2Dot1LinkType(arg: None)¶

class ServiceDefinitionV2Dot1LinkType(arg: ModelComposed)

class ServiceDefinitionV2Dot1LinkType(*args, **kwargs)

Bases: ModelSimple

Link type.

Parameters:

value (str) – Must be one of [“doc”, “repo”, “runbook”, “dashboard”, “other”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_dot1_ms_teams module¶

class ServiceDefinitionV2Dot1MSTeams(arg: None)¶

class ServiceDefinitionV2Dot1MSTeams(arg: ModelComposed)

class ServiceDefinitionV2Dot1MSTeams(*args, **kwargs)

Bases: ModelNormal

Service owner’s Microsoft Teams.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact Microsoft Teams.
type (ServiceDefinitionV2Dot1MSTeamsType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_dot1_ms_teams_type module¶

class ServiceDefinitionV2Dot1MSTeamsType(arg: None)¶

class ServiceDefinitionV2Dot1MSTeamsType(arg: ModelComposed)

class ServiceDefinitionV2Dot1MSTeamsType(*args, **kwargs)

Bases: ModelSimple

Contact type.

Parameters:

value (str) – If omitted defaults to “microsoft-teams”. Must be one of [“microsoft-teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_dot1_opsgenie module¶

class ServiceDefinitionV2Dot1Opsgenie(arg: None)¶

class ServiceDefinitionV2Dot1Opsgenie(arg: ModelComposed)

class ServiceDefinitionV2Dot1Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

region (ServiceDefinitionV2Dot1OpsgenieRegion, optional) – Opsgenie instance region.
service_url (str) – Opsgenie service url.

datadog_api_client.v2.model.service_definition_v2_dot1_opsgenie_region module¶

class ServiceDefinitionV2Dot1OpsgenieRegion(arg: None)¶

class ServiceDefinitionV2Dot1OpsgenieRegion(arg: ModelComposed)

class ServiceDefinitionV2Dot1OpsgenieRegion(*args, **kwargs)

Bases: ModelSimple

Opsgenie instance region.

Parameters:

value (str) – Must be one of [“US”, “EU”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_dot1_pagerduty module¶

class ServiceDefinitionV2Dot1Pagerduty(arg: None)¶

class ServiceDefinitionV2Dot1Pagerduty(arg: ModelComposed)

class ServiceDefinitionV2Dot1Pagerduty(*args, **kwargs)

Bases: ModelNormal

PagerDuty integration for the service.

Parameters:: service_url (str, optional) – PagerDuty service url.

datadog_api_client.v2.model.service_definition_v2_dot1_slack module¶

class ServiceDefinitionV2Dot1Slack(arg: None)¶

class ServiceDefinitionV2Dot1Slack(arg: ModelComposed)

class ServiceDefinitionV2Dot1Slack(*args, **kwargs)

Bases: ModelNormal

Service owner’s Slack channel.

Parameters:

contact (str) – Slack Channel.
name (str, optional) – Contact Slack.
type (ServiceDefinitionV2Dot1SlackType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_dot1_slack_type module¶

class ServiceDefinitionV2Dot1SlackType(arg: None)¶

class ServiceDefinitionV2Dot1SlackType(arg: ModelComposed)

class ServiceDefinitionV2Dot1SlackType(*args, **kwargs)

Bases: ModelSimple

Contact type.

Parameters:

value (str) – If omitted defaults to “slack”. Must be one of [“slack”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_dot2 module¶

class ServiceDefinitionV2Dot2(arg: None)¶

class ServiceDefinitionV2Dot2(arg: ModelComposed)

class ServiceDefinitionV2Dot2(*args, **kwargs)

Bases: ModelNormal

Service definition v2.2 for providing service metadata and integrations.

Parameters:

application (str, optional) – Identifier for a group of related services serving a product feature, which the service is a part of.
ci_pipeline_fingerprints ([str], optional) – A set of CI fingerprints.
contacts ([ServiceDefinitionV2Dot2Contact], optional) – A list of contacts related to the services.
dd_service (str) – Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
description (str, optional) – A short description of the service.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Extensions to v2.2 schema.
integrations (ServiceDefinitionV2Dot2Integrations, optional) – Third party integrations that Datadog supports.
languages ([str], optional) – The service’s programming language. Datadog recognizes the following languages: dotnet , go , java , js , php , python , ruby , and c++.
lifecycle (str, optional) – The current life cycle phase of the service.
links ([ServiceDefinitionV2Dot2Link], optional) – A list of links related to the services.
schema_version (ServiceDefinitionV2Dot2Version) – Schema version being used.
tags ([str], optional) – A set of custom tags.
team (str, optional) – Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.
tier (str, optional) – Importance of the service.
type (str, optional) – The type of service.

datadog_api_client.v2.model.service_definition_v2_dot2_contact module¶

class ServiceDefinitionV2Dot2Contact(arg: None)¶

class ServiceDefinitionV2Dot2Contact(arg: ModelComposed)

class ServiceDefinitionV2Dot2Contact(*args, **kwargs)

Bases: ModelNormal

Service owner’s contacts information.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact Name.
type (str) – Contact type. Datadog recognizes the following types: email , slack , and microsoft-teams.

datadog_api_client.v2.model.service_definition_v2_dot2_integrations module¶

class ServiceDefinitionV2Dot2Integrations(arg: None)¶

class ServiceDefinitionV2Dot2Integrations(arg: ModelComposed)

class ServiceDefinitionV2Dot2Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

opsgenie (ServiceDefinitionV2Dot2Opsgenie, optional) – Opsgenie integration for the service.
pagerduty (ServiceDefinitionV2Dot2Pagerduty, optional) – PagerDuty integration for the service.

datadog_api_client.v2.model.service_definition_v2_dot2_link module¶

class ServiceDefinitionV2Dot2Link(arg: None)¶

class ServiceDefinitionV2Dot2Link(arg: ModelComposed)

class ServiceDefinitionV2Dot2Link(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

name (str) – Link name.
provider (str, optional) – Link provider.
type (str) – Link type. Datadog recognizes the following types: runbook , doc , repo , dashboard , and other.
url (str) – Link URL.

datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie module¶

class ServiceDefinitionV2Dot2Opsgenie(arg: None)¶

class ServiceDefinitionV2Dot2Opsgenie(arg: ModelComposed)

class ServiceDefinitionV2Dot2Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

region (ServiceDefinitionV2Dot2OpsgenieRegion, optional) – Opsgenie instance region.
service_url (str) – Opsgenie service url.

datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie_region module¶

class ServiceDefinitionV2Dot2OpsgenieRegion(arg: None)¶

class ServiceDefinitionV2Dot2OpsgenieRegion(arg: ModelComposed)

class ServiceDefinitionV2Dot2OpsgenieRegion(*args, **kwargs)

Bases: ModelSimple

Opsgenie instance region.

Parameters:

value (str) – Must be one of [“US”, “EU”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_dot2_pagerduty module¶

class ServiceDefinitionV2Dot2Pagerduty(arg: None)¶

class ServiceDefinitionV2Dot2Pagerduty(arg: ModelComposed)

class ServiceDefinitionV2Dot2Pagerduty(*args, **kwargs)

Bases: ModelNormal

PagerDuty integration for the service.

Parameters:: service_url (str, optional) – PagerDuty service url.

datadog_api_client.v2.model.service_definition_v2_email module¶

class ServiceDefinitionV2Email(arg: None)¶

class ServiceDefinitionV2Email(arg: ModelComposed)

class ServiceDefinitionV2Email(*args, **kwargs)

Bases: ModelNormal

Service owner’s email.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact email.
type (ServiceDefinitionV2EmailType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_email_type module¶

class ServiceDefinitionV2EmailType(arg: None)¶

class ServiceDefinitionV2EmailType(arg: ModelComposed)

class ServiceDefinitionV2EmailType(*args, **kwargs)

Bases: ModelSimple

Contact type.

Parameters:

value (str) – If omitted defaults to “email”. Must be one of [“email”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_integrations module¶

class ServiceDefinitionV2Integrations(arg: None)¶

class ServiceDefinitionV2Integrations(arg: ModelComposed)

class ServiceDefinitionV2Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

opsgenie (ServiceDefinitionV2Opsgenie, optional) – Opsgenie integration for the service.
pagerduty (str, optional) – PagerDuty service URL for the service.

datadog_api_client.v2.model.service_definition_v2_link module¶

class ServiceDefinitionV2Link(arg: None)¶

class ServiceDefinitionV2Link(arg: ModelComposed)

class ServiceDefinitionV2Link(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

name (str) – Link name.
type (ServiceDefinitionV2LinkType) – Link type.
url (str) – Link URL.

datadog_api_client.v2.model.service_definition_v2_link_type module¶

class ServiceDefinitionV2LinkType(arg: None)¶

class ServiceDefinitionV2LinkType(arg: ModelComposed)

class ServiceDefinitionV2LinkType(*args, **kwargs)

Bases: ModelSimple

Link type.

Parameters:

value (str) – Must be one of [“doc”, “wiki”, “runbook”, “url”, “repo”, “dashboard”, “oncall”, “code”, “link”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_ms_teams module¶

class ServiceDefinitionV2MSTeams(arg: None)¶

class ServiceDefinitionV2MSTeams(arg: ModelComposed)

class ServiceDefinitionV2MSTeams(*args, **kwargs)

Bases: ModelNormal

Service owner’s Microsoft Teams.

Parameters:

contact (str) – Contact value.
name (str, optional) – Contact Microsoft Teams.
type (ServiceDefinitionV2MSTeamsType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_ms_teams_type module¶

class ServiceDefinitionV2MSTeamsType(arg: None)¶

class ServiceDefinitionV2MSTeamsType(arg: ModelComposed)

class ServiceDefinitionV2MSTeamsType(*args, **kwargs)

Bases: ModelSimple

Contact type.

Parameters:

value (str) – If omitted defaults to “microsoft-teams”. Must be one of [“microsoft-teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_opsgenie module¶

class ServiceDefinitionV2Opsgenie(arg: None)¶

class ServiceDefinitionV2Opsgenie(arg: ModelComposed)

class ServiceDefinitionV2Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

region (ServiceDefinitionV2OpsgenieRegion, optional) – Opsgenie instance region.
service_url (str) – Opsgenie service url.

datadog_api_client.v2.model.service_definition_v2_opsgenie_region module¶

class ServiceDefinitionV2OpsgenieRegion(arg: None)¶

class ServiceDefinitionV2OpsgenieRegion(arg: ModelComposed)

class ServiceDefinitionV2OpsgenieRegion(*args, **kwargs)

Bases: ModelSimple

Opsgenie instance region.

Parameters:

value (str) – Must be one of [“US”, “EU”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definition_v2_repo module¶

class ServiceDefinitionV2Repo(arg: None)¶

class ServiceDefinitionV2Repo(arg: ModelComposed)

class ServiceDefinitionV2Repo(*args, **kwargs)

Bases: ModelNormal

Service code repositories.

Parameters:

name (str) – Repository name.
provider (str, optional) – Repository provider.
url (str) – Repository URL.

datadog_api_client.v2.model.service_definition_v2_slack module¶

class ServiceDefinitionV2Slack(arg: None)¶

class ServiceDefinitionV2Slack(arg: ModelComposed)

class ServiceDefinitionV2Slack(*args, **kwargs)

Bases: ModelNormal

Service owner’s Slack channel.

Parameters:

contact (str) – Slack Channel.
name (str, optional) – Contact Slack.
type (ServiceDefinitionV2SlackType) – Contact type.

datadog_api_client.v2.model.service_definition_v2_slack_type module¶

class ServiceDefinitionV2SlackType(arg: None)¶

class ServiceDefinitionV2SlackType(arg: ModelComposed)

class ServiceDefinitionV2SlackType(*args, **kwargs)

Bases: ModelSimple

Contact type.

Parameters:

value (str) – If omitted defaults to “slack”. Must be one of [“slack”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_definitions_create_request module¶

class ServiceDefinitionsCreateRequest(arg: None)¶

class ServiceDefinitionsCreateRequest(arg: ModelComposed)

class ServiceDefinitionsCreateRequest(*args, **kwargs)

Bases: ModelComposed

Create service definitions request.

Parameters:

application (str, optional) – Identifier for a group of related services serving a product feature, which the service is a part of.
ci_pipeline_fingerprints ([str], optional) – A set of CI fingerprints.
contacts ([ServiceDefinitionV2Dot2Contact], optional) – A list of contacts related to the services.
dd_service (str) – Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
description (str, optional) – A short description of the service.
extensions ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Extensions to v2.2 schema.
integrations (ServiceDefinitionV2Dot2Integrations, optional) – Third party integrations that Datadog supports.
languages ([str], optional) – The service’s programming language. Datadog recognizes the following languages: dotnet, go, java, js, php, python, ruby, and c++.
lifecycle (str, optional) – The current life cycle phase of the service.
links ([ServiceDefinitionV2Dot2Link], optional) – A list of links related to the services.
schema_version (ServiceDefinitionV2Dot2Version) – Schema version being used.
tags ([str], optional) – A set of custom tags.
team (str, optional) – Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.
tier (str, optional) – Importance of the service.
type (str, optional) – The type of service.
dd_team (str, optional) – Experimental feature. A Team handle that matches a Team in the Datadog Teams product.
docs ([ServiceDefinitionV2Doc], optional) – A list of documentation related to the services.
repos ([ServiceDefinitionV2Repo], optional) – A list of code repositories related to the services.

datadog_api_client.v2.model.service_definitions_list_response module¶

class ServiceDefinitionsListResponse(arg: None)¶

class ServiceDefinitionsListResponse(arg: ModelComposed)

class ServiceDefinitionsListResponse(*args, **kwargs)

Bases: ModelNormal

Create service definitions response.

Parameters:: data ([ServiceDefinitionData], optional) – Data representing service definitions.

datadog_api_client.v2.model.service_now_basic_auth module¶

class ServiceNowBasicAuth(arg: None)¶

class ServiceNowBasicAuth(arg: ModelComposed)

class ServiceNowBasicAuth(*args, **kwargs)

Bases: ModelNormal

The definition of the ServiceNowBasicAuth object.

Parameters:

instance (str) – The ServiceNowBasicAuth instance.
password (str) – The ServiceNowBasicAuth password.
type (ServiceNowBasicAuthType) – The definition of the ServiceNowBasicAuth object.
username (str) – The ServiceNowBasicAuth username.

datadog_api_client.v2.model.service_now_basic_auth_type module¶

class ServiceNowBasicAuthType(arg: None)¶

class ServiceNowBasicAuthType(arg: ModelComposed)

class ServiceNowBasicAuthType(*args, **kwargs)

Bases: ModelSimple

The definition of the ServiceNowBasicAuth object.

Parameters:

value (str) – If omitted defaults to “ServiceNowBasicAuth”. Must be one of [“ServiceNowBasicAuth”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_now_basic_auth_update module¶

class ServiceNowBasicAuthUpdate(arg: None)¶

class ServiceNowBasicAuthUpdate(arg: ModelComposed)

class ServiceNowBasicAuthUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the ServiceNowBasicAuth object.

Parameters:

instance (str, optional) – The ServiceNowBasicAuthUpdate instance.
password (str, optional) – The ServiceNowBasicAuthUpdate password.
type (ServiceNowBasicAuthType) – The definition of the ServiceNowBasicAuth object.
username (str, optional) – The ServiceNowBasicAuthUpdate username.

datadog_api_client.v2.model.service_now_credentials module¶

class ServiceNowCredentials(arg: None)¶

class ServiceNowCredentials(arg: ModelComposed)

class ServiceNowCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the ServiceNowCredentials object.

Parameters:

instance (str) – The ServiceNowBasicAuth instance.
password (str) – The ServiceNowBasicAuth password.
type (ServiceNowBasicAuthType) – The definition of the ServiceNowBasicAuth object.
username (str) – The ServiceNowBasicAuth username.

datadog_api_client.v2.model.service_now_credentials_update module¶

class ServiceNowCredentialsUpdate(arg: None)¶

class ServiceNowCredentialsUpdate(arg: ModelComposed)

class ServiceNowCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the ServiceNowCredentialsUpdate object.

Parameters:

instance (str, optional) – The ServiceNowBasicAuthUpdate instance.
password (str, optional) – The ServiceNowBasicAuthUpdate password.
type (ServiceNowBasicAuthType) – The definition of the ServiceNowBasicAuth object.
username (str, optional) – The ServiceNowBasicAuthUpdate username.

datadog_api_client.v2.model.service_now_integration module¶

class ServiceNowIntegration(arg: None)¶

class ServiceNowIntegration(arg: ModelComposed)

class ServiceNowIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the ServiceNowIntegration object.

Parameters:

credentials (ServiceNowCredentials) – The definition of the ServiceNowCredentials object.
type (ServiceNowIntegrationType) – The definition of the ServiceNowIntegrationType object.

datadog_api_client.v2.model.service_now_integration_type module¶

class ServiceNowIntegrationType(arg: None)¶

class ServiceNowIntegrationType(arg: ModelComposed)

class ServiceNowIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the ServiceNowIntegrationType object.

Parameters:

value (str) – If omitted defaults to “ServiceNow”. Must be one of [“ServiceNow”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.service_now_integration_update module¶

class ServiceNowIntegrationUpdate(arg: None)¶

class ServiceNowIntegrationUpdate(arg: ModelComposed)

class ServiceNowIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the ServiceNowIntegrationUpdate object.

Parameters:

credentials (ServiceNowCredentialsUpdate, optional) – The definition of the ServiceNowCredentialsUpdate object.
type (ServiceNowIntegrationType) – The definition of the ServiceNowIntegrationType object.

datadog_api_client.v2.model.service_now_ticket module¶

class ServiceNowTicket(arg: None)¶

class ServiceNowTicket(arg: ModelComposed)

class ServiceNowTicket(*args, **kwargs)

Bases: ModelNormal

ServiceNow ticket attached to case

Parameters:

result (ServiceNowTicketResult, optional) – ServiceNow ticket information
status (Case3rdPartyTicketStatus, optional) – Case status

datadog_api_client.v2.model.service_now_ticket_result module¶

class ServiceNowTicketResult(arg: None)¶

class ServiceNowTicketResult(arg: ModelComposed)

class ServiceNowTicketResult(*args, **kwargs)

Bases: ModelNormal

ServiceNow ticket information

Parameters:: sys_target_link (str, optional) – Link to the Incident created on ServiceNow

datadog_api_client.v2.model.shift module¶

class Shift(arg: None)¶

class Shift(arg: ModelComposed)

class Shift(*args, **kwargs)

Bases: ModelNormal

An on-call shift with its associated data and relationships.

Parameters:

data (ShiftData, optional) – Data for an on-call shift.
included ([ShiftIncluded], optional) – The Shift included.

datadog_api_client.v2.model.shift_data module¶

class ShiftData(arg: None)¶

class ShiftData(arg: ModelComposed)

class ShiftData(*args, **kwargs)

Bases: ModelNormal

Data for an on-call shift.

Parameters:

attributes (ShiftDataAttributes, optional) – Attributes for an on-call shift.
id (str, optional) – The ShiftData id.
relationships (ShiftDataRelationships, optional) – Relationships for an on-call shift.
type (ShiftDataType) – Indicates that the resource is of type ‘shifts’.

datadog_api_client.v2.model.shift_data_attributes module¶

class ShiftDataAttributes(arg: None)¶

class ShiftDataAttributes(arg: ModelComposed)

class ShiftDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for an on-call shift.

Parameters:

end (datetime, optional) – The end time of the shift.
start (datetime, optional) – The start time of the shift.

datadog_api_client.v2.model.shift_data_relationships module¶

class ShiftDataRelationships(arg: None)¶

class ShiftDataRelationships(arg: ModelComposed)

class ShiftDataRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships for an on-call shift.

Parameters:: user (ShiftDataRelationshipsUser, optional) – Defines the relationship between a shift and the user who is working that shift.

datadog_api_client.v2.model.shift_data_relationships_user module¶

class ShiftDataRelationshipsUser(arg: None)¶

class ShiftDataRelationshipsUser(arg: ModelComposed)

class ShiftDataRelationshipsUser(*args, **kwargs)

Bases: ModelNormal

Defines the relationship between a shift and the user who is working that shift.

Parameters:: data (ShiftDataRelationshipsUserData) – Represents a reference to the user assigned to this shift, containing the user’s ID and resource type.

datadog_api_client.v2.model.shift_data_relationships_user_data module¶

class ShiftDataRelationshipsUserData(arg: None)¶

class ShiftDataRelationshipsUserData(arg: ModelComposed)

class ShiftDataRelationshipsUserData(*args, **kwargs)

Bases: ModelNormal

Represents a reference to the user assigned to this shift, containing the user’s ID and resource type.

Parameters:

id (str) – Specifies the unique identifier of the user.
type (ShiftDataRelationshipsUserDataType) – Indicates that the related resource is of type ‘users’.

datadog_api_client.v2.model.shift_data_relationships_user_data_type module¶

class ShiftDataRelationshipsUserDataType(arg: None)¶

class ShiftDataRelationshipsUserDataType(arg: ModelComposed)

class ShiftDataRelationshipsUserDataType(*args, **kwargs)

Bases: ModelSimple

Indicates that the related resource is of type ‘users’.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.shift_data_type module¶

class ShiftDataType(arg: None)¶

class ShiftDataType(arg: ModelComposed)

class ShiftDataType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type ‘shifts’.

Parameters:

value (str) – If omitted defaults to “shifts”. Must be one of [“shifts”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.shift_included module¶

class ShiftIncluded(arg: None)¶

class ShiftIncluded(arg: ModelComposed)

class ShiftIncluded(*args, **kwargs)

Bases: ModelComposed

Included data for shift operations.

Parameters:

attributes (ScheduleUserAttributes, optional) – Provides basic user information for a schedule, including a name and email address.
id (str, optional) – The unique user identifier.
type (ScheduleUserType) – Users resource type.

datadog_api_client.v2.model.simple_monitor_user_template module¶

class SimpleMonitorUserTemplate(arg: None)¶

class SimpleMonitorUserTemplate(arg: ModelComposed)

class SimpleMonitorUserTemplate(*args, **kwargs)

Bases: ModelNormal

A simplified version of a monitor user template.

Parameters:

created (datetime, optional) – The created timestamp of the template.
description (str, none_type, optional) – A brief description of the monitor user template.
id (str, optional) – The unique identifier. The initial version will match the template ID.
monitor_definition ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) –
A valid monitor definition in the same format as the V1 Monitor API.
tags ([str], optional) – The definition of MonitorUserTemplateTags object.
template_variables ([MonitorUserTemplateTemplateVariablesItems], optional) – The definition of MonitorUserTemplateTemplateVariables object.
title (str, optional) – The title of the monitor user template.
version (int, none_type, optional) – The version of the monitor user template.

datadog_api_client.v2.model.single_aggregated_connection_response_array module¶

class SingleAggregatedConnectionResponseArray(arg: None)¶

class SingleAggregatedConnectionResponseArray(arg: ModelComposed)

class SingleAggregatedConnectionResponseArray(*args, **kwargs)

Bases: ModelNormal

List of aggregated connections.

Parameters:: data ([SingleAggregatedConnectionResponseData], optional) – Array of aggregated connection objects.

datadog_api_client.v2.model.single_aggregated_connection_response_data module¶

class SingleAggregatedConnectionResponseData(arg: None)¶

class SingleAggregatedConnectionResponseData(arg: ModelComposed)

class SingleAggregatedConnectionResponseData(*args, **kwargs)

Bases: ModelNormal

Object describing an aggregated connection.

Parameters:

attributes (SingleAggregatedConnectionResponseDataAttributes, optional) – Attributes for an aggregated connection.
id (str, optional) – A unique identifier for the aggregated connection based on the group by values.
type (SingleAggregatedConnectionResponseDataType, optional) – Aggregated connection resource type.

datadog_api_client.v2.model.single_aggregated_connection_response_data_attributes module¶

class SingleAggregatedConnectionResponseDataAttributes(arg: None)¶

class SingleAggregatedConnectionResponseDataAttributes(arg: ModelComposed)

class SingleAggregatedConnectionResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for an aggregated connection.

Parameters:

bytes_sent_by_client (int, optional) – The total number of bytes sent by the client over the given period.
bytes_sent_by_server (int, optional) – The total number of bytes sent by the server over the given period.
group_bys ({str: ([str],)}, optional) – The key, value pairs for each group by.
packets_sent_by_client (int, optional) – The total number of packets sent by the client over the given period.
packets_sent_by_server (int, optional) – The total number of packets sent by the server over the given period.
rtt_micro_seconds (int, optional) – Measured as TCP smoothed round trip time in microseconds (the time between a TCP frame being sent and acknowledged).
tcp_closed_connections (int, optional) – The number of TCP connections in a closed state. Measured in connections per second from the client.
tcp_established_connections (int, optional) – The number of TCP connections in an established state. Measured in connections per second from the client.
tcp_refusals (int, optional) – The number of TCP connections that were refused by the server. Typically this indicates an attempt to connect to an IP/port that is not receiving connections, or a firewall/security misconfiguration.
tcp_resets (int, optional) – The number of TCP connections that were reset by the server.
tcp_retransmits (int, optional) – TCP Retransmits represent detected failures that are retransmitted to ensure delivery. Measured in count of retransmits from the client.
tcp_timeouts (int, optional) – The number of TCP connections that timed out from the perspective of the operating system. This can indicate general connectivity and latency issues.

datadog_api_client.v2.model.single_aggregated_connection_response_data_type module¶

class SingleAggregatedConnectionResponseDataType(arg: None)¶

class SingleAggregatedConnectionResponseDataType(arg: ModelComposed)

class SingleAggregatedConnectionResponseDataType(*args, **kwargs)

Bases: ModelSimple

Aggregated connection resource type.

Parameters:

value (str) – If omitted defaults to “aggregated_connection”. Must be one of [“aggregated_connection”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.single_aggregated_dns_response_array module¶

class SingleAggregatedDnsResponseArray(arg: None)¶

class SingleAggregatedDnsResponseArray(arg: ModelComposed)

class SingleAggregatedDnsResponseArray(*args, **kwargs)

Bases: ModelNormal

List of aggregated DNS flows.

Parameters:: data ([SingleAggregatedDnsResponseData], optional) – Array of aggregated DNS objects.

datadog_api_client.v2.model.single_aggregated_dns_response_data module¶

class SingleAggregatedDnsResponseData(arg: None)¶

class SingleAggregatedDnsResponseData(arg: ModelComposed)

class SingleAggregatedDnsResponseData(*args, **kwargs)

Bases: ModelNormal

Object describing an aggregated DNS flow.

Parameters:

attributes (SingleAggregatedDnsResponseDataAttributes, optional) – Attributes for an aggregated DNS flow.
id (str, optional) – A unique identifier for the aggregated DNS traffic based on the group by values.
type (SingleAggregatedDnsResponseDataType, optional) – Aggregated DNS resource type.

datadog_api_client.v2.model.single_aggregated_dns_response_data_attributes module¶

class SingleAggregatedDnsResponseDataAttributes(arg: None)¶

class SingleAggregatedDnsResponseDataAttributes(arg: ModelComposed)

class SingleAggregatedDnsResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for an aggregated DNS flow.

Parameters:

group_bys ([SingleAggregatedDnsResponseDataAttributesGroupByItems], optional) – The key, value pairs for each group by.
metrics ([SingleAggregatedDnsResponseDataAttributesMetricsItems], optional) – Metrics associated with an aggregated DNS flow.

datadog_api_client.v2.model.single_aggregated_dns_response_data_attributes_group_by_items module¶

class SingleAggregatedDnsResponseDataAttributesGroupByItems(arg: None)¶

class SingleAggregatedDnsResponseDataAttributesGroupByItems(arg: ModelComposed)

class SingleAggregatedDnsResponseDataAttributesGroupByItems(*args, **kwargs)

Bases: ModelNormal

Attributes associated with a group by

Parameters:

key (str, optional) – The group by key.
value (str, optional) – The group by value.

datadog_api_client.v2.model.single_aggregated_dns_response_data_attributes_metrics_items module¶

class SingleAggregatedDnsResponseDataAttributesMetricsItems(arg: None)¶

class SingleAggregatedDnsResponseDataAttributesMetricsItems(arg: ModelComposed)

class SingleAggregatedDnsResponseDataAttributesMetricsItems(*args, **kwargs)

Bases: ModelNormal

Metrics associated with an aggregated DNS flow.

Parameters:

key (DnsMetricKey, optional) – The metric key for DNS metrics.
value (int, optional) – The metric value.

datadog_api_client.v2.model.single_aggregated_dns_response_data_type module¶

class SingleAggregatedDnsResponseDataType(arg: None)¶

class SingleAggregatedDnsResponseDataType(arg: ModelComposed)

class SingleAggregatedDnsResponseDataType(*args, **kwargs)

Bases: ModelSimple

Aggregated DNS resource type.

Parameters:

value (str) – If omitted defaults to “aggregated_dns”. Must be one of [“aggregated_dns”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.slack_integration_metadata module¶

class SlackIntegrationMetadata(arg: None)¶

class SlackIntegrationMetadata(arg: ModelComposed)

class SlackIntegrationMetadata(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata for the Slack integration.

Parameters:: channels ([SlackIntegrationMetadataChannelItem]) – Array of Slack channels in this integration metadata.

datadog_api_client.v2.model.slack_integration_metadata_channel_item module¶

class SlackIntegrationMetadataChannelItem(arg: None)¶

class SlackIntegrationMetadataChannelItem(arg: ModelComposed)

class SlackIntegrationMetadataChannelItem(*args, **kwargs)

Bases: ModelNormal

Item in the Slack integration metadata channel array.

Parameters:

channel_id (str) – Slack channel ID.
channel_name (str) – Name of the Slack channel.
redirect_url (str) – URL redirecting to the Slack channel.
team_id (str, optional) – Slack team ID.

datadog_api_client.v2.model.slack_trigger_wrapper module¶

class SlackTriggerWrapper(arg: None)¶

class SlackTriggerWrapper(arg: ModelComposed)

class SlackTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Slack-based trigger.

Parameters:

slack_trigger (dict) – Trigger a workflow from Slack. The workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.slo_report_create_request module¶

class SloReportCreateRequest(arg: None)¶

class SloReportCreateRequest(arg: ModelComposed)

class SloReportCreateRequest(*args, **kwargs)

Bases: ModelNormal

The SLO report request body.

Parameters:: data (SloReportCreateRequestData) – The data portion of the SLO report request.

datadog_api_client.v2.model.slo_report_create_request_attributes module¶

class SloReportCreateRequestAttributes(arg: None)¶

class SloReportCreateRequestAttributes(arg: ModelComposed)

class SloReportCreateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes portion of the SLO report request.

Parameters:

from_ts (int) – The from timestamp for the report in epoch seconds.
interval (SLOReportInterval, optional) – The frequency at which report data is to be generated.
query (str) – The query string used to filter SLO results. Some examples of queries include service:<service-name> and slo-name.
timezone (str, optional) – The timezone used to determine the start and end of each interval. For example, weekly intervals start at 12am on Sunday in the specified timezone.
to_ts (int) – The to timestamp for the report in epoch seconds.

datadog_api_client.v2.model.slo_report_create_request_data module¶

class SloReportCreateRequestData(arg: None)¶

class SloReportCreateRequestData(arg: ModelComposed)

class SloReportCreateRequestData(*args, **kwargs)

Bases: ModelNormal

The data portion of the SLO report request.

Parameters:: attributes (SloReportCreateRequestAttributes) – The attributes portion of the SLO report request.

datadog_api_client.v2.model.slo_report_interval module¶

class SLOReportInterval(arg: None)¶

class SLOReportInterval(arg: ModelComposed)

class SLOReportInterval(*args, **kwargs)

Bases: ModelSimple

The frequency at which report data is to be generated.

Parameters:

value (str) – Must be one of [“daily”, “weekly”, “monthly”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.slo_report_post_response module¶

class SLOReportPostResponse(arg: None)¶

class SLOReportPostResponse(arg: ModelComposed)

class SLOReportPostResponse(*args, **kwargs)

Bases: ModelNormal

The SLO report response.

Parameters:: data (SLOReportPostResponseData, optional) – The data portion of the SLO report response.

datadog_api_client.v2.model.slo_report_post_response_data module¶

class SLOReportPostResponseData(arg: None)¶

class SLOReportPostResponseData(arg: ModelComposed)

class SLOReportPostResponseData(*args, **kwargs)

Bases: ModelNormal

The data portion of the SLO report response.

Parameters:

id (str, optional) – The ID of the report job.
type (str, optional) – The type of ID.

datadog_api_client.v2.model.slo_report_status module¶

class SLOReportStatus(arg: None)¶

class SLOReportStatus(arg: ModelComposed)

class SLOReportStatus(*args, **kwargs)

Bases: ModelSimple

The status of the SLO report job.

Parameters:

value (str) – Must be one of [“in_progress”, “completed”, “completed_with_errors”, “failed”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.slo_report_status_get_response module¶

class SLOReportStatusGetResponse(arg: None)¶

class SLOReportStatusGetResponse(arg: ModelComposed)

class SLOReportStatusGetResponse(*args, **kwargs)

Bases: ModelNormal

The SLO report status response.

Parameters:: data (SLOReportStatusGetResponseData, optional) – The data portion of the SLO report status response.

datadog_api_client.v2.model.slo_report_status_get_response_attributes module¶

class SLOReportStatusGetResponseAttributes(arg: None)¶

class SLOReportStatusGetResponseAttributes(arg: ModelComposed)

class SLOReportStatusGetResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes portion of the SLO report status response.

Parameters:: status (SLOReportStatus, optional) – The status of the SLO report job.

datadog_api_client.v2.model.slo_report_status_get_response_data module¶

class SLOReportStatusGetResponseData(arg: None)¶

class SLOReportStatusGetResponseData(arg: ModelComposed)

class SLOReportStatusGetResponseData(*args, **kwargs)

Bases: ModelNormal

The data portion of the SLO report status response.

Parameters:

attributes (SLOReportStatusGetResponseAttributes, optional) – The attributes portion of the SLO report status response.
id (str, optional) – The ID of the report job.
type (str, optional) – The type of ID.

datadog_api_client.v2.model.software_catalog_trigger_wrapper module¶

class SoftwareCatalogTriggerWrapper(arg: None)¶

class SoftwareCatalogTriggerWrapper(arg: ModelComposed)

class SoftwareCatalogTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Software Catalog-based trigger.

Parameters:

software_catalog_trigger (dict) – Trigger a workflow from Software Catalog.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.

datadog_api_client.v2.model.sort_direction module¶

class SortDirection(arg: None)¶

class SortDirection(arg: ModelComposed)

class SortDirection(*args, **kwargs)

Bases: ModelSimple

The direction to sort by.

Parameters:

value (str) – If omitted defaults to “desc”. Must be one of [“desc”, “asc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.span module¶

class Span(arg: None)¶

class Span(arg: ModelComposed)

class Span(*args, **kwargs)

Bases: ModelNormal

Object description of a spans after being processed and stored by Datadog.

Parameters:

attributes (SpansAttributes, optional) – JSON object containing all span attributes and their associated values.
id (str, optional) – Unique ID of the Span.
type (SpansType, optional) – Type of the span.

datadog_api_client.v2.model.spans_aggregate_bucket module¶

class SpansAggregateBucket(arg: None)¶

class SpansAggregateBucket(arg: ModelComposed)

class SpansAggregateBucket(*args, **kwargs)

Bases: ModelNormal

Spans aggregate.

Parameters:

attributes (SpansAggregateBucketAttributes, optional) – A bucket values.
id (str, optional) – ID of the spans aggregate.
type (SpansAggregateBucketType, optional) – The spans aggregate bucket type.

datadog_api_client.v2.model.spans_aggregate_bucket_attributes module¶

class SpansAggregateBucketAttributes(arg: None)¶

class SpansAggregateBucketAttributes(arg: ModelComposed)

class SpansAggregateBucketAttributes(*args, **kwargs)

Bases: ModelNormal

A bucket values.

Parameters:

by ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The key, value pairs for each group by.
compute (dict, optional) – The compute data.
computes ({str: (SpansAggregateBucketValue,)}, optional) – A map of the metric name -> value for regular compute or list of values for a timeseries.

datadog_api_client.v2.model.spans_aggregate_bucket_type module¶

class SpansAggregateBucketType(arg: None)¶

class SpansAggregateBucketType(arg: ModelComposed)

class SpansAggregateBucketType(*args, **kwargs)

Bases: ModelSimple

The spans aggregate bucket type.

Parameters:

value (str) – If omitted defaults to “bucket”. Must be one of [“bucket”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_aggregate_bucket_value module¶

class SpansAggregateBucketValue(arg: None)¶

class SpansAggregateBucketValue(arg: ModelComposed)

class SpansAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

A bucket value, can be either a timeseries or a single value.

datadog_api_client.v2.model.spans_aggregate_bucket_value_timeseries_point module¶

class SpansAggregateBucketValueTimeseriesPoint(arg: None)¶

class SpansAggregateBucketValueTimeseriesPoint(arg: ModelComposed)

class SpansAggregateBucketValueTimeseriesPoint(*args, **kwargs)

Bases: ModelNormal

A timeseries point.

Parameters:

time (str, optional) – The time value for this point.
value (float, optional) – The value for this point.

datadog_api_client.v2.model.spans_aggregate_data module¶

class SpansAggregateData(arg: None)¶

class SpansAggregateData(arg: ModelComposed)

class SpansAggregateData(*args, **kwargs)

Bases: ModelNormal

The object containing the query content.

Parameters:

attributes (SpansAggregateRequestAttributes, optional) – The object containing all the query parameters.
type (SpansAggregateRequestType, optional) – The type of resource. The value should always be aggregate_request.

datadog_api_client.v2.model.spans_aggregate_request module¶

class SpansAggregateRequest(arg: None)¶

class SpansAggregateRequest(arg: ModelComposed)

class SpansAggregateRequest(*args, **kwargs)

Bases: ModelNormal

The object sent with the request to retrieve a list of aggregated spans from your organization.

Parameters:: data (SpansAggregateData, optional) – The object containing the query content.

datadog_api_client.v2.model.spans_aggregate_request_attributes module¶

class SpansAggregateRequestAttributes(arg: None)¶

class SpansAggregateRequestAttributes(arg: ModelComposed)

class SpansAggregateRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The object containing all the query parameters.

Parameters:

compute ([SpansCompute], optional) – The list of metrics or timeseries to compute for the retrieved buckets.
filter (SpansQueryFilter, optional) – The search and filter query settings.
group_by ([SpansGroupBy], optional) – The rules for the group by.
options (SpansQueryOptions, optional) – Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.

datadog_api_client.v2.model.spans_aggregate_request_type module¶

class SpansAggregateRequestType(arg: None)¶

class SpansAggregateRequestType(arg: ModelComposed)

class SpansAggregateRequestType(*args, **kwargs)

Bases: ModelSimple

The type of resource. The value should always be aggregate_request.

Parameters:

value (str) – If omitted defaults to “aggregate_request”. Must be one of [“aggregate_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_aggregate_response module¶

class SpansAggregateResponse(arg: None)¶

class SpansAggregateResponse(arg: ModelComposed)

class SpansAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the spans aggregate API endpoint.

Parameters:

data ([SpansAggregateBucket], optional) – The list of matching buckets, one item per bucket.
meta (SpansAggregateResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.spans_aggregate_response_metadata module¶

class SpansAggregateResponseMetadata(arg: None)¶

class SpansAggregateResponseMetadata(arg: ModelComposed)

class SpansAggregateResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds.
request_id (str, optional) – The identifier of the request.
status (SpansAggregateResponseStatus, optional) – The status of the response.
warnings ([SpansWarning], optional) – A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response.

datadog_api_client.v2.model.spans_aggregate_response_status module¶

class SpansAggregateResponseStatus(arg: None)¶

class SpansAggregateResponseStatus(arg: ModelComposed)

class SpansAggregateResponseStatus(*args, **kwargs)

Bases: ModelSimple

The status of the response.

Parameters:

value (str) – Must be one of [“done”, “timeout”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_aggregate_sort module¶

class SpansAggregateSort(arg: None)¶

class SpansAggregateSort(arg: ModelComposed)

class SpansAggregateSort(*args, **kwargs)

Bases: ModelNormal

A sort rule.

Parameters:

aggregation (SpansAggregationFunction, optional) – An aggregation function.
metric (str, optional) – The metric to sort by (only used for type=measure ).
order (SpansSortOrder, optional) – The order to use, ascending or descending.
type (SpansAggregateSortType, optional) – The type of sorting algorithm.

datadog_api_client.v2.model.spans_aggregate_sort_type module¶

class SpansAggregateSortType(arg: None)¶

class SpansAggregateSortType(arg: ModelComposed)

class SpansAggregateSortType(*args, **kwargs)

Bases: ModelSimple

The type of sorting algorithm.

Parameters:

value (str) – If omitted defaults to “alphabetical”. Must be one of [“alphabetical”, “measure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_aggregation_function module¶

class SpansAggregationFunction(arg: None)¶

class SpansAggregationFunction(arg: ModelComposed)

class SpansAggregationFunction(*args, **kwargs)

Bases: ModelSimple

An aggregation function.

Parameters:

value (str) – Must be one of [“count”, “cardinality”, “pc75”, “pc90”, “pc95”, “pc98”, “pc99”, “sum”, “min”, “max”, “avg”, “median”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_attributes module¶

class SpansAttributes(arg: None)¶

class SpansAttributes(arg: ModelComposed)

class SpansAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all span attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of attributes from your span.
custom ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – JSON object of custom spans data.
end_timestamp (datetime, optional) – End timestamp of your span.
env (str, optional) – Name of the environment from where the spans are being sent.
host (str, optional) – Name of the machine from where the spans are being sent.
ingestion_reason (str, optional) – The reason why the span was ingested.
parent_id (str, optional) – Id of the span that’s parent of this span.
resource_hash (str, optional) – Unique identifier of the resource.
resource_name (str, optional) – The name of the resource.
retained_by (str, optional) – The reason why the span was indexed.
service (str, optional) – The name of the application or service generating the span events. It is used to switch from APM to Logs, so make sure you define the same value when you use both products.
single_span (bool, optional) – Whether or not the span was collected as a stand-alone span. Always associated to “single_span” ingestion_reason if true.
span_id (str, optional) – Id of the span.
start_timestamp (datetime, optional) – Start timestamp of your span.
tags ([str], optional) – Array of tags associated with your span.
trace_id (str, optional) – Id of the trace to which the span belongs.
type (str, optional) – The type of the span.

datadog_api_client.v2.model.spans_compute module¶

class SpansCompute(arg: None)¶

class SpansCompute(arg: ModelComposed)

class SpansCompute(*args, **kwargs)

Bases: ModelNormal

A compute rule to compute metrics or timeseries.

Parameters:

aggregation (SpansAggregationFunction) – An aggregation function.
interval (str, optional) – The time buckets’ size (only used for type=timeseries) Defaults to a resolution of 150 points.
metric (str, optional) – The metric to use.
type (SpansComputeType, optional) – The type of compute.

datadog_api_client.v2.model.spans_compute_type module¶

class SpansComputeType(arg: None)¶

class SpansComputeType(arg: ModelComposed)

class SpansComputeType(*args, **kwargs)

Bases: ModelSimple

The type of compute.

Parameters:

value (str) – If omitted defaults to “total”. Must be one of [“timeseries”, “total”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_filter module¶

class SpansFilter(arg: None)¶

class SpansFilter(arg: ModelComposed)

class SpansFilter(*args, **kwargs)

Bases: ModelNormal

The spans filter used to index spans.

Parameters:: query (str, optional) – The search query - following the span search syntax.

datadog_api_client.v2.model.spans_filter_create module¶

class SpansFilterCreate(arg: None)¶

class SpansFilterCreate(arg: ModelComposed)

class SpansFilterCreate(*args, **kwargs)

Bases: ModelNormal

The spans filter. Spans matching this filter will be indexed and stored.

Parameters:

query (str) –

The search query - following the span search syntax.

datadog_api_client.v2.model.spans_group_by module¶

class SpansGroupBy(arg: None)¶

class SpansGroupBy(arg: ModelComposed)

class SpansGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

facet (str) – The name of the facet to use (required).
histogram (SpansGroupByHistogram, optional) – Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
limit (int, optional) – The maximum buckets to return for this group by.
missing (SpansGroupByMissing, optional) – The value to use for spans that don’t have the facet used to group by.
sort (SpansAggregateSort, optional) – A sort rule.
total (SpansGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.spans_group_by_histogram module¶

class SpansGroupByHistogram(arg: None)¶

class SpansGroupByHistogram(arg: ModelComposed)

class SpansGroupByHistogram(*args, **kwargs)

Bases: ModelNormal

Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.

Parameters:

interval (float) – The bin size of the histogram buckets.
max (float) – The maximum value for the measure used in the histogram (values greater than this one are filtered out).
min (float) – The minimum value for the measure used in the histogram (values smaller than this one are filtered out).

datadog_api_client.v2.model.spans_group_by_missing module¶

class SpansGroupByMissing(arg: None)¶

class SpansGroupByMissing(arg: ModelComposed)

class SpansGroupByMissing(*args, **kwargs)

Bases: ModelComposed

The value to use for spans that don’t have the facet used to group by.

datadog_api_client.v2.model.spans_group_by_total module¶

class SpansGroupByTotal(arg: None)¶

class SpansGroupByTotal(arg: ModelComposed)

class SpansGroupByTotal(*args, **kwargs)

Bases: ModelComposed

A resulting object to put the given computes in over all the matching records.

datadog_api_client.v2.model.spans_list_request module¶

class SpansListRequest(arg: None)¶

class SpansListRequest(arg: ModelComposed)

class SpansListRequest(*args, **kwargs)

Bases: ModelNormal

The request for a spans list.

Parameters:: data (SpansListRequestData, optional) – The object containing the query content.

datadog_api_client.v2.model.spans_list_request_attributes module¶

class SpansListRequestAttributes(arg: None)¶

class SpansListRequestAttributes(arg: ModelComposed)

class SpansListRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The object containing all the query parameters.

Parameters:

filter (SpansQueryFilter, optional) – The search and filter query settings.
options (SpansQueryOptions, optional) – Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.
page (SpansListRequestPage, optional) – Paging attributes for listing spans.
sort (SpansSort, optional) – Sort parameters when querying spans.

datadog_api_client.v2.model.spans_list_request_data module¶

class SpansListRequestData(arg: None)¶

class SpansListRequestData(arg: ModelComposed)

class SpansListRequestData(*args, **kwargs)

Bases: ModelNormal

The object containing the query content.

Parameters:

attributes (SpansListRequestAttributes, optional) – The object containing all the query parameters.
type (SpansListRequestType, optional) – The type of resource. The value should always be search_request.

datadog_api_client.v2.model.spans_list_request_page module¶

class SpansListRequestPage(arg: None)¶

class SpansListRequestPage(arg: ModelComposed)

class SpansListRequestPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes for listing spans.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous query.
limit (int, optional) – Maximum number of spans in the response.

datadog_api_client.v2.model.spans_list_request_type module¶

class SpansListRequestType(arg: None)¶

class SpansListRequestType(arg: ModelComposed)

class SpansListRequestType(*args, **kwargs)

Bases: ModelSimple

The type of resource. The value should always be search_request.

Parameters:

value (str) – If omitted defaults to “search_request”. Must be one of [“search_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_list_response module¶

class SpansListResponse(arg: None)¶

class SpansListResponse(arg: ModelComposed)

class SpansListResponse(*args, **kwargs)

Bases: ModelNormal

Response object with all spans matching the request and pagination information.

Parameters:

data ([Span], optional) – Array of spans matching the request.
links (SpansListResponseLinks, optional) – Links attributes.
meta (SpansListResponseMetadata, optional) – The metadata associated with a request.

datadog_api_client.v2.model.spans_list_response_links module¶

class SpansListResponseLinks(arg: None)¶

class SpansListResponseLinks(arg: ModelComposed)

class SpansListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. Note that the request can also be made using the POST endpoint.

datadog_api_client.v2.model.spans_list_response_metadata module¶

class SpansListResponseMetadata(arg: None)¶

class SpansListResponseMetadata(arg: ModelComposed)

class SpansListResponseMetadata(*args, **kwargs)

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – The time elapsed in milliseconds.
page (SpansResponseMetadataPage, optional) – Paging attributes.
request_id (str, optional) – The identifier of the request.
status (SpansAggregateResponseStatus, optional) – The status of the response.
warnings ([SpansWarning], optional) – A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response.

datadog_api_client.v2.model.spans_metric_compute module¶

class SpansMetricCompute(arg: None)¶

class SpansMetricCompute(arg: ModelComposed)

class SpansMetricCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the span-based metric.

Parameters:

aggregation_type (SpansMetricComputeAggregationType) – The type of aggregation to use.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path (str, optional) – The path to the value the span-based metric will aggregate on (only used if the aggregation type is a “distribution”).

datadog_api_client.v2.model.spans_metric_compute_aggregation_type module¶

class SpansMetricComputeAggregationType(arg: None)¶

class SpansMetricComputeAggregationType(arg: ModelComposed)

class SpansMetricComputeAggregationType(*args, **kwargs)

Bases: ModelSimple

The type of aggregation to use.

Parameters:

value (str) – Must be one of [“count”, “distribution”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_metric_create_attributes module¶

class SpansMetricCreateAttributes(arg: None)¶

class SpansMetricCreateAttributes(arg: ModelComposed)

class SpansMetricCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing the Datadog span-based metric to create.

Parameters:

compute (SpansMetricCompute) – The compute rule to compute the span-based metric.
filter (SpansMetricFilter, optional) – The span-based metric filter. Spans matching this filter will be aggregated in this metric.
group_by ([SpansMetricGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.spans_metric_create_data module¶

class SpansMetricCreateData(arg: None)¶

class SpansMetricCreateData(arg: ModelComposed)

class SpansMetricCreateData(*args, **kwargs)

Bases: ModelNormal

The new span-based metric properties.

Parameters:

attributes (SpansMetricCreateAttributes) – The object describing the Datadog span-based metric to create.
id (str) – The name of the span-based metric.
type (SpansMetricType) – The type of resource. The value should always be spans_metrics.

datadog_api_client.v2.model.spans_metric_create_request module¶

class SpansMetricCreateRequest(arg: None)¶

class SpansMetricCreateRequest(arg: ModelComposed)

class SpansMetricCreateRequest(*args, **kwargs)

Bases: ModelNormal

The new span-based metric body.

Parameters:: data (SpansMetricCreateData) – The new span-based metric properties.

datadog_api_client.v2.model.spans_metric_filter module¶

class SpansMetricFilter(arg: None)¶

class SpansMetricFilter(arg: ModelComposed)

class SpansMetricFilter(*args, **kwargs)

Bases: ModelNormal

The span-based metric filter. Spans matching this filter will be aggregated in this metric.

Parameters:: query (str, optional) – The search query - following the span search syntax.

datadog_api_client.v2.model.spans_metric_group_by module¶

class SpansMetricGroupBy(arg: None)¶

class SpansMetricGroupBy(arg: ModelComposed)

class SpansMetricGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

path (str) – The path to the value the span-based metric will be aggregated over.
tag_name (str, optional) – Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

datadog_api_client.v2.model.spans_metric_response module¶

class SpansMetricResponse(arg: None)¶

class SpansMetricResponse(arg: ModelComposed)

class SpansMetricResponse(*args, **kwargs)

Bases: ModelNormal

The span-based metric object.

Parameters:: data (SpansMetricResponseData, optional) – The span-based metric properties.

datadog_api_client.v2.model.spans_metric_response_attributes module¶

class SpansMetricResponseAttributes(arg: None)¶

class SpansMetricResponseAttributes(arg: ModelComposed)

class SpansMetricResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog span-based metric.

Parameters:

compute (SpansMetricResponseCompute, optional) – The compute rule to compute the span-based metric.
filter (SpansMetricResponseFilter, optional) – The span-based metric filter. Spans matching this filter will be aggregated in this metric.
group_by ([SpansMetricResponseGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.spans_metric_response_compute module¶

class SpansMetricResponseCompute(arg: None)¶

class SpansMetricResponseCompute(arg: ModelComposed)

class SpansMetricResponseCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the span-based metric.

Parameters:

aggregation_type (SpansMetricComputeAggregationType, optional) – The type of aggregation to use.
include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path (str, optional) – The path to the value the span-based metric will aggregate on (only used if the aggregation type is a “distribution”).

datadog_api_client.v2.model.spans_metric_response_data module¶

class SpansMetricResponseData(arg: None)¶

class SpansMetricResponseData(arg: ModelComposed)

class SpansMetricResponseData(*args, **kwargs)

Bases: ModelNormal

The span-based metric properties.

Parameters:

attributes (SpansMetricResponseAttributes, optional) – The object describing a Datadog span-based metric.
id (str, optional) – The name of the span-based metric.
type (SpansMetricType, optional) – The type of resource. The value should always be spans_metrics.

datadog_api_client.v2.model.spans_metric_response_filter module¶

class SpansMetricResponseFilter(arg: None)¶

class SpansMetricResponseFilter(arg: ModelComposed)

class SpansMetricResponseFilter(*args, **kwargs)

Bases: ModelNormal

The span-based metric filter. Spans matching this filter will be aggregated in this metric.

Parameters:: query (str, optional) – The search query - following the span search syntax.

datadog_api_client.v2.model.spans_metric_response_group_by module¶

class SpansMetricResponseGroupBy(arg: None)¶

class SpansMetricResponseGroupBy(arg: ModelComposed)

class SpansMetricResponseGroupBy(*args, **kwargs)

Bases: ModelNormal

A group by rule.

Parameters:

path (str, optional) – The path to the value the span-based metric will be aggregated over.
tag_name (str, optional) – Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

datadog_api_client.v2.model.spans_metric_type module¶

class SpansMetricType(arg: None)¶

class SpansMetricType(arg: ModelComposed)

class SpansMetricType(*args, **kwargs)

Bases: ModelSimple

The type of resource. The value should always be spans_metrics.

Parameters:

value (str) – If omitted defaults to “spans_metrics”. Must be one of [“spans_metrics”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_metric_update_attributes module¶

class SpansMetricUpdateAttributes(arg: None)¶

class SpansMetricUpdateAttributes(arg: ModelComposed)

class SpansMetricUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The span-based metric properties that will be updated.

Parameters:

compute (SpansMetricUpdateCompute, optional) – The compute rule to compute the span-based metric.
filter (SpansMetricFilter, optional) – The span-based metric filter. Spans matching this filter will be aggregated in this metric.
group_by ([SpansMetricGroupBy], optional) – The rules for the group by.

datadog_api_client.v2.model.spans_metric_update_compute module¶

class SpansMetricUpdateCompute(arg: None)¶

class SpansMetricUpdateCompute(arg: ModelComposed)

class SpansMetricUpdateCompute(*args, **kwargs)

Bases: ModelNormal

The compute rule to compute the span-based metric.

Parameters:: include_percentiles (bool, optional) – Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.

datadog_api_client.v2.model.spans_metric_update_data module¶

class SpansMetricUpdateData(arg: None)¶

class SpansMetricUpdateData(arg: ModelComposed)

class SpansMetricUpdateData(*args, **kwargs)

Bases: ModelNormal

The new span-based metric properties.

Parameters:

attributes (SpansMetricUpdateAttributes) – The span-based metric properties that will be updated.
type (SpansMetricType) – The type of resource. The value should always be spans_metrics.

datadog_api_client.v2.model.spans_metric_update_request module¶

class SpansMetricUpdateRequest(arg: None)¶

class SpansMetricUpdateRequest(arg: ModelComposed)

class SpansMetricUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new span-based metric body.

Parameters:: data (SpansMetricUpdateData) – The new span-based metric properties.

datadog_api_client.v2.model.spans_metrics_response module¶

class SpansMetricsResponse(arg: None)¶

class SpansMetricsResponse(arg: ModelComposed)

class SpansMetricsResponse(*args, **kwargs)

Bases: ModelNormal

All the available span-based metric objects.

Parameters:: data ([SpansMetricResponseData], optional) – A list of span-based metric objects.

datadog_api_client.v2.model.spans_query_filter module¶

class SpansQueryFilter(arg: None)¶

class SpansQueryFilter(arg: ModelComposed)

class SpansQueryFilter(*args, **kwargs)

Bases: ModelNormal

The search and filter query settings.

Parameters:

_from (str, optional) – The minimum time for the requested spans, supports date-time ISO8601, date math, and regular timestamps (milliseconds).
query (str, optional) – The search query - following the span search syntax.
to (str, optional) – The maximum time for the requested spans, supports date-time ISO8601, date math, and regular timestamps (milliseconds).

datadog_api_client.v2.model.spans_query_options module¶

class SpansQueryOptions(arg: None)¶

class SpansQueryOptions(arg: ModelComposed)

class SpansQueryOptions(*args, **kwargs)

Bases: ModelNormal

Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.

Parameters:

time_offset (int, optional) – The time offset (in seconds) to apply to the query.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

datadog_api_client.v2.model.spans_response_metadata_page module¶

class SpansResponseMetadataPage(arg: None)¶

class SpansResponseMetadataPage(arg: ModelComposed)

class SpansResponseMetadataPage(*args, **kwargs)

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor].

datadog_api_client.v2.model.spans_sort module¶

class SpansSort(arg: None)¶

class SpansSort(arg: ModelComposed)

class SpansSort(*args, **kwargs)

Bases: ModelSimple

Sort parameters when querying spans.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_sort_order module¶

class SpansSortOrder(arg: None)¶

class SpansSortOrder(arg: ModelComposed)

class SpansSortOrder(*args, **kwargs)

Bases: ModelSimple

The order to use, ascending or descending.

Parameters:

value (str) – Must be one of [“asc”, “desc”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_type module¶

class SpansType(arg: None)¶

class SpansType(arg: ModelComposed)

class SpansType(*args, **kwargs)

Bases: ModelSimple

Type of the span.

Parameters:

value (str) – If omitted defaults to “spans”. Must be one of [“spans”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.spans_warning module¶

class SpansWarning(arg: None)¶

class SpansWarning(arg: ModelComposed)

class SpansWarning(*args, **kwargs)

Bases: ModelNormal

A warning message indicating something that went wrong with the query.

Parameters:

code (str, optional) – A unique code for this type of warning.
detail (str, optional) – A detailed explanation of this specific warning.
title (str, optional) – A short human-readable summary of the warning.

datadog_api_client.v2.model.spec module¶

class Spec(arg: None)¶

class Spec(arg: ModelComposed)

class Spec(*args, **kwargs)

Bases: ModelNormal

The spec defines what the workflow does.

Parameters:

annotations ([Annotation], optional) – A list of annotations used in the workflow. These are like sticky notes for your workflow!
connection_envs ([ConnectionEnv], optional) – A list of connections or connection groups used in the workflow.
handle (str, optional) – Unique identifier used to trigger workflows automatically in Datadog.
input_schema (InputSchema, optional) – A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow.
output_schema (OutputSchema, optional) – A list of output parameters for the workflow.
steps ([Step], optional) – A Step is a sub-component of a workflow. Each Step performs an action.
triggers ([Trigger], optional) – The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

datadog_api_client.v2.model.split_api_key module¶

class SplitAPIKey(arg: None)¶

class SplitAPIKey(arg: ModelComposed)

class SplitAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the SplitAPIKey object.

Parameters:

api_key (str) – The SplitAPIKey api_key.
type (SplitAPIKeyType) – The definition of the SplitAPIKey object.

datadog_api_client.v2.model.split_api_key_type module¶

class SplitAPIKeyType(arg: None)¶

class SplitAPIKeyType(arg: ModelComposed)

class SplitAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the SplitAPIKey object.

Parameters:

value (str) – If omitted defaults to “SplitAPIKey”. Must be one of [“SplitAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.split_api_key_update module¶

class SplitAPIKeyUpdate(arg: None)¶

class SplitAPIKeyUpdate(arg: ModelComposed)

class SplitAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the SplitAPIKey object.

Parameters:

api_key (str, optional) – The SplitAPIKeyUpdate api_key.
type (SplitAPIKeyType) – The definition of the SplitAPIKey object.

datadog_api_client.v2.model.split_credentials module¶

class SplitCredentials(arg: None)¶

class SplitCredentials(arg: ModelComposed)

class SplitCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the SplitCredentials object.

Parameters:

api_key (str) – The SplitAPIKey api_key.
type (SplitAPIKeyType) – The definition of the SplitAPIKey object.

datadog_api_client.v2.model.split_credentials_update module¶

class SplitCredentialsUpdate(arg: None)¶

class SplitCredentialsUpdate(arg: ModelComposed)

class SplitCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the SplitCredentialsUpdate object.

Parameters:

api_key (str, optional) – The SplitAPIKeyUpdate api_key.
type (SplitAPIKeyType) – The definition of the SplitAPIKey object.

datadog_api_client.v2.model.split_integration module¶

class SplitIntegration(arg: None)¶

class SplitIntegration(arg: ModelComposed)

class SplitIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the SplitIntegration object.

Parameters:

credentials (SplitCredentials) – The definition of the SplitCredentials object.
type (SplitIntegrationType) – The definition of the SplitIntegrationType object.

datadog_api_client.v2.model.split_integration_type module¶

class SplitIntegrationType(arg: None)¶

class SplitIntegrationType(arg: ModelComposed)

class SplitIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the SplitIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Split”. Must be one of [“Split”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.split_integration_update module¶

class SplitIntegrationUpdate(arg: None)¶

class SplitIntegrationUpdate(arg: ModelComposed)

class SplitIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the SplitIntegrationUpdate object.

Parameters:

credentials (SplitCredentialsUpdate, optional) – The definition of the SplitCredentialsUpdate object.
type (SplitIntegrationType) – The definition of the SplitIntegrationType object.

datadog_api_client.v2.model.state module¶

class State(arg: None)¶

class State(arg: ModelComposed)

class State(*args, **kwargs)

Bases: ModelSimple

The state of the rule evaluation.

Parameters:

value (str) – Must be one of [“pass”, “fail”, “skip”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.state_variable module¶

class StateVariable(arg: None)¶

class StateVariable(arg: ModelComposed)

class StateVariable(*args, **kwargs)

Bases: ModelNormal

A variable, which can be set and read by other components in the app.

Parameters:

id (UUID) – The ID of the state variable.
name (str) – A unique identifier for this state variable. This name is also used to access the variable’s value throughout the app.
properties (StateVariableProperties) – The properties of the state variable.
type (StateVariableType) – The state variable type.

datadog_api_client.v2.model.state_variable_properties module¶

class StateVariableProperties(arg: None)¶

class StateVariableProperties(arg: ModelComposed)

class StateVariableProperties(*args, **kwargs)

Bases: ModelNormal

The properties of the state variable.

Parameters:: default_value (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The default value of the state variable.

datadog_api_client.v2.model.state_variable_type module¶

class StateVariableType(arg: None)¶

class StateVariableType(arg: ModelComposed)

class StateVariableType(*args, **kwargs)

Bases: ModelSimple

The state variable type.

Parameters:

value (str) – If omitted defaults to “stateVariable”. Must be one of [“stateVariable”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.statsig_api_key module¶

class StatsigAPIKey(arg: None)¶

class StatsigAPIKey(arg: ModelComposed)

class StatsigAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the StatsigAPIKey object.

Parameters:

api_key (str) – The StatsigAPIKey api_key.
type (StatsigAPIKeyType) – The definition of the StatsigAPIKey object.

datadog_api_client.v2.model.statsig_api_key_type module¶

class StatsigAPIKeyType(arg: None)¶

class StatsigAPIKeyType(arg: ModelComposed)

class StatsigAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the StatsigAPIKey object.

Parameters:

value (str) – If omitted defaults to “StatsigAPIKey”. Must be one of [“StatsigAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.statsig_api_key_update module¶

class StatsigAPIKeyUpdate(arg: None)¶

class StatsigAPIKeyUpdate(arg: ModelComposed)

class StatsigAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the StatsigAPIKey object.

Parameters:

api_key (str, optional) – The StatsigAPIKeyUpdate api_key.
type (StatsigAPIKeyType) – The definition of the StatsigAPIKey object.

datadog_api_client.v2.model.statsig_credentials module¶

class StatsigCredentials(arg: None)¶

class StatsigCredentials(arg: ModelComposed)

class StatsigCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the StatsigCredentials object.

Parameters:

api_key (str) – The StatsigAPIKey api_key.
type (StatsigAPIKeyType) – The definition of the StatsigAPIKey object.

datadog_api_client.v2.model.statsig_credentials_update module¶

class StatsigCredentialsUpdate(arg: None)¶

class StatsigCredentialsUpdate(arg: ModelComposed)

class StatsigCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the StatsigCredentialsUpdate object.

Parameters:

api_key (str, optional) – The StatsigAPIKeyUpdate api_key.
type (StatsigAPIKeyType) – The definition of the StatsigAPIKey object.

datadog_api_client.v2.model.statsig_integration module¶

class StatsigIntegration(arg: None)¶

class StatsigIntegration(arg: ModelComposed)

class StatsigIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the StatsigIntegration object.

Parameters:

credentials (StatsigCredentials) – The definition of the StatsigCredentials object.
type (StatsigIntegrationType) – The definition of the StatsigIntegrationType object.

datadog_api_client.v2.model.statsig_integration_type module¶

class StatsigIntegrationType(arg: None)¶

class StatsigIntegrationType(arg: ModelComposed)

class StatsigIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the StatsigIntegrationType object.

Parameters:

value (str) – If omitted defaults to “Statsig”. Must be one of [“Statsig”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.statsig_integration_update module¶

class StatsigIntegrationUpdate(arg: None)¶

class StatsigIntegrationUpdate(arg: ModelComposed)

class StatsigIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the StatsigIntegrationUpdate object.

Parameters:

credentials (StatsigCredentialsUpdate, optional) – The definition of the StatsigCredentialsUpdate object.
type (StatsigIntegrationType) – The definition of the StatsigIntegrationType object.

datadog_api_client.v2.model.step module¶

class Step(arg: None)¶

class Step(arg: ModelComposed)

class Step(*args, **kwargs)

Bases: ModelNormal

A Step is a sub-component of a workflow. Each Step performs an action.

Parameters:

action_id (str) – The unique identifier of an action.
completion_gate (CompletionGate, optional) – Used to create conditions before running subsequent actions.
connection_label (str, optional) – The unique identifier of a connection defined in the spec.
display (StepDisplay, optional) – The definition of StepDisplay object.
error_handlers ([ErrorHandler], optional) – The Step errorHandlers.
name (str) – Name of the step.
outbound_edges ([OutboundEdge], optional) – A list of subsequent actions to run.
parameters ([Parameter], optional) – A list of inputs for an action.
readiness_gate (ReadinessGate, optional) – Used to merge multiple branches into a single branch.

datadog_api_client.v2.model.step_display module¶

class StepDisplay(arg: None)¶

class StepDisplay(arg: ModelComposed)

class StepDisplay(*args, **kwargs)

Bases: ModelNormal

The definition of StepDisplay object.

Parameters:: bounds (StepDisplayBounds, optional) – The definition of StepDisplayBounds object.

datadog_api_client.v2.model.step_display_bounds module¶

class StepDisplayBounds(arg: None)¶

class StepDisplayBounds(arg: ModelComposed)

class StepDisplayBounds(*args, **kwargs)

Bases: ModelNormal

The definition of StepDisplayBounds object.

Parameters:

x (float, optional) – The bounds x.
y (float, optional) – The bounds y.

datadog_api_client.v2.model.table_result_v2 module¶

class TableResultV2(arg: None)¶

class TableResultV2(arg: ModelComposed)

class TableResultV2(*args, **kwargs)

Bases: ModelNormal

A reference table resource containing its full configuration and state.

Parameters:: data (TableResultV2Data, optional) – The data object containing the reference table configuration and state.

datadog_api_client.v2.model.table_result_v2_array module¶

class TableResultV2Array(arg: None)¶

class TableResultV2Array(arg: ModelComposed)

class TableResultV2Array(*args, **kwargs)

Bases: ModelNormal

List of reference tables.

Parameters:: data ([TableResultV2Data]) – The reference tables.

datadog_api_client.v2.model.table_result_v2_data module¶

class TableResultV2Data(arg: None)¶

class TableResultV2Data(arg: ModelComposed)

class TableResultV2Data(*args, **kwargs)

Bases: ModelNormal

The data object containing the reference table configuration and state.

Parameters:

attributes (TableResultV2DataAttributes, optional) – Attributes that define the reference table’s configuration and properties.
id (str, optional) – Unique identifier for the reference table.
type (TableResultV2DataType) – Reference table resource type.

additional_properties_type = None¶

datadog_api_client.v2.model.table_result_v2_data_attributes module¶

class TableResultV2DataAttributes(arg: None)¶

class TableResultV2DataAttributes(arg: ModelComposed)

class TableResultV2DataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes that define the reference table’s configuration and properties.

Parameters:

created_by (str, optional) – UUID of the user who created the reference table.
description (str, optional) – Optional text describing the purpose or contents of this reference table.
file_metadata (TableResultV2DataAttributesFileMetadata, optional) –
Metadata specifying where and how to access the reference table’s data file.

For cloud storage tables (S3/GCS/Azure):
- sync_enabled and access_details will always be present
- error fields (error_message, error_row_count, error_type) are present only when errors occur
For local file tables:
- error fields (error_message, error_row_count) are present only when errors occur
- sync_enabled, access_details are never present
last_updated_by (str, optional) – UUID of the user who last updated the reference table.
row_count (int, optional) – The number of successfully processed rows in the reference table.
schema (TableResultV2DataAttributesSchema, optional) – Schema defining the structure and columns of the reference table.
source (ReferenceTableSourceType, optional) – The source type for reference table data. Includes all possible source types that can appear in responses.
status (str, optional) – The processing status of the table.
table_name (str, optional) – Unique name to identify this reference table. Used in enrichment processors and API calls.
tags ([str], optional) – Tags for organizing and filtering reference tables.
updated_at (str, optional) – When the reference table was last updated, in ISO 8601 format.

datadog_api_client.v2.model.table_result_v2_data_attributes_file_metadata module¶

class TableResultV2DataAttributesFileMetadata(arg: None)¶

class TableResultV2DataAttributesFileMetadata(arg: ModelComposed)

class TableResultV2DataAttributesFileMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata specifying where and how to access the reference table’s data file.

For cloud storage tables (S3/GCS/Azure):

sync_enabled and access_details will always be present
error fields (error_message, error_row_count, error_type) are present only when errors occur

For local file tables:

error fields (error_message, error_row_count) are present only when errors occur
sync_enabled, access_details are never present

Parameters:

access_details (TableResultV2DataAttributesFileMetadataOneOfAccessDetails, optional) – Cloud storage access configuration for the reference table data file.
error_message (str, optional) – The error message returned from the last operation (sync for cloud storage, upload for local file).
error_row_count (int, optional) – The number of rows that failed to process.
error_type (TableResultV2DataAttributesFileMetadataCloudStorageErrorType, optional) – The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors.
sync_enabled (bool, optional) – Whether this table is synced automatically from cloud storage. Only applicable for cloud storage sources.

additional_properties_type = None¶

datadog_api_client.v2.model.table_result_v2_data_attributes_file_metadata_cloud_storage_error_type module¶

class TableResultV2DataAttributesFileMetadataCloudStorageErrorType(arg: None)¶

class TableResultV2DataAttributesFileMetadataCloudStorageErrorType(arg: ModelComposed)

class TableResultV2DataAttributesFileMetadataCloudStorageErrorType(*args, **kwargs)

Bases: ModelSimple

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors.

Parameters:

value (str) – Must be one of [“TABLE_SCHEMA_ERROR”, “FILE_FORMAT_ERROR”, “CONFIGURATION_ERROR”, “QUOTA_EXCEEDED”, “CONFLICT_ERROR”, “VALIDATION_ERROR”, “STATE_ERROR”, “OPERATION_ERROR”, “SYSTEM_ERROR”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.table_result_v2_data_attributes_file_metadata_one_of_access_details module¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetails(arg: None)¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetails(arg: ModelComposed)

class TableResultV2DataAttributesFileMetadataOneOfAccessDetails(*args, **kwargs)

Bases: ModelNormal

Cloud storage access configuration for the reference table data file.

Parameters:

aws_detail (TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail, optional) – Amazon Web Services S3 storage access configuration.
azure_detail (TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail, optional) – Azure Blob Storage access configuration.
gcp_detail (TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail, optional) – Google Cloud Platform storage access configuration.

datadog_api_client.v2.model.table_result_v2_data_attributes_file_metadata_one_of_access_details_aws_detail module¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail(arg: None)¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail(arg: ModelComposed)

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail(*args, **kwargs)

Bases: ModelNormal

Amazon Web Services S3 storage access configuration.

Parameters:

aws_account_id (str, optional) – AWS account ID where the S3 bucket is located.
aws_bucket_name (str, optional) – S3 bucket containing the CSV file.
file_path (str, optional) – The relative file path from the S3 bucket root to the CSV file.

datadog_api_client.v2.model.table_result_v2_data_attributes_file_metadata_one_of_access_details_azure_detail module¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail(arg: None)¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail(arg: ModelComposed)

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail(*args, **kwargs)

Bases: ModelNormal

Azure Blob Storage access configuration.

Parameters:

azure_client_id (str, optional) – Azure service principal (application) client ID with permissions to read from the container.
azure_container_name (str, optional) – Azure Blob Storage container containing the CSV file.
azure_storage_account_name (str, optional) – Azure storage account where the container is located.
azure_tenant_id (str, optional) – Azure Active Directory tenant ID.
file_path (str, optional) – The relative file path from the Azure container root to the CSV file.

datadog_api_client.v2.model.table_result_v2_data_attributes_file_metadata_one_of_access_details_gcp_detail module¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail(arg: None)¶

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail(arg: ModelComposed)

class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail(*args, **kwargs)

Bases: ModelNormal

Google Cloud Platform storage access configuration.

Parameters:

file_path (str, optional) – The relative file path from the GCS bucket root to the CSV file.
gcp_bucket_name (str, optional) – GCP bucket containing the CSV file.
gcp_project_id (str, optional) – GCP project ID where the bucket is located.
gcp_service_account_email (str, optional) – Service account email with read permissions for the GCS bucket.

datadog_api_client.v2.model.table_result_v2_data_attributes_schema module¶

class TableResultV2DataAttributesSchema(arg: None)¶

class TableResultV2DataAttributesSchema(arg: ModelComposed)

class TableResultV2DataAttributesSchema(*args, **kwargs)

Bases: ModelNormal

Schema defining the structure and columns of the reference table.

Parameters:

fields ([TableResultV2DataAttributesSchemaFieldsItems]) – The schema fields.
primary_keys ([str]) – List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows.

datadog_api_client.v2.model.table_result_v2_data_attributes_schema_fields_items module¶

class TableResultV2DataAttributesSchemaFieldsItems(arg: None)¶

class TableResultV2DataAttributesSchemaFieldsItems(arg: ModelComposed)

class TableResultV2DataAttributesSchemaFieldsItems(*args, **kwargs)

Bases: ModelNormal

A single field (column) in the reference table schema to be returned.

Parameters:

name (str) – The field name.
type (ReferenceTableSchemaFieldType) – The field type for reference table schema fields.

datadog_api_client.v2.model.table_result_v2_data_type module¶

class TableResultV2DataType(arg: None)¶

class TableResultV2DataType(arg: ModelComposed)

class TableResultV2DataType(*args, **kwargs)

Bases: ModelSimple

Reference table resource type.

Parameters:

value (str) – If omitted defaults to “reference_table”. Must be one of [“reference_table”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.table_row_resource_array module¶

class TableRowResourceArray(arg: None)¶

class TableRowResourceArray(arg: ModelComposed)

class TableRowResourceArray(*args, **kwargs)

Bases: ModelNormal

List of rows from a reference table query.

Parameters:: data ([TableRowResourceData]) – The rows.

datadog_api_client.v2.model.table_row_resource_data module¶

class TableRowResourceData(arg: None)¶

class TableRowResourceData(arg: ModelComposed)

class TableRowResourceData(*args, **kwargs)

Bases: ModelNormal

The data object containing the row column names and values.

Parameters:

attributes (TableRowResourceDataAttributes, optional) – Column values for this row in the reference table.
id (str, optional) – Row identifier, corresponding to the primary key value.
type (TableRowResourceDataType) – Row resource type.

additional_properties_type = None¶

datadog_api_client.v2.model.table_row_resource_data_attributes module¶

class TableRowResourceDataAttributes(arg: None)¶

class TableRowResourceDataAttributes(arg: ModelComposed)

class TableRowResourceDataAttributes(*args, **kwargs)

Bases: ModelNormal

Column values for this row in the reference table.

Parameters:: values (dict, optional) – Key-value pairs representing the row data, where keys are field names from the schema.

additional_properties_type = None¶

datadog_api_client.v2.model.table_row_resource_data_type module¶

class TableRowResourceDataType(arg: None)¶

class TableRowResourceDataType(arg: ModelComposed)

class TableRowResourceDataType(*args, **kwargs)

Bases: ModelSimple

Row resource type.

Parameters:

value (str) – If omitted defaults to “row”. Must be one of [“row”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.tag_filter module¶

class TagFilter(arg: None)¶

class TagFilter(arg: ModelComposed)

class TagFilter(*args, **kwargs)

Bases: ModelNormal

Tag filter for the budget’s entries.

Parameters:

tag_key (str, optional) – The key of the tag.
tag_value (str, optional) – The value of the tag.

datadog_api_client.v2.model.tags_event_attribute module¶

class TagsEventAttribute(arg: None)¶

class TagsEventAttribute(arg: ModelComposed)

class TagsEventAttribute(*args, **kwargs)

Bases: ModelSimple

Array of tags associated with your event.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team module¶

class Team(arg: None)¶

class Team(arg: ModelComposed)

class Team(*args, **kwargs)

Bases: ModelNormal

A team

Parameters:

attributes (TeamAttributes) – Team attributes
id (str) – The team’s identifier
relationships (TeamRelationships, optional) – Resources related to a team
type (TeamType) – Team type

datadog_api_client.v2.model.team_attributes module¶

class TeamAttributes(arg: None)¶

class TeamAttributes(arg: ModelComposed)

class TeamAttributes(*args, **kwargs)

Bases: ModelNormal

Team attributes

Parameters:

avatar (str, none_type, optional) – Unicode representation of the avatar for the team, limited to a single grapheme
banner (int, none_type, optional) – Banner selection for the team
created_at (datetime, optional) – Creation date of the team
description (str, none_type, optional) – Free-form markdown description/content for the team’s homepage
handle (str) – The team’s identifier
hidden_modules ([str], optional) – Collection of hidden modules for the team
link_count (int, optional) – The number of links belonging to the team
modified_at (datetime, optional) – Modification date of the team
name (str) – The name of the team
summary (str, none_type, optional) – A brief summary of the team, derived from the description
user_count (int, optional) – The number of users belonging to the team
visible_modules ([str], optional) – Collection of visible modules for the team

datadog_api_client.v2.model.team_connection module¶

class TeamConnection(arg: None)¶

class TeamConnection(arg: ModelComposed)

class TeamConnection(*args, **kwargs)

Bases: ModelNormal

A relationship between a Datadog team and a team from another external system.

Parameters:

attributes (TeamConnectionAttributes, optional) – Attributes of the team connection.
id (str) – The unique identifier of the team connection.
relationships (TeamConnectionRelationships, optional) – Relationships of the team connection.
type (TeamConnectionType) – Team connection resource type.

datadog_api_client.v2.model.team_connection_attributes module¶

class TeamConnectionAttributes(arg: None)¶

class TeamConnectionAttributes(arg: ModelComposed)

class TeamConnectionAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the team connection.

Parameters:

managed_by (str, optional) – The entity that manages this team connection.
source (str, optional) – The name of the external source.

datadog_api_client.v2.model.team_connection_create_data module¶

class TeamConnectionCreateData(arg: None)¶

class TeamConnectionCreateData(arg: ModelComposed)

class TeamConnectionCreateData(*args, **kwargs)

Bases: ModelNormal

Data for creating a team connection.

Parameters:

attributes (TeamConnectionAttributes, optional) – Attributes of the team connection.
relationships (TeamConnectionRelationships, optional) – Relationships of the team connection.
type (TeamConnectionType) – Team connection resource type.

datadog_api_client.v2.model.team_connection_create_request module¶

class TeamConnectionCreateRequest(arg: None)¶

class TeamConnectionCreateRequest(arg: ModelComposed)

class TeamConnectionCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating team connections.

Parameters:: data ([TeamConnectionCreateData]) – Array of team connections to create.

datadog_api_client.v2.model.team_connection_delete_request module¶

class TeamConnectionDeleteRequest(arg: None)¶

class TeamConnectionDeleteRequest(arg: ModelComposed)

class TeamConnectionDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Request for deleting team connections.

Parameters:: data ([TeamConnectionDeleteRequestDataItem]) – Array of team connection IDs to delete.

datadog_api_client.v2.model.team_connection_delete_request_data_item module¶

class TeamConnectionDeleteRequestDataItem(arg: None)¶

class TeamConnectionDeleteRequestDataItem(arg: ModelComposed)

class TeamConnectionDeleteRequestDataItem(*args, **kwargs)

Bases: ModelNormal

A collection of connection ids to delete.

Parameters:

id (str) – The unique identifier of the team connection to delete.
type (TeamConnectionType) – Team connection resource type.

datadog_api_client.v2.model.team_connection_relationships module¶

class TeamConnectionRelationships(arg: None)¶

class TeamConnectionRelationships(arg: ModelComposed)

class TeamConnectionRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the team connection.

Parameters:

connected_team (ConnectedTeamRef, optional) – Reference to a team from an external system.
team (TeamRef, optional) – Reference to a Datadog team.

datadog_api_client.v2.model.team_connection_type module¶

class TeamConnectionType(arg: None)¶

class TeamConnectionType(arg: ModelComposed)

class TeamConnectionType(*args, **kwargs)

Bases: ModelSimple

Team connection resource type.

Parameters:

value (str) – If omitted defaults to “team_connection”. Must be one of [“team_connection”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_connections_response module¶

class TeamConnectionsResponse(arg: None)¶

class TeamConnectionsResponse(arg: ModelComposed)

class TeamConnectionsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about multiple team connections.

Parameters:

data ([TeamConnection], optional) – Array of team connections.
meta (ConnectionsResponseMeta, optional) – Connections response metadata.

datadog_api_client.v2.model.team_create module¶

class TeamCreate(arg: None)¶

class TeamCreate(arg: ModelComposed)

class TeamCreate(*args, **kwargs)

Bases: ModelNormal

Team create

Parameters:

attributes (TeamCreateAttributes) – Team creation attributes
relationships (TeamCreateRelationships, optional) – Relationships formed with the team on creation
type (TeamType) – Team type

datadog_api_client.v2.model.team_create_attributes module¶

class TeamCreateAttributes(arg: None)¶

class TeamCreateAttributes(arg: ModelComposed)

class TeamCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Team creation attributes

Parameters:

avatar (str, none_type, optional) – Unicode representation of the avatar for the team, limited to a single grapheme
banner (int, none_type, optional) – Banner selection for the team
description (str, optional) – Free-form markdown description/content for the team’s homepage
handle (str) – The team’s identifier
hidden_modules ([str], optional) – Collection of hidden modules for the team
name (str) – The name of the team
visible_modules ([str], optional) – Collection of visible modules for the team

datadog_api_client.v2.model.team_create_relationships module¶

class TeamCreateRelationships(arg: None)¶

class TeamCreateRelationships(arg: ModelComposed)

class TeamCreateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships formed with the team on creation

Parameters:: users (RelationshipToUsers, optional) – Relationship to users.

datadog_api_client.v2.model.team_create_request module¶

class TeamCreateRequest(arg: None)¶

class TeamCreateRequest(arg: ModelComposed)

class TeamCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a team

Parameters:: data (TeamCreate) – Team create

datadog_api_client.v2.model.team_included module¶

class TeamIncluded(arg: None)¶

class TeamIncluded(arg: ModelComposed)

class TeamIncluded(*args, **kwargs)

Bases: ModelComposed

Included resources related to the team

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.team_link module¶

class TeamLink(arg: None)¶

class TeamLink(arg: ModelComposed)

class TeamLink(*args, **kwargs)

Bases: ModelNormal

Team link

Parameters:

attributes (TeamLinkAttributes) – Team link attributes
id (str) – The team link’s identifier
type (TeamLinkType) – Team link type

datadog_api_client.v2.model.team_link_attributes module¶

class TeamLinkAttributes(arg: None)¶

class TeamLinkAttributes(arg: ModelComposed)

class TeamLinkAttributes(*args, **kwargs)

Bases: ModelNormal

Team link attributes

Parameters:

label (str) – The link’s label
position (int, optional) – The link’s position, used to sort links for the team
team_id (str, optional) – ID of the team the link is associated with
url (str) – The URL for the link

datadog_api_client.v2.model.team_link_create module¶

class TeamLinkCreate(arg: None)¶

class TeamLinkCreate(arg: ModelComposed)

class TeamLinkCreate(*args, **kwargs)

Bases: ModelNormal

Team link create

Parameters:

attributes (TeamLinkAttributes) – Team link attributes
type (TeamLinkType) – Team link type

datadog_api_client.v2.model.team_link_create_request module¶

class TeamLinkCreateRequest(arg: None)¶

class TeamLinkCreateRequest(arg: ModelComposed)

class TeamLinkCreateRequest(*args, **kwargs)

Bases: ModelNormal

Team link create request

Parameters:: data (TeamLinkCreate) – Team link create

datadog_api_client.v2.model.team_link_response module¶

class TeamLinkResponse(arg: None)¶

class TeamLinkResponse(arg: ModelComposed)

class TeamLinkResponse(*args, **kwargs)

Bases: ModelNormal

Team link response

Parameters:: data (TeamLink, optional) – Team link

datadog_api_client.v2.model.team_link_type module¶

class TeamLinkType(arg: None)¶

class TeamLinkType(arg: ModelComposed)

class TeamLinkType(*args, **kwargs)

Bases: ModelSimple

Team link type

Parameters:

value (str) – If omitted defaults to “team_links”. Must be one of [“team_links”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_links_response module¶

class TeamLinksResponse(arg: None)¶

class TeamLinksResponse(arg: ModelComposed)

class TeamLinksResponse(*args, **kwargs)

Bases: ModelNormal

Team links response

Parameters:: data ([TeamLink], optional) – Team links response data

datadog_api_client.v2.model.team_on_call_responders module¶

class TeamOnCallResponders(arg: None)¶

class TeamOnCallResponders(arg: ModelComposed)

class TeamOnCallResponders(*args, **kwargs)

Bases: ModelNormal

Root object representing a team’s on-call responder configuration.

Parameters:

data (TeamOnCallRespondersData, optional) – Defines the main on-call responder object for a team, including relationships and metadata.
included ([TeamOnCallRespondersIncluded], optional) – The TeamOnCallResponders included.

datadog_api_client.v2.model.team_on_call_responders_data module¶

class TeamOnCallRespondersData(arg: None)¶

class TeamOnCallRespondersData(arg: ModelComposed)

class TeamOnCallRespondersData(*args, **kwargs)

Bases: ModelNormal

Defines the main on-call responder object for a team, including relationships and metadata.

Parameters:

id (str, optional) – Unique identifier of the on-call responder configuration.
relationships (TeamOnCallRespondersDataRelationships, optional) – Relationship objects linked to a team’s on-call responder configuration, including escalations and responders.
type (TeamOnCallRespondersDataType) – Represents the resource type for a group of users assigned to handle on-call duties within a team.

datadog_api_client.v2.model.team_on_call_responders_data_relationships module¶

class TeamOnCallRespondersDataRelationships(arg: None)¶

class TeamOnCallRespondersDataRelationships(arg: ModelComposed)

class TeamOnCallRespondersDataRelationships(*args, **kwargs)

Bases: ModelNormal

Relationship objects linked to a team’s on-call responder configuration, including escalations and responders.

Parameters:

escalations (TeamOnCallRespondersDataRelationshipsEscalations, optional) – Defines the escalation policy steps linked to the team’s on-call configuration.
responders (TeamOnCallRespondersDataRelationshipsResponders, optional) – Defines the list of users assigned as on-call responders for the team.

datadog_api_client.v2.model.team_on_call_responders_data_relationships_escalations module¶

class TeamOnCallRespondersDataRelationshipsEscalations(arg: None)¶

class TeamOnCallRespondersDataRelationshipsEscalations(arg: ModelComposed)

class TeamOnCallRespondersDataRelationshipsEscalations(*args, **kwargs)

Bases: ModelNormal

Defines the escalation policy steps linked to the team’s on-call configuration.

Parameters:: data ([TeamOnCallRespondersDataRelationshipsEscalationsDataItems], optional) – Array of escalation step references.

datadog_api_client.v2.model.team_on_call_responders_data_relationships_escalations_data_items module¶

class TeamOnCallRespondersDataRelationshipsEscalationsDataItems(arg: None)¶

class TeamOnCallRespondersDataRelationshipsEscalationsDataItems(arg: ModelComposed)

class TeamOnCallRespondersDataRelationshipsEscalationsDataItems(*args, **kwargs)

Bases: ModelNormal

Represents a link to a specific escalation policy step associated with the on-call team.

Parameters:

id (str) – Unique identifier of the escalation step.
type (TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType) – Identifies the resource type for escalation policy steps linked to a team’s on-call configuration.

datadog_api_client.v2.model.team_on_call_responders_data_relationships_escalations_data_items_type module¶

class TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType(arg: None)¶

class TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType(arg: ModelComposed)

class TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType(*args, **kwargs)

Bases: ModelSimple

Identifies the resource type for escalation policy steps linked to a team’s on-call configuration.

Parameters:

value (str) – If omitted defaults to “escalation_policy_steps”. Must be one of [“escalation_policy_steps”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_on_call_responders_data_relationships_responders module¶

class TeamOnCallRespondersDataRelationshipsResponders(arg: None)¶

class TeamOnCallRespondersDataRelationshipsResponders(arg: ModelComposed)

class TeamOnCallRespondersDataRelationshipsResponders(*args, **kwargs)

Bases: ModelNormal

Defines the list of users assigned as on-call responders for the team.

Parameters:: data ([TeamOnCallRespondersDataRelationshipsRespondersDataItems], optional) – Array of user references associated as responders.

datadog_api_client.v2.model.team_on_call_responders_data_relationships_responders_data_items module¶

class TeamOnCallRespondersDataRelationshipsRespondersDataItems(arg: None)¶

class TeamOnCallRespondersDataRelationshipsRespondersDataItems(arg: ModelComposed)

class TeamOnCallRespondersDataRelationshipsRespondersDataItems(*args, **kwargs)

Bases: ModelNormal

Represents a user responder associated with the on-call team.

Parameters:

id (str) – Unique identifier of the responder.
type (TeamOnCallRespondersDataRelationshipsRespondersDataItemsType) – Identifies the resource type for individual user entities associated with on-call response.

datadog_api_client.v2.model.team_on_call_responders_data_relationships_responders_data_items_type module¶

class TeamOnCallRespondersDataRelationshipsRespondersDataItemsType(arg: None)¶

class TeamOnCallRespondersDataRelationshipsRespondersDataItemsType(arg: ModelComposed)

class TeamOnCallRespondersDataRelationshipsRespondersDataItemsType(*args, **kwargs)

Bases: ModelSimple

Identifies the resource type for individual user entities associated with on-call response.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_on_call_responders_data_type module¶

class TeamOnCallRespondersDataType(arg: None)¶

class TeamOnCallRespondersDataType(arg: ModelComposed)

class TeamOnCallRespondersDataType(*args, **kwargs)

Bases: ModelSimple

Represents the resource type for a group of users assigned to handle on-call duties within a team.

Parameters:

value (str) – If omitted defaults to “team_oncall_responders”. Must be one of [“team_oncall_responders”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_on_call_responders_included module¶

class TeamOnCallRespondersIncluded(arg: None)¶

class TeamOnCallRespondersIncluded(arg: ModelComposed)

class TeamOnCallRespondersIncluded(*args, **kwargs)

Bases: ModelComposed

Represents an union of related resources included in the response, such as users and escalation steps.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.team_permission_setting module¶

class TeamPermissionSetting(arg: None)¶

class TeamPermissionSetting(arg: ModelComposed)

class TeamPermissionSetting(*args, **kwargs)

Bases: ModelNormal

Team permission setting

Parameters:

attributes (TeamPermissionSettingAttributes, optional) – Team permission setting attributes
id (str) – The team permission setting’s identifier
type (TeamPermissionSettingType) – Team permission setting type

datadog_api_client.v2.model.team_permission_setting_attributes module¶

class TeamPermissionSettingAttributes(arg: None)¶

class TeamPermissionSettingAttributes(arg: ModelComposed)

class TeamPermissionSettingAttributes(*args, **kwargs)

Bases: ModelNormal

Team permission setting attributes

Parameters:

action (TeamPermissionSettingSerializerAction, optional) – The identifier for the action
editable (bool, optional) – Whether or not the permission setting is editable by the current user
options (TeamPermissionSettingValues, optional) – Possible values for action
title (str, optional) – The team permission name
value (TeamPermissionSettingValue, optional) – What type of user is allowed to perform the specified action

datadog_api_client.v2.model.team_permission_setting_response module¶

class TeamPermissionSettingResponse(arg: None)¶

class TeamPermissionSettingResponse(arg: ModelComposed)

class TeamPermissionSettingResponse(*args, **kwargs)

Bases: ModelNormal

Team permission setting response

Parameters:: data (TeamPermissionSetting, optional) – Team permission setting

datadog_api_client.v2.model.team_permission_setting_serializer_action module¶

class TeamPermissionSettingSerializerAction(arg: None)¶

class TeamPermissionSettingSerializerAction(arg: ModelComposed)

class TeamPermissionSettingSerializerAction(*args, **kwargs)

Bases: ModelSimple

The identifier for the action

Parameters:

value (str) – Must be one of [“manage_membership”, “edit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_permission_setting_type module¶

class TeamPermissionSettingType(arg: None)¶

class TeamPermissionSettingType(arg: ModelComposed)

class TeamPermissionSettingType(*args, **kwargs)

Bases: ModelSimple

Team permission setting type

Parameters:

value (str) – If omitted defaults to “team_permission_settings”. Must be one of [“team_permission_settings”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_permission_setting_update module¶

class TeamPermissionSettingUpdate(arg: None)¶

class TeamPermissionSettingUpdate(arg: ModelComposed)

class TeamPermissionSettingUpdate(*args, **kwargs)

Bases: ModelNormal

Team permission setting update

Parameters:

attributes (TeamPermissionSettingUpdateAttributes, optional) – Team permission setting update attributes
type (TeamPermissionSettingType) – Team permission setting type

datadog_api_client.v2.model.team_permission_setting_update_attributes module¶

class TeamPermissionSettingUpdateAttributes(arg: None)¶

class TeamPermissionSettingUpdateAttributes(arg: ModelComposed)

class TeamPermissionSettingUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Team permission setting update attributes

Parameters:: value (TeamPermissionSettingValue, optional) – What type of user is allowed to perform the specified action

datadog_api_client.v2.model.team_permission_setting_update_request module¶

class TeamPermissionSettingUpdateRequest(arg: None)¶

class TeamPermissionSettingUpdateRequest(arg: ModelComposed)

class TeamPermissionSettingUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Team permission setting update request

Parameters:: data (TeamPermissionSettingUpdate) – Team permission setting update

datadog_api_client.v2.model.team_permission_setting_value module¶

class TeamPermissionSettingValue(arg: None)¶

class TeamPermissionSettingValue(arg: ModelComposed)

class TeamPermissionSettingValue(*args, **kwargs)

Bases: ModelSimple

What type of user is allowed to perform the specified action

Parameters:

value (str) – Must be one of [“admins”, “members”, “organization”, “user_access_manage”, “teams_manage”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_permission_setting_values module¶

class TeamPermissionSettingValues(arg: None)¶

class TeamPermissionSettingValues(arg: ModelComposed)

class TeamPermissionSettingValues(*args, **kwargs)

Bases: ModelSimple

Possible values for action

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_permission_settings_response module¶

class TeamPermissionSettingsResponse(arg: None)¶

class TeamPermissionSettingsResponse(arg: ModelComposed)

class TeamPermissionSettingsResponse(*args, **kwargs)

Bases: ModelNormal

Team permission settings response

Parameters:: data ([TeamPermissionSetting], optional) – Team permission settings response data

datadog_api_client.v2.model.team_ref module¶

class TeamRef(arg: None)¶

class TeamRef(arg: ModelComposed)

class TeamRef(*args, **kwargs)

Bases: ModelNormal

Reference to a Datadog team.

Parameters:: data (TeamRefData, optional) – Reference to a Datadog team.

datadog_api_client.v2.model.team_ref_data module¶

class TeamRefData(arg: None)¶

class TeamRefData(arg: ModelComposed)

class TeamRefData(*args, **kwargs)

Bases: ModelNormal

Reference to a Datadog team.

Parameters:

id (str) – The Datadog team ID.
type (TeamRefDataType) – Datadog team resource type.

datadog_api_client.v2.model.team_ref_data_type module¶

class TeamRefDataType(arg: None)¶

class TeamRefDataType(arg: ModelComposed)

class TeamRefDataType(*args, **kwargs)

Bases: ModelSimple

Datadog team resource type.

Parameters:

value (str) – If omitted defaults to “team”. Must be one of [“team”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_reference module¶

class TeamReference(arg: None)¶

class TeamReference(arg: ModelComposed)

class TeamReference(*args, **kwargs)

Bases: ModelNormal

Provides a reference to a team, including ID, type, and basic attributes/relationships.

Parameters:

attributes (TeamReferenceAttributes, optional) – Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
id (str, optional) – The team’s unique identifier.
type (TeamReferenceType) – Teams resource type.

datadog_api_client.v2.model.team_reference_attributes module¶

class TeamReferenceAttributes(arg: None)¶

class TeamReferenceAttributes(arg: ModelComposed)

class TeamReferenceAttributes(*args, **kwargs)

Bases: ModelNormal

Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.

Parameters:

avatar (str, optional) – URL or reference for the team’s avatar (if available).
description (str, optional) – A short text describing the team.
handle (str, optional) – A unique handle/slug for the team.
name (str, optional) – The full, human-readable name of the team.

datadog_api_client.v2.model.team_reference_type module¶

class TeamReferenceType(arg: None)¶

class TeamReferenceType(arg: ModelComposed)

class TeamReferenceType(*args, **kwargs)

Bases: ModelSimple

Teams resource type.

Parameters:

value (str) – If omitted defaults to “teams”. Must be one of [“teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_relationships module¶

class TeamRelationships(arg: None)¶

class TeamRelationships(arg: ModelComposed)

class TeamRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to a team

Parameters:

team_links (RelationshipToTeamLinks, optional) – Relationship between a team and a team link
user_team_permissions (RelationshipToUserTeamPermission, optional) – Relationship between a user team permission and a team

datadog_api_client.v2.model.team_relationships_links module¶

class TeamRelationshipsLinks(arg: None)¶

class TeamRelationshipsLinks(arg: ModelComposed)

class TeamRelationshipsLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:: related (str, optional) – Related link.

datadog_api_client.v2.model.team_response module¶

class TeamResponse(arg: None)¶

class TeamResponse(arg: ModelComposed)

class TeamResponse(*args, **kwargs)

Bases: ModelNormal

Response with a team

Parameters:: data (Team, optional) – A team

datadog_api_client.v2.model.team_routing_rules module¶

class TeamRoutingRules(arg: None)¶

class TeamRoutingRules(arg: ModelComposed)

class TeamRoutingRules(*args, **kwargs)

Bases: ModelNormal

Represents a complete set of team routing rules, including data and optionally included related resources.

Parameters:

data (TeamRoutingRulesData, optional) – Represents the top-level data object for team routing rules, containing the ID, relationships, and resource type.
included ([TeamRoutingRulesIncluded], optional) – Provides related routing rules or other included resources.

datadog_api_client.v2.model.team_routing_rules_data module¶

class TeamRoutingRulesData(arg: None)¶

class TeamRoutingRulesData(arg: ModelComposed)

class TeamRoutingRulesData(*args, **kwargs)

Bases: ModelNormal

Represents the top-level data object for team routing rules, containing the ID, relationships, and resource type.

Parameters:

id (str, optional) – Specifies the unique identifier of this team routing rules record.
relationships (TeamRoutingRulesDataRelationships, optional) – Specifies relationships for team routing rules, including rule references.
type (TeamRoutingRulesDataType) – Team routing rules resource type.

datadog_api_client.v2.model.team_routing_rules_data_relationships module¶

class TeamRoutingRulesDataRelationships(arg: None)¶

class TeamRoutingRulesDataRelationships(arg: ModelComposed)

class TeamRoutingRulesDataRelationships(*args, **kwargs)

Bases: ModelNormal

Specifies relationships for team routing rules, including rule references.

Parameters:: rules (TeamRoutingRulesDataRelationshipsRules, optional) – Holds references to a set of routing rules in a relationship.

datadog_api_client.v2.model.team_routing_rules_data_relationships_rules module¶

class TeamRoutingRulesDataRelationshipsRules(arg: None)¶

class TeamRoutingRulesDataRelationshipsRules(arg: ModelComposed)

class TeamRoutingRulesDataRelationshipsRules(*args, **kwargs)

Bases: ModelNormal

Holds references to a set of routing rules in a relationship.

Parameters:: data ([TeamRoutingRulesDataRelationshipsRulesDataItems], optional) – An array of references to the routing rules associated with this team.

datadog_api_client.v2.model.team_routing_rules_data_relationships_rules_data_items module¶

class TeamRoutingRulesDataRelationshipsRulesDataItems(arg: None)¶

class TeamRoutingRulesDataRelationshipsRulesDataItems(arg: ModelComposed)

class TeamRoutingRulesDataRelationshipsRulesDataItems(*args, **kwargs)

Bases: ModelNormal

Defines a relationship item to link a routing rule by its ID and type.

Parameters:

id (str) – Specifies the unique identifier for the related routing rule.
type (TeamRoutingRulesDataRelationshipsRulesDataItemsType) – Indicates that the resource is of type ‘team_routing_rules’.

datadog_api_client.v2.model.team_routing_rules_data_relationships_rules_data_items_type module¶

class TeamRoutingRulesDataRelationshipsRulesDataItemsType(arg: None)¶

class TeamRoutingRulesDataRelationshipsRulesDataItemsType(arg: ModelComposed)

class TeamRoutingRulesDataRelationshipsRulesDataItemsType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type ‘team_routing_rules’.

Parameters:

value (str) – If omitted defaults to “team_routing_rules”. Must be one of [“team_routing_rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_routing_rules_data_type module¶

class TeamRoutingRulesDataType(arg: None)¶

class TeamRoutingRulesDataType(arg: ModelComposed)

class TeamRoutingRulesDataType(*args, **kwargs)

Bases: ModelSimple

Team routing rules resource type.

Parameters:

value (str) – If omitted defaults to “team_routing_rules”. Must be one of [“team_routing_rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_routing_rules_included module¶

class TeamRoutingRulesIncluded(arg: None)¶

class TeamRoutingRulesIncluded(arg: ModelComposed)

class TeamRoutingRulesIncluded(*args, **kwargs)

Bases: ModelComposed

Represents additional included resources for team routing rules, such as associated routing rules.

Parameters:

attributes (RoutingRuleAttributes, optional) – Defines the configurable attributes of a routing rule, such as actions, query, time restriction, and urgency.
id (str, optional) – Specifies the unique identifier of this routing rule.
relationships (RoutingRuleRelationships, optional) – Specifies relationships for a routing rule, linking to associated policy resources.
type (RoutingRuleType) – Team routing rules resource type.

datadog_api_client.v2.model.team_routing_rules_request module¶

class TeamRoutingRulesRequest(arg: None)¶

class TeamRoutingRulesRequest(arg: ModelComposed)

class TeamRoutingRulesRequest(*args, **kwargs)

Bases: ModelNormal

Represents a request to create or update team routing rules, including the data payload.

Parameters:: data (TeamRoutingRulesRequestData, optional) – Holds the data necessary to create or update team routing rules, including attributes, ID, and resource type.

datadog_api_client.v2.model.team_routing_rules_request_data module¶

class TeamRoutingRulesRequestData(arg: None)¶

class TeamRoutingRulesRequestData(arg: ModelComposed)

class TeamRoutingRulesRequestData(*args, **kwargs)

Bases: ModelNormal

Holds the data necessary to create or update team routing rules, including attributes, ID, and resource type.

Parameters:

attributes (TeamRoutingRulesRequestDataAttributes, optional) – Represents the attributes of a request to update or create team routing rules.
id (str, optional) – Specifies the unique identifier for this set of team routing rules.
type (TeamRoutingRulesRequestDataType) – Team routing rules resource type.

datadog_api_client.v2.model.team_routing_rules_request_data_attributes module¶

class TeamRoutingRulesRequestDataAttributes(arg: None)¶

class TeamRoutingRulesRequestDataAttributes(arg: ModelComposed)

class TeamRoutingRulesRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Represents the attributes of a request to update or create team routing rules.

Parameters:: rules ([TeamRoutingRulesRequestRule], optional) – A list of routing rule items that define how incoming pages should be handled.

datadog_api_client.v2.model.team_routing_rules_request_data_type module¶

class TeamRoutingRulesRequestDataType(arg: None)¶

class TeamRoutingRulesRequestDataType(arg: ModelComposed)

class TeamRoutingRulesRequestDataType(*args, **kwargs)

Bases: ModelSimple

Team routing rules resource type.

Parameters:

value (str) – If omitted defaults to “team_routing_rules”. Must be one of [“team_routing_rules”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_routing_rules_request_rule module¶

class TeamRoutingRulesRequestRule(arg: None)¶

class TeamRoutingRulesRequestRule(arg: ModelComposed)

class TeamRoutingRulesRequestRule(*args, **kwargs)

Bases: ModelNormal

Defines an individual routing rule item that contains the rule data for the request.

Parameters:

actions ([RoutingRuleAction], optional) – Specifies the list of actions to perform when the routing rule is matched.
policy_id (str, optional) – Identifies the policy to be applied when this routing rule matches.
query (str, optional) – Defines the query or condition that triggers this routing rule.
time_restriction (TimeRestrictions, optional) – Holds time zone information and a list of time restrictions for a routing rule.
urgency (Urgency, optional) – Specifies the level of urgency for a routing rule (low, high, or dynamic).

datadog_api_client.v2.model.team_sync_attributes module¶

class TeamSyncAttributes(arg: None)¶

class TeamSyncAttributes(arg: ModelComposed)

class TeamSyncAttributes(*args, **kwargs)

Bases: ModelNormal

Team sync attributes.

Parameters:

frequency (TeamSyncAttributesFrequency, optional) – How often the sync process should be run. Defaults to once when not provided.
source (TeamSyncAttributesSource) – The external source platform for team synchronization. Only “github” is supported.
sync_membership (bool, optional) – Whether to sync members from the external team to the Datadog team. Defaults to false when not provided.
type (TeamSyncAttributesType) – The type of synchronization operation. “link” connects teams by matching names. “provision” creates new teams when no match is found.

datadog_api_client.v2.model.team_sync_attributes_frequency module¶

class TeamSyncAttributesFrequency(arg: None)¶

class TeamSyncAttributesFrequency(arg: ModelComposed)

class TeamSyncAttributesFrequency(*args, **kwargs)

Bases: ModelSimple

How often the sync process should be run. Defaults to once when not provided.

Parameters:

value (str) – Must be one of [“once”, “continuously”, “paused”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_sync_attributes_source module¶

class TeamSyncAttributesSource(arg: None)¶

class TeamSyncAttributesSource(arg: ModelComposed)

class TeamSyncAttributesSource(*args, **kwargs)

Bases: ModelSimple

The external source platform for team synchronization. Only “github” is supported.

Parameters:

value (str) – If omitted defaults to “github”. Must be one of [“github”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_sync_attributes_type module¶

class TeamSyncAttributesType(arg: None)¶

class TeamSyncAttributesType(arg: ModelComposed)

class TeamSyncAttributesType(*args, **kwargs)

Bases: ModelSimple

The type of synchronization operation. “link” connects teams by matching names. “provision” creates new teams when no match is found.

Parameters:

value (str) – Must be one of [“link”, “provision”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_sync_bulk_type module¶

class TeamSyncBulkType(arg: None)¶

class TeamSyncBulkType(arg: ModelComposed)

class TeamSyncBulkType(*args, **kwargs)

Bases: ModelSimple

Team sync bulk type.

Parameters:

value (str) – If omitted defaults to “team_sync_bulk”. Must be one of [“team_sync_bulk”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_sync_data module¶

class TeamSyncData(arg: None)¶

class TeamSyncData(arg: ModelComposed)

class TeamSyncData(*args, **kwargs)

Bases: ModelNormal

A configuration governing syncing between Datadog teams and teams from an external system.

Parameters:

attributes (TeamSyncAttributes) – Team sync attributes.
id (str, optional) – The sync’s identifier
type (TeamSyncBulkType) – Team sync bulk type.

datadog_api_client.v2.model.team_sync_request module¶

class TeamSyncRequest(arg: None)¶

class TeamSyncRequest(arg: ModelComposed)

class TeamSyncRequest(*args, **kwargs)

Bases: ModelNormal

Team sync request.

Parameters:: data (TeamSyncData) – A configuration governing syncing between Datadog teams and teams from an external system.

datadog_api_client.v2.model.team_sync_response module¶

class TeamSyncResponse(arg: None)¶

class TeamSyncResponse(arg: ModelComposed)

class TeamSyncResponse(*args, **kwargs)

Bases: ModelNormal

Team sync configurations response.

Parameters:: data ([TeamSyncData], optional) – List of team sync configurations

datadog_api_client.v2.model.team_target module¶

class TeamTarget(arg: None)¶

class TeamTarget(arg: ModelComposed)

class TeamTarget(*args, **kwargs)

Bases: ModelNormal

Represents a team target for an escalation policy step, including the team’s ID and resource type.

Parameters:

id (str) – Specifies the unique identifier of the team resource.
type (TeamTargetType) – Indicates that the resource is of type teams.

datadog_api_client.v2.model.team_target_type module¶

class TeamTargetType(arg: None)¶

class TeamTargetType(arg: ModelComposed)

class TeamTargetType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type teams.

Parameters:

value (str) – If omitted defaults to “teams”. Must be one of [“teams”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_type module¶

class TeamType(arg: None)¶

class TeamType(arg: ModelComposed)

class TeamType(*args, **kwargs)

Bases: ModelSimple

Team type

Parameters:

value (str) – If omitted defaults to “team”. Must be one of [“team”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.team_update module¶

class TeamUpdate(arg: None)¶

class TeamUpdate(arg: ModelComposed)

class TeamUpdate(*args, **kwargs)

Bases: ModelNormal

Team update request

Parameters:

attributes (TeamUpdateAttributes) – Team update attributes
relationships (TeamUpdateRelationships, optional) – Team update relationships
type (TeamType) – Team type

datadog_api_client.v2.model.team_update_attributes module¶

class TeamUpdateAttributes(arg: None)¶

class TeamUpdateAttributes(arg: ModelComposed)

class TeamUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Team update attributes

Parameters:

avatar (str, none_type, optional) – Unicode representation of the avatar for the team, limited to a single grapheme
banner (int, none_type, optional) – Banner selection for the team
description (str, optional) – Free-form markdown description/content for the team’s homepage
handle (str) – The team’s identifier
hidden_modules ([str], optional) – Collection of hidden modules for the team
name (str) – The name of the team
visible_modules ([str], optional) – Collection of visible modules for the team

datadog_api_client.v2.model.team_update_relationships module¶

class TeamUpdateRelationships(arg: None)¶

class TeamUpdateRelationships(arg: ModelComposed)

class TeamUpdateRelationships(*args, **kwargs)

Bases: ModelNormal

Team update relationships

Parameters:: team_links (RelationshipToTeamLinks, optional) – Relationship between a team and a team link

datadog_api_client.v2.model.team_update_request module¶

class TeamUpdateRequest(arg: None)¶

class TeamUpdateRequest(arg: ModelComposed)

class TeamUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Team update request

Parameters:: data (TeamUpdate) – Team update request

datadog_api_client.v2.model.teams_field module¶

class TeamsField(arg: None)¶

class TeamsField(arg: ModelComposed)

class TeamsField(*args, **kwargs)

Bases: ModelSimple

Supported teams field.

Parameters:

value (str) – Must be one of [“id”, “name”, “handle”, “summary”, “description”, “avatar”, “banner”, “visible_modules”, “hidden_modules”, “created_at”, “modified_at”, “user_count”, “link_count”, “team_links”, “user_team_permissions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.teams_response module¶

class TeamsResponse(arg: None)¶

class TeamsResponse(arg: ModelComposed)

class TeamsResponse(*args, **kwargs)

Bases: ModelNormal

Response with multiple teams

Parameters:

data ([Team], optional) – Teams response data
included ([TeamIncluded], optional) – Resources related to the team
links (TeamsResponseLinks, optional) – Teams response links.
meta (TeamsResponseMeta, optional) – Teams response metadata.

datadog_api_client.v2.model.teams_response_links module¶

class TeamsResponseLinks(arg: None)¶

class TeamsResponseLinks(arg: ModelComposed)

class TeamsResponseLinks(*args, **kwargs)

Bases: ModelNormal

Teams response links.

Parameters:

first (str, optional) – First link.
last (str, none_type, optional) – Last link.
next (str, optional) – Next link.
prev (str, none_type, optional) – Previous link.
self (str, optional) – Current link.

datadog_api_client.v2.model.teams_response_meta module¶

class TeamsResponseMeta(arg: None)¶

class TeamsResponseMeta(arg: ModelComposed)

class TeamsResponseMeta(*args, **kwargs)

Bases: ModelNormal

Teams response metadata.

Parameters:: pagination (TeamsResponseMetaPagination, optional) – Teams response metadata.

datadog_api_client.v2.model.teams_response_meta_pagination module¶

class TeamsResponseMetaPagination(arg: None)¶

class TeamsResponseMetaPagination(arg: ModelComposed)

class TeamsResponseMetaPagination(*args, **kwargs)

Bases: ModelNormal

Teams response metadata.

Parameters:

first_offset (int, optional) – The first offset.
last_offset (int, optional) – The last offset.
limit (int, optional) – Pagination limit.
next_offset (int, optional) – The next offset.
offset (int, optional) – The offset.
prev_offset (int, optional) – The previous offset.
total (int, optional) – Total results.
type (str, optional) – Offset type.

datadog_api_client.v2.model.threat_hunting_job_data_type module¶

class ThreatHuntingJobDataType(arg: None)¶

class ThreatHuntingJobDataType(arg: ModelComposed)

class ThreatHuntingJobDataType(*args, **kwargs)

Bases: ModelSimple

Type of payload.

Parameters:

value (str) – If omitted defaults to “historicalDetectionsJob”. Must be one of [“historicalDetectionsJob”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.threat_hunting_job_list_meta module¶

class ThreatHuntingJobListMeta(arg: None)¶

class ThreatHuntingJobListMeta(arg: ModelComposed)

class ThreatHuntingJobListMeta(*args, **kwargs)

Bases: ModelNormal

Metadata about the list of jobs.

Parameters:: total_count (int, optional) – Number of jobs in the list.

datadog_api_client.v2.model.threat_hunting_job_options module¶

class ThreatHuntingJobOptions(arg: None)¶

class ThreatHuntingJobOptions(arg: ModelComposed)

class ThreatHuntingJobOptions(*args, **kwargs)

Bases: ModelNormal

Job options.

Parameters:

detection_method (SecurityMonitoringRuleDetectionMethod, optional) – The detection method.
evaluation_window (SecurityMonitoringRuleEvaluationWindow, optional) – A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
impossible_travel_options (SecurityMonitoringRuleImpossibleTravelOptions, optional) – Options on impossible travel detection method.
keep_alive (SecurityMonitoringRuleKeepAlive, optional) – Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window. For third party detection method, this field is not used.
max_signal_duration (SecurityMonitoringRuleMaxSignalDuration, optional) – A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.
new_value_options (SecurityMonitoringRuleNewValueOptions, optional) – Options on new value detection method.
sequence_detection_options (SecurityMonitoringRuleSequenceDetectionOptions, optional) – Options on sequence detection method.
third_party_rule_options (SecurityMonitoringRuleThirdPartyOptions, optional) – Options on third party detection method.

datadog_api_client.v2.model.threat_hunting_job_query module¶

class ThreatHuntingJobQuery(arg: None)¶

class ThreatHuntingJobQuery(arg: ModelComposed)

class ThreatHuntingJobQuery(*args, **kwargs)

Bases: ModelNormal

Query for selecting logs analyzed by the threat hunting job.

Parameters:

aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.
data_source (SecurityMonitoringStandardDataSource, optional) – Source of events, either logs, audit trail, or Datadog events.
distinct_fields ([str], optional) – Field for which the cardinality is measured. Sent as an array.
group_by_fields ([str], optional) – Fields to group by.
has_optional_group_by_fields (bool, optional) – When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A , replacing the missing values.
metrics ([str], optional) – Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
name (str, optional) – Name of the query.
query (str, optional) – Query to run on logs.

datadog_api_client.v2.model.threat_hunting_job_response module¶

class ThreatHuntingJobResponse(arg: None)¶

class ThreatHuntingJobResponse(arg: ModelComposed)

class ThreatHuntingJobResponse(*args, **kwargs)

Bases: ModelNormal

Threat hunting job response.

Parameters:: data (ThreatHuntingJobResponseData, optional) – Threat hunting job response data.

datadog_api_client.v2.model.threat_hunting_job_response_attributes module¶

class ThreatHuntingJobResponseAttributes(arg: None)¶

class ThreatHuntingJobResponseAttributes(arg: ModelComposed)

class ThreatHuntingJobResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Threat hunting job attributes.

Parameters:

created_at (str, optional) – Time when the job was created.
created_by_handle (str, optional) – The handle of the user who created the job.
created_by_name (str, optional) – The name of the user who created the job.
created_from_rule_id (str, optional) – ID of the rule used to create the job (if it is created from a rule).
job_definition (JobDefinition, optional) – Definition of a threat hunting job.
job_name (str, optional) – Job name.
job_status (str, optional) – Job status.
modified_at (str, optional) – Last modification time of the job.
signal_output (bool, optional) – Whether the job outputs signals.

datadog_api_client.v2.model.threat_hunting_job_response_data module¶

class ThreatHuntingJobResponseData(arg: None)¶

class ThreatHuntingJobResponseData(arg: ModelComposed)

class ThreatHuntingJobResponseData(*args, **kwargs)

Bases: ModelNormal

Threat hunting job response data.

Parameters:

attributes (ThreatHuntingJobResponseAttributes, optional) – Threat hunting job attributes.
id (str, optional) – ID of the job.
type (ThreatHuntingJobDataType, optional) – Type of payload.

datadog_api_client.v2.model.time_restriction module¶

class TimeRestriction(arg: None)¶

class TimeRestriction(arg: ModelComposed)

class TimeRestriction(*args, **kwargs)

Bases: ModelNormal

Defines a single time restriction rule with start and end times and the applicable weekdays.

Parameters:

end_day (Weekday, optional) – A day of the week.
end_time (str, optional) – Specifies the ending time for this restriction.
start_day (Weekday, optional) – A day of the week.
start_time (str, optional) – Specifies the starting time for this restriction.

datadog_api_client.v2.model.time_restrictions module¶

class TimeRestrictions(arg: None)¶

class TimeRestrictions(arg: ModelComposed)

class TimeRestrictions(*args, **kwargs)

Bases: ModelNormal

Holds time zone information and a list of time restrictions for a routing rule.

Parameters:

restrictions ([TimeRestriction]) – Defines the list of time-based restrictions.
time_zone (str) – Specifies the time zone applicable to the restrictions.

datadog_api_client.v2.model.timeline_cell module¶

class TimelineCell(arg: None)¶

class TimelineCell(arg: ModelComposed)

class TimelineCell(*args, **kwargs)

Bases: ModelNormal

timeline cell

Parameters:

author (TimelineCellAuthor, optional) – author of the timeline cell
cell_content (TimelineCellContent, optional) – timeline cell content
created_at (datetime, optional) – Timestamp of when the cell was created
deleted_at (datetime, optional) – Timestamp of when the cell was deleted
modified_at (datetime, optional) – Timestamp of when the cell was last modified
type (TimelineCellType, optional) – Timeline cell content type

datadog_api_client.v2.model.timeline_cell_author module¶

class TimelineCellAuthor(arg: None)¶

class TimelineCellAuthor(arg: ModelComposed)

class TimelineCellAuthor(*args, **kwargs)

Bases: ModelComposed

author of the timeline cell

Parameters:

content (TimelineCellAuthorUserContent, optional) – user author content.
type (TimelineCellAuthorUserType, optional) – user author type.

datadog_api_client.v2.model.timeline_cell_author_user module¶

class TimelineCellAuthorUser(arg: None)¶

class TimelineCellAuthorUser(arg: ModelComposed)

class TimelineCellAuthorUser(*args, **kwargs)

Bases: ModelNormal

timeline cell user author

Parameters:

content (TimelineCellAuthorUserContent, optional) – user author content.
type (TimelineCellAuthorUserType, optional) – user author type.

datadog_api_client.v2.model.timeline_cell_author_user_content module¶

class TimelineCellAuthorUserContent(arg: None)¶

class TimelineCellAuthorUserContent(arg: ModelComposed)

class TimelineCellAuthorUserContent(*args, **kwargs)

Bases: ModelNormal

user author content.

Parameters:

email (str, optional) – user email
handle (str, optional) – user handle
id (str, optional) – user UUID
name (str, optional) – user name

datadog_api_client.v2.model.timeline_cell_author_user_type module¶

class TimelineCellAuthorUserType(arg: None)¶

class TimelineCellAuthorUserType(arg: ModelComposed)

class TimelineCellAuthorUserType(*args, **kwargs)

Bases: ModelSimple

user author type.

Parameters:

value (str) – If omitted defaults to “USER”. Must be one of [“USER”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeline_cell_content module¶

class TimelineCellContent(arg: None)¶

class TimelineCellContent(arg: ModelComposed)

class TimelineCellContent(*args, **kwargs)

Bases: ModelComposed

timeline cell content

Parameters:: message (str, optional) – comment message

datadog_api_client.v2.model.timeline_cell_content_comment module¶

class TimelineCellContentComment(arg: None)¶

class TimelineCellContentComment(arg: ModelComposed)

class TimelineCellContentComment(*args, **kwargs)

Bases: ModelNormal

comment content

Parameters:: message (str, optional) – comment message

datadog_api_client.v2.model.timeline_cell_resource module¶

class TimelineCellResource(arg: None)¶

class TimelineCellResource(arg: ModelComposed)

class TimelineCellResource(*args, **kwargs)

Bases: ModelNormal

Timeline cell JSON:API resource

Parameters:

attributes (TimelineCell) – timeline cell
id (str) – Timeline cell’s identifier
type (TimelineCellResourceType) – Timeline cell JSON:API resource type

datadog_api_client.v2.model.timeline_cell_resource_type module¶

class TimelineCellResourceType(arg: None)¶

class TimelineCellResourceType(arg: ModelComposed)

class TimelineCellResourceType(*args, **kwargs)

Bases: ModelSimple

Timeline cell JSON:API resource type

Parameters:

value (str) – If omitted defaults to “timeline_cell”. Must be one of [“timeline_cell”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeline_cell_type module¶

class TimelineCellType(arg: None)¶

class TimelineCellType(arg: ModelComposed)

class TimelineCellType(*args, **kwargs)

Bases: ModelSimple

Timeline cell content type

Parameters:

value (str) – If omitted defaults to “COMMENT”. Must be one of [“COMMENT”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeline_response module¶

class TimelineResponse(arg: None)¶

class TimelineResponse(arg: ModelComposed)

class TimelineResponse(*args, **kwargs)

Bases: ModelNormal

Timeline response

Parameters:: data ([TimelineCellResource], optional) – The TimelineResponse data.

datadog_api_client.v2.model.timeseries_formula_query_request module¶

class TimeseriesFormulaQueryRequest(arg: None)¶

class TimeseriesFormulaQueryRequest(arg: ModelComposed)

class TimeseriesFormulaQueryRequest(*args, **kwargs)

Bases: ModelNormal

A request wrapper around a single timeseries query to be executed.

Parameters:: data (TimeseriesFormulaRequest) – A single timeseries query to be executed.

datadog_api_client.v2.model.timeseries_formula_query_response module¶

class TimeseriesFormulaQueryResponse(arg: None)¶

class TimeseriesFormulaQueryResponse(arg: ModelComposed)

class TimeseriesFormulaQueryResponse(*args, **kwargs)

Bases: ModelNormal

A message containing one response to a timeseries query made with timeseries formula query request.

Parameters:

data (TimeseriesResponse, optional) – A message containing the response to a timeseries query.
errors (str, optional) – The error generated by the request.

datadog_api_client.v2.model.timeseries_formula_request module¶

class TimeseriesFormulaRequest(arg: None)¶

class TimeseriesFormulaRequest(arg: ModelComposed)

class TimeseriesFormulaRequest(*args, **kwargs)

Bases: ModelNormal

A single timeseries query to be executed.

Parameters:

attributes (TimeseriesFormulaRequestAttributes) – The object describing a timeseries formula request.
type (TimeseriesFormulaRequestType) – The type of the resource. The value should always be timeseries_request.

datadog_api_client.v2.model.timeseries_formula_request_attributes module¶

class TimeseriesFormulaRequestAttributes(arg: None)¶

class TimeseriesFormulaRequestAttributes(arg: ModelComposed)

class TimeseriesFormulaRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a timeseries formula request.

Parameters:

formulas ([QueryFormula], optional) – List of formulas to be calculated and returned as responses.
_from (int) – Start date (inclusive) of the query in milliseconds since the Unix epoch.
interval (int, optional) – A time interval in milliseconds. May be overridden by a larger interval if the query would result in too many points for the specified timeframe. Defaults to a reasonable interval for the given timeframe.
queries (TimeseriesFormulaRequestQueries) – List of queries to be run and used as inputs to the formulas.
to (int) – End date (exclusive) of the query in milliseconds since the Unix epoch.

datadog_api_client.v2.model.timeseries_formula_request_queries module¶

class TimeseriesFormulaRequestQueries(arg: None)¶

class TimeseriesFormulaRequestQueries(arg: ModelComposed)

class TimeseriesFormulaRequestQueries(*args, **kwargs)

Bases: ModelSimple

List of queries to be run and used as inputs to the formulas.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeseries_formula_request_type module¶

class TimeseriesFormulaRequestType(arg: None)¶

class TimeseriesFormulaRequestType(arg: ModelComposed)

class TimeseriesFormulaRequestType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be timeseries_request.

Parameters:

value (str) – If omitted defaults to “timeseries_request”. Must be one of [“timeseries_request”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeseries_formula_response_type module¶

class TimeseriesFormulaResponseType(arg: None)¶

class TimeseriesFormulaResponseType(arg: ModelComposed)

class TimeseriesFormulaResponseType(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should always be timeseries_response.

Parameters:

value (str) – If omitted defaults to “timeseries_response”. Must be one of [“timeseries_response”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeseries_query module¶

class TimeseriesQuery(arg: None)¶

class TimeseriesQuery(arg: ModelComposed)

class TimeseriesQuery(*args, **kwargs)

Bases: ModelComposed

An individual timeseries query to one of the basic Datadog data sources.

Parameters:

data_source (MetricsDataSource) – A data source that is powered by the Metrics platform.
name (str, optional) – The variable name for use in formulas.
query (str) – A classic metrics query string.
compute (EventsCompute) – The instructions for what to compute for this query.
group_by (EventsQueryGroupBys, optional) – The list of facets on which to split results.
indexes ([str], optional) – The indexes in which to search.
search (EventsSearch, optional) – Configuration of the search/filter for an events query.

datadog_api_client.v2.model.timeseries_response module¶

class TimeseriesResponse(arg: None)¶

class TimeseriesResponse(arg: ModelComposed)

class TimeseriesResponse(*args, **kwargs)

Bases: ModelNormal

A message containing the response to a timeseries query.

Parameters:

attributes (TimeseriesResponseAttributes, optional) – The object describing a timeseries response.
type (TimeseriesFormulaResponseType, optional) – The type of the resource. The value should always be timeseries_response.

datadog_api_client.v2.model.timeseries_response_attributes module¶

class TimeseriesResponseAttributes(arg: None)¶

class TimeseriesResponseAttributes(arg: ModelComposed)

class TimeseriesResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a timeseries response.

Parameters:

series (TimeseriesResponseSeriesList, optional) – Array of response series. The index here corresponds to the index in the formulas or queries array from the request.
times (TimeseriesResponseTimes, optional) – Array of times, 1-1 match with individual values arrays.
values (TimeseriesResponseValuesList, optional) – Array of value-arrays. The index here corresponds to the index in the formulas or queries array from the request.

datadog_api_client.v2.model.timeseries_response_series module¶

class TimeseriesResponseSeries(arg: None)¶

class TimeseriesResponseSeries(arg: ModelComposed)

class TimeseriesResponseSeries(*args, **kwargs)

Bases: ModelNormal

Parameters:

group_tags (GroupTags, optional) – List of tags that apply to a single response value.
query_index (int, optional) – The index of the query in the “formulas” array (or “queries” array if no “formulas” was specified).
unit ([Unit, none_type], none_type, optional) – Detailed information about the unit. The first element describes the “primary unit” (for example, bytes in bytes per second ). The second element describes the “per unit” (for example, second in bytes per second ). If the second element is not present, the API returns null.

datadog_api_client.v2.model.timeseries_response_series_list module¶

class TimeseriesResponseSeriesList(arg: None)¶

class TimeseriesResponseSeriesList(arg: ModelComposed)

class TimeseriesResponseSeriesList(*args, **kwargs)

Bases: ModelSimple

Array of response series. The index here corresponds to the index in the formulas or queries array from the request.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeseries_response_times module¶

class TimeseriesResponseTimes(arg: None)¶

class TimeseriesResponseTimes(arg: ModelComposed)

class TimeseriesResponseTimes(*args, **kwargs)

Bases: ModelSimple

Array of times, 1-1 match with individual values arrays.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeseries_response_values module¶

class TimeseriesResponseValues(arg: None)¶

class TimeseriesResponseValues(arg: ModelComposed)

class TimeseriesResponseValues(*args, **kwargs)

Bases: ModelSimple

Array of values for an individual formula or query.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.timeseries_response_values_list module¶

class TimeseriesResponseValuesList(arg: None)¶

class TimeseriesResponseValuesList(arg: ModelComposed)

class TimeseriesResponseValuesList(*args, **kwargs)

Bases: ModelSimple

Array of value-arrays. The index here corresponds to the index in the formulas or queries array from the request.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.token_type module¶

class TokenType(arg: None)¶

class TokenType(arg: ModelComposed)

class TokenType(*args, **kwargs)

Bases: ModelSimple

The definition of TokenType object.

Parameters:

value (str) – If omitted defaults to “SECRET”. Must be one of [“SECRET”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.trigger module¶

class Trigger(arg: None)¶

class Trigger(arg: ModelComposed)

class Trigger(*args, **kwargs)

Bases: ModelComposed

One of the triggers that can start the execution of a workflow.

Parameters:

api_trigger (APITrigger) – Trigger a workflow from an API request. The workflow must be published.
start_step_names ([str], optional) – A list of steps that run first after a trigger fires.
app_trigger (dict) – Trigger a workflow from an App.
case_trigger (CaseTrigger) – Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
change_event_trigger (dict) – Trigger a workflow from a Change Event.
database_monitoring_trigger (dict) – Trigger a workflow from Database Monitoring.
datastore_trigger (DatastoreTrigger) – Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.
dashboard_trigger (dict) – Trigger a workflow from a Dashboard.
github_webhook_trigger (GithubWebhookTrigger) – Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a webhookSecret. In your GitHub Webhook Settings, set the Payload URL to “base_url”/api/v2/workflows/”workflow_id”/webhook?orgId=”org_id”, select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.
incident_trigger (IncidentTrigger) – Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published.
monitor_trigger (MonitorTrigger) – Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.
notebook_trigger (dict) – Trigger a workflow from a Notebook.
schedule_trigger (ScheduleTrigger) – Trigger a workflow from a Schedule. The workflow must be published.
security_trigger (SecurityTrigger) – Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.
self_service_trigger (dict) – Trigger a workflow from Self Service.
slack_trigger (dict) – Trigger a workflow from Slack. The workflow must be published.
software_catalog_trigger (dict) – Trigger a workflow from Software Catalog.
workflow_trigger (dict) – Trigger a workflow from the Datadog UI. Only required if no other trigger exists.

datadog_api_client.v2.model.trigger_rate_limit module¶

class TriggerRateLimit(arg: None)¶

class TriggerRateLimit(arg: ModelComposed)

class TriggerRateLimit(*args, **kwargs)

Bases: ModelNormal

Defines a rate limit for a trigger.

Parameters:

count (int, optional) – The TriggerRateLimit count.
interval (str, optional) – The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

datadog_api_client.v2.model.trigger_source module¶

class TriggerSource(arg: None)¶

class TriggerSource(arg: ModelComposed)

class TriggerSource(*args, **kwargs)

Bases: ModelSimple

The type of security issues on which the rule applies. Notification rules based on security signals need to use the trigger source “security_signals”,: while notification rules based on security vulnerabilities need to use the trigger source “security_findings”.

Parameters:

value (str) – Must be one of [“security_findings”, “security_signals”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.uc_config_pair module¶

class UCConfigPair(arg: None)¶

class UCConfigPair(arg: ModelComposed)

class UCConfigPair(*args, **kwargs)

Bases: ModelNormal

The definition of UCConfigPair object.

Parameters:: data (UCConfigPairData, optional) – The definition of UCConfigPairData object.

datadog_api_client.v2.model.uc_config_pair_data module¶

class UCConfigPairData(arg: None)¶

class UCConfigPairData(arg: ModelComposed)

class UCConfigPairData(*args, **kwargs)

Bases: ModelNormal

The definition of UCConfigPairData object.

Parameters:

attributes (UCConfigPairDataAttributes, optional) – The definition of UCConfigPairDataAttributes object.
id (str, optional) – The UCConfigPairData id.
type (UCConfigPairDataType) – Azure UC configs resource type.

datadog_api_client.v2.model.uc_config_pair_data_attributes module¶

class UCConfigPairDataAttributes(arg: None)¶

class UCConfigPairDataAttributes(arg: ModelComposed)

class UCConfigPairDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of UCConfigPairDataAttributes object.

Parameters:: configs ([UCConfigPairDataAttributesConfigsItems], optional) – The attributes configs.

datadog_api_client.v2.model.uc_config_pair_data_attributes_configs_items module¶

class UCConfigPairDataAttributesConfigsItems(arg: None)¶

class UCConfigPairDataAttributesConfigsItems(arg: ModelComposed)

class UCConfigPairDataAttributesConfigsItems(*args, **kwargs)

Bases: ModelNormal

The definition of UCConfigPairDataAttributesConfigsItems object.

Parameters:

account_id (str, optional) – The items account_id.
client_id (str, optional) – The items client_id.
created_at (str, optional) – The items created_at.
dataset_type (str, optional) – The items dataset_type.
error_messages ([str], none_type, optional) – The items error_messages.
export_name (str, optional) – The items export_name.
export_path (str, optional) – The items export_path.
id (str, optional) – The items id.
months (int, optional) – The items months.
scope (str, optional) – The items scope.
status (str, optional) – The items status.
status_updated_at (str, optional) – The items status_updated_at.
storage_account (str, optional) – The items storage_account.
storage_container (str, optional) – The items storage_container.
updated_at (str, optional) – The items updated_at.

datadog_api_client.v2.model.uc_config_pair_data_type module¶

class UCConfigPairDataType(arg: None)¶

class UCConfigPairDataType(arg: ModelComposed)

class UCConfigPairDataType(*args, **kwargs)

Bases: ModelSimple

Azure UC configs resource type.

Parameters:

value (str) – If omitted defaults to “azure_uc_configs”. Must be one of [“azure_uc_configs”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.unit module¶

class Unit(arg: None)¶

class Unit(arg: ModelComposed)

class Unit(*args, **kwargs)

Bases: ModelNormal

Object containing the metric unit family, scale factor, name, and short name.

Parameters:

family (str, optional) – Unit family, allows for conversion between units of the same family, for scaling.
name (str, optional) – Unit name
plural (str, optional) – Plural form of the unit name.
scale_factor (float, optional) – Factor for scaling between units of the same family.
short_name (str, optional) – Abbreviation of the unit.

datadog_api_client.v2.model.unpublish_app_response module¶

class UnpublishAppResponse(arg: None)¶

class UnpublishAppResponse(arg: ModelComposed)

class UnpublishAppResponse(*args, **kwargs)

Bases: ModelNormal

The response object after an app is successfully unpublished.

Parameters:: data (Deployment, optional) – The version of the app that was published.

datadog_api_client.v2.model.update_action_connection_request module¶

class UpdateActionConnectionRequest(arg: None)¶

class UpdateActionConnectionRequest(arg: ModelComposed)

class UpdateActionConnectionRequest(*args, **kwargs)

Bases: ModelNormal

Request used to update an action connection.

Parameters:: data (ActionConnectionDataUpdate) – Data related to the connection update.

datadog_api_client.v2.model.update_action_connection_response module¶

class UpdateActionConnectionResponse(arg: None)¶

class UpdateActionConnectionResponse(arg: ModelComposed)

class UpdateActionConnectionResponse(*args, **kwargs)

Bases: ModelNormal

The response for an updated connection.

Parameters:: data (ActionConnectionData, optional) – Data related to the connection.

datadog_api_client.v2.model.update_app_request module¶

class UpdateAppRequest(arg: None)¶

class UpdateAppRequest(arg: ModelComposed)

class UpdateAppRequest(*args, **kwargs)

Bases: ModelNormal

A request object for updating an existing app.

Parameters:: data (UpdateAppRequestData, optional) – The data object containing the new app definition. Any fields not included in the request remain unchanged.

datadog_api_client.v2.model.update_app_request_data module¶

class UpdateAppRequestData(arg: None)¶

class UpdateAppRequestData(arg: ModelComposed)

class UpdateAppRequestData(*args, **kwargs)

Bases: ModelNormal

The data object containing the new app definition. Any fields not included in the request remain unchanged.

Parameters:

attributes (UpdateAppRequestDataAttributes, optional) – App definition attributes to be updated, such as name, description, and components.
id (UUID, optional) – The ID of the app to update. The app ID must match the ID in the URL path.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.update_app_request_data_attributes module¶

class UpdateAppRequestDataAttributes(arg: None)¶

class UpdateAppRequestDataAttributes(arg: ModelComposed)

class UpdateAppRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

App definition attributes to be updated, such as name, description, and components.

Parameters:

components ([ComponentGrid], optional) – The new UI components that make up the app. If this field is set, all existing components are replaced with the new components under this field.
description (str, optional) – The new human-readable description for the app.
name (str, optional) – The new name of the app.
queries ([Query], optional) – The new array of queries, such as external actions and state variables, that the app uses. If this field is set, all existing queries are replaced with the new queries under this field.
root_instance_name (str, optional) – The new name of the root component of the app. This must be a grid component that contains all other components.
tags ([str], optional) – The new list of tags for the app, which can be used to filter apps. If this field is set, any existing tags not included in the request are removed.

datadog_api_client.v2.model.update_app_response module¶

class UpdateAppResponse(arg: None)¶

class UpdateAppResponse(arg: ModelComposed)

class UpdateAppResponse(*args, **kwargs)

Bases: ModelNormal

The response object after an app is successfully updated.

Parameters:

data (UpdateAppResponseData, optional) – The data object containing the updated app definition.
included ([Deployment], optional) – Data on the version of the app that was published.
meta (AppMeta, optional) – Metadata of an app.
relationship (AppRelationship, optional) – The app’s publication relationship and custom connections.

datadog_api_client.v2.model.update_app_response_data module¶

class UpdateAppResponseData(arg: None)¶

class UpdateAppResponseData(arg: ModelComposed)

class UpdateAppResponseData(*args, **kwargs)

Bases: ModelNormal

The data object containing the updated app definition.

Parameters:

attributes (UpdateAppResponseDataAttributes) – The updated app definition attributes, such as name, description, and components.
id (UUID) – The ID of the updated app.
type (AppDefinitionType) – The app definition type.

datadog_api_client.v2.model.update_app_response_data_attributes module¶

class UpdateAppResponseDataAttributes(arg: None)¶

class UpdateAppResponseDataAttributes(arg: ModelComposed)

class UpdateAppResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The updated app definition attributes, such as name, description, and components.

Parameters:

components ([ComponentGrid], optional) – The UI components that make up the app.
description (str, optional) – The human-readable description for the app.
favorite (bool, optional) – Whether the app is marked as a favorite by the current user.
name (str, optional) – The name of the app.
queries ([Query], optional) – An array of queries, such as external actions and state variables, that the app uses.
root_instance_name (str, optional) – The name of the root component of the app. This must be a grid component that contains all other components.
tags ([str], optional) – A list of tags for the app, which can be used to filter apps.

datadog_api_client.v2.model.update_apps_datastore_item_request module¶

class UpdateAppsDatastoreItemRequest(arg: None)¶

class UpdateAppsDatastoreItemRequest(arg: ModelComposed)

class UpdateAppsDatastoreItemRequest(*args, **kwargs)

Bases: ModelNormal

Request to update specific fields on an existing datastore item.

Parameters:: data (UpdateAppsDatastoreItemRequestData, optional) – Data wrapper containing the item identifier and the changes to apply during the update operation.

datadog_api_client.v2.model.update_apps_datastore_item_request_data module¶

class UpdateAppsDatastoreItemRequestData(arg: None)¶

class UpdateAppsDatastoreItemRequestData(arg: ModelComposed)

class UpdateAppsDatastoreItemRequestData(*args, **kwargs)

Bases: ModelNormal

Data wrapper containing the item identifier and the changes to apply during the update operation.

Parameters:

attributes (UpdateAppsDatastoreItemRequestDataAttributes, optional) – Attributes for updating a datastore item, including the item key and changes to apply.
id (str, optional) – The unique identifier of the datastore item.
type (UpdateAppsDatastoreItemRequestDataType) – The resource type for datastore items.

datadog_api_client.v2.model.update_apps_datastore_item_request_data_attributes module¶

class UpdateAppsDatastoreItemRequestDataAttributes(arg: None)¶

class UpdateAppsDatastoreItemRequestDataAttributes(arg: ModelComposed)

class UpdateAppsDatastoreItemRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for updating a datastore item, including the item key and changes to apply.

Parameters:

id (str, optional) – The unique identifier of the item being updated.
item_changes (UpdateAppsDatastoreItemRequestDataAttributesItemChanges) – Changes to apply to a datastore item using set operations.
item_key (str) – The primary key that identifies the item to update. Cannot exceed 256 characters.

datadog_api_client.v2.model.update_apps_datastore_item_request_data_attributes_item_changes module¶

class UpdateAppsDatastoreItemRequestDataAttributesItemChanges(arg: None)¶

class UpdateAppsDatastoreItemRequestDataAttributesItemChanges(arg: ModelComposed)

class UpdateAppsDatastoreItemRequestDataAttributesItemChanges(*args, **kwargs)

Bases: ModelNormal

Changes to apply to a datastore item using set operations.

Parameters:: ops_set ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Set operation that contains key-value pairs to set on the datastore item.

datadog_api_client.v2.model.update_apps_datastore_item_request_data_type module¶

class UpdateAppsDatastoreItemRequestDataType(arg: None)¶

class UpdateAppsDatastoreItemRequestDataType(arg: ModelComposed)

class UpdateAppsDatastoreItemRequestDataType(*args, **kwargs)

Bases: ModelSimple

The resource type for datastore items.

Parameters:

value (str) – If omitted defaults to “items”. Must be one of [“items”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.update_apps_datastore_request module¶

class UpdateAppsDatastoreRequest(arg: None)¶

class UpdateAppsDatastoreRequest(arg: ModelComposed)

class UpdateAppsDatastoreRequest(*args, **kwargs)

Bases: ModelNormal

Request to update a datastore’s configuration such as its name or description.

Parameters:: data (UpdateAppsDatastoreRequestData, optional) – Data wrapper containing the datastore identifier and the attributes to update.

datadog_api_client.v2.model.update_apps_datastore_request_data module¶

class UpdateAppsDatastoreRequestData(arg: None)¶

class UpdateAppsDatastoreRequestData(arg: ModelComposed)

class UpdateAppsDatastoreRequestData(*args, **kwargs)

Bases: ModelNormal

Data wrapper containing the datastore identifier and the attributes to update.

Parameters:

attributes (UpdateAppsDatastoreRequestDataAttributes, optional) – Attributes that can be updated on a datastore.
id (str, optional) – The unique identifier of the datastore to update.
type (DatastoreDataType) – The resource type for datastores.

datadog_api_client.v2.model.update_apps_datastore_request_data_attributes module¶

class UpdateAppsDatastoreRequestDataAttributes(arg: None)¶

class UpdateAppsDatastoreRequestDataAttributes(arg: ModelComposed)

class UpdateAppsDatastoreRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes that can be updated on a datastore.

Parameters:

description (str, optional) – A human-readable description about the datastore.
name (str, optional) – The display name of the datastore.

datadog_api_client.v2.model.update_connection_request module¶

class UpdateConnectionRequest(arg: None)¶

class UpdateConnectionRequest(arg: ModelComposed)

class UpdateConnectionRequest(*args, **kwargs)

Bases: ModelNormal

Parameters:: data (UpdateConnectionRequestData, optional)

datadog_api_client.v2.model.update_connection_request_data module¶

class UpdateConnectionRequestData(arg: None)¶

class UpdateConnectionRequestData(arg: ModelComposed)

class UpdateConnectionRequestData(*args, **kwargs)

Bases: ModelNormal

Parameters:

attributes (UpdateConnectionRequestDataAttributes, optional)
id (str)
type (UpdateConnectionRequestDataType) – Connection id resource type.

datadog_api_client.v2.model.update_connection_request_data_attributes module¶

class UpdateConnectionRequestDataAttributes(arg: None)¶

class UpdateConnectionRequestDataAttributes(arg: ModelComposed)

class UpdateConnectionRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters:

fields_to_add ([CreateConnectionRequestDataAttributesFieldsItems], optional)
fields_to_delete ([str], optional)
fields_to_update ([UpdateConnectionRequestDataAttributesFieldsToUpdateItems], optional)

datadog_api_client.v2.model.update_connection_request_data_attributes_fields_to_update_items module¶

class UpdateConnectionRequestDataAttributesFieldsToUpdateItems(arg: None)¶

class UpdateConnectionRequestDataAttributesFieldsToUpdateItems(arg: ModelComposed)

class UpdateConnectionRequestDataAttributesFieldsToUpdateItems(*args, **kwargs)

Bases: ModelNormal

Parameters:

field_id (str)
updated_description (str, optional)
updated_display_name (str, optional)
updated_field_id (str, optional)
updated_groups ([str], optional)

datadog_api_client.v2.model.update_connection_request_data_type module¶

class UpdateConnectionRequestDataType(arg: None)¶

class UpdateConnectionRequestDataType(arg: ModelComposed)

class UpdateConnectionRequestDataType(*args, **kwargs)

Bases: ModelSimple

Connection id resource type.

Parameters:

value (str) – If omitted defaults to “connection_id”. Must be one of [“connection_id”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.update_custom_framework_request module¶

class UpdateCustomFrameworkRequest(arg: None)¶

class UpdateCustomFrameworkRequest(arg: ModelComposed)

class UpdateCustomFrameworkRequest(*args, **kwargs)

Bases: ModelNormal

Request object to update a custom framework.

Parameters:: data (CustomFrameworkData) – Contains type and attributes for custom frameworks.

datadog_api_client.v2.model.update_custom_framework_response module¶

class UpdateCustomFrameworkResponse(arg: None)¶

class UpdateCustomFrameworkResponse(arg: ModelComposed)

class UpdateCustomFrameworkResponse(*args, **kwargs)

Bases: ModelNormal

Response object to update a custom framework.

Parameters:: data (FrameworkHandleAndVersionResponseData) – Contains type and attributes for custom frameworks.

datadog_api_client.v2.model.update_deployment_gate_params module¶

class UpdateDeploymentGateParams(arg: None)¶

class UpdateDeploymentGateParams(arg: ModelComposed)

class UpdateDeploymentGateParams(*args, **kwargs)

Bases: ModelNormal

Parameters for updating a deployment gate.

Parameters:: data (UpdateDeploymentGateParamsData) – Parameters for updating a deployment gate.

datadog_api_client.v2.model.update_deployment_gate_params_data module¶

class UpdateDeploymentGateParamsData(arg: None)¶

class UpdateDeploymentGateParamsData(arg: ModelComposed)

class UpdateDeploymentGateParamsData(*args, **kwargs)

Bases: ModelNormal

Parameters for updating a deployment gate.

Parameters:

attributes (UpdateDeploymentGateParamsDataAttributes) – Attributes for updating a deployment gate.
id (str) – Unique identifier of the deployment gate.
type (DeploymentGateDataType) – Deployment gate resource type.

datadog_api_client.v2.model.update_deployment_gate_params_data_attributes module¶

class UpdateDeploymentGateParamsDataAttributes(arg: None)¶

class UpdateDeploymentGateParamsDataAttributes(arg: ModelComposed)

class UpdateDeploymentGateParamsDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for updating a deployment gate.

Parameters:: dry_run (bool) – Whether to run in dry-run mode.

datadog_api_client.v2.model.update_deployment_rule_params module¶

class UpdateDeploymentRuleParams(arg: None)¶

class UpdateDeploymentRuleParams(arg: ModelComposed)

class UpdateDeploymentRuleParams(*args, **kwargs)

Bases: ModelNormal

Parameters for updating a deployment rule.

Parameters:: data (UpdateDeploymentRuleParamsData) – Parameters for updating a deployment rule.

datadog_api_client.v2.model.update_deployment_rule_params_data module¶

class UpdateDeploymentRuleParamsData(arg: None)¶

class UpdateDeploymentRuleParamsData(arg: ModelComposed)

class UpdateDeploymentRuleParamsData(*args, **kwargs)

Bases: ModelNormal

Parameters for updating a deployment rule.

Parameters:

attributes (UpdateDeploymentRuleParamsDataAttributes) – Parameters for updating a deployment rule.
type (DeploymentRuleDataType) – Deployment rule resource type.

datadog_api_client.v2.model.update_deployment_rule_params_data_attributes module¶

class UpdateDeploymentRuleParamsDataAttributes(arg: None)¶

class UpdateDeploymentRuleParamsDataAttributes(arg: ModelComposed)

class UpdateDeploymentRuleParamsDataAttributes(*args, **kwargs)

Bases: ModelNormal

Parameters for updating a deployment rule.

Parameters:

dry_run (bool) – Whether to run this rule in dry-run mode.
name (str) – The name of the deployment rule.
options (DeploymentRulesOptions) – Options for deployment rule response representing either faulty deployment detection or monitor options.

datadog_api_client.v2.model.update_open_api_response module¶

class UpdateOpenAPIResponse(arg: None)¶

class UpdateOpenAPIResponse(arg: ModelComposed)

class UpdateOpenAPIResponse(*args, **kwargs)

Bases: ModelNormal

Response for UpdateOpenAPI.

Parameters:: data (UpdateOpenAPIResponseData, optional) – Data envelope for UpdateOpenAPIResponse.

datadog_api_client.v2.model.update_open_api_response_attributes module¶

class UpdateOpenAPIResponseAttributes(arg: None)¶

class UpdateOpenAPIResponseAttributes(arg: ModelComposed)

class UpdateOpenAPIResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for UpdateOpenAPI.

Parameters:: failed_endpoints ([OpenAPIEndpoint], optional) – List of endpoints which couldn’t be parsed.

datadog_api_client.v2.model.update_open_api_response_data module¶

class UpdateOpenAPIResponseData(arg: None)¶

class UpdateOpenAPIResponseData(arg: ModelComposed)

class UpdateOpenAPIResponseData(*args, **kwargs)

Bases: ModelNormal

Data envelope for UpdateOpenAPIResponse.

Parameters:

attributes (UpdateOpenAPIResponseAttributes, optional) – Attributes for UpdateOpenAPI.
id (UUID, optional) – API identifier.

datadog_api_client.v2.model.update_outcomes_async_attributes module¶

class UpdateOutcomesAsyncAttributes(arg: None)¶

class UpdateOutcomesAsyncAttributes(arg: ModelComposed)

class UpdateOutcomesAsyncAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes for a batched set of scorecard outcomes.

Parameters:: results ([UpdateOutcomesAsyncRequestItem], optional) – Set of scorecard outcomes to update asynchronously.

datadog_api_client.v2.model.update_outcomes_async_request module¶

class UpdateOutcomesAsyncRequest(arg: None)¶

class UpdateOutcomesAsyncRequest(arg: ModelComposed)

class UpdateOutcomesAsyncRequest(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request.

Parameters:: data (UpdateOutcomesAsyncRequestData, optional) – Scorecard outcomes batch request data.

datadog_api_client.v2.model.update_outcomes_async_request_data module¶

class UpdateOutcomesAsyncRequestData(arg: None)¶

class UpdateOutcomesAsyncRequestData(arg: ModelComposed)

class UpdateOutcomesAsyncRequestData(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request data.

Parameters:

attributes (UpdateOutcomesAsyncAttributes, optional) – The JSON:API attributes for a batched set of scorecard outcomes.
type (UpdateOutcomesAsyncType, optional) – The JSON:API type for scorecard outcomes.

datadog_api_client.v2.model.update_outcomes_async_request_item module¶

class UpdateOutcomesAsyncRequestItem(arg: None)¶

class UpdateOutcomesAsyncRequestItem(arg: ModelComposed)

class UpdateOutcomesAsyncRequestItem(*args, **kwargs)

Bases: ModelNormal

Scorecard outcome for a single entity and rule.

Parameters:

entity_reference (str) – The unique reference for an IDP entity.
remarks (str, optional) – Any remarks regarding the scorecard rule’s evaluation. Supports HTML hyperlinks.
rule_id (str) – The unique ID for a scorecard rule.
state (State) – The state of the rule evaluation.

datadog_api_client.v2.model.update_outcomes_async_type module¶

class UpdateOutcomesAsyncType(arg: None)¶

class UpdateOutcomesAsyncType(arg: ModelComposed)

class UpdateOutcomesAsyncType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type for scorecard outcomes.

Parameters:

value (str) – If omitted defaults to “batched-outcome”. Must be one of [“batched-outcome”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.update_resource_evaluation_filters_request module¶

class UpdateResourceEvaluationFiltersRequest(arg: None)¶

class UpdateResourceEvaluationFiltersRequest(arg: ModelComposed)

class UpdateResourceEvaluationFiltersRequest(*args, **kwargs)

Bases: ModelNormal

Request object to update a resource filter.

Parameters:: data (UpdateResourceEvaluationFiltersRequestData) – The definition of UpdateResourceFilterRequestData object.

datadog_api_client.v2.model.update_resource_evaluation_filters_request_data module¶

class UpdateResourceEvaluationFiltersRequestData(arg: None)¶

class UpdateResourceEvaluationFiltersRequestData(arg: ModelComposed)

class UpdateResourceEvaluationFiltersRequestData(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateResourceFilterRequestData object.

Parameters:

attributes (ResourceFilterAttributes) – Attributes of a resource filter.
id (str, optional) – The UpdateResourceEvaluationFiltersRequestData id.
type (ResourceFilterRequestType) – Constant string to identify the request type.

datadog_api_client.v2.model.update_resource_evaluation_filters_response module¶

class UpdateResourceEvaluationFiltersResponse(arg: None)¶

class UpdateResourceEvaluationFiltersResponse(arg: ModelComposed)

class UpdateResourceEvaluationFiltersResponse(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateResourceEvaluationFiltersResponse object.

Parameters:: data (UpdateResourceEvaluationFiltersResponseData) – The definition of UpdateResourceFilterResponseData object.

datadog_api_client.v2.model.update_resource_evaluation_filters_response_data module¶

class UpdateResourceEvaluationFiltersResponseData(arg: None)¶

class UpdateResourceEvaluationFiltersResponseData(arg: ModelComposed)

class UpdateResourceEvaluationFiltersResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateResourceFilterResponseData object.

Parameters:

attributes (ResourceFilterAttributes) – Attributes of a resource filter.
id (str, optional) – The data id.
type (ResourceFilterRequestType) – Constant string to identify the request type.

datadog_api_client.v2.model.update_rule_request module¶

class UpdateRuleRequest(arg: None)¶

class UpdateRuleRequest(arg: ModelComposed)

class UpdateRuleRequest(*args, **kwargs)

Bases: ModelNormal

Request to update a scorecard rule.

Parameters:: data (UpdateRuleRequestData, optional) – Data for the request to update a scorecard rule.

datadog_api_client.v2.model.update_rule_request_data module¶

class UpdateRuleRequestData(arg: None)¶

class UpdateRuleRequestData(arg: ModelComposed)

class UpdateRuleRequestData(*args, **kwargs)

Bases: ModelNormal

Data for the request to update a scorecard rule.

Parameters:

attributes (RuleAttributes, optional) – Details of a rule.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.update_rule_response module¶

class UpdateRuleResponse(arg: None)¶

class UpdateRuleResponse(arg: ModelComposed)

class UpdateRuleResponse(*args, **kwargs)

Bases: ModelNormal

The response from a rule update request.

Parameters:: data (UpdateRuleResponseData, optional) – The data for a rule update response.

datadog_api_client.v2.model.update_rule_response_data module¶

class UpdateRuleResponseData(arg: None)¶

class UpdateRuleResponseData(arg: ModelComposed)

class UpdateRuleResponseData(*args, **kwargs)

Bases: ModelNormal

The data for a rule update response.

Parameters:

attributes (RuleAttributes, optional) – Details of a rule.
id (str, optional) – The unique ID for a scorecard rule.
relationships (RelationshipToRule, optional) – Scorecard create rule response relationship.
type (RuleType, optional) – The JSON:API type for scorecard rules.

datadog_api_client.v2.model.update_ruleset_request module¶

class UpdateRulesetRequest(arg: None)¶

class UpdateRulesetRequest(arg: ModelComposed)

class UpdateRulesetRequest(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequest object.

Parameters:: data (UpdateRulesetRequestData, optional) – The definition of UpdateRulesetRequestData object.

datadog_api_client.v2.model.update_ruleset_request_data module¶

class UpdateRulesetRequestData(arg: None)¶

class UpdateRulesetRequestData(arg: ModelComposed)

class UpdateRulesetRequestData(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestData object.

Parameters:

attributes (UpdateRulesetRequestDataAttributes, optional) – The definition of UpdateRulesetRequestDataAttributes object.
id (str, optional) – The UpdateRulesetRequestData id.
type (UpdateRulesetRequestDataType) – Update ruleset resource type.

datadog_api_client.v2.model.update_ruleset_request_data_attributes module¶

class UpdateRulesetRequestDataAttributes(arg: None)¶

class UpdateRulesetRequestDataAttributes(arg: ModelComposed)

class UpdateRulesetRequestDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributes object.

Parameters:

enabled (bool) – The attributes enabled.
last_version (int, optional) – The attributes last_version.
rules ([UpdateRulesetRequestDataAttributesRulesItems]) – The attributes rules.

datadog_api_client.v2.model.update_ruleset_request_data_attributes_rules_items module¶

class UpdateRulesetRequestDataAttributesRulesItems(arg: None)¶

class UpdateRulesetRequestDataAttributesRulesItems(arg: ModelComposed)

class UpdateRulesetRequestDataAttributesRulesItems(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributesRulesItems object.

Parameters:

enabled (bool) – The items enabled.
mapping (UpdateRulesetRequestDataAttributesRulesItemsMapping, none_type, optional) – The definition of UpdateRulesetRequestDataAttributesRulesItemsMapping object.
metadata (RulesetItemMetadata, none_type, optional) – The items metadata.
name (str) – The items name.
query (UpdateRulesetRequestDataAttributesRulesItemsQuery, none_type, optional) – The definition of UpdateRulesetRequestDataAttributesRulesItemsQuery object.
reference_table (UpdateRulesetRequestDataAttributesRulesItemsReferenceTable, none_type, optional) – The definition of UpdateRulesetRequestDataAttributesRulesItemsReferenceTable object.

datadog_api_client.v2.model.update_ruleset_request_data_attributes_rules_items_mapping module¶

class UpdateRulesetRequestDataAttributesRulesItemsMapping(arg: None)¶

class UpdateRulesetRequestDataAttributesRulesItemsMapping(arg: ModelComposed)

class UpdateRulesetRequestDataAttributesRulesItemsMapping(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributesRulesItemsMapping object.

Parameters:

destination_key (str) – The mapping destination_key.
if_not_exists (bool) – The mapping if_not_exists.
source_keys ([str]) – The mapping source_keys.

datadog_api_client.v2.model.update_ruleset_request_data_attributes_rules_items_query module¶

class UpdateRulesetRequestDataAttributesRulesItemsQuery(arg: None)¶

class UpdateRulesetRequestDataAttributesRulesItemsQuery(arg: ModelComposed)

class UpdateRulesetRequestDataAttributesRulesItemsQuery(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributesRulesItemsQuery object.

Parameters:

addition (UpdateRulesetRequestDataAttributesRulesItemsQueryAddition, none_type) – The definition of UpdateRulesetRequestDataAttributesRulesItemsQueryAddition object.
case_insensitivity (bool, optional) – The query case_insensitivity.
if_not_exists (bool) – The query if_not_exists.
query (str) – The query query.

datadog_api_client.v2.model.update_ruleset_request_data_attributes_rules_items_query_addition module¶

class UpdateRulesetRequestDataAttributesRulesItemsQueryAddition(arg: None)¶

class UpdateRulesetRequestDataAttributesRulesItemsQueryAddition(arg: ModelComposed)

class UpdateRulesetRequestDataAttributesRulesItemsQueryAddition(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributesRulesItemsQueryAddition object.

Parameters:

key (str) – The addition key.
value (str) – The addition value.

datadog_api_client.v2.model.update_ruleset_request_data_attributes_rules_items_reference_table module¶

class UpdateRulesetRequestDataAttributesRulesItemsReferenceTable(arg: None)¶

class UpdateRulesetRequestDataAttributesRulesItemsReferenceTable(arg: ModelComposed)

class UpdateRulesetRequestDataAttributesRulesItemsReferenceTable(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributesRulesItemsReferenceTable object.

Parameters:

case_insensitivity (bool, optional) – The reference_table case_insensitivity.
field_pairs ([UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems]) – The reference_table field_pairs.
if_not_exists (bool, optional) – The reference_table if_not_exists.
source_keys ([str]) – The reference_table source_keys.
table_name (str) – The reference_table table_name.

datadog_api_client.v2.model.update_ruleset_request_data_attributes_rules_items_reference_table_field_pairs_items module¶

class UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems(arg: None)¶

class UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems(arg: ModelComposed)

class UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems(*args, **kwargs)

Bases: ModelNormal

The definition of UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems object.

Parameters:

input_column (str) – The items input_column.
output_key (str) – The items output_key.

datadog_api_client.v2.model.update_ruleset_request_data_type module¶

class UpdateRulesetRequestDataType(arg: None)¶

class UpdateRulesetRequestDataType(arg: ModelComposed)

class UpdateRulesetRequestDataType(*args, **kwargs)

Bases: ModelSimple

Update ruleset resource type.

Parameters:

value (str) – If omitted defaults to “update_ruleset”. Must be one of [“update_ruleset”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.update_workflow_request module¶

class UpdateWorkflowRequest(arg: None)¶

class UpdateWorkflowRequest(arg: ModelComposed)

class UpdateWorkflowRequest(*args, **kwargs)

Bases: ModelNormal

A request object for updating an existing workflow.

Parameters:: data (WorkflowDataUpdate) – Data related to the workflow being updated.

datadog_api_client.v2.model.update_workflow_response module¶

class UpdateWorkflowResponse(arg: None)¶

class UpdateWorkflowResponse(arg: ModelComposed)

class UpdateWorkflowResponse(*args, **kwargs)

Bases: ModelNormal

The response object after updating a workflow.

Parameters:: data (WorkflowDataUpdate, optional) – Data related to the workflow being updated.

datadog_api_client.v2.model.upsert_catalog_entity_request module¶

class UpsertCatalogEntityRequest(arg: None)¶

class UpsertCatalogEntityRequest(arg: ModelComposed)

class UpsertCatalogEntityRequest(*args, **kwargs)

Bases: ModelComposed

Create or update entity request.

datadog_api_client.v2.model.upsert_catalog_entity_response module¶

class UpsertCatalogEntityResponse(arg: None)¶

class UpsertCatalogEntityResponse(arg: ModelComposed)

class UpsertCatalogEntityResponse(*args, **kwargs)

Bases: ModelNormal

Upsert entity response.

Parameters:

data ([EntityData], optional) – List of entity data.
included ([UpsertCatalogEntityResponseIncludedItem], optional) – Upsert entity response included.
meta (EntityResponseMeta, optional) – Entity metadata.

datadog_api_client.v2.model.upsert_catalog_entity_response_included_item module¶

class UpsertCatalogEntityResponseIncludedItem(arg: None)¶

class UpsertCatalogEntityResponseIncludedItem(arg: ModelComposed)

class UpsertCatalogEntityResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

Upsert entity response included item.

Parameters:

attributes (EntityResponseIncludedSchemaAttributes, optional) – Included schema.
id (str, optional) – Entity ID.
type (EntityResponseIncludedSchemaType, optional) – Schema type.

datadog_api_client.v2.model.upsert_catalog_kind_request module¶

class UpsertCatalogKindRequest(arg: None)¶

class UpsertCatalogKindRequest(arg: ModelComposed)

class UpsertCatalogKindRequest(*args, **kwargs)

Bases: ModelComposed

Create or update kind request.

Parameters:

description (str, optional) – Short description of the kind.
display_name (str, optional) – The display name of the kind. Automatically generated if not provided.
kind (str) – The name of the kind to create or update. This must be in kebab-case format.

datadog_api_client.v2.model.upsert_catalog_kind_response module¶

class UpsertCatalogKindResponse(arg: None)¶

class UpsertCatalogKindResponse(arg: ModelComposed)

class UpsertCatalogKindResponse(*args, **kwargs)

Bases: ModelNormal

Upsert kind response.

Parameters:

data ([KindData], optional) – List of kind responses.
meta (KindResponseMeta, optional) – Kind response metadata.

datadog_api_client.v2.model.urgency module¶

class Urgency(arg: None)¶

class Urgency(arg: ModelComposed)

class Urgency(*args, **kwargs)

Bases: ModelSimple

Specifies the level of urgency for a routing rule (low, high, or dynamic).

Parameters:

value (str) – Must be one of [“low”, “high”, “dynamic”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.url_param module¶

class UrlParam(arg: None)¶

class UrlParam(arg: ModelComposed)

class UrlParam(*args, **kwargs)

Bases: ModelNormal

The definition of UrlParam object.

Parameters:

name (str) – Name for tokens.
value (str) – The UrlParam value.

datadog_api_client.v2.model.url_param_update module¶

class UrlParamUpdate(arg: None)¶

class UrlParamUpdate(arg: ModelComposed)

class UrlParamUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of UrlParamUpdate object.

Parameters:

deleted (bool, optional) – Should the header be deleted.
name (str) – Name for tokens.
value (str, optional) – The UrlParamUpdate value.

datadog_api_client.v2.model.usage_application_security_monitoring_response module¶

class UsageApplicationSecurityMonitoringResponse(arg: None)¶

class UsageApplicationSecurityMonitoringResponse(arg: ModelComposed)

class UsageApplicationSecurityMonitoringResponse(*args, **kwargs)

Bases: ModelNormal

Application Security Monitoring usage response.

Parameters:: data ([UsageDataObject], optional) – Response containing Application Security Monitoring usage.

datadog_api_client.v2.model.usage_attributes_object module¶

class UsageAttributesObject(arg: None)¶

class UsageAttributesObject(arg: ModelComposed)

class UsageAttributesObject(*args, **kwargs)

Bases: ModelNormal

Usage attributes data.

Parameters:

org_name (str, optional) – The organization name.
product_family (str, optional) – The product for which usage is being reported.
public_id (str, optional) – The organization public ID.
region (str, optional) – The region of the Datadog instance that the organization belongs to.
timeseries ([UsageTimeSeriesObject], optional) – List of usage data reported for each requested hour.
usage_type (HourlyUsageType, optional) – Usage type that is being measured.

datadog_api_client.v2.model.usage_data_object module¶

class UsageDataObject(arg: None)¶

class UsageDataObject(arg: ModelComposed)

class UsageDataObject(*args, **kwargs)

Bases: ModelNormal

Usage data.

Parameters:

attributes (UsageAttributesObject, optional) – Usage attributes data.
id (str, optional) – Unique ID of the response.
type (UsageTimeSeriesType, optional) – Type of usage data.

datadog_api_client.v2.model.usage_lambda_traced_invocations_response module¶

class UsageLambdaTracedInvocationsResponse(arg: None)¶

class UsageLambdaTracedInvocationsResponse(arg: ModelComposed)

class UsageLambdaTracedInvocationsResponse(*args, **kwargs)

Bases: ModelNormal

Lambda Traced Invocations usage response.

Parameters:: data ([UsageDataObject], optional) – Response containing Lambda Traced Invocations usage.

datadog_api_client.v2.model.usage_observability_pipelines_response module¶

class UsageObservabilityPipelinesResponse(arg: None)¶

class UsageObservabilityPipelinesResponse(arg: ModelComposed)

class UsageObservabilityPipelinesResponse(*args, **kwargs)

Bases: ModelNormal

Observability Pipelines usage response.

Parameters:: data ([UsageDataObject], optional) – Response containing Observability Pipelines usage.

datadog_api_client.v2.model.usage_time_series_object module¶

class UsageTimeSeriesObject(arg: None)¶

class UsageTimeSeriesObject(arg: ModelComposed)

class UsageTimeSeriesObject(*args, **kwargs)

Bases: ModelNormal

Usage timeseries data.

Parameters:

timestamp (datetime, optional) – Datetime in ISO-8601 format, UTC. The hour for the usage.
value (int, none_type, optional) – Contains the number measured for the given usage_type during the hour.

datadog_api_client.v2.model.usage_time_series_type module¶

class UsageTimeSeriesType(arg: None)¶

class UsageTimeSeriesType(arg: ModelComposed)

class UsageTimeSeriesType(*args, **kwargs)

Bases: ModelSimple

Type of usage data.

Parameters:

value (str) – If omitted defaults to “usage_timeseries”. Must be one of [“usage_timeseries”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user module¶

class User(arg: None)¶

class User(arg: ModelComposed)

class User(*args, **kwargs)

Bases: ModelNormal

User object returned by the API.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.user_attributes module¶

class UserAttributes(arg: None)¶

class UserAttributes(arg: ModelComposed)

class UserAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of user object returned by the API.

Parameters:

created_at (datetime, optional) – Creation time of the user.
disabled (bool, optional) – Whether the user is disabled.
email (str, optional) – Email of the user.
handle (str, optional) – Handle of the user.
icon (str, optional) – URL of the user’s icon.
last_login_time (datetime, none_type, optional) – The last time the user logged in.
mfa_enabled (bool, optional) – If user has MFA enabled.
modified_at (datetime, optional) – Time that the user was last modified.
name (str, none_type, optional) – Name of the user.
service_account (bool, optional) – Whether the user is a service account.
status (str, optional) – Status of the user.
title (str, none_type, optional) – Title of the user.
verified (bool, optional) – Whether the user is verified.

datadog_api_client.v2.model.user_attributes_status module¶

class UserAttributesStatus(arg: None)¶

class UserAttributesStatus(arg: ModelComposed)

class UserAttributesStatus(*args, **kwargs)

Bases: ModelSimple

The user’s status.

Parameters:

value (str) – Must be one of [“active”, “deactivated”, “pending”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_create_attributes module¶

class UserCreateAttributes(arg: None)¶

class UserCreateAttributes(arg: ModelComposed)

class UserCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the created user.

Parameters:

email (str) – The email of the user.
name (str, optional) – The name of the user.
title (str, optional) – The title of the user.

datadog_api_client.v2.model.user_create_data module¶

class UserCreateData(arg: None)¶

class UserCreateData(arg: ModelComposed)

class UserCreateData(*args, **kwargs)

Bases: ModelNormal

Object to create a user.

Parameters:

attributes (UserCreateAttributes) – Attributes of the created user.
relationships (UserRelationships, optional) – Relationships of the user object.
type (UsersType) – Users resource type.

datadog_api_client.v2.model.user_create_request module¶

class UserCreateRequest(arg: None)¶

class UserCreateRequest(arg: ModelComposed)

class UserCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create a user.

Parameters:: data (UserCreateData) – Object to create a user.

datadog_api_client.v2.model.user_invitation_data module¶

class UserInvitationData(arg: None)¶

class UserInvitationData(arg: ModelComposed)

class UserInvitationData(*args, **kwargs)

Bases: ModelNormal

Object to create a user invitation.

Parameters:

relationships (UserInvitationRelationships) – Relationships data for user invitation.
type (UserInvitationsType) – User invitations type.

datadog_api_client.v2.model.user_invitation_data_attributes module¶

class UserInvitationDataAttributes(arg: None)¶

class UserInvitationDataAttributes(arg: ModelComposed)

class UserInvitationDataAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a user invitation.

Parameters:

created_at (datetime, optional) – Creation time of the user invitation.
expires_at (datetime, optional) – Time of invitation expiration.
invite_type (str, optional) – Type of invitation.
uuid (str, optional) – UUID of the user invitation.

datadog_api_client.v2.model.user_invitation_relationships module¶

class UserInvitationRelationships(arg: None)¶

class UserInvitationRelationships(arg: ModelComposed)

class UserInvitationRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships data for user invitation.

Parameters:: user (RelationshipToUser) – Relationship to user.

datadog_api_client.v2.model.user_invitation_response module¶

class UserInvitationResponse(arg: None)¶

class UserInvitationResponse(arg: ModelComposed)

class UserInvitationResponse(*args, **kwargs)

Bases: ModelNormal

User invitation as returned by the API.

Parameters:: data (UserInvitationResponseData, optional) – Object of a user invitation returned by the API.

datadog_api_client.v2.model.user_invitation_response_data module¶

class UserInvitationResponseData(arg: None)¶

class UserInvitationResponseData(arg: ModelComposed)

class UserInvitationResponseData(*args, **kwargs)

Bases: ModelNormal

Object of a user invitation returned by the API.

Parameters:

attributes (UserInvitationDataAttributes, optional) – Attributes of a user invitation.
id (str, optional) – ID of the user invitation.
relationships (UserInvitationRelationships, optional) – Relationships data for user invitation.
type (UserInvitationsType, optional) – User invitations type.

datadog_api_client.v2.model.user_invitations_request module¶

class UserInvitationsRequest(arg: None)¶

class UserInvitationsRequest(arg: ModelComposed)

class UserInvitationsRequest(*args, **kwargs)

Bases: ModelNormal

Object to invite users to join the organization.

Parameters:: data ([UserInvitationData]) – List of user invitations.

datadog_api_client.v2.model.user_invitations_response module¶

class UserInvitationsResponse(arg: None)¶

class UserInvitationsResponse(arg: ModelComposed)

class UserInvitationsResponse(*args, **kwargs)

Bases: ModelNormal

User invitations as returned by the API.

Parameters:: data ([UserInvitationResponseData], optional) – Array of user invitations.

datadog_api_client.v2.model.user_invitations_type module¶

class UserInvitationsType(arg: None)¶

class UserInvitationsType(arg: ModelComposed)

class UserInvitationsType(*args, **kwargs)

Bases: ModelSimple

User invitations type.

Parameters:

value (str) – If omitted defaults to “user_invitations”. Must be one of [“user_invitations”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_relationship_data module¶

class UserRelationshipData(arg: None)¶

class UserRelationshipData(arg: ModelComposed)

class UserRelationshipData(*args, **kwargs)

Bases: ModelNormal

Relationship to user object.

Parameters:

id (str) – A unique identifier that represents the user.
type (UserResourceType) – User resource type.

datadog_api_client.v2.model.user_relationships module¶

class UserRelationships(arg: None)¶

class UserRelationships(arg: ModelComposed)

class UserRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the user object.

Parameters:: roles (RelationshipToRoles, optional) – Relationship to roles.

datadog_api_client.v2.model.user_resource_type module¶

class UserResourceType(arg: None)¶

class UserResourceType(arg: ModelComposed)

class UserResourceType(*args, **kwargs)

Bases: ModelSimple

User resource type.

Parameters:

value (str) – If omitted defaults to “user”. Must be one of [“user”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_response module¶

class UserResponse(arg: None)¶

class UserResponse(arg: ModelComposed)

class UserResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a single user.

Parameters:

data (User, optional) – User object returned by the API.
included ([UserResponseIncludedItem], optional) – Array of objects related to the user.

datadog_api_client.v2.model.user_response_included_item module¶

class UserResponseIncludedItem(arg: None)¶

class UserResponseIncludedItem(arg: ModelComposed)

class UserResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to a user.

Parameters:

attributes (OrganizationAttributes, optional) – Attributes of the organization.
id (str, optional) – ID of the organization.
type (OrganizationsType) – Organizations resource type.
relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.

datadog_api_client.v2.model.user_response_relationships module¶

class UserResponseRelationships(arg: None)¶

class UserResponseRelationships(arg: ModelComposed)

class UserResponseRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the user object returned by the API.

Parameters:

org (RelationshipToOrganization, optional) – Relationship to an organization.
other_orgs (RelationshipToOrganizations, optional) – Relationship to organizations.
other_users (RelationshipToUsers, optional) – Relationship to users.
roles (RelationshipToRoles, optional) – Relationship to roles.

datadog_api_client.v2.model.user_target module¶

class UserTarget(arg: None)¶

class UserTarget(arg: ModelComposed)

class UserTarget(*args, **kwargs)

Bases: ModelNormal

Represents a user target for an escalation policy step, including the user’s ID and resource type.

Parameters:

id (str) – Specifies the unique identifier of the user resource.
type (UserTargetType) – Indicates that the resource is of type users.

datadog_api_client.v2.model.user_target_type module¶

class UserTargetType(arg: None)¶

class UserTargetType(arg: ModelComposed)

class UserTargetType(*args, **kwargs)

Bases: ModelSimple

Indicates that the resource is of type users.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_team module¶

class UserTeam(arg: None)¶

class UserTeam(arg: ModelComposed)

class UserTeam(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

attributes (UserTeamAttributes, optional) – Team membership attributes
id (str) – The ID of a user’s relationship with a team
relationships (UserTeamRelationships, optional) – Relationship between membership and a user
type (UserTeamType) – Team membership type

datadog_api_client.v2.model.user_team_attributes module¶

class UserTeamAttributes(arg: None)¶

class UserTeamAttributes(arg: ModelComposed)

class UserTeamAttributes(*args, **kwargs)

Bases: ModelNormal

Team membership attributes

Parameters:

provisioned_by (str, none_type, optional) – The mechanism responsible for provisioning the team relationship. Possible values: null for added by a user, “service_account” if added by a service account, and “saml_mapping” if provisioned via SAML mapping.
provisioned_by_id (str, none_type, optional) – UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role (UserTeamRole, none_type, optional) – The user’s role within the team

datadog_api_client.v2.model.user_team_create module¶

class UserTeamCreate(arg: None)¶

class UserTeamCreate(arg: ModelComposed)

class UserTeamCreate(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

attributes (UserTeamAttributes, optional) – Team membership attributes
relationships (UserTeamRelationships, optional) – Relationship between membership and a user
type (UserTeamType) – Team membership type

datadog_api_client.v2.model.user_team_included module¶

class UserTeamIncluded(arg: None)¶

class UserTeamIncluded(arg: ModelComposed)

class UserTeamIncluded(*args, **kwargs)

Bases: ModelComposed

Included resources related to the team membership

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

datadog_api_client.v2.model.user_team_permission module¶

class UserTeamPermission(arg: None)¶

class UserTeamPermission(arg: ModelComposed)

class UserTeamPermission(*args, **kwargs)

Bases: ModelNormal

A user’s permissions for a given team

Parameters:

attributes (UserTeamPermissionAttributes, optional) – User team permission attributes
id (str) – The user team permission’s identifier
type (UserTeamPermissionType) – User team permission type

datadog_api_client.v2.model.user_team_permission_attributes module¶

class UserTeamPermissionAttributes(arg: None)¶

class UserTeamPermissionAttributes(arg: ModelComposed)

class UserTeamPermissionAttributes(*args, **kwargs)

Bases: ModelNormal

User team permission attributes

Parameters:: permissions (dict, optional) – Object of team permission actions and boolean values that a logged in user can perform on this team.

datadog_api_client.v2.model.user_team_permission_type module¶

class UserTeamPermissionType(arg: None)¶

class UserTeamPermissionType(arg: ModelComposed)

class UserTeamPermissionType(*args, **kwargs)

Bases: ModelSimple

User team permission type

Parameters:

value (str) – If omitted defaults to “user_team_permissions”. Must be one of [“user_team_permissions”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_team_relationships module¶

class UserTeamRelationships(arg: None)¶

class UserTeamRelationships(arg: ModelComposed)

class UserTeamRelationships(*args, **kwargs)

Bases: ModelNormal

Relationship between membership and a user

Parameters:

team (RelationshipToUserTeamTeam, optional) – Relationship between team membership and team
user (RelationshipToUserTeamUser, optional) – Relationship between team membership and user

datadog_api_client.v2.model.user_team_request module¶

class UserTeamRequest(arg: None)¶

class UserTeamRequest(arg: ModelComposed)

class UserTeamRequest(*args, **kwargs)

Bases: ModelNormal

Team membership request

Parameters:: data (UserTeamCreate) – A user’s relationship with a team

datadog_api_client.v2.model.user_team_response module¶

class UserTeamResponse(arg: None)¶

class UserTeamResponse(arg: ModelComposed)

class UserTeamResponse(*args, **kwargs)

Bases: ModelNormal

Team membership response

Parameters:

data (UserTeam, optional) – A user’s relationship with a team
included ([UserTeamIncluded], optional) – Resources related to the team memberships

datadog_api_client.v2.model.user_team_role module¶

class UserTeamRole(arg: None)¶

class UserTeamRole(arg: ModelComposed)

class UserTeamRole(*args, **kwargs)

Bases: ModelSimple

The user’s role within the team

Parameters:

value (str) – If omitted defaults to “admin”. Must be one of [“admin”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_team_team_type module¶

class UserTeamTeamType(arg: None)¶

class UserTeamTeamType(arg: ModelComposed)

class UserTeamTeamType(*args, **kwargs)

Bases: ModelSimple

User team team type

Parameters:

value (str) – If omitted defaults to “team”. Must be one of [“team”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_team_type module¶

class UserTeamType(arg: None)¶

class UserTeamType(arg: ModelComposed)

class UserTeamType(*args, **kwargs)

Bases: ModelSimple

Team membership type

Parameters:

value (str) – If omitted defaults to “team_memberships”. Must be one of [“team_memberships”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_team_update module¶

class UserTeamUpdate(arg: None)¶

class UserTeamUpdate(arg: ModelComposed)

class UserTeamUpdate(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

attributes (UserTeamAttributes, optional) – Team membership attributes
type (UserTeamType) – Team membership type

datadog_api_client.v2.model.user_team_update_request module¶

class UserTeamUpdateRequest(arg: None)¶

class UserTeamUpdateRequest(arg: ModelComposed)

class UserTeamUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Team membership request

Parameters:: data (UserTeamUpdate) – A user’s relationship with a team

datadog_api_client.v2.model.user_team_user_type module¶

class UserTeamUserType(arg: None)¶

class UserTeamUserType(arg: ModelComposed)

class UserTeamUserType(*args, **kwargs)

Bases: ModelSimple

User team user type

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.user_teams_response module¶

class UserTeamsResponse(arg: None)¶

class UserTeamsResponse(arg: ModelComposed)

class UserTeamsResponse(*args, **kwargs)

Bases: ModelNormal

Team memberships response

Parameters:

data ([UserTeam], optional) – Team memberships response data
included ([UserTeamIncluded], optional) – Resources related to the team memberships
links (TeamsResponseLinks, optional) – Teams response links.
meta (TeamsResponseMeta, optional) – Teams response metadata.

datadog_api_client.v2.model.user_update_attributes module¶

class UserUpdateAttributes(arg: None)¶

class UserUpdateAttributes(arg: ModelComposed)

class UserUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the edited user.

Parameters:

disabled (bool, optional) – If the user is enabled or disabled.
email (str, optional) – The email of the user.
name (str, optional) – The name of the user.

datadog_api_client.v2.model.user_update_data module¶

class UserUpdateData(arg: None)¶

class UserUpdateData(arg: ModelComposed)

class UserUpdateData(*args, **kwargs)

Bases: ModelNormal

Object to update a user.

Parameters:

attributes (UserUpdateAttributes) – Attributes of the edited user.
id (str) – ID of the user.
type (UsersType) – Users resource type.

datadog_api_client.v2.model.user_update_request module¶

class UserUpdateRequest(arg: None)¶

class UserUpdateRequest(arg: ModelComposed)

class UserUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update a user.

Parameters:: data (UserUpdateData) – Object to update a user.

datadog_api_client.v2.model.users_relationship module¶

class UsersRelationship(arg: None)¶

class UsersRelationship(arg: ModelComposed)

class UsersRelationship(*args, **kwargs)

Bases: ModelNormal

Relationship to users.

Parameters:: data ([UserRelationshipData]) – Relationships to user objects.

datadog_api_client.v2.model.users_response module¶

class UsersResponse(arg: None)¶

class UsersResponse(arg: ModelComposed)

class UsersResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about multiple users.

Parameters:

data ([User], optional) – Array of returned users.
included ([UserResponseIncludedItem], optional) – Array of objects related to the users.
meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

datadog_api_client.v2.model.users_type module¶

class UsersType(arg: None)¶

class UsersType(arg: ModelComposed)

class UsersType(*args, **kwargs)

Bases: ModelSimple

Users resource type.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.v2_event module¶

class V2Event(arg: None)¶

class V2Event(arg: ModelComposed)

class V2Event(*args, **kwargs)

Bases: ModelNormal

An event object.

Parameters:

attributes (V2EventAttributes, optional) – Event attributes.
id (str, optional) – The event’s ID.
type (str, optional) – Entity type.

datadog_api_client.v2.model.v2_event_attributes module¶

class V2EventAttributes(arg: None)¶

class V2EventAttributes(arg: ModelComposed)

class V2EventAttributes(*args, **kwargs)

Bases: ModelNormal

Event attributes.

Parameters:

attributes (V2EventAttributesAttributes, optional) – JSON object for category-specific attributes.
message (str, optional) – Free-form text associated with the event.
tags ([str], optional) – A list of tags associated with the event.
timestamp (str, optional) – Timestamp when the event occurred.

datadog_api_client.v2.model.v2_event_attributes_attributes module¶

class V2EventAttributesAttributes(arg: None)¶

class V2EventAttributesAttributes(arg: ModelComposed)

class V2EventAttributesAttributes(*args, **kwargs)

Bases: ModelComposed

JSON object for category-specific attributes.

Parameters:

aggregation_key (str, optional) – Aggregation key of the event.
author (ChangeEventAttributesAuthor, optional) – The entity that made the change.
change_metadata (dict, optional) – JSON object of change metadata.
changed_resource (ChangeEventAttributesChangedResource, optional) – A uniquely identified resource.
evt (EventSystemAttributes, optional) – JSON object of event system attributes.
impacted_resources ([ChangeEventAttributesImpactedResourcesItem], optional) – A list of resources impacted by this change.
new_value (dict, optional) – The new state of the changed resource.
prev_value (dict, optional) – The previous state of the changed resource.
service (str, optional) – Service that triggered the event.
timestamp (int, optional) – POSIX timestamp of the event.
title (str, optional) – The title of the event.
custom (dict, optional) – JSON object of custom attributes.
links ([AlertEventAttributesLinksItem], optional) – The links related to the event.
priority (AlertEventAttributesPriority, optional) – The priority of the alert.
status (AlertEventAttributesStatus, optional) – The status of the alert.

datadog_api_client.v2.model.v2_event_response module¶

class V2EventResponse(arg: None)¶

class V2EventResponse(arg: ModelComposed)

class V2EventResponse(*args, **kwargs)

Bases: ModelNormal

Get an event response.

Parameters:: data (V2Event, optional) – An event object.

datadog_api_client.v2.model.validation_error module¶

class ValidationError(arg: None)¶

class ValidationError(arg: ModelComposed)

class ValidationError(*args, **kwargs)

Bases: ModelNormal

Represents a single validation error, including a human-readable title and metadata.

Parameters:

meta (ValidationErrorMeta) – Describes additional metadata for validation errors, including field names and error messages.
title (str) – A short, human-readable summary of the error.

datadog_api_client.v2.model.validation_error_meta module¶

class ValidationErrorMeta(arg: None)¶

class ValidationErrorMeta(arg: ModelComposed)

class ValidationErrorMeta(*args, **kwargs)

Bases: ModelNormal

Describes additional metadata for validation errors, including field names and error messages.

Parameters:

field (str, optional) – The field name that caused the error.
id (str, optional) – The ID of the component in which the error occurred.
message (str) – The detailed error message.

datadog_api_client.v2.model.validation_response module¶

class ValidationResponse(arg: None)¶

class ValidationResponse(arg: ModelComposed)

class ValidationResponse(*args, **kwargs)

Bases: ModelNormal

Response containing validation errors.

Parameters:: errors ([ValidationError], optional) – The ValidationResponse errors.

datadog_api_client.v2.model.virus_total_api_key module¶

class VirusTotalAPIKey(arg: None)¶

class VirusTotalAPIKey(arg: ModelComposed)

class VirusTotalAPIKey(*args, **kwargs)

Bases: ModelNormal

The definition of the VirusTotalAPIKey object.

Parameters:

api_key (str) – The VirusTotalAPIKey api_key.
type (VirusTotalAPIKeyType) – The definition of the VirusTotalAPIKey object.

datadog_api_client.v2.model.virus_total_api_key_type module¶

class VirusTotalAPIKeyType(arg: None)¶

class VirusTotalAPIKeyType(arg: ModelComposed)

class VirusTotalAPIKeyType(*args, **kwargs)

Bases: ModelSimple

The definition of the VirusTotalAPIKey object.

Parameters:

value (str) – If omitted defaults to “VirusTotalAPIKey”. Must be one of [“VirusTotalAPIKey”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.virus_total_api_key_update module¶

class VirusTotalAPIKeyUpdate(arg: None)¶

class VirusTotalAPIKeyUpdate(arg: ModelComposed)

class VirusTotalAPIKeyUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the VirusTotalAPIKey object.

Parameters:

api_key (str, optional) – The VirusTotalAPIKeyUpdate api_key.
type (VirusTotalAPIKeyType) – The definition of the VirusTotalAPIKey object.

datadog_api_client.v2.model.virus_total_credentials module¶

class VirusTotalCredentials(arg: None)¶

class VirusTotalCredentials(arg: ModelComposed)

class VirusTotalCredentials(*args, **kwargs)

Bases: ModelComposed

The definition of the VirusTotalCredentials object.

Parameters:

api_key (str) – The VirusTotalAPIKey api_key.
type (VirusTotalAPIKeyType) – The definition of the VirusTotalAPIKey object.

datadog_api_client.v2.model.virus_total_credentials_update module¶

class VirusTotalCredentialsUpdate(arg: None)¶

class VirusTotalCredentialsUpdate(arg: ModelComposed)

class VirusTotalCredentialsUpdate(*args, **kwargs)

Bases: ModelComposed

The definition of the VirusTotalCredentialsUpdate object.

Parameters:

api_key (str, optional) – The VirusTotalAPIKeyUpdate api_key.
type (VirusTotalAPIKeyType) – The definition of the VirusTotalAPIKey object.

datadog_api_client.v2.model.virus_total_integration module¶

class VirusTotalIntegration(arg: None)¶

class VirusTotalIntegration(arg: ModelComposed)

class VirusTotalIntegration(*args, **kwargs)

Bases: ModelNormal

The definition of the VirusTotalIntegration object.

Parameters:

credentials (VirusTotalCredentials) – The definition of the VirusTotalCredentials object.
type (VirusTotalIntegrationType) – The definition of the VirusTotalIntegrationType object.

datadog_api_client.v2.model.virus_total_integration_type module¶

class VirusTotalIntegrationType(arg: None)¶

class VirusTotalIntegrationType(arg: ModelComposed)

class VirusTotalIntegrationType(*args, **kwargs)

Bases: ModelSimple

The definition of the VirusTotalIntegrationType object.

Parameters:

value (str) – If omitted defaults to “VirusTotal”. Must be one of [“VirusTotal”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.virus_total_integration_update module¶

class VirusTotalIntegrationUpdate(arg: None)¶

class VirusTotalIntegrationUpdate(arg: ModelComposed)

class VirusTotalIntegrationUpdate(*args, **kwargs)

Bases: ModelNormal

The definition of the VirusTotalIntegrationUpdate object.

Parameters:

credentials (VirusTotalCredentialsUpdate, optional) – The definition of the VirusTotalCredentialsUpdate object.
type (VirusTotalIntegrationType) – The definition of the VirusTotalIntegrationType object.

datadog_api_client.v2.model.vulnerabilities_type module¶

class VulnerabilitiesType(arg: None)¶

class VulnerabilitiesType(arg: ModelComposed)

class VulnerabilitiesType(*args, **kwargs)

Bases: ModelSimple

The JSON:API type.

Parameters:

value (str) – If omitted defaults to “vulnerabilities”. Must be one of [“vulnerabilities”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.vulnerability module¶

class Vulnerability(arg: None)¶

class Vulnerability(arg: ModelComposed)

class Vulnerability(*args, **kwargs)

Bases: ModelNormal

A single vulnerability

Parameters:

attributes (VulnerabilityAttributes) – The JSON:API attributes of the vulnerability.
id (str) – The unique ID for this vulnerability.
relationships (VulnerabilityRelationships) – Related entities object.
type (VulnerabilitiesType) – The JSON:API type.

datadog_api_client.v2.model.vulnerability_advisory module¶

class VulnerabilityAdvisory(arg: None)¶

class VulnerabilityAdvisory(arg: ModelComposed)

class VulnerabilityAdvisory(*args, **kwargs)

Bases: ModelNormal

Advisory associated with the vulnerability.

Parameters:

id (str) – Vulnerability advisory ID.
last_modification_date (str, optional) – Vulnerability advisory last modification date.
publish_date (str, optional) – Vulnerability advisory publish date.

datadog_api_client.v2.model.vulnerability_attributes module¶

class VulnerabilityAttributes(arg: None)¶

class VulnerabilityAttributes(arg: ModelComposed)

class VulnerabilityAttributes(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes of the vulnerability.

Parameters:

advisory (VulnerabilityAdvisory, optional) – Advisory associated with the vulnerability.
advisory_id (str, optional) – Vulnerability advisory ID.
code_location (CodeLocation, optional) – Code vulnerability location.
cve_list ([str]) – Vulnerability CVE list.
cvss (VulnerabilityCvss) – Vulnerability severities.
dependency_locations (VulnerabilityDependencyLocations, optional) – Static library vulnerability location.
description (str) – Vulnerability description.
ecosystem (VulnerabilityEcosystem, optional) – The related vulnerability asset ecosystem.
exposure_time (int) – Vulnerability exposure time in seconds.
first_detection (str) – First detection of the vulnerability in RFC 3339 format
fix_available (bool) – Whether the vulnerability has a remediation or not.
language (str) – Vulnerability language.
last_detection (str) –
Last detection of the vulnerability in RFC 3339 format
library (Library, optional) – Vulnerability library.
origin ([str]) – Vulnerability origin.
remediations ([Remediation]) – List of remediations.
repo_digests ([str], optional) – Vulnerability repo_digest list (when the vulnerability is related to Image asset).
risks (VulnerabilityRisks) – Vulnerability risks.
status (VulnerabilityStatus) – The vulnerability status.
title (str) – Vulnerability title.
tool (VulnerabilityTool) – The vulnerability tool.
type (VulnerabilityType) – The vulnerability type.

datadog_api_client.v2.model.vulnerability_cvss module¶

class VulnerabilityCvss(arg: None)¶

class VulnerabilityCvss(arg: ModelComposed)

class VulnerabilityCvss(*args, **kwargs)

Bases: ModelNormal

Vulnerability severities.

Parameters:

base (CVSS) – Vulnerability severity.
datadog (CVSS) – Vulnerability severity.

datadog_api_client.v2.model.vulnerability_dependency_locations module¶

class VulnerabilityDependencyLocations(arg: None)¶

class VulnerabilityDependencyLocations(arg: ModelComposed)

class VulnerabilityDependencyLocations(*args, **kwargs)

Bases: ModelNormal

Static library vulnerability location.

Parameters:

block (DependencyLocation) – Static library vulnerability location.
name (DependencyLocation, optional) – Static library vulnerability location.
version (DependencyLocation, optional) – Static library vulnerability location.

datadog_api_client.v2.model.vulnerability_ecosystem module¶

class VulnerabilityEcosystem(arg: None)¶

class VulnerabilityEcosystem(arg: ModelComposed)

class VulnerabilityEcosystem(*args, **kwargs)

Bases: ModelSimple

The related vulnerability asset ecosystem.

Parameters:

value (str) – Must be one of [“PyPI”, “Maven”, “NuGet”, “Npm”, “RubyGems”, “Go”, “Packagist”, “Ddeb”, “Rpm”, “Apk”, “Windows”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.vulnerability_relationships module¶

class VulnerabilityRelationships(arg: None)¶

class VulnerabilityRelationships(arg: ModelComposed)

class VulnerabilityRelationships(*args, **kwargs)

Bases: ModelNormal

Related entities object.

Parameters:: affects (VulnerabilityRelationshipsAffects) – Relationship type.

datadog_api_client.v2.model.vulnerability_relationships_affects module¶

class VulnerabilityRelationshipsAffects(arg: None)¶

class VulnerabilityRelationshipsAffects(arg: ModelComposed)

class VulnerabilityRelationshipsAffects(*args, **kwargs)

Bases: ModelNormal

Relationship type.

Parameters:: data (VulnerabilityRelationshipsAffectsData) – Asset affected by this vulnerability.

datadog_api_client.v2.model.vulnerability_relationships_affects_data module¶

class VulnerabilityRelationshipsAffectsData(arg: None)¶

class VulnerabilityRelationshipsAffectsData(arg: ModelComposed)

class VulnerabilityRelationshipsAffectsData(*args, **kwargs)

Bases: ModelNormal

Asset affected by this vulnerability.

Parameters:

id (str) – The unique ID for this related asset.
type (AssetEntityType) – The JSON:API type.

datadog_api_client.v2.model.vulnerability_risks module¶

class VulnerabilityRisks(arg: None)¶

class VulnerabilityRisks(arg: ModelComposed)

class VulnerabilityRisks(*args, **kwargs)

Bases: ModelNormal

Vulnerability risks.

Parameters:

epss (EPSS, optional) – Vulnerability EPSS severity.
exploit_available (bool) – Vulnerability public exploit availability.
exploit_sources ([str]) – Vulnerability exploit sources.
exploitation_probability (bool) – Vulnerability exploitation probability.
poc_exploit_available (bool) – Vulnerability POC exploit availability.

datadog_api_client.v2.model.vulnerability_severity module¶

class VulnerabilitySeverity(arg: None)¶

class VulnerabilitySeverity(arg: ModelComposed)

class VulnerabilitySeverity(*args, **kwargs)

Bases: ModelSimple

The vulnerability severity.

Parameters:

value (str) – Must be one of [“Unknown”, “None”, “Low”, “Medium”, “High”, “Critical”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.vulnerability_status module¶

class VulnerabilityStatus(arg: None)¶

class VulnerabilityStatus(arg: ModelComposed)

class VulnerabilityStatus(*args, **kwargs)

Bases: ModelSimple

The vulnerability status.

Parameters:

value (str) – Must be one of [“Open”, “Muted”, “Remediated”, “InProgress”, “AutoClosed”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.vulnerability_tool module¶

class VulnerabilityTool(arg: None)¶

class VulnerabilityTool(arg: ModelComposed)

class VulnerabilityTool(*args, **kwargs)

Bases: ModelSimple

The vulnerability tool.

Parameters:

value (str) – Must be one of [“IAST”, “SCA”, “Infra”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.vulnerability_type module¶

class VulnerabilityType(arg: None)¶

class VulnerabilityType(arg: ModelComposed)

class VulnerabilityType(*args, **kwargs)

Bases: ModelSimple

The vulnerability type.

Parameters:

value (str) – Must be one of [“AdminConsoleActive”, “CodeInjection”, “CommandInjection”, “ComponentWithKnownVulnerability”, “DangerousWorkflows”, “DefaultAppDeployed”, “DefaultHtmlEscapeInvalid”, “DirectoryListingLeak”, “EmailHtmlInjection”, “EndOfLife”, “HardcodedPassword”, “HardcodedSecret”, “HeaderInjection”, “HstsHeaderMissing”, “InsecureAuthProtocol”, “InsecureCookie”, “InsecureJspLayout”, “LdapInjection”, “MaliciousPackage”, “MandatoryRemediation”, “NoHttpOnlyCookie”, “NoSameSiteCookie”, “NoSqlMongoDbInjection”, “PathTraversal”, “ReflectionInjection”, “RiskyLicense”, “SessionRewriting”, “SessionTimeout”, “SqlInjection”, “Ssrf”, “StackTraceLeak”, “TrustBoundaryViolation”, “Unmaintained”, “UntrustedDeserialization”, “UnvalidatedRedirect”, “VerbTampering”, “WeakCipher”, “WeakHash”, “WeakRandomness”, “XContentTypeHeaderMissing”, “XPathInjection”, “Xss”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.weekday module¶

class Weekday(arg: None)¶

class Weekday(arg: ModelComposed)

class Weekday(*args, **kwargs)

Bases: ModelSimple

A day of the week.

Parameters:

value (str) – Must be one of [“monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday”, “sunday”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.widget_live_span module¶

class WidgetLiveSpan(arg: None)¶

class WidgetLiveSpan(arg: ModelComposed)

class WidgetLiveSpan(*args, **kwargs)

Bases: ModelSimple

The available timeframes depend on the widget you are using.

Parameters:

value (str) – Must be one of [“1m”, “5m”, “10m”, “15m”, “30m”, “1h”, “4h”, “1d”, “2d”, “1w”, “1mo”, “3mo”, “6mo”, “1y”, “alert”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.workflow_data module¶

class WorkflowData(arg: None)¶

class WorkflowData(arg: ModelComposed)

class WorkflowData(*args, **kwargs)

Bases: ModelNormal

Data related to the workflow.

Parameters:

attributes (WorkflowDataAttributes) – The definition of WorkflowDataAttributes object.
id (str, optional) – The workflow identifier
relationships (WorkflowDataRelationships, optional) – The definition of WorkflowDataRelationships object.
type (WorkflowDataType) – The definition of WorkflowDataType object.

datadog_api_client.v2.model.workflow_data_attributes module¶

class WorkflowDataAttributes(arg: None)¶

class WorkflowDataAttributes(arg: ModelComposed)

class WorkflowDataAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of WorkflowDataAttributes object.

Parameters:

created_at (datetime, optional) – When the workflow was created.
description (str, optional) – Description of the workflow.
name (str) – Name of the workflow.
published (bool, optional) – Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec (Spec) – The spec defines what the workflow does.
tags ([str], optional) – Tags of the workflow.
updated_at (datetime, optional) – When the workflow was last updated.
webhook_secret (str, optional) – If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

datadog_api_client.v2.model.workflow_data_relationships module¶

class WorkflowDataRelationships(arg: None)¶

class WorkflowDataRelationships(arg: ModelComposed)

class WorkflowDataRelationships(*args, **kwargs)

Bases: ModelNormal

The definition of WorkflowDataRelationships object.

Parameters:

creator (WorkflowUserRelationship, optional) – The definition of WorkflowUserRelationship object.
owner (WorkflowUserRelationship, optional) – The definition of WorkflowUserRelationship object.

datadog_api_client.v2.model.workflow_data_type module¶

class WorkflowDataType(arg: None)¶

class WorkflowDataType(arg: ModelComposed)

class WorkflowDataType(*args, **kwargs)

Bases: ModelSimple

The definition of WorkflowDataType object.

Parameters:

value (str) – If omitted defaults to “workflows”. Must be one of [“workflows”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.workflow_data_update module¶

class WorkflowDataUpdate(arg: None)¶

class WorkflowDataUpdate(arg: ModelComposed)

class WorkflowDataUpdate(*args, **kwargs)

Bases: ModelNormal

Data related to the workflow being updated.

Parameters:

attributes (WorkflowDataUpdateAttributes) – The definition of WorkflowDataUpdateAttributes object.
id (str, optional) – The workflow identifier
relationships (WorkflowDataRelationships, optional) – The definition of WorkflowDataRelationships object.
type (WorkflowDataType) – The definition of WorkflowDataType object.

datadog_api_client.v2.model.workflow_data_update_attributes module¶

class WorkflowDataUpdateAttributes(arg: None)¶

class WorkflowDataUpdateAttributes(arg: ModelComposed)

class WorkflowDataUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The definition of WorkflowDataUpdateAttributes object.

Parameters:

created_at (datetime, optional) – When the workflow was created.
description (str, optional) – Description of the workflow.
name (str, optional) – Name of the workflow.
published (bool, optional) – Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published.
spec (Spec, optional) – The spec defines what the workflow does.
tags ([str], optional) – Tags of the workflow.
updated_at (datetime, optional) – When the workflow was last updated.
webhook_secret (str, optional) – If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

datadog_api_client.v2.model.workflow_instance_create_meta module¶

class WorkflowInstanceCreateMeta(arg: None)¶

class WorkflowInstanceCreateMeta(arg: ModelComposed)

class WorkflowInstanceCreateMeta(*args, **kwargs)

Bases: ModelNormal

Additional information for creating a workflow instance.

Parameters:: payload ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – The input parameters to the workflow.

datadog_api_client.v2.model.workflow_instance_create_request module¶

class WorkflowInstanceCreateRequest(arg: None)¶

class WorkflowInstanceCreateRequest(arg: ModelComposed)

class WorkflowInstanceCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to create a workflow instance.

Parameters:: meta (WorkflowInstanceCreateMeta, optional) – Additional information for creating a workflow instance.

datadog_api_client.v2.model.workflow_instance_create_response module¶

class WorkflowInstanceCreateResponse(arg: None)¶

class WorkflowInstanceCreateResponse(arg: ModelComposed)

class WorkflowInstanceCreateResponse(*args, **kwargs)

Bases: ModelNormal

Response returned upon successful workflow instance creation.

Parameters:: data (WorkflowInstanceCreateResponseData, optional) – Data about the created workflow instance.

datadog_api_client.v2.model.workflow_instance_create_response_data module¶

class WorkflowInstanceCreateResponseData(arg: None)¶

class WorkflowInstanceCreateResponseData(arg: ModelComposed)

class WorkflowInstanceCreateResponseData(*args, **kwargs)

Bases: ModelNormal

Data about the created workflow instance.

Parameters:: id (str, optional) – The ID of the workflow execution. It can be used to fetch the execution status.

datadog_api_client.v2.model.workflow_instance_list_item module¶

class WorkflowInstanceListItem(arg: None)¶

class WorkflowInstanceListItem(arg: ModelComposed)

class WorkflowInstanceListItem(*args, **kwargs)

Bases: ModelNormal

An item in the workflow instances list.

Parameters:: id (str, optional) – The ID of the workflow instance

datadog_api_client.v2.model.workflow_list_instances_response module¶

class WorkflowListInstancesResponse(arg: None)¶

class WorkflowListInstancesResponse(arg: ModelComposed)

class WorkflowListInstancesResponse(*args, **kwargs)

Bases: ModelNormal

Response returned when listing workflow instances.

Parameters:

data ([WorkflowInstanceListItem], optional) – A list of workflow instances.
meta (WorkflowListInstancesResponseMeta, optional) – Metadata about the instances list

datadog_api_client.v2.model.workflow_list_instances_response_meta module¶

class WorkflowListInstancesResponseMeta(arg: None)¶

class WorkflowListInstancesResponseMeta(arg: ModelComposed)

class WorkflowListInstancesResponseMeta(*args, **kwargs)

Bases: ModelNormal

Metadata about the instances list

Parameters:: page (WorkflowListInstancesResponseMetaPage, optional) – Page information for the list instances response.

datadog_api_client.v2.model.workflow_list_instances_response_meta_page module¶

class WorkflowListInstancesResponseMetaPage(arg: None)¶

class WorkflowListInstancesResponseMetaPage(arg: ModelComposed)

class WorkflowListInstancesResponseMetaPage(*args, **kwargs)

Bases: ModelNormal

Page information for the list instances response.

Parameters:: total_count (int, optional) – The total count of items.

datadog_api_client.v2.model.workflow_trigger_wrapper module¶

class WorkflowTriggerWrapper(arg: None)¶

class WorkflowTriggerWrapper(arg: ModelComposed)

class WorkflowTriggerWrapper(*args, **kwargs)

Bases: ModelNormal

Schema for a Workflow-based trigger.

Parameters:

start_step_names ([str], optional) – A list of steps that run first after a trigger fires.
workflow_trigger (dict) – Trigger a workflow from the Datadog UI. Only required if no other trigger exists.

datadog_api_client.v2.model.workflow_user_relationship module¶

class WorkflowUserRelationship(arg: None)¶

class WorkflowUserRelationship(arg: ModelComposed)

class WorkflowUserRelationship(*args, **kwargs)

Bases: ModelNormal

The definition of WorkflowUserRelationship object.

Parameters:: data (WorkflowUserRelationshipData, optional) – The definition of WorkflowUserRelationshipData object.

datadog_api_client.v2.model.workflow_user_relationship_data module¶

class WorkflowUserRelationshipData(arg: None)¶

class WorkflowUserRelationshipData(arg: ModelComposed)

class WorkflowUserRelationshipData(*args, **kwargs)

Bases: ModelNormal

The definition of WorkflowUserRelationshipData object.

Parameters:

id (str) – The user identifier
type (WorkflowUserRelationshipType) – The definition of WorkflowUserRelationshipType object.

datadog_api_client.v2.model.workflow_user_relationship_type module¶

class WorkflowUserRelationshipType(arg: None)¶

class WorkflowUserRelationshipType(arg: ModelComposed)

class WorkflowUserRelationshipType(*args, **kwargs)

Bases: ModelSimple

The definition of WorkflowUserRelationshipType object.

Parameters:

value (str) – If omitted defaults to “users”. Must be one of [“users”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

datadog_api_client.v2.model.worklflow_cancel_instance_response module¶

class WorklflowCancelInstanceResponse(arg: None)¶

class WorklflowCancelInstanceResponse(arg: ModelComposed)

class WorklflowCancelInstanceResponse(*args, **kwargs)

Bases: ModelNormal

Information about the canceled instance.

Parameters:: data (WorklflowCancelInstanceResponseData, optional) – Data about the canceled instance.

datadog_api_client.v2.model.worklflow_cancel_instance_response_data module¶

class WorklflowCancelInstanceResponseData(arg: None)¶

class WorklflowCancelInstanceResponseData(arg: ModelComposed)

class WorklflowCancelInstanceResponseData(*args, **kwargs)

Bases: ModelNormal

Data about the canceled instance.

Parameters:: id (str, optional) – The id of the canceled instance

datadog_api_client.v2.model.worklflow_get_instance_response module¶

class WorklflowGetInstanceResponse(arg: None)¶

class WorklflowGetInstanceResponse(arg: ModelComposed)

class WorklflowGetInstanceResponse(*args, **kwargs)

Bases: ModelNormal

The state of the given workflow instance.

Parameters:: data (WorklflowGetInstanceResponseData, optional) – The data of the instance response.

datadog_api_client.v2.model.worklflow_get_instance_response_data module¶

class WorklflowGetInstanceResponseData(arg: None)¶

class WorklflowGetInstanceResponseData(arg: ModelComposed)

class WorklflowGetInstanceResponseData(*args, **kwargs)

Bases: ModelNormal

The data of the instance response.

Parameters:: attributes (WorklflowGetInstanceResponseDataAttributes, optional) – The attributes of the instance response data.

datadog_api_client.v2.model.worklflow_get_instance_response_data_attributes module¶

class WorklflowGetInstanceResponseDataAttributes(arg: None)¶

class WorklflowGetInstanceResponseDataAttributes(arg: ModelComposed)

class WorklflowGetInstanceResponseDataAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes of the instance response data.

Parameters:: id (str, optional) – The id of the instance.

datadog_api_client.v2.model.x_ray_services_include_all module¶

class XRayServicesIncludeAll(arg: None)¶

class XRayServicesIncludeAll(arg: ModelComposed)

class XRayServicesIncludeAll(*args, **kwargs)

Bases: ModelNormal

Include all services.

Parameters:: include_all (bool) – Include all services.

datadog_api_client.v2.model.x_ray_services_include_only module¶

class XRayServicesIncludeOnly(arg: None)¶

class XRayServicesIncludeOnly(arg: ModelComposed)

class XRayServicesIncludeOnly(*args, **kwargs)

Bases: ModelNormal

Include only these services. Defaults to [].

Parameters:: include_only ([str]) – Include only these services.

datadog_api_client.v2.model.x_ray_services_list module¶

class XRayServicesList(arg: None)¶

class XRayServicesList(arg: ModelComposed)

class XRayServicesList(*args, **kwargs)

Bases: ModelComposed

AWS X-Ray services to collect traces from. Defaults to include_only.

Parameters:

include_all (bool) – Include all services.
include_only ([str]) – Include only these services.

datadog_api_client.v2.model.zoom_configuration_reference module¶

class ZoomConfigurationReference(arg: None)¶

class ZoomConfigurationReference(arg: ModelComposed)

class ZoomConfigurationReference(*args, **kwargs)

Bases: ModelNormal

A reference to a Zoom configuration resource.

Parameters:: data (ZoomConfigurationReferenceData, none_type) – The Zoom configuration relationship data object.

datadog_api_client.v2.model.zoom_configuration_reference_data module¶

class ZoomConfigurationReferenceData(arg: None)¶

class ZoomConfigurationReferenceData(arg: ModelComposed)

class ZoomConfigurationReferenceData(*args, **kwargs)

Bases: ModelNormal

The Zoom configuration relationship data object.

Parameters:

id (str) – The unique identifier of the Zoom configuration.
type (str) – The type of the Zoom configuration.