datadog_api_client.v2.model package

Submodules

datadog_api_client.v2.model.active_billing_dimensions_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Active billing dimensions data.

Parameters:

datadog_api_client.v2.model.active_billing_dimensions_response module

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(*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.api_error_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Object used to create an API key.

Parameters:

datadog_api_client.v2.model.api_key_create_request module

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(*args, **kwargs)

Bases: ModelNormal

Resources related to the API key.

Parameters:

datadog_api_client.v2.model.api_key_response module

class APIKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving an API key.

Parameters:

datadog_api_client.v2.model.api_key_response_included_item module

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(*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(*args, **kwargs)

Bases: ModelNormal

Object used to update an API key.

Parameters:

datadog_api_client.v2.model.api_key_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Response for a list of API keys.

Parameters:

datadog_api_client.v2.model.api_keys_response_meta module

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(*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(*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(*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.apm_retention_filter_type module

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.application_key_create_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Object used to create an application key.

Parameters:

datadog_api_client.v2.model.application_key_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

Response for retrieving an application key.

Parameters:

datadog_api_client.v2.model.application_key_response_included_item module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object used to update an application key.

Parameters:

datadog_api_client.v2.model.application_key_update_request module

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(*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(*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.audit_logs_event module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.audit_logs_query_filter module

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(*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(*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_metadata module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The AuthN Mapping object returned by API.

Parameters:

datadog_api_client.v2.model.authn_mapping_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Data for creating an AuthN Mapping.

Parameters:

datadog_api_client.v2.model.authn_mapping_create_relationships module

class AuthNMappingCreateRelationships(*args, **kwargs)

Bases: ModelComposed

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

Parameters:

datadog_api_client.v2.model.authn_mapping_create_request module

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(*args, **kwargs)

Bases: ModelComposed

Included data in the AuthN Mapping response.

Parameters:

datadog_api_client.v2.model.authn_mapping_relationship_to_role module

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(*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(*args, **kwargs)

Bases: ModelNormal

All relationships associated with AuthN Mapping.

Parameters:

datadog_api_client.v2.model.authn_mapping_resource_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Team.

Parameters:

datadog_api_client.v2.model.authn_mapping_team_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Data for updating an AuthN Mapping.

Parameters:

datadog_api_client.v2.model.authn_mapping_update_relationships module

class AuthNMappingUpdateRelationships(*args, **kwargs)

Bases: ModelComposed

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

Parameters:

datadog_api_client.v2.model.authn_mapping_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Array of AuthN Mappings response.

Parameters:

datadog_api_client.v2.model.authn_mappings_sort module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The AWS Account Integration Config to be created

Parameters:

  • account_tags ([str], none_type, optional) – Tags to apply to all metrics in the account

  • auth_config (AWSAuthConfig) – AWS Authentication config

  • aws_account_id (str) – AWS Account ID

  • aws_partition (AWSAccountPartition) – AWS Account partition

  • aws_regions (AWSRegions, optional) – AWS Regions to collect data from

  • logs_config (AWSLogsConfig, optional) – AWS Logs config

  • metrics_config (AWSMetricsConfig, optional) – AWS Metrics config

  • resources_config (AWSResourcesConfig, optional) – AWS Resources config

  • traces_config (AWSTracesConfig, optional) – AWS Traces config

datadog_api_client.v2.model.aws_account_create_request_data module

class AWSAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

AWS Account Create Request data

Parameters:

datadog_api_client.v2.model.aws_account_partition module

class AWSAccountPartition(*args, **kwargs)

Bases: ModelSimple

AWS Account partition

Parameters:

  • value (str) – If omitted defaults to “aws”. 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(*args, **kwargs)

Bases: ModelNormal

AWS Account response body

Parameters:

data (AWSAccountResponseData) – AWS Account Response body

datadog_api_client.v2.model.aws_account_response_attributes module

class AWSAccountResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The AWS Account Integration Config

Parameters:

  • account_tags ([str], none_type, optional) – Tags to apply to all metrics in the account

  • auth_config (AWSAuthConfig, optional) – AWS Authentication config

  • aws_account_id (str) – AWS Account ID

  • aws_partition (AWSAccountPartition, optional) – AWS Account partition

  • aws_regions (AWSRegions, optional) – AWS Regions to collect data from

  • created_at (datetime, optional) – Timestamp of when the account integration was created

  • logs_config (AWSLogsConfig, optional) – AWS Logs config

  • metrics_config (AWSMetricsConfig, optional) – AWS Metrics config

  • modified_at (datetime, optional) – Timestamp of when the account integration was updated

  • resources_config (AWSResourcesConfig, optional) – AWS Resources config

  • traces_config (AWSTracesConfig, optional) – AWS Traces config

datadog_api_client.v2.model.aws_account_response_data module

class AWSAccountResponseData(*args, **kwargs)

Bases: ModelNormal

AWS Account Response body

Parameters:

  • attributes (AWSAccountResponseAttributes, optional) – The AWS Account Integration Config

  • id (str) – Unique Datadog ID of the AWS Account Integration Config

  • type (AWSAccountType) – AWS Account resource type.

datadog_api_client.v2.model.aws_account_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

The AWS Account Integration Config to be updated

Parameters:

  • account_tags ([str], none_type, optional) – Tags to apply to all metrics in the account

  • auth_config (AWSAuthConfig, optional) – AWS Authentication config

  • aws_account_id (str) – AWS Account ID

  • aws_partition (AWSAccountPartition, optional) – AWS Account partition

  • aws_regions (AWSRegions, optional) – AWS Regions to collect data from

  • logs_config (AWSLogsConfig, optional) – AWS Logs config

  • metrics_config (AWSMetricsConfig, optional) – AWS Metrics config

  • resources_config (AWSResourcesConfig, optional) – AWS Resources config

  • traces_config (AWSTracesConfig, optional) – AWS Traces config

datadog_api_client.v2.model.aws_account_update_request_data module

class AWSAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

AWS Account Update Request data

Parameters:

datadog_api_client.v2.model.aws_accounts_response module

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_auth_config module

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(*args, **kwargs)

Bases: ModelNormal

AWS Authentication config for key-based account

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(*args, **kwargs)

Bases: ModelNormal

AWS Authentication config for role-based account

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_cur_config module

class AwsCURConfig(*args, **kwargs)

Bases: ModelNormal

AWS CUR config.

Parameters:

datadog_api_client.v2.model.aws_cur_config_attributes module

class AwsCURConfigAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for An AWS CUR config.

Parameters:

  • 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], 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(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Patch data.

Parameters:

datadog_api_client.v2.model.aws_cur_config_patch_request module

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(*args, **kwargs)

Bases: ModelNormal

Attributes for AWS CUR config Patch Request.

Parameters:

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

datadog_api_client.v2.model.aws_cur_config_patch_request_type module

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(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Post data.

Parameters:

datadog_api_client.v2.model.aws_cur_config_post_request module

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(*args, **kwargs)

Bases: ModelNormal

Attributes for AWS CUR config Post Request.

Parameters:

  • 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.

  • is_enabled (bool, optional) – Whether or not the Cloud Cost Management account is enabled.

  • 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(*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(*args, **kwargs)

Bases: ModelNormal

Response of AWS CUR config.

Parameters:

data (AwsCURConfig, optional) – AWS CUR config.

datadog_api_client.v2.model.aws_cur_config_type module

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(*args, **kwargs)

Bases: ModelNormal

List of AWS CUR configs.

Parameters:

data ([AwsCURConfig], optional) – An AWS CUR config.

datadog_api_client.v2.model.aws_lambda_forwarder_config module

class AWSLambdaForwarderConfig(*args, **kwargs)

Bases: ModelNormal

AWS Lambda forwarder

Parameters:

  • lambdas ([str], optional) – List of Datadog Lambda Log Forwarder ARNs

  • sources ([str], optional) – List of AWS services that will send logs to the Datadog Lambda Log Forwarder

datadog_api_client.v2.model.aws_logs_config module

class AWSLogsConfig(*args, **kwargs)

Bases: ModelNormal

AWS Logs config

Parameters:

lambda_forwarder (AWSLambdaForwarderConfig, optional) – AWS Lambda forwarder

datadog_api_client.v2.model.aws_logs_services_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

AWS Logs Services response body

Parameters:

datadog_api_client.v2.model.aws_logs_services_response_data_type module

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(*args, **kwargs)

Bases: ModelNormal

AWS Metrics config

Parameters:

  • automute_enabled (bool, optional) – Enable EC2 automute for AWS metrics

  • collect_cloudwatch_alarms (bool, optional) – Enable CloudWatch alarms collection

  • collect_custom_metrics (bool, optional) – Enable custom metrics collection

  • enabled (bool, optional) – Enable AWS metrics collection

  • namespace_filters (AWSNamespaceFilters, optional) – AWS Metrics namespace filters

  • tag_filters ([AWSNamespaceTagFilter], optional) – AWS Metrics tag filters list

datadog_api_client.v2.model.aws_namespace_filters module

class AWSNamespaceFilters(*args, **kwargs)

Bases: ModelComposed

AWS Metrics namespace filters

Parameters:

  • exclude_all (bool) – Exclude all namespaces

  • exclude_only ([str]) – Exclude only these namespaces

  • include_all (bool) – Include all namespaces

  • include_only ([str]) – Include only these namespaces

datadog_api_client.v2.model.aws_namespace_filters_exclude_all module

class AWSNamespaceFiltersExcludeAll(*args, **kwargs)

Bases: ModelNormal

Exclude all namespaces

Parameters:

exclude_all (bool) – Exclude all namespaces

datadog_api_client.v2.model.aws_namespace_filters_exclude_only module

class AWSNamespaceFiltersExcludeOnly(*args, **kwargs)

Bases: ModelNormal

Exclude only these namespaces

Parameters:

exclude_only ([str]) – Exclude only these namespaces

datadog_api_client.v2.model.aws_namespace_filters_include_all module

class AWSNamespaceFiltersIncludeAll(*args, **kwargs)

Bases: ModelNormal

Include all namespaces

Parameters:

include_all (bool) – Include all namespaces

datadog_api_client.v2.model.aws_namespace_filters_include_only module

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(*args, **kwargs)

Bases: ModelNormal

AWS Metrics tag filters

Parameters:

  • namespace (str, optional) – The AWS Namespace to apply the tag filters against

  • tags ([str], none_type, optional) – The tags to filter based on

datadog_api_client.v2.model.aws_namespaces_response module

class AWSNamespacesResponse(*args, **kwargs)

Bases: ModelNormal

AWS Namespaces response body

Parameters:

data (AWSNamespacesResponseData) – AWS Namespaces response body

datadog_api_client.v2.model.aws_namespaces_response_attributes module

class AWSNamespacesResponseAttributes(*args, **kwargs)

Bases: ModelNormal

AWS Namespaces response body

Parameters:

namespaces ([str]) – AWS CloudWatch namespace

datadog_api_client.v2.model.aws_namespaces_response_data module

class AWSNamespacesResponseData(*args, **kwargs)

Bases: ModelNormal

AWS Namespaces response body

Parameters:

datadog_api_client.v2.model.aws_namespaces_response_data_type module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

AWS External ID response body

Parameters:

datadog_api_client.v2.model.aws_new_external_id_response_data_type module

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_regions module

class AWSRegions(*args, **kwargs)

Bases: ModelComposed

AWS Regions to collect data from

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(*args, **kwargs)

Bases: ModelNormal

Include all regions

Parameters:

include_all (bool) – Include all regions

datadog_api_client.v2.model.aws_regions_include_only module

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(*args, **kwargs)

Bases: ModelNormal

AWS Resources config

Parameters:

  • cloud_security_posture_management_collection (bool, optional) – Whether Datadog collects cloud security posture management resources from your AWS account.

  • extended_collection (bool, optional) – Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

datadog_api_client.v2.model.aws_traces_config module

class AWSTracesConfig(*args, **kwargs)

Bases: ModelNormal

AWS Traces config

Parameters:

xray_services (XRayServicesList, optional) – AWS X-Ray services to collect traces from

datadog_api_client.v2.model.azure_uc_config module

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], 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 (int, 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(*args, **kwargs)

Bases: ModelNormal

Azure config pair.

Parameters:

datadog_api_client.v2.model.azure_uc_config_pair_attributes module

class AzureUCConfigPairAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Azure config pair.

Parameters:

  • configs ([AzureUCConfig]) – An Azure config.

  • id (int, optional) – The ID of the Azure config pair.

datadog_api_client.v2.model.azure_uc_config_pair_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Azure config Patch data.

Parameters:

datadog_api_client.v2.model.azure_uc_config_patch_request module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Azure config Post data.

Parameters:

datadog_api_client.v2.model.azure_uc_config_post_request module

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(*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.

  • is_enabled (bool, optional) – Whether or not the Cloud Cost Management account is enabled.

  • scope (str) – The scope of your observed subscription.

datadog_api_client.v2.model.azure_uc_config_post_request_type module

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(*args, **kwargs)

Bases: ModelNormal

List of Azure accounts with configs.

Parameters:

data ([AzureUCConfigPair], optional) – An Azure config pair.

datadog_api_client.v2.model.bill_config module

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(*args, **kwargs)

Bases: ModelNormal

The mapping data for each billing dimension.

Parameters:

datadog_api_client.v2.model.billing_dimensions_mapping_body_item_attributes module

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(*args, **kwargs)

Bases: ModelNormal

An endpoint’s keys mapped to the billing_dimension.

Parameters:

datadog_api_client.v2.model.billing_dimensions_mapping_body_item_attributes_endpoints_items_status module

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(*args, **kwargs)

Bases: ModelNormal

Billing dimensions mapping response.

Parameters:

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

datadog_api_client.v2.model.bulk_mute_findings_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.bulk_mute_findings_request_meta module

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(*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(*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(*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(*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.calculated_field module

class CalculatedField(*args, **kwargs)

Bases: ModelNormal

Calculated field.

Parameters:

  • expression (str) – Expression.

  • name (str) – Field name.

datadog_api_client.v2.model.case module

class Case(*args, **kwargs)

Bases: ModelNormal

A case

Parameters:

datadog_api_client.v2.model.case3rd_party_ticket_status module

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(*args, **kwargs)

Bases: ModelNormal

Case assign

Parameters:

datadog_api_client.v2.model.case_assign_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Case assign request

Parameters:

data (CaseAssign) – Case assign

datadog_api_client.v2.model.case_attributes module

class CaseAttributes(*args, **kwargs)

Bases: ModelNormal

Case attributes

Parameters:

  • archived_at (datetime, none_type, optional) – Timestamp of when the case was archived

  • closed_at (datetime, none_type, optional) – Timestamp of when the case was closed

  • created_at (datetime, optional) – Timestamp of when the case was created

  • 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

datadog_api_client.v2.model.case_create module

class CaseCreate(*args, **kwargs)

Bases: ModelNormal

Case creation data

Parameters:

datadog_api_client.v2.model.case_create_attributes module

class CaseCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Case creation attributes

Parameters:

  • description (str, optional) – Description

  • priority (CasePriority, optional) – Case priority

  • title (str) – Title

  • type (CaseType) – Case type

datadog_api_client.v2.model.case_create_relationships module

class CaseCreateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships formed with the case on creation

Parameters:

datadog_api_client.v2.model.case_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

Case empty request

Parameters:

data (CaseEmpty) – Case empty request data

datadog_api_client.v2.model.case_priority module

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(*args, **kwargs)

Bases: ModelNormal

Resources related to a case

Parameters:

datadog_api_client.v2.model.case_resource_type module

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(*args, **kwargs)

Bases: ModelNormal

Case response

Parameters:

data (Case, optional) – A case

datadog_api_client.v2.model.case_sortable_field module

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(*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_type module

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_update_priority module

class CaseUpdatePriority(*args, **kwargs)

Bases: ModelNormal

Case priority status

Parameters:

datadog_api_client.v2.model.case_update_priority_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Case update status

Parameters:

datadog_api_client.v2.model.case_update_status_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Case update status request

Parameters:

data (CaseUpdateStatus) – Case update status

datadog_api_client.v2.model.cases_response module

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(*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(*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_custom_attributes module

class ChangeEventCustomAttributes(*args, **kwargs)

Bases: ModelNormal

Object representing custom change event attributes.

Parameters:

  • author (ChangeEventCustomAttributesAuthor, optional) – Object representing the entity which made the change. Optional field but if provided should include type and name.

  • change_metadata ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form object with information related to the change event. Can be arbitrarily nested and contain any valid JSON.

  • changed_resource (ChangeEventCustomAttributesChangedResource) – Object representing a uniquely identified resource. Only the resource type feature_flag is supported.

  • 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 right location. Only resources of type service are supported.

  • new_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form object to track new value of the changed resource.

  • prev_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form object to track previous value of the changed resource.

datadog_api_client.v2.model.change_event_custom_attributes_author module

class ChangeEventCustomAttributesAuthor(*args, **kwargs)

Bases: ModelNormal

Object representing the entity which made the change. Optional field but if provided should include type and name.

Parameters:

datadog_api_client.v2.model.change_event_custom_attributes_author_type module

class ChangeEventCustomAttributesAuthorType(*args, **kwargs)

Bases: ModelSimple

Author’s type.

Parameters:

  • value (str) – Must be one of [“user”, “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.change_event_custom_attributes_changed_resource module

class ChangeEventCustomAttributesChangedResource(*args, **kwargs)

Bases: ModelNormal

Object representing a uniquely identified resource. Only the resource type feature_flag is supported.

Parameters:

datadog_api_client.v2.model.change_event_custom_attributes_changed_resource_type module

class ChangeEventCustomAttributesChangedResourceType(*args, **kwargs)

Bases: ModelSimple

Resource’s type.

Parameters:

  • value (str) – If omitted defaults to “feature_flag”. Must be one of [“feature_flag”].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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(*args, **kwargs)

Bases: ModelNormal

Object representing a uniquely identified resource. Only the resource type service is supported.

Parameters:

datadog_api_client.v2.model.change_event_custom_attributes_impacted_resources_items_type module

class ChangeEventCustomAttributesImpactedResourcesItemsType(*args, **kwargs)

Bases: ModelSimple

Resource’s type.

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.chargeback_breakdown module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Request object.

Parameters:

data (CIAppCreatePipelineEventRequestData, optional) – Data of the pipeline event to create.

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_attributes module

class CIAppCreatePipelineEventRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of the pipeline event to create.

Parameters:

  • env (str, optional) – The Datadog environment.

  • 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(*args, **kwargs)

Bases: ModelComposed

Details of the CI pipeline event.

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.

  • dependencies ([str], none_type, optional) – A list of stage IDs that this stage depends on.

  • id (str) – UUID for the stage. It has to be unique at least in the pipeline scope.

  • 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).

  • 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(*args, **kwargs)

Bases: ModelNormal

Data of the pipeline event to create.

Parameters:

datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data_type module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.ci_app_pipeline_event_attributes module

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_job module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

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_level module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.ci_app_pipeline_level module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The response object for the pipeline events aggregate API endpoint.

Parameters:

datadog_api_client.v2.model.ci_app_pipelines_bucket_response module

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(*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(*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(*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(*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_metadata module

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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.ci_app_test_level module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The response object for the test events aggregate API endpoint.

Parameters:

datadog_api_client.v2.model.ci_app_tests_bucket_response module

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(*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(*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(*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.cloud_configuration_compliance_rule_options module

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(*args, **kwargs)

Bases: ModelNormal

Rule details.

Parameters:

datadog_api_client.v2.model.cloud_configuration_rule_case_create module

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(*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(*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(*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(*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.

  • 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(*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_cost_activity module

class CloudCostActivity(*args, **kwargs)

Bases: ModelNormal

Cloud Cost Activity.

Parameters:

datadog_api_client.v2.model.cloud_cost_activity_attributes module

class CloudCostActivityAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Cloud Cost activity.

Parameters:

is_enabled (bool) – Whether or not the cloud account is enabled.

datadog_api_client.v2.model.cloud_cost_activity_response module

class CloudCostActivityResponse(*args, **kwargs)

Bases: ModelNormal

Response for Cloud Cost activity.

Parameters:

data (CloudCostActivity, optional) – Cloud Cost Activity.

datadog_api_client.v2.model.cloud_cost_activity_type module

class CloudCostActivityType(*args, **kwargs)

Bases: ModelSimple

Type of Cloud Cost Activity.

Parameters:

  • value (str) – If omitted defaults to “cloud_cost_activity”. Must be one of [“cloud_cost_activity”].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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_action module

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

  • kill (CloudWorkloadSecurityAgentRuleKill, optional) – Kill system call applied on the container matching the rule

datadog_api_client.v2.model.cloud_workload_security_agent_rule_attributes module

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.

  • 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.

  • 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.

  • name (str, optional) – The name of the Agent rule.

  • 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(*args, **kwargs)

Bases: ModelNormal

Create a new Cloud Workload Security Agent rule.

Parameters:

  • description (str, optional) – The description of the Agent rule.

  • 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.

  • name (str) – The name of the Agent rule.

datadog_api_client.v2.model.cloud_workload_security_agent_rule_create_data module

class CloudWorkloadSecurityAgentRuleCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule.

Parameters:

datadog_api_client.v2.model.cloud_workload_security_agent_rule_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule.

Parameters:

datadog_api_client.v2.model.cloud_workload_security_agent_rule_kill module

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(*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(*args, **kwargs)

Bases: ModelSimple

The type of the resource. The value should 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(*args, **kwargs)

Bases: ModelNormal

Update an existing Cloud Workload Security Agent rule.

Parameters:

  • description (str, optional) – The description of the Agent rule.

  • enabled (bool, optional) – Whether the Agent rule is enabled.

  • expression (str, optional) – The SECL expression of the Agent rule.

datadog_api_client.v2.model.cloud_workload_security_agent_rule_update_data module

class CloudWorkloadSecurityAgentRuleUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule.

Parameters:

datadog_api_client.v2.model.cloud_workload_security_agent_rule_update_request module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data object for creating a Cloudflare account.

Parameters:

datadog_api_client.v2.model.cloudflare_account_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Data object of a Cloudflare account.

Parameters:

datadog_api_client.v2.model.cloudflare_account_type module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Cloudflare account.

Parameters:

datadog_api_client.v2.model.cloudflare_accounts_response module

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.confluent_account_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

The data body for adding a Confluent account.

Parameters:

datadog_api_client.v2.model.confluent_account_resource_attributes module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Confluent account.

Parameters:

datadog_api_client.v2.model.confluent_accounts_response module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

JSON:API request for updating a Confluent resource.

Parameters:

datadog_api_client.v2.model.confluent_resource_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Confluent Cloud resource data.

Parameters:

datadog_api_client.v2.model.confluent_resource_type module

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(*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.container module

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(*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(*args, **kwargs)

Bases: ModelNormal

Container group object.

Parameters:

datadog_api_client.v2.model.container_group_attributes module

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(*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_type module

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(*args, **kwargs)

Bases: ModelNormal

Container Image object.

Parameters:

datadog_api_client.v2.model.container_image_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Container Image Group object.

Parameters:

datadog_api_client.v2.model.container_image_group_attributes module

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_relationships module

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_type module

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(*args, **kwargs)

Bases: ModelComposed

Possible Container Image models.

Parameters:

datadog_api_client.v2.model.container_image_meta module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

List of Container Images.

Parameters:

datadog_api_client.v2.model.container_item module

class ContainerItem(*args, **kwargs)

Bases: ModelComposed

Possible Container models.

Parameters:

datadog_api_client.v2.model.container_meta module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

List of containers.

Parameters:

datadog_api_client.v2.model.content_encoding module

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(*args, **kwargs)

Bases: ModelNormal

Attributes for converting historical 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(*args, **kwargs)

Bases: ModelNormal

Data for converting historical job results to signals.

Parameters:

datadog_api_client.v2.model.convert_job_results_to_signals_data_type module

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(*args, **kwargs)

Bases: ModelNormal

Request for converting historical job results to signals.

Parameters:

data (ConvertJobResultsToSignalsData, optional) – Data for converting historical job results to signals.

datadog_api_client.v2.model.cost_attribution_aggregates_body module

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(*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(*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(*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(*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(*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(*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.create_open_api_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Data envelope for CreateOpenAPIResponse.

Parameters:

datadog_api_client.v2.model.create_rule_request module

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(*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(*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(*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.creator module

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.custom_cost_get_response_meta module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response for Get Custom Costs files.

Parameters:

datadog_api_client.v2.model.custom_costs_file_line_item module

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(*args, **kwargs)

Bases: ModelNormal

Response for List Custom Costs files.

Parameters:

datadog_api_client.v2.model.custom_costs_file_metadata module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response for Uploaded Custom Costs files.

Parameters:

datadog_api_client.v2.model.custom_costs_file_usage_charge_period module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The definition of a custom destination.

Parameters:

datadog_api_client.v2.model.custom_destination_elasticsearch_destination_auth module

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(*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).

datadog_api_client.v2.model.custom_destination_forward_destination_elasticsearch module

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(*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(*args, **kwargs)

Bases: ModelNormal

The HTTP destination.

Parameters:

datadog_api_client.v2.model.custom_destination_forward_destination_http_type module

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_splunk module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Basic access authentication.

datadog_api_client.v2.model.custom_destination_response_forward_destination module

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).

datadog_api_client.v2.model.custom_destination_response_forward_destination_elasticsearch module

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(*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(*args, **kwargs)

Bases: ModelNormal

The HTTP destination.

Parameters:

datadog_api_client.v2.model.custom_destination_response_forward_destination_http_type module

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_splunk module

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(*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(*args, **kwargs)

Bases: ModelComposed

Authentication method of the HTTP requests.

Parameters:

datadog_api_client.v2.model.custom_destination_response_http_destination_auth_basic module

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(*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(*args, **kwargs)

Bases: ModelNormal

Custom header access authentication.

Parameters:

datadog_api_client.v2.model.custom_destination_response_http_destination_auth_custom_header_type module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The definition of a custom destination.

Parameters:

datadog_api_client.v2.model.custom_destinations_response module

class CustomDestinationsResponse(*args, **kwargs)

Bases: ModelNormal

The available custom destinations.

Parameters:

data ([CustomDestinationResponseDefinition], optional) – A list of custom destinations.

datadog_api_client.v2.model.dashboard_list_add_items_request module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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_type module

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_scalar_column module

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.detailed_finding module

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(*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(*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(*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(*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(*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.domain_allowlist module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The email domain allowlist response for an org.

Parameters:

datadog_api_client.v2.model.domain_allowlist_response_data_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Attributes to create a DORA deployment event.

Parameters:

  • 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, and it should not be older than 1 hour.

  • 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(*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(*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(*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(*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_git_info module

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_incident_request module

class DORAIncidentRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a DORA incident event.

Parameters:

data (DORAIncidentRequestData) – The JSON:API data.

datadog_api_client.v2.model.dora_incident_request_attributes module

class DORAIncidentRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes to create a DORA incident event.

Parameters:

  • env (str, optional) – Environment name that was impacted by the incident.

  • finished_at (int, optional) – Unix timestamp when the incident finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.

  • git (DORAGitInfo, optional) – Git info for DORA Metrics events.

  • id (str, optional) – Incident ID. Required to update a previously sent incident.

  • name (str, optional) – Incident name.

  • services ([str], optional) – Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided.

  • severity (str, optional) – Incident severity.

  • started_at (int) – Unix timestamp when the incident 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_incident_request_data module

class DORAIncidentRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:

attributes (DORAIncidentRequestAttributes) – Attributes to create a DORA incident event.

datadog_api_client.v2.model.dora_incident_response module

class DORAIncidentResponse(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA incident event.

Parameters:

data (DORAIncidentResponseData) – Response after receiving a DORA incident event.

datadog_api_client.v2.model.dora_incident_response_data module

class DORAIncidentResponseData(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA incident event.

Parameters:

  • id (str) – The ID of the received DORA incident event.

  • type (DORAIncidentType, optional) – JSON:API type for DORA incident events.

datadog_api_client.v2.model.dora_incident_type module

class DORAIncidentType(*args, **kwargs)

Bases: ModelSimple

JSON:API type for DORA incident events.

Parameters:

  • value (str) – If omitted defaults to “dora_incident”. Must be one of [“dora_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.downtime_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

Object to create a downtime.

Parameters:

datadog_api_client.v2.model.downtime_included_monitor_type module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Information about the monitor identified by the downtime.

Parameters:

datadog_api_client.v2.model.downtime_notify_end_state_actions module

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(*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(*args, **kwargs)

Bases: ModelNormal

All relationships associated with downtime.

Parameters:

datadog_api_client.v2.model.downtime_relationships_created_by module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data for the monitor.

Parameters:

datadog_api_client.v2.model.downtime_resource_type module

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(*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:

datadog_api_client.v2.model.downtime_response_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Downtime data.

Parameters:

datadog_api_client.v2.model.downtime_response_included_item module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:

datadog_api_client.v2.model.downtime_schedule_recurrences_response module

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(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:
additional_properties_type = None

datadog_api_client.v2.model.downtime_schedule_response module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object to update a downtime.

Parameters:

datadog_api_client.v2.model.entity_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Entity relationships.

Parameters:

datadog_api_client.v2.model.entity_response_included_incident module

class EntityResponseIncludedIncident(*args, **kwargs)

Bases: ModelNormal

Included incident.

Parameters:

datadog_api_client.v2.model.entity_response_included_oncall module

class EntityResponseIncludedOncall(*args, **kwargs)

Bases: ModelNormal

Included oncall.

Parameters:

datadog_api_client.v2.model.entity_response_included_raw_schema module

class EntityResponseIncludedRawSchema(*args, **kwargs)

Bases: ModelNormal

Included raw schema.

Parameters:

datadog_api_client.v2.model.entity_response_included_raw_schema_attributes module

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_schema module

class EntityResponseIncludedSchema(*args, **kwargs)

Bases: ModelNormal

Included detail entity schema.

Parameters:

datadog_api_client.v2.model.entity_response_included_schema_attributes module

class EntityResponseIncludedSchemaAttributes(*args, **kwargs)

Bases: ModelNormal

Included schema.

Parameters:

schema (EntityV3, optional) – Entity schema v3.

datadog_api_client.v2.model.entity_response_meta module

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(*args, **kwargs)

Bases: ModelNormal

Entity to incidents relationship.

Parameters:

data ([RelationshipItem], optional) – Relationships.

datadog_api_client.v2.model.entity_to_oncalls module

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(*args, **kwargs)

Bases: ModelNormal

Entity to raw schema relationship.

Parameters:

data (RelationshipItem, optional) – Relationship entry.

datadog_api_client.v2.model.entity_to_schema module

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(*args, **kwargs)

Bases: ModelComposed

Entity schema v3.

Parameters:

  • api_version (EntityV3APIVersion) – The schema version of entity type. 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_datadog_code_location_item module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Schema for datastore entities.

Parameters:

  • api_version (EntityV3APIVersion) – The schema version of entity type. 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(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the datastore entity.

Parameters:
additional_properties_type = None

datadog_api_client.v2.model.entity_v3_datastore_kind module

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(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Datastore Spec object.

Parameters:

  • 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(*args, **kwargs)

Bases: ModelNormal

A base schema for defining third-party integrations.

Parameters:
additional_properties_type = None

datadog_api_client.v2.model.entity_v3_metadata module

class EntityV3Metadata(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Metadata object.

Parameters:

  • additional_owners ([bool, date, datetime, dict, float, int, list, str, UUID, none_type], 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 (bool, date, datetime, dict, float, int, list, str, UUID, none_type, 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(*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(*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_owner module

class EntityV3MetadataOwner(*args, **kwargs)

Bases: ModelNormal

The owner of the entity, usually a team.

Parameters:

name (str, optional) – Team name.

additional_properties_type = None

datadog_api_client.v2.model.entity_v3_queue module

class EntityV3Queue(*args, **kwargs)

Bases: ModelNormal

Schema for queue entities.

Parameters:

  • api_version (EntityV3APIVersion) – The schema version of entity type. 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(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the datastore entity.

Parameters:
additional_properties_type = None

datadog_api_client.v2.model.entity_v3_queue_kind module

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(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Queue Spec object.

Parameters:

  • 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(*args, **kwargs)

Bases: ModelNormal

Schema for service entities.

Parameters:

  • api_version (EntityV3APIVersion) – The schema version of entity type. 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(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the service entity.

Parameters:
additional_properties_type = None

datadog_api_client.v2.model.entity_v3_service_kind module

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(*args, **kwargs)

Bases: ModelNormal

The definition of Entity V3 Service Spec object.

Parameters:

  • 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(*args, **kwargs)

Bases: ModelNormal

Schema for system entities.

Parameters:

  • api_version (EntityV3APIVersion) – The schema version of entity type. 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(*args, **kwargs)

Bases: ModelNormal

Datadog product integrations for the service entity.

Parameters:
additional_properties_type = None

datadog_api_client.v2.model.entity_v3_system_kind module

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(*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.event module

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(*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(*args, **kwargs)

Bases: ModelSimple

Event category to identify the type of event. Only the value change is supported. Support for other categories are coming. please reach out to datadog support if you’re interested.

Parameters:

  • value (str) – If omitted defaults to “change”. Must be one of [“change”].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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(*args, **kwargs)

Bases: ModelNormal

Object representing an event creation request.

Parameters:

datadog_api_client.v2.model.event_create_request_payload module

class EventCreateRequestPayload(*args, **kwargs)

Bases: ModelNormal

Payload for creating an event.

Parameters:

data (EventCreateRequest, optional) – Object representing an event creation request.

datadog_api_client.v2.model.event_create_request_type module

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(*args, **kwargs)

Bases: ModelNormal

Object containing an event response.

Parameters:

  • attributes (EventCreateResponseAttributes, optional) – JSON object containing all events attributes and their associated values.

  • type (str, optional) – Event type

datadog_api_client.v2.model.event_create_response_attributes module

class EventCreateResponseAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object containing all events attributes and their associated values.

Parameters:

attributes (EventCreateResponseAttributesAttributes, optional) – JSON object of attributes from your events.

datadog_api_client.v2.model.event_create_response_attributes_attributes module

class EventCreateResponseAttributesAttributes(*args, **kwargs)

Bases: ModelNormal

JSON object of attributes from your events.

Parameters:

evt (EventCreateResponseAttributesAttributesEvt, optional) – JSON object of event system attributes.

datadog_api_client.v2.model.event_create_response_attributes_attributes_evt module

class EventCreateResponseAttributesAttributesEvt(*args, **kwargs)

Bases: ModelNormal

JSON object of event system attributes.

Parameters:

id (str, optional) – Event id

datadog_api_client.v2.model.event_create_response_payload module

class EventCreateResponsePayload(*args, **kwargs)

Bases: ModelNormal

Response containing information about created event.

Parameters:

data (EventCreateResponse, optional) – Object containing an event response.

datadog_api_client.v2.model.event_payload module

class EventPayload(*args, **kwargs)

Bases: ModelNormal

Event attributes.

Parameters:

  • aggregation_key (str, optional) – An arbitrary string to use for aggregation when correlating events. Limited to 100 characters.

  • attributes (EventPayloadAttributes) – JSON object for custom attributes. Schema are different per each event category.

  • category (EventCategory) – Event category to identify the type of event. Only the value change is supported. Support for other categories are coming. please reach out to datadog support if you’re interested.

  • message (str, optional) – The body of the event. Limited to 4000 characters.

  • tags ([str], optional) – A list of tags to apply to the event. 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 event title. Limited to 500 characters.

datadog_api_client.v2.model.event_payload_attributes module

class EventPayloadAttributes(*args, **kwargs)

Bases: ModelComposed

JSON object for custom attributes. Schema are different per each event category.

Parameters:

  • author (ChangeEventCustomAttributesAuthor, optional) – Object representing the entity which made the change. Optional field but if provided should include type and name.

  • change_metadata ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form object with information related to the change event. Can be arbitrarily nested and contain any valid JSON.

  • changed_resource (ChangeEventCustomAttributesChangedResource) – Object representing a uniquely identified resource. Only the resource type feature_flag is supported.

  • 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 right location. Only resources of type service are supported.

  • new_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form object to track new value of the changed resource.

  • prev_value ({str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional) – Free form object to track previous value of the changed resource.

datadog_api_client.v2.model.event_priority module

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(*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(*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(*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_type module

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(*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(*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(*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”].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The response object with all events matching the request and pagination information.

Parameters:

datadog_api_client.v2.model.events_query_filter module

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(*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(*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(*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(*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(*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(*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_sort module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data object for creating a Fastly account.

Parameters:

datadog_api_client.v2.model.fastly_account_response module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Fastly account.

Parameters:

datadog_api_client.v2.model.fastly_accounts_response module

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_service module

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(*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(*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(*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(*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(*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(*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.finding module

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(*args, **kwargs)

Bases: ModelNormal

The JSON:API attributes of the 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).

  • 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(*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(*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(*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(*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(*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(*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(*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.formula_limit module

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.full_api_key module

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(*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.

  • 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(*args, **kwargs)

Bases: ModelNormal

Datadog application key.

Parameters:

datadog_api_client.v2.model.full_application_key_attributes module

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.

  • 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.gcp_metric_namespace_config module

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.

  • id (str, optional) – The id of the GCP metric namespace.

datadog_api_client.v2.model.gcp_service_account_meta module

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(*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.gcpsts_delegate_account module

class GCPSTSDelegateAccount(*args, **kwargs)

Bases: ModelNormal

Datadog principal service account info.

Parameters:

datadog_api_client.v2.model.gcpsts_delegate_account_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Info on your service account.

Parameters:

datadog_api_client.v2.model.gcpsts_service_account_attributes module

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.

  • host_filters ([str], optional) – Your Host Filters.

  • 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_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.

  • 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(*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(*args, **kwargs)

Bases: ModelNormal

Additional metadata on your generated service account.

Parameters:

datadog_api_client.v2.model.gcpsts_service_account_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Data on your service account.

Parameters:

datadog_api_client.v2.model.gcpsts_service_accounts_response module

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.get_device_attributes module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The GetInterfaces operation’s response.

Parameters:

data ([GetInterfacesData], optional) – Get Interfaces response

datadog_api_client.v2.model.get_team_memberships_sort module

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.group_scalar_column module

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(*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.historical_job_data_type module

class HistoricalJobDataType(*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.historical_job_list_meta module

class HistoricalJobListMeta(*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.historical_job_response module

class HistoricalJobResponse(*args, **kwargs)

Bases: ModelNormal

Historical job response.

Parameters:

data (HistoricalJobResponseData, optional) – Historical job response data.

datadog_api_client.v2.model.historical_job_response_attributes module

class HistoricalJobResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Historical 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 historical job.

  • job_name (str, optional) – Job name.

  • job_status (str, optional) – Job status.

  • modified_at (str, optional) – Last modification time of the job.

datadog_api_client.v2.model.historical_job_response_data module

class HistoricalJobResponseData(*args, **kwargs)

Bases: ModelNormal

Historical job response data.

Parameters:

datadog_api_client.v2.model.hourly_usage module

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(*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(*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(*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(*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(*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(*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_log module

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(*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(*args, **kwargs)

Bases: ModelNormal

Invalid query performed.

Parameters:

errors ([HTTPLogError], optional) – Structured errors.

datadog_api_client.v2.model.http_log_item module

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.httpci_app_error module

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(*args, **kwargs)

Bases: ModelNormal

Errors occurred.

Parameters:

errors ([HTTPCIAppError], optional) – Structured errors.

datadog_api_client.v2.model.idp_metadata_form_data module

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(*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(*args, **kwargs)

Bases: ModelComposed

The attributes object for an attachment.

Parameters:

datadog_api_client.v2.model.incident_attachment_data module

class IncidentAttachmentData(*args, **kwargs)

Bases: ModelNormal

A single incident attachment.

Parameters:

datadog_api_client.v2.model.incident_attachment_postmortem_attachment_type module

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(*args, **kwargs)

Bases: ModelNormal

The attributes object for a postmortem attachment.

Parameters:

datadog_api_client.v2.model.incident_attachment_relationships module

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(*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(*args, **kwargs)

Bases: ModelComposed

Incident attachment attributes.

Parameters:

datadog_api_client.v2.model.incident_attachment_update_data module

class IncidentAttachmentUpdateData(*args, **kwargs)

Bases: ModelNormal

A single incident attachment.

Parameters:

datadog_api_client.v2.model.incident_attachment_update_request module

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(*args, **kwargs)

Bases: ModelNormal

The response object containing the created or updated incident attachments.

Parameters:

datadog_api_client.v2.model.incident_attachments_postmortem_attributes_attachment_object module

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(*args, **kwargs)

Bases: ModelNormal

The response object containing an incident’s attachments.

Parameters:

datadog_api_client.v2.model.incident_attachments_response_included_item module

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(*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.

  • 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(*args, **kwargs)

Bases: ModelNormal

Incident data for a create request.

Parameters:

datadog_api_client.v2.model.incident_create_relationships module

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(*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(*args, **kwargs)

Bases: ModelComposed

Dynamic fields for which selections can be made, with field names as keys.

Parameters:

datadog_api_client.v2.model.incident_field_attributes_multiple_value module

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(*args, **kwargs)

Bases: ModelNormal

A field with a single value selected.

Parameters:

datadog_api_client.v2.model.incident_field_attributes_single_value_type module

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(*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_impacts_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata data for a create request.

Parameters:

datadog_api_client.v2.model.incident_integration_metadata_create_request module

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(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident integration metadata.

Parameters:

datadog_api_client.v2.model.incident_integration_metadata_metadata module

class IncidentIntegrationMetadataMetadata(*args, **kwargs)

Bases: ModelComposed

Incident integration metadata’s metadata attribute.

Parameters:

datadog_api_client.v2.model.incident_integration_metadata_patch_data module

class IncidentIntegrationMetadataPatchData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata data for a patch request.

Parameters:

datadog_api_client.v2.model.incident_integration_metadata_patch_request module

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(*args, **kwargs)

Bases: ModelNormal

Response with an incident integration metadata.

Parameters:

datadog_api_client.v2.model.incident_integration_metadata_response_data module

class IncidentIntegrationMetadataResponseData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata from a response.

Parameters:

datadog_api_client.v2.model.incident_integration_metadata_response_included_item module

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(*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(*args, **kwargs)

Bases: ModelNormal

The incident’s integration relationships from a response.

Parameters:

datadog_api_client.v2.model.incident_non_datadog_creator module

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(*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_postmortem_type module

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_responders_type module

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(*args, **kwargs)

Bases: ModelNormal

Response with an incident.

Parameters:

datadog_api_client.v2.model.incident_response_attributes module

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.

  • 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.

  • 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(*args, **kwargs)

Bases: ModelNormal

Incident data from a response.

Parameters:

datadog_api_client.v2.model.incident_response_included_item module

class IncidentResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an incident that is included in the response.

Parameters:

datadog_api_client.v2.model.incident_response_meta module

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(*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(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships from a response.

Parameters:

datadog_api_client.v2.model.incident_search_response module

class IncidentSearchResponse(*args, **kwargs)

Bases: ModelNormal

Response with incidents and facets.

Parameters:

datadog_api_client.v2.model.incident_search_response_attributes module

class IncidentSearchResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes returned by an incident search.

Parameters:

datadog_api_client.v2.model.incident_search_response_data module

class IncidentSearchResponseData(*args, **kwargs)

Bases: ModelNormal

Data returned by an incident search.

Parameters:

datadog_api_client.v2.model.incident_search_response_facets_data module

class IncidentSearchResponseFacetsData(*args, **kwargs)

Bases: ModelNormal

Facet data for incidents returned by a search query.

Parameters:

datadog_api_client.v2.model.incident_search_response_field_facet_data module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Facet data numeric attributes of an incident.

Parameters:

datadog_api_client.v2.model.incident_search_response_numeric_facet_data_aggregates module

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(*args, **kwargs)

Bases: ModelNormal

Facet data for the incident property fields.

Parameters:

datadog_api_client.v2.model.incident_search_response_user_facet_data module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Incident Service payload for create requests.

Parameters:

datadog_api_client.v2.model.incident_service_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

The incident service’s relationships.

Parameters:

datadog_api_client.v2.model.incident_service_response module

class IncidentServiceResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident service payload.

Parameters:

datadog_api_client.v2.model.incident_service_response_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Incident Service data from responses.

Parameters:

datadog_api_client.v2.model.incident_service_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Incident Service payload for update requests.

Parameters:

datadog_api_client.v2.model.incident_service_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident service payloads.

Parameters:

datadog_api_client.v2.model.incident_severity module

class IncidentSeverity(*args, **kwargs)

Bases: ModelSimple

The incident severity.

Parameters:

  • value (str) – Must be one of [“UNKNOWN”, “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(*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(*args, **kwargs)

Bases: ModelNormal

Incident Team data for a create request.

Parameters:

datadog_api_client.v2.model.incident_team_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

The incident team’s relationships.

Parameters:

datadog_api_client.v2.model.incident_team_response module

class IncidentTeamResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident team payload.

Parameters:

datadog_api_client.v2.model.incident_team_response_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Incident Team data from a response.

Parameters:

datadog_api_client.v2.model.incident_team_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Incident Team data for an update request.

Parameters:

datadog_api_client.v2.model.incident_team_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident team payloads.

Parameters:

datadog_api_client.v2.model.incident_timeline_cell_create_attributes module

class IncidentTimelineCellCreateAttributes(*args, **kwargs)

Bases: ModelComposed

The timeline cell’s attributes for a create request.

Parameters:

datadog_api_client.v2.model.incident_timeline_cell_markdown_content_type module

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(*args, **kwargs)

Bases: ModelNormal

Timeline cell data for Markdown timeline cells for a create request.

Parameters:

datadog_api_client.v2.model.incident_timeline_cell_markdown_create_attributes_content module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Incident todo data for a create request.

Parameters:

datadog_api_client.v2.model.incident_todo_create_request module

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(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident todos.

Parameters:

datadog_api_client.v2.model.incident_todo_patch_data module

class IncidentTodoPatchData(*args, **kwargs)

Bases: ModelNormal

Incident todo data for a patch request.

Parameters:

datadog_api_client.v2.model.incident_todo_patch_request module

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(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships from a response.

Parameters:

datadog_api_client.v2.model.incident_todo_response module

class IncidentTodoResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident todo.

Parameters:

datadog_api_client.v2.model.incident_todo_response_data module

class IncidentTodoResponseData(*args, **kwargs)

Bases: ModelNormal

Incident todo response data.

Parameters:

datadog_api_client.v2.model.incident_todo_response_included_item module

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(*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_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Incident type data for a create request.

Parameters:

datadog_api_client.v2.model.incident_type_create_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

Incident type response data.

Parameters:

datadog_api_client.v2.model.incident_type_patch_data module

class IncidentTypePatchData(*args, **kwargs)

Bases: ModelNormal

Incident type data for a patch request.

Parameters:

datadog_api_client.v2.model.incident_type_patch_request module

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_response module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Incident data for an update request.

Parameters:

datadog_api_client.v2.model.incident_update_relationships module

class IncidentUpdateRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships for an update request.

Parameters:

datadog_api_client.v2.model.incident_update_request module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response with a list of incidents.

Parameters:

datadog_api_client.v2.model.include_type module

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.intake_payload_accepted module

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(*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

  • 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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data of the IP allowlist entry object.

Parameters:

datadog_api_client.v2.model.ip_allowlist_entry_type module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Update the IP allowlist.

Parameters:

data (IPAllowlistData) – IP allowlist data.

datadog_api_client.v2.model.jira_integration_metadata module

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(*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(*args, **kwargs)

Bases: ModelNormal

Jira issue attached to case

Parameters:

datadog_api_client.v2.model.jira_issue_result module

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(*args, **kwargs)

Bases: ModelNormal

Run a historical job response.

Parameters:

data (JobCreateResponseData, optional) – The definition of JobCreateResponseData object.

datadog_api_client.v2.model.job_create_response_data module

class JobCreateResponseData(*args, **kwargs)

Bases: ModelNormal

The definition of JobCreateResponseData object.

Parameters:

  • id (str, optional) – ID of the created job.

  • type (HistoricalJobDataType, optional) – Type of payload.

datadog_api_client.v2.model.job_definition module

class JobDefinition(*args, **kwargs)

Bases: ModelNormal

Definition of a historical job.

Parameters:

  • calculated_fields ([CalculatedField], optional) – Calculated fields.

  • cases ([SecurityMonitoringRuleCaseCreate]) – Cases used for generating job results.

  • 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.

  • _from (int) – Starting time of data analyzed by the job.

  • index (str) – Index used to load the data.

  • message (str) – Message for generated results.

  • name (str) – Job name.

  • options (SecurityMonitoringRuleOptions, optional) – Options on rules.

  • queries ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs analyzed by the job.

  • reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.

  • tags ([str], optional) – Tags for generated signals.

  • third_party_cases ([SecurityMonitoringThirdPartyRuleCaseCreate], optional) – Cases for generating results from third-party rules. Only available for third-party rules.

  • 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(*args, **kwargs)

Bases: ModelNormal

Definition of a historical job based on a security monitoring rule.

Parameters:

  • case_index (int) – Index of the rule case applied by the job.

  • _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(*args, **kwargs)

Bases: ModelNormal

API error response body

Parameters:

  • detail (str, optional) – A human-readable explanation specific to this occurrence 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_response module

class JSONAPIErrorResponse(*args, **kwargs)

Bases: ModelNormal

API error response.

Parameters:

errors ([JSONAPIErrorItem]) – A list of errors.

datadog_api_client.v2.model.leaked_key module

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(*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(*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.list_apis_response module

class ListAPIsResponse(*args, **kwargs)

Bases: ModelNormal

Response for ListAPIs.

Parameters:

datadog_api_client.v2.model.list_apis_response_data module

class ListAPIsResponseData(*args, **kwargs)

Bases: ModelNormal

Data envelope for ListAPIsResponse.

Parameters:

datadog_api_client.v2.model.list_apis_response_data_attributes module

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(*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(*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_application_keys_response module

class ListApplicationKeysResponse(*args, **kwargs)

Bases: ModelNormal

Response for a list of application keys.

Parameters:

datadog_api_client.v2.model.list_devices_response module

class ListDevicesResponse(*args, **kwargs)

Bases: ModelNormal

List devices response.

Parameters:

datadog_api_client.v2.model.list_devices_response_metadata module

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(*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(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all downtimes.

Parameters:

datadog_api_client.v2.model.list_entity_catalog_response module

class ListEntityCatalogResponse(*args, **kwargs)

Bases: ModelNormal

List entity response.

Parameters:

datadog_api_client.v2.model.list_entity_catalog_response_included_item module

class ListEntityCatalogResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

List entity response included item.

Parameters:

datadog_api_client.v2.model.list_findings_meta module

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(*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(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing findings.

Parameters:

datadog_api_client.v2.model.list_historical_jobs_response module

class ListHistoricalJobsResponse(*args, **kwargs)

Bases: ModelNormal

List of historical jobs.

Parameters:

datadog_api_client.v2.model.list_powerpacks_response module

class ListPowerpacksResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes all powerpack configurations.

Parameters:

datadog_api_client.v2.model.list_rules_response module

class ListRulesResponse(*args, **kwargs)

Bases: ModelNormal

Scorecard rules response.

Parameters:

datadog_api_client.v2.model.list_rules_response_data_item module

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_tags_response module

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(*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(*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(*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(*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.log module

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(*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(*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(*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(*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(*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(*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(*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: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.

  • page (LogsAggregateRequestPage, optional) – Paging settings

datadog_api_client.v2.model.logs_aggregate_request_page module

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(*args, **kwargs)

Bases: ModelNormal

The response object for the logs aggregate API endpoint

Parameters:

datadog_api_client.v2.model.logs_aggregate_response_data module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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.

datadog_api_client.v2.model.logs_archive_definition module

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(*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.

datadog_api_client.v2.model.logs_archive_destination_azure module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The S3 archive destination.

Parameters:

  • bucket (str) – The bucket where the archive will be stored.

  • integration (LogsArchiveIntegrationS3) – The S3 Archive’s integration destination.

  • path (str, optional) – The archive path.

  • type (LogsArchiveDestinationS3Type) – Type of the S3 archive destination.

datadog_api_client.v2.model.logs_archive_destination_s3_type module

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_integration_azure module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The definition of an archive order.

Parameters:

datadog_api_client.v2.model.logs_archive_order_definition_type module

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(*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_archives module

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(*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(*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(*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(*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(*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(*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(*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: you should supply either timezone or time offset, but not both. Otherwise, the query will fail.

  • 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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.logs_metric_compute module

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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog log-based metric.

Parameters:

datadog_api_client.v2.model.logs_metric_response_compute module

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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The new log-based metric properties.

Parameters:

datadog_api_client.v2.model.logs_metric_update_request module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Global query options that are used during the query. Note: you should supply either 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.logs_response_metadata module

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(*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(*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(*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(*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(*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.metric module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Assets related to the object, including title and url.

Parameters:

  • 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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Metric assets response data.

Parameters:

datadog_api_client.v2.model.metric_asset_response_included module

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(*args, **kwargs)

Bases: ModelNormal

Relationships to assets related to the metric.

Parameters:

datadog_api_client.v2.model.metric_asset_slo_relationship module

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(*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(*args, **kwargs)

Bases: ModelNormal

Response object that includes related dashboards, monitors, notebooks, and SLOs.

Parameters:

datadog_api_client.v2.model.metric_bulk_configure_tags_type module

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(*args, **kwargs)

Bases: ModelNormal

Request object to bulk configure tags for metrics matching the given prefix.

Parameters:

datadog_api_client.v2.model.metric_bulk_tag_config_create_attributes module

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.

  • 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(*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(*args, **kwargs)

Bases: ModelNormal

Request object to bulk delete all tag configurations for metrics matching the given prefix.

Parameters:

datadog_api_client.v2.model.metric_bulk_tag_config_delete_attributes module

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(*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(*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(*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(*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:

datadog_api_client.v2.model.metric_bulk_tag_config_status_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A time and space aggregation combination for use in query.

Parameters:

datadog_api_client.v2.model.metric_custom_aggregations module

class MetricCustomAggregations(*args, **kwargs)

Bases: ModelSimple

A list of queryable aggregation combinations for a count, rate, or gauge metric.

By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available:

  • time: avg, space: avg

  • time: avg, space: max

  • time: avg, space: min

  • time: avg, space: sum

  • time: count, space: sum

  • time: max, space: max

  • time: min, space: min

  • time: sum, space: avg

  • time: sum, space: sum

Can only be applied to non_distribution metrics that have a metric_type of count , rate , or gauge.

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(*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(*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(*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(*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.

  • 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(*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(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s distinct volume.

Parameters:

datadog_api_client.v2.model.metric_distinct_volume_attributes module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s ingested and indexed volume.

Parameters:

datadog_api_client.v2.model.metric_ingested_indexed_volume_attributes module

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(*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(*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_metadata module

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(*args, **kwargs)

Bases: ModelNormal

A monitor object with title.

Parameters:

  • attributes (MetricAssetAttributes, optional) – Assets related to the object, including title and url.

  • id (str) – The related monitor’s ID.

  • type (MetricMonitorType) – Monitor resource type.

datadog_api_client.v2.model.metric_monitor_type module

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(*args, **kwargs)

Bases: ModelNormal

A notebook object with title.

Parameters:

  • attributes (MetricAssetAttributes, optional) – Assets related to the object, including title and url.

  • id (str) – The related notebook’s ID.

  • type (MetricNotebookType) – Notebook resource type.

datadog_api_client.v2.model.metric_notebook_type module

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(*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_payload module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A SLO object with title.

Parameters:

  • attributes (MetricAssetAttributes, optional) – Assets related to the object, including title and url.

  • id (str) – The SLO ID.

  • type (MetricSLOType) – SLO resource type.

datadog_api_client.v2.model.metric_slo_type module

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(*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(*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(*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(*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_configuration module

class MetricTagConfiguration(*args, **kwargs)

Bases: ModelNormal

Object for a single metric tag configuration.

Parameters:

datadog_api_client.v2.model.metric_tag_configuration_attributes module

class MetricTagConfigurationAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric tag configuration attributes.

Parameters:

  • aggregations (MetricCustomAggregations, optional) –

    A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available:

    • time: avg, space: avg

    • time: avg, space: max

    • time: avg, space: min

    • time: avg, space: sum

    • time: count, space: sum

    • time: max, space: max

    • time: min, space: min

    • time: sum, space: avg

    • time: sum, space: sum

    Can only be applied to non_distribution metrics that have a metric_type of count , rate , or gauge.

  • 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(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric tag configuration to be created.

Parameters:

  • aggregations (MetricCustomAggregations, optional) –

    A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available:

    • time: avg, space: avg

    • time: avg, space: max

    • time: avg, space: min

    • time: avg, space: sum

    • time: count, space: sum

    • time: max, space: max

    • time: min, space: min

    • time: sum, space: avg

    • time: sum, space: sum

    Can only be applied to non_distribution metrics that have a metric_type of count , rate , or gauge.

  • 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(*args, **kwargs)

Bases: ModelNormal

Object for a single metric to be configure tags on.

Parameters:

datadog_api_client.v2.model.metric_tag_configuration_create_request module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object containing the definition of a metric tag configuration to be updated.

Parameters:

  • aggregations (MetricCustomAggregations, optional) –

    A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available:

    • time: avg, space: avg

    • time: avg, space: max

    • time: avg, space: min

    • time: avg, space: sum

    • time: count, space: sum

    • time: max, space: max

    • time: min, space: min

    • time: sum, space: avg

    • time: sum, space: sum

    Can only be applied to non_distribution metrics that have a metric_type of count , rate , or gauge.

  • 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(*args, **kwargs)

Bases: ModelNormal

Object for a single tag configuration to be edited.

Parameters:

datadog_api_client.v2.model.metric_tag_configuration_update_request module

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(*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(*args, **kwargs)

Bases: ModelComposed

Possible response objects for a metric’s volume.

Parameters:

datadog_api_client.v2.model.metric_volumes_response module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response object that includes metrics and metric tag configurations.

Parameters:

data ([MetricsAndMetricTagConfigurations], optional) – Array of metrics and metric tag configurations.

datadog_api_client.v2.model.metrics_data_source module

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_scalar_query module

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(*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_teams_channel_info_response_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Channel data from a response.

Parameters:

datadog_api_client.v2.model.microsoft_teams_channel_info_type module

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_create_tenant_based_handle_request module

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_get_channel_by_name_response module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_info_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_response module

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(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

datadog_api_client.v2.model.microsoft_teams_tenant_based_handle_type module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Tenant-based handle data from a response.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_attribute_create_request module

class MonitorConfigPolicyAttributeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_attribute_edit_request module

class MonitorConfigPolicyAttributeEditRequest(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_attribute_response module

class MonitorConfigPolicyAttributeResponse(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_create_data module

class MonitorConfigPolicyCreateData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_create_request module

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(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_edit_request module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

datadog_api_client.v2.model.monitor_config_policy_tag_policy module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all downtime matches for a monitor.

Parameters:

datadog_api_client.v2.model.monitor_downtime_match_response_attributes module

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(*args, **kwargs)

Bases: ModelNormal

A downtime match.

Parameters:

datadog_api_client.v2.model.monitor_type module

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.monthly_cost_attribution_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Cost data.

Parameters:

datadog_api_client.v2.model.monthly_cost_attribution_meta module

class MonthlyCostAttributionMeta(*args, **kwargs)

Bases: ModelNormal

The object containing document metadata.

Parameters:

datadog_api_client.v2.model.monthly_cost_attribution_pagination module

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(*args, **kwargs)

Bases: ModelNormal

Response containing the monthly cost attribution by tag(s).

Parameters:

datadog_api_client.v2.model.ms_teams_integration_metadata module

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(*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.nullable_relationship_to_user module

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(*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(*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(*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.okta_account module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Payload schema when updating an Okta account.

Parameters:

data (bool, date, datetime, dict, float, int, list, str, UUID, none_type) – Data object for updating an Okta account.

datadog_api_client.v2.model.okta_account_update_request_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Data object for updating an Okta account.

Parameters:

datadog_api_client.v2.model.okta_accounts_response module

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.on_demand_concurrency_cap module

class OnDemandConcurrencyCap(*args, **kwargs)

Bases: ModelNormal

On-demand concurrency cap.

Parameters:

datadog_api_client.v2.model.on_demand_concurrency_cap_attributes module

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(*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(*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_api_endpoint module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Opsgenie service data for a create request.

Parameters:

datadog_api_client.v2.model.opsgenie_service_create_request module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Opsgenie service data from a response.

Parameters:

datadog_api_client.v2.model.opsgenie_service_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

Opsgenie service for an update request.

Parameters:

datadog_api_client.v2.model.opsgenie_service_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Response with a list of Opsgenie services.

Parameters:

data ([OpsgenieServiceResponseData]) – An array of Opsgenie services.

datadog_api_client.v2.model.org_config_get_response module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

An Org Config write operation.

Parameters:

datadog_api_client.v2.model.org_config_write_attributes module

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(*args, **kwargs)

Bases: ModelNormal

A request to update an Org Config.

Parameters:

data (OrgConfigWrite) – An Org Config write operation.

datadog_api_client.v2.model.organization module

class Organization(*args, **kwargs)

Bases: ModelNormal

Organization object.

Parameters:

datadog_api_client.v2.model.organization_attributes module

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(*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.outcome_type module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request data.

Parameters:

datadog_api_client.v2.model.outcomes_batch_request_item module

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(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch response.

Parameters:

datadog_api_client.v2.model.outcomes_batch_response_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes - the result of a rule for a service.

Parameters:

datadog_api_client.v2.model.outcomes_response_data_item module

class OutcomesResponseDataItem(*args, **kwargs)

Bases: ModelNormal

A single rule outcome.

Parameters:

datadog_api_client.v2.model.outcomes_response_included_item module

class OutcomesResponseIncludedItem(*args, **kwargs)

Bases: ModelNormal

Attributes of the included rule.

Parameters:

datadog_api_client.v2.model.outcomes_response_included_rule_attributes module

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.pagination module

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.partial_api_key module

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(*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.

  • 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(*args, **kwargs)

Bases: ModelNormal

Partial Datadog application key.

Parameters:

datadog_api_client.v2.model.partial_application_key_attributes module

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.

  • 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(*args, **kwargs)

Bases: ModelNormal

Response for retrieving a partial application key.

Parameters:

datadog_api_client.v2.model.permission module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Powerpack group widget definition object.

Parameters:

datadog_api_client.v2.model.powerpack_group_widget_definition module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Powerpack relationship object.

Parameters:

author (RelationshipToUser, optional) – Relationship to user.

datadog_api_client.v2.model.powerpack_response module

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_template_variable module

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(*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(*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.process_summaries_meta module

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(*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(*args, **kwargs)

Bases: ModelNormal

List of process summaries.

Parameters:

datadog_api_client.v2.model.process_summary module

class ProcessSummary(*args, **kwargs)

Bases: ModelNormal

Process summary object.

Parameters:

datadog_api_client.v2.model.process_summary_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

A Project

Parameters:

datadog_api_client.v2.model.project_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Project create

Parameters:

datadog_api_client.v2.model.project_create_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Project create request

Parameters:

data (ProjectCreate) – Project create

datadog_api_client.v2.model.project_relationship module

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(*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(*args, **kwargs)

Bases: ModelNormal

Project relationships

Parameters:

datadog_api_client.v2.model.project_resource_type module

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(*args, **kwargs)

Bases: ModelNormal

Project response

Parameters:

data (Project, optional) – A Project

datadog_api_client.v2.model.projected_cost module

class ProjectedCost(*args, **kwargs)

Bases: ModelNormal

Projected Cost data.

Parameters:

datadog_api_client.v2.model.projected_cost_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response with projects

Parameters:

data ([Project], optional) – Projects response data

datadog_api_client.v2.model.query_formula module

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_sort_order module

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.relation_type module

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(*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_attachment module

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(*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_impact_data module

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(*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(*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(*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_postmortem module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Relationship to incident responders.

Parameters:

data ([RelationshipToIncidentResponderData]) – An array of incident responders.

datadog_api_client.v2.model.relationship_to_incident_user_defined_field_data module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data of AuthN Mapping relationship to SAML Assertion Attribute.

Parameters:

datadog_api_client.v2.model.relationship_to_team module

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(*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_user module

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(*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(*args, **kwargs)

Bases: ModelNormal

Relationship between a user team permission and a team

Parameters:

datadog_api_client.v2.model.relationship_to_user_team_permission_data module

class RelationshipToUserTeamPermissionData(*args, **kwargs)

Bases: ModelNormal

Related user team permission data

Parameters:

datadog_api_client.v2.model.relationship_to_user_team_team module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Relationship to users.

Parameters:

data ([RelationshipToUserData]) – Relationships to user objects.

datadog_api_client.v2.model.reorder_retention_filters_request module

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.response_meta_attributes module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The definition of the retention filter.

Parameters:

datadog_api_client.v2.model.retention_filter_all module

class RetentionFilterAll(*args, **kwargs)

Bases: ModelNormal

The definition of the retention filter.

Parameters:

datadog_api_client.v2.model.retention_filter_all_attributes module

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.

datadog_api_client.v2.model.retention_filter_all_type module

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(*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.

datadog_api_client.v2.model.retention_filter_create_attributes module

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.

datadog_api_client.v2.model.retention_filter_create_data module

class RetentionFilterCreateData(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be created.

Parameters:

datadog_api_client.v2.model.retention_filter_create_request module

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(*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(*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(*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(*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.

datadog_api_client.v2.model.retention_filter_update_data module

class RetentionFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be updated.

Parameters:

datadog_api_client.v2.model.retention_filter_update_request module

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(*args, **kwargs)

Bases: ModelNormal

The retention filter object .

Parameters:

datadog_api_client.v2.model.retention_filters_response module

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.role module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a role.

Parameters:

datadog_api_client.v2.model.role_create_request module

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(*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(*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(*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(*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(*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_update_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a role.

Parameters:

datadog_api_client.v2.model.role_update_request module

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(*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(*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(*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(*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(*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.rule_attributes module

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.

  • 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(*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_type module

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.rum_aggregate_bucket_value module

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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The response object for the RUM events aggregate API endpoint.

Parameters:

datadog_api_client.v2.model.rum_application module

class RUMApplication(*args, **kwargs)

Bases: ModelNormal

RUM application.

Parameters:

datadog_api_client.v2.model.rum_application_attributes module

class RUMApplicationAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application attributes.

Parameters:

  • 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.

  • 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(*args, **kwargs)

Bases: ModelNormal

RUM application creation.

Parameters:

datadog_api_client.v2.model.rum_application_create_attributes module

class RUMApplicationCreateAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application creation attributes.

Parameters:

  • name (str) – Name of the RUM 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(*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(*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(*args, **kwargs)

Bases: ModelNormal

RUM application list.

Parameters:

datadog_api_client.v2.model.rum_application_list_attributes module

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.

  • 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(*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(*args, **kwargs)

Bases: ModelNormal

RUM application response.

Parameters:

data (RUMApplication, optional) – RUM application.

datadog_api_client.v2.model.rum_application_type module

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(*args, **kwargs)

Bases: ModelNormal

RUM application update.

Parameters:

datadog_api_client.v2.model.rum_application_update_attributes module

class RUMApplicationUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

RUM application update attributes.

Parameters:

  • name (str, optional) – Name of the RUM 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(*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(*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(*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(*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(*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(*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(*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(*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_type module

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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.rum_group_by module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog rum-based metric.

Parameters:

datadog_api_client.v2.model.rum_metric_response_compute module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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_query_filter module

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(*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(*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_metadata module

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(*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(*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_search_events_request module

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(*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(*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(*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_historical_job_request module

class RunHistoricalJobRequest(*args, **kwargs)

Bases: ModelNormal

Run a historical job request.

Parameters:

data (RunHistoricalJobRequestData, optional) – Data for running a historical job request.

datadog_api_client.v2.model.run_historical_job_request_attributes module

class RunHistoricalJobRequestAttributes(*args, **kwargs)

Bases: ModelNormal

Run a historical job request.

Parameters:

  • from_rule (JobDefinitionFromRule, optional) – Definition of a historical job based on a security monitoring rule.

  • id (str, optional) – Request ID.

  • job_definition (JobDefinition, optional) – Definition of a historical job.

datadog_api_client.v2.model.run_historical_job_request_data module

class RunHistoricalJobRequestData(*args, **kwargs)

Bases: ModelNormal

Data for running a historical job request.

Parameters:

datadog_api_client.v2.model.run_historical_job_request_data_type module

class RunHistoricalJobRequestDataType(*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(*args, **kwargs)

Bases: ModelNormal

SAML assertion attribute.

Parameters:

datadog_api_client.v2.model.saml_assertion_attribute_attributes module

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(*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.scalar_column module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A single scalar query to be executed.

Parameters:

datadog_api_client.v2.model.scalar_formula_request_attributes module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A message containing the response to a scalar query.

Parameters:

datadog_api_client.v2.model.scorecard_type module

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.security_filter module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object for a single security filter.

Parameters:

datadog_api_client.v2.model.security_filter_create_request module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response object which includes a single security filter.

Parameters:

datadog_api_client.v2.model.security_filter_type module

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(*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(*args, **kwargs)

Bases: ModelNormal

The new security filter properties.

Parameters:

datadog_api_client.v2.model.security_filter_update_request module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

List of rules.

Parameters:

datadog_api_client.v2.model.security_monitoring_reference_table module

class SecurityMonitoringReferenceTable(*args, **kwargs)

Bases: ModelNormal

Reference table for the rule.

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 rule 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(*args, **kwargs)

Bases: ModelNormal

Case when signal is generated.

Parameters:

  • 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.

  • 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_create module

class SecurityMonitoringRuleCaseCreate(*args, **kwargs)

Bases: ModelNormal

Case when signal is generated.

Parameters:

  • 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.

  • name (str, optional) – Name of the case.

  • notifications ([str], optional) – Notification targets for each rule case.

  • status (SecurityMonitoringRuleSeverity) – Severity of the Security Signal.

datadog_api_client.v2.model.security_monitoring_rule_convert_payload module

class SecurityMonitoringRuleConvertPayload(*args, **kwargs)

Bases: ModelComposed

Convert a rule from JSON to Terraform.

Parameters:

datadog_api_client.v2.model.security_monitoring_rule_convert_response module

class SecurityMonitoringRuleConvertResponse(*args, **kwargs)

Bases: ModelNormal

Result of the convert rule request containing Terraform content.

Parameters:

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(*args, **kwargs)

Bases: ModelComposed

Create a new rule.

Parameters:

datadog_api_client.v2.model.security_monitoring_rule_detection_method module

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”].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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(*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 rules, this field is not used.

Parameters:

  • value (int) – Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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(*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(*args, **kwargs)

Bases: ModelNormal

Options on impossible travel rules.

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(*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 rules, this field is not used.

Parameters:

  • value (int) – Must be one of [0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600].

  • _check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.

  • _path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.

  • _spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).

  • _configuration (Configuration) – The instance to use 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(*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(*args, **kwargs)

Bases: ModelNormal

Options on new value rules.

Parameters:

datadog_api_client.v2.model.security_monitoring_rule_new_value_options_forget_after module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Options on rules.

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 rules, this field is not used.

  • hardcoded_evaluator_type (SecurityMonitoringRuleHardcodedEvaluatorType, optional) – Hardcoded evaluator type.

  • impossible_travel_options (SecurityMonitoringRuleImpossibleTravelOptions, optional) – Options on impossible travel rules.

  • 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 rules, 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 rules.

  • third_party_rule_options (SecurityMonitoringRuleThirdPartyOptions, optional) – Options on third party rules.

datadog_api_client.v2.model.security_monitoring_rule_query module

class SecurityMonitoringRuleQuery(*args, **kwargs)

Bases: ModelComposed

Query for matching rule.

Parameters:

  • aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.

  • 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.

  • 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(*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(*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(*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(*args, **kwargs)

Bases: ModelComposed

Create a new rule.

Parameters:

  • 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.

  • 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.

  • 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 on rules.

  • queries ([SecurityMonitoringStandardRuleQuery], optional) – Queries for selecting logs which are part of the rule.

  • reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.

  • 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.

  • version (int, optional) – The version of the rule.

datadog_api_client.v2.model.security_monitoring_rule_severity module

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(*args, **kwargs)

Bases: ModelComposed

Test a rule.

Parameters:

datadog_api_client.v2.model.security_monitoring_rule_test_request module

class SecurityMonitoringRuleTestRequest(*args, **kwargs)

Bases: ModelNormal

Test the rule queries of a rule (rule property is ignored when applied to an existing rule)

Parameters:

datadog_api_client.v2.model.security_monitoring_rule_test_response module

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(*args, **kwargs)

Bases: ModelNormal

Options on third party rules.

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(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

  • value (str) – Must be one of [“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(*args, **kwargs)

Bases: ModelSimple

The rule type.

Parameters:

  • value (str) – Must be one of [“log_detection”, “infrastructure_configuration”, “workload_security”, “cloud_configuration”, “application_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(*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(*args, **kwargs)

Bases: ModelNormal

Update an existing rule.

Parameters:

  • cases ([SecurityMonitoringRuleCase], optional) – Cases for generating signals.

  • compliance_signal_options (CloudConfigurationRuleComplianceSignalOptions, optional) – How to generate compliance signals. Useful for cloud_configuration rules only.

  • 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, optional) – Whether the rule is enabled.

  • message (str, optional) – Message for generated signals.

  • name (str, optional) – Name of the rule.

  • options (SecurityMonitoringRuleOptions, optional) – Options on rules.

  • queries ([SecurityMonitoringRuleQuery], optional) – Queries for selecting logs which are part of the rule.

  • reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.

  • 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(*args, **kwargs)

Bases: ModelComposed

Validate a rule.

Parameters:

datadog_api_client.v2.model.security_monitoring_signal module

class SecurityMonitoringSignal(*args, **kwargs)

Bases: ModelNormal

Object description of a security signal.

Parameters:

datadog_api_client.v2.model.security_monitoring_signal_archive_reason module

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”, “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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The request for a security signal list.

Parameters:

datadog_api_client.v2.model.security_monitoring_signal_list_request_filter module

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(*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(*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(*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(*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 on rules.

  • 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(*args, **kwargs)

Bases: ModelNormal

The payload of a 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 on rules.

  • 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(*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(*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.

  • 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 on rules.

  • 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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data containing the patch for changing the state of a signal.

Parameters:

datadog_api_client.v2.model.security_monitoring_signal_state_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Attributes describing a triage state update operation over a security signal.

Parameters:

datadog_api_client.v2.model.security_monitoring_signal_triage_update_data module

class SecurityMonitoringSignalTriageUpdateData(*args, **kwargs)

Bases: ModelNormal

Data containing the updated triage attributes of the signal.

Parameters:

datadog_api_client.v2.model.security_monitoring_signal_triage_update_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

The response object with all security signals matching the request and pagination information.

Parameters:

datadog_api_client.v2.model.security_monitoring_signals_list_response_meta module

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(*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(*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_rule_create_payload module

class SecurityMonitoringStandardRuleCreatePayload(*args, **kwargs)

Bases: ModelNormal

Create a new rule.

Parameters:

datadog_api_client.v2.model.security_monitoring_standard_rule_payload module

class SecurityMonitoringStandardRulePayload(*args, **kwargs)

Bases: ModelNormal

The payload of a rule.

Parameters:

datadog_api_client.v2.model.security_monitoring_standard_rule_query module

class SecurityMonitoringStandardRuleQuery(*args, **kwargs)

Bases: ModelNormal

Query for matching rule.

Parameters:

  • aggregation (SecurityMonitoringRuleQueryAggregation, optional) – The aggregation type.

  • 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.

  • 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(*args, **kwargs)

Bases: ModelNormal

Rule.

Parameters:

  • 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.

  • 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.

  • 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 on rules.

  • queries ([SecurityMonitoringStandardRuleQuery], optional) – Queries for selecting logs which are part of the rule.

  • reference_tables ([SecurityMonitoringReferenceTable], optional) – Reference tables for the rule.

  • 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.

  • version (int, optional) – The version of the rule.

datadog_api_client.v2.model.security_monitoring_standard_rule_test_payload module

class SecurityMonitoringStandardRuleTestPayload(*args, **kwargs)

Bases: ModelNormal

The payload of a rule to test

Parameters:

datadog_api_client.v2.model.security_monitoring_suppression module

class SecurityMonitoringSuppression(*args, **kwargs)

Bases: ModelNormal

The suppression rule’s properties.

Parameters:

datadog_api_client.v2.model.security_monitoring_suppression_attributes module

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.

  • 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.

  • 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(*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.

  • 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.

datadog_api_client.v2.model.security_monitoring_suppression_create_data module

class SecurityMonitoringSuppressionCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single suppression rule.

Parameters:

datadog_api_client.v2.model.security_monitoring_suppression_create_request module

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(*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(*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(*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.

  • 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.

  • 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(*args, **kwargs)

Bases: ModelNormal

The new suppression properties; partial updates are supported.

Parameters:

datadog_api_client.v2.model.security_monitoring_suppression_update_request module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Case when signal is generated by a third party rule.

Parameters:

  • 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(*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 rule 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(*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(*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.sensitive_data_scanner_config_request module

class SensitiveDataScannerConfigRequest(*args, **kwargs)

Bases: ModelNormal

Group reorder request.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_configuration module

class SensitiveDataScannerConfiguration(*args, **kwargs)

Bases: ModelNormal

A Sensitive Data Scanner configuration.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_configuration_data module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Create group response.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_create_rule_response module

class SensitiveDataScannerCreateRuleResponse(*args, **kwargs)

Bases: ModelNormal

Create rule response.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_filter module

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(*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(*args, **kwargs)

Bases: ModelComposed

An object related to the configuration.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_get_config_response module

class SensitiveDataScannerGetConfigResponse(*args, **kwargs)

Bases: ModelNormal

Get all groups response.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_get_config_response_data module

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(*args, **kwargs)

Bases: ModelNormal

A scanning group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_attributes module

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.

datadog_api_client.v2.model.sensitive_data_scanner_group_create module

class SensitiveDataScannerGroupCreate(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_create_request module

class SensitiveDataScannerGroupCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create group request.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_data module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A Scanning Group included item.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_item module

class SensitiveDataScannerGroupItem(*args, **kwargs)

Bases: ModelNormal

Data related to a Sensitive Data Scanner Group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_list module

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(*args, **kwargs)

Bases: ModelNormal

Relationships of the group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_response module

class SensitiveDataScannerGroupResponse(*args, **kwargs)

Bases: ModelNormal

Response data related to the creation of a group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_type module

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(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_update_request module

class SensitiveDataScannerGroupUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update group request.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_group_update_response module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Data related to the reordering of scanning groups.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_reorder_groups_response module

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(*args, **kwargs)

Bases: ModelNormal

Rule item included in the group.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a rule.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_create_request module

class SensitiveDataScannerRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create rule request.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_data module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A Scanning Rule included item.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_relationships module

class SensitiveDataScannerRuleRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of a scanning rule.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_response module

class SensitiveDataScannerRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response data related to the creation of a rule.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_type module

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(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a rule.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_update_request module

class SensitiveDataScannerRuleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update rule request.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_rule_update_response module

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_standard_pattern module

class SensitiveDataScannerStandardPattern(*args, **kwargs)

Bases: ModelNormal

Data containing the standard pattern id.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_standard_pattern_attributes module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Standard pattern item.

Parameters:

datadog_api_client.v2.model.sensitive_data_scanner_text_replacement module

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’.

  • 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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object to create a service account User.

Parameters:

datadog_api_client.v2.model.service_account_create_request module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Service definition attributes.

Parameters:

datadog_api_client.v2.model.service_definition_get_response module

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(*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(*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(*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 (ServiceDefinitionV2Dot2Type, optional) – The type of service.

datadog_api_client.v2.model.service_definition_schema_versions module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

datadog_api_client.v2.model.service_definition_v1_resource_type module

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(*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(*args, **kwargs)

Bases: ModelComposed

Service owner’s contacts information.

Parameters:

datadog_api_client.v2.model.service_definition_v2_doc module

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(*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(*args, **kwargs)

Bases: ModelComposed

Service owner’s contacts information.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot1_email module

class ServiceDefinitionV2Dot1Email(*args, **kwargs)

Bases: ModelNormal

Service owner’s email.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot1_email_type module

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(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot1_ms_teams module

class ServiceDefinitionV2Dot1MSTeams(*args, **kwargs)

Bases: ModelNormal

Service owner’s Microsoft Teams.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot1_ms_teams_type module

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(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot1_opsgenie_region module

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(*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(*args, **kwargs)

Bases: ModelNormal

Service owner’s Slack channel.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot1_slack_type module

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(*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 (ServiceDefinitionV2Dot2Type, optional) – The type of service.

datadog_api_client.v2.model.service_definition_v2_dot2_contact module

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(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie module

class ServiceDefinitionV2Dot2Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

datadog_api_client.v2.model.service_definition_v2_dot2_opsgenie_region module

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(*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_dot2_type module

class ServiceDefinitionV2Dot2Type(*args, **kwargs)

Bases: ModelSimple

The type of service.

Parameters:

  • value (str) – Must be one of [“web”, “db”, “cache”, “function”, “browser”, “mobile”, “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.service_definition_v2_email module

class ServiceDefinitionV2Email(*args, **kwargs)

Bases: ModelNormal

Service owner’s email.

Parameters:

datadog_api_client.v2.model.service_definition_v2_email_type module

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(*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_ms_teams module

class ServiceDefinitionV2MSTeams(*args, **kwargs)

Bases: ModelNormal

Service owner’s Microsoft Teams.

Parameters:

datadog_api_client.v2.model.service_definition_v2_ms_teams_type module

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(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

datadog_api_client.v2.model.service_definition_v2_opsgenie_region module

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(*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(*args, **kwargs)

Bases: ModelNormal

Service owner’s Slack channel.

Parameters:

datadog_api_client.v2.model.service_definition_v2_slack_type module

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(*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 (ServiceDefinitionV2Dot2Type, 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(*args, **kwargs)

Bases: ModelNormal

Create service definitions response.

Parameters:

data ([ServiceDefinitionData], optional) – Data representing service definitions.

datadog_api_client.v2.model.service_now_ticket module

class ServiceNowTicket(*args, **kwargs)

Bases: ModelNormal

ServiceNow ticket attached to case

Parameters:

datadog_api_client.v2.model.service_now_ticket_result module

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.slack_integration_metadata module

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(*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.slo_report_create_request module

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(*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(*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(*args, **kwargs)

Bases: ModelSimple

The frequency at which report data is to be generated.

Parameters:

  • value (str) – Must be one of [“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(*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(*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(*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(*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(*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(*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.sort_direction module

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(*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(*args, **kwargs)

Bases: ModelNormal

Spans aggregate.

Parameters:

datadog_api_client.v2.model.spans_aggregate_bucket_attributes module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The object containing the query content.

Parameters:

datadog_api_client.v2.model.spans_aggregate_request module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The response object for the spans aggregate API endpoint.

Parameters:

datadog_api_client.v2.model.spans_aggregate_response_metadata module

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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The object containing the query content.

Parameters:

datadog_api_client.v2.model.spans_list_request_page module

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(*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(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

datadog_api_client.v2.model.spans_list_response_metadata module

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(*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(*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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog span-based metric.

Parameters:

datadog_api_client.v2.model.spans_metric_response_compute module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

The new span-based metric properties.

Parameters:

datadog_api_client.v2.model.spans_metric_update_request module

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(*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(*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(*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(*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(*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(*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(*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(*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.state module

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.tags_event_attribute module

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(*args, **kwargs)

Bases: ModelNormal

A team

Parameters:

datadog_api_client.v2.model.team_attributes module

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_create module

class TeamCreate(*args, **kwargs)

Bases: ModelNormal

Team create

Parameters:

datadog_api_client.v2.model.team_create_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Request to create a team

Parameters:

data (TeamCreate) – Team create

datadog_api_client.v2.model.team_included module

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_permission_setting module

class TeamPermissionSetting(*args, **kwargs)

Bases: ModelNormal

Team permission setting

Parameters:

datadog_api_client.v2.model.team_permission_setting_attributes module

class TeamPermissionSettingAttributes(*args, **kwargs)

Bases: ModelNormal

Team permission setting attributes

Parameters:

datadog_api_client.v2.model.team_permission_setting_response module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Team permission setting update

Parameters:

datadog_api_client.v2.model.team_permission_setting_update_attributes module

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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Team permission settings response

Parameters:

data ([TeamPermissionSetting], optional) – Team permission settings response data

datadog_api_client.v2.model.team_relationships module

class TeamRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to a team

Parameters:

datadog_api_client.v2.model.team_response module

class TeamResponse(*args, **kwargs)

Bases: ModelNormal

Response with a team

Parameters:

data (Team, optional) – A team

datadog_api_client.v2.model.team_type module

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(*args, **kwargs)

Bases: ModelNormal

Team update request

Parameters:

datadog_api_client.v2.model.team_update_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Team update request

Parameters:

data (TeamUpdate) – Team update request

datadog_api_client.v2.model.teams_field module

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(*args, **kwargs)

Bases: ModelNormal

Response with multiple teams

Parameters:

datadog_api_client.v2.model.teams_response_meta module

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(*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.timeseries_formula_query_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

A single timeseries query to be executed.

Parameters:

datadog_api_client.v2.model.timeseries_formula_request_attributes module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A message containing the response to a timeseries query.

Parameters:

datadog_api_client.v2.model.timeseries_response_attributes module

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(*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(*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(*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(*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(*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.unit module

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.update_open_api_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Data envelope for UpdateOpenAPIResponse.

Parameters:

datadog_api_client.v2.model.update_rule_request module

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(*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(*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(*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.upsert_catalog_entity_request module

class UpsertCatalogEntityRequest(*args, **kwargs)

Bases: ModelComposed

Create or update entity request.

datadog_api_client.v2.model.upsert_catalog_entity_response module

class UpsertCatalogEntityResponse(*args, **kwargs)

Bases: ModelNormal

Upsert entity response.

Parameters:

datadog_api_client.v2.model.upsert_catalog_entity_response_included_item module

class UpsertCatalogEntityResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

Upsert entity response included item.

Parameters:

datadog_api_client.v2.model.usage_application_security_monitoring_response module

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(*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(*args, **kwargs)

Bases: ModelNormal

Usage data.

Parameters:

datadog_api_client.v2.model.usage_lambda_traced_invocations_response module

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(*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(*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(*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(*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(*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.

  • 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_create_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Object to create a user.

Parameters:

datadog_api_client.v2.model.user_create_request module

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(*args, **kwargs)

Bases: ModelNormal

Object to create a user invitation.

Parameters:

datadog_api_client.v2.model.user_invitation_data_attributes module

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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Object of a user invitation returned by the API.

Parameters:

datadog_api_client.v2.model.user_invitations_request module

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(*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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelComposed

An object related to a user.

Parameters:

datadog_api_client.v2.model.user_response_relationships module

class UserResponseRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the user object returned by the API.

Parameters:

datadog_api_client.v2.model.user_team module

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(*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(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

datadog_api_client.v2.model.user_team_included module

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(*args, **kwargs)

Bases: ModelNormal

A user’s permissions for a given team

Parameters:

datadog_api_client.v2.model.user_team_permission_attributes module

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(*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(*args, **kwargs)

Bases: ModelNormal

Relationship between membership and a user

Parameters:

datadog_api_client.v2.model.user_team_request module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

datadog_api_client.v2.model.user_team_update_request module

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(*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(*args, **kwargs)

Bases: ModelNormal

Team memberships response

Parameters:

datadog_api_client.v2.model.user_update_attributes module

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(*args, **kwargs)

Bases: ModelNormal

Object to update a user.

Parameters:

datadog_api_client.v2.model.user_update_request module

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(*args, **kwargs)

Bases: ModelNormal

Relationship to users.

Parameters:

data ([UserRelationshipData]) – Relationships to user objects.

datadog_api_client.v2.model.users_response module

class UsersResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about multiple users.

Parameters:

datadog_api_client.v2.model.users_type module

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.widget_live_span module

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_instance_create_meta module

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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Response returned when listing workflow instances.

Parameters:

datadog_api_client.v2.model.workflow_list_instances_response_meta module

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(*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.worklflow_cancel_instance_response module

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(*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(*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(*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(*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(*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(*args, **kwargs)

Bases: ModelNormal

Include only these services

Parameters:

include_only ([str]) – Include only these services

datadog_api_client.v2.model.x_ray_services_list module

class XRayServicesList(*args, **kwargs)

Bases: ModelComposed

AWS X-Ray services to collect traces from

Parameters:

  • include_all (bool) – Include all services

  • include_only ([str]) – Include only these services

Module contents