datadog_api_client.v2.model

active_billing_dimensions_attributes

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

active_billing_dimensions_body

class ActiveBillingDimensionsBody(*args, **kwargs)

Bases: ModelNormal

Active billing dimensions data.

Parameters:

• attributes (ActiveBillingDimensionsAttributes, optional) – List of active billing dimensions.

• id (str, optional) – Unique ID of the response.

• type (ActiveBillingDimensionsType, optional) – Type of active billing dimensions data.

active_billing_dimensions_response

class ActiveBillingDimensionsResponse(*args, **kwargs)

Bases: ModelNormal

Active billing dimensions response.

Parameters:

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

active_billing_dimensions_type

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.

api_error_response

class APIErrorResponse(*args, **kwargs)

Bases: ModelNormal

API error response.

Parameters:

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

api_key_create_attributes

class APIKeyCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes used to create an API Key.

Parameters:

name (str) – Name of the API key.

api_key_create_data

class APIKeyCreateData(*args, **kwargs)

Bases: ModelNormal

Object used to create an API key.

Parameters:

• attributes (APIKeyCreateAttributes) – Attributes used to create an API Key.

• type (APIKeysType) – API Keys resource type.

api_key_create_request

class APIKeyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to create an API key.

Parameters:

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

api_key_relationships

class APIKeyRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to the API key.

Parameters:

• created_by (RelationshipToUser, optional) – Relationship to user.

• modified_by (RelationshipToUser, optional) – Relationship to user.

api_key_response

class APIKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving an API key.

Parameters:

• data (FullAPIKey, optional) – Datadog API key.

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

api_key_response_included_item

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.

api_key_update_attributes

class APIKeyUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes used to update an API Key.

Parameters:

name (str) – Name of the API key.

api_key_update_data

class APIKeyUpdateData(*args, **kwargs)

Bases: ModelNormal

Object used to update an API key.

Parameters:

• attributes (APIKeyUpdateAttributes) – Attributes used to update an API Key.

• id (str) – ID of the API key.

• type (APIKeysType) – API Keys resource type.

api_key_update_request

class APIKeyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to update an API key.

Parameters:

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

api_keys_response

class APIKeysResponse(*args, **kwargs)

Bases: ModelNormal

Response for a list of API keys.

Parameters:

• data ([PartialAPIKey], optional) – Array of API keys.

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

• meta (APIKeysResponseMeta, optional) – Additional information related to api keys response.

api_keys_response_meta

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.

api_keys_response_meta_page

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.

api_keys_sort

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.

api_keys_type

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.

apm_retention_filter_type

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.

application_key_create_attributes

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.

application_key_create_data

class ApplicationKeyCreateData(*args, **kwargs)

Bases: ModelNormal

Object used to create an application key.

Parameters:

• attributes (ApplicationKeyCreateAttributes) – Attributes used to create an application Key.

• type (ApplicationKeysType) – Application Keys resource type.

application_key_create_request

class ApplicationKeyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to create an application key.

Parameters:

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

application_key_relationships

class ApplicationKeyRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to the application key.

Parameters:

owned_by (RelationshipToUser, optional) – Relationship to user.

application_key_response

class ApplicationKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving an application key.

Parameters:

• data (FullApplicationKey, optional) – Datadog application key.

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

application_key_response_included_item

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.

application_key_response_meta

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.

application_key_response_meta_page

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.

application_key_update_attributes

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.

application_key_update_data

class ApplicationKeyUpdateData(*args, **kwargs)

Bases: ModelNormal

Object used to update an application key.

Parameters:

• attributes (ApplicationKeyUpdateAttributes) – Attributes used to update an application Key.

• id (str) – ID of the application key.

• type (ApplicationKeysType) – Application Keys resource type.

application_key_update_request

class ApplicationKeyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request used to update an application key.

Parameters:

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

application_keys_sort

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.

application_keys_type

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.

audit_logs_event

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.

audit_logs_event_attributes

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.

audit_logs_event_type

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.

audit_logs_events_response

class AuditLogsEventsResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([AuditLogsEvent], optional) – Array of events matching the request.

• links (AuditLogsResponseLinks, optional) – Links attributes.

• meta (AuditLogsResponseMetadata, optional) – The metadata associated with a request.

audit_logs_query_filter

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

audit_logs_query_options

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

audit_logs_query_page_options

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.

audit_logs_response_links

class AuditLogsResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

audit_logs_response_metadata

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.

audit_logs_response_page

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

audit_logs_response_status

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.

audit_logs_search_events_request

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.

audit_logs_sort

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.

audit_logs_warning

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.

authn_mapping

class AuthNMapping(*args, **kwargs)

Bases: ModelNormal

The AuthN Mapping object returned by API.

Parameters:

• attributes (AuthNMappingAttributes, optional) – Attributes of AuthN Mapping.

• id (str) – ID of the AuthN Mapping.

• relationships (AuthNMappingRelationships, optional) – All relationships associated with AuthN Mapping.

• type (AuthNMappingsType) – AuthN Mappings resource type.

authn_mapping_attributes

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.

authn_mapping_create_attributes

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.

authn_mapping_create_data

class AuthNMappingCreateData(*args, **kwargs)

Bases: ModelNormal

Data for creating an AuthN Mapping.

Parameters:

• attributes (AuthNMappingCreateAttributes, optional) – Key/Value pair of attributes used for create request.

• relationships (AuthNMappingCreateRelationships, optional) – Relationship of AuthN Mapping create object to Role.

• type (AuthNMappingsType) – AuthN Mappings resource type.

authn_mapping_create_relationships

class AuthNMappingCreateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationship of AuthN Mapping create object to Role.

Parameters:

role (RelationshipToRole, optional) – Relationship to role.

authn_mapping_create_request

class AuthNMappingCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating an AuthN Mapping.

Parameters:

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

authn_mapping_included

class AuthNMappingIncluded(*args, **kwargs)

Bases: ModelComposed

Included data in the AuthN Mapping response.

Parameters:

• attributes (SAMLAssertionAttributeAttributes, optional) – Key/Value pair of attributes used in SAML assertion attributes.

• id (str) – The ID of the SAML assertion attribute.

• type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.

• relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.

authn_mapping_relationships

class AuthNMappingRelationships(*args, **kwargs)

Bases: ModelNormal

All relationships associated with AuthN Mapping.

Parameters:

• role (RelationshipToRole, optional) – Relationship to role.

• saml_assertion_attribute (RelationshipToSAMLAssertionAttribute, optional) – AuthN Mapping relationship to SAML Assertion Attribute.

authn_mapping_response

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.

authn_mapping_update_attributes

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.

authn_mapping_update_data

class AuthNMappingUpdateData(*args, **kwargs)

Bases: ModelNormal

Data for updating an AuthN Mapping.

Parameters:

• attributes (AuthNMappingUpdateAttributes, optional) – Key/Value pair of attributes used for update request.

• id (str) – ID of the AuthN Mapping.

• relationships (AuthNMappingUpdateRelationships, optional) – Relationship of AuthN Mapping update object to Role.

• type (AuthNMappingsType) – AuthN Mappings resource type.

authn_mapping_update_relationships

class AuthNMappingUpdateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationship of AuthN Mapping update object to Role.

Parameters:

role (RelationshipToRole, optional) – Relationship to role.

authn_mapping_update_request

class AuthNMappingUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request to update an AuthN Mapping.

Parameters:

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

authn_mappings_response

class AuthNMappingsResponse(*args, **kwargs)

Bases: ModelNormal

Array of AuthN Mappings response.

Parameters:

• data ([AuthNMapping], optional) – Array of returned AuthN Mappings.

• included ([AuthNMappingIncluded], optional) – Included data in the AuthN Mapping response.

• meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

authn_mappings_sort

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.

authn_mappings_type

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.

aws_cur_config

class AwsCURConfig(*args, **kwargs)

Bases: ModelNormal

AWS CUR config.

Parameters:

• attributes (AwsCURConfigAttributes) – Attributes for An AWS CUR config.

• id (int, optional) – The ID of the AWS CUR config.

• type (AwsCURConfigType) – Type of AWS CUR config.

aws_cur_config_attributes

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.

aws_cur_config_patch_data

class AwsCURConfigPatchData(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Patch data.

Parameters:

• attributes (AwsCURConfigPatchRequestAttributes) – Attributes for AWS CUR config Patch Request.

• type (AwsCURConfigPatchRequestType) – Type of AWS CUR config Patch Request.

aws_cur_config_patch_request

class AwsCURConfigPatchRequest(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Patch Request.

Parameters:

data (AwsCURConfigPatchData) – AWS CUR config Patch data.

aws_cur_config_patch_request_attributes

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.

aws_cur_config_patch_request_type

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.

aws_cur_config_post_data

class AwsCURConfigPostData(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Post data.

Parameters:

• attributes (AwsCURConfigPostRequestAttributes) – Attributes for AWS CUR config Post Request.

• type (AwsCURConfigPostRequestType) – Type of AWS CUR config Post Request.

aws_cur_config_post_request

class AwsCURConfigPostRequest(*args, **kwargs)

Bases: ModelNormal

AWS CUR config Post Request.

Parameters:

data (AwsCURConfigPostData) – AWS CUR config Post data.

aws_cur_config_post_request_attributes

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.

aws_cur_config_post_request_type

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.

aws_cur_config_response

class AwsCURConfigResponse(*args, **kwargs)

Bases: ModelNormal

Response of AWS CUR config.

Parameters:

data (AwsCURConfig, optional) – AWS CUR config.

aws_cur_config_type

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.

aws_cur_configs_response

class AwsCURConfigsResponse(*args, **kwargs)

Bases: ModelNormal

List of AWS CUR configs.

Parameters:

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

aws_related_account

class AWSRelatedAccount(*args, **kwargs)

Bases: ModelNormal

AWS related account.

Parameters:

• attributes (AWSRelatedAccountAttributes, optional) – Attributes for an AWS related account.

• id (str) – The AWS account ID.

• type (AWSRelatedAccountType) – Type of AWS related account.

aws_related_account_attributes

class AWSRelatedAccountAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for an AWS related account.

Parameters:

• has_datadog_integration (bool, optional) – Whether or not the AWS account has a Datadog integration.

• name (str, optional) – The name of the AWS account.

aws_related_account_type

class AWSRelatedAccountType(*args, **kwargs)

Bases: ModelSimple

Type of AWS related account.

Parameters:

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

aws_related_accounts_response

class AWSRelatedAccountsResponse(*args, **kwargs)

Bases: ModelNormal

List of AWS related accounts.

Parameters:

data ([AWSRelatedAccount], optional) – An AWS related account.

azure_uc_config

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.

azure_uc_config_pair

class AzureUCConfigPair(*args, **kwargs)

Bases: ModelNormal

Azure config pair.

Parameters:

• attributes (AzureUCConfigPairAttributes) – Attributes for Azure config pair.

• id (int, optional) – The ID of Cloud Cost Management account.

• type (AzureUCConfigPairType) – Type of Azure config pair.

azure_uc_config_pair_attributes

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.

azure_uc_config_pair_type

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.

azure_uc_config_pairs_response

class AzureUCConfigPairsResponse(*args, **kwargs)

Bases: ModelNormal

Response of Azure config pair.

Parameters:

data (AzureUCConfigPair, optional) – Azure config pair.

azure_uc_config_patch_data

class AzureUCConfigPatchData(*args, **kwargs)

Bases: ModelNormal

Azure config Patch data.

Parameters:

• attributes (AzureUCConfigPatchRequestAttributes) – Attributes for Azure config Patch Request.

• type (AzureUCConfigPatchRequestType) – Type of Azure config Patch Request.

azure_uc_config_patch_request

class AzureUCConfigPatchRequest(*args, **kwargs)

Bases: ModelNormal

Azure config Patch Request.

Parameters:

data (AzureUCConfigPatchData) – Azure config Patch data.

azure_uc_config_patch_request_attributes

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.

azure_uc_config_patch_request_type

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.

azure_uc_config_post_data

class AzureUCConfigPostData(*args, **kwargs)

Bases: ModelNormal

Azure config Post data.

Parameters:

• attributes (AzureUCConfigPostRequestAttributes) – Attributes for Azure config Post Request.

• type (AzureUCConfigPostRequestType) – Type of Azure config Post Request.

azure_uc_config_post_request

class AzureUCConfigPostRequest(*args, **kwargs)

Bases: ModelNormal

Azure config Post Request.

Parameters:

data (AzureUCConfigPostData) – Azure config Post data.

azure_uc_config_post_request_attributes

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.

azure_uc_config_post_request_type

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.

azure_uc_configs_response

class AzureUCConfigsResponse(*args, **kwargs)

Bases: ModelNormal

List of Azure accounts with configs.

Parameters:

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

bill_config

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.

bulk_mute_findings_request

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.

bulk_mute_findings_request_attributes

class BulkMuteFindingsRequestAttributes(*args, **kwargs)

Bases: ModelNormal

The mute properties to be updated.

Parameters:

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

bulk_mute_findings_request_data

class BulkMuteFindingsRequestData(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• attributes (BulkMuteFindingsRequestAttributes) – The mute properties to be updated.

• id (str) – UUID to identify the request

• meta (BulkMuteFindingsRequestMeta) – Meta object containing the findings to be updated.

• type (FindingType) – The JSON:API type for findings.

bulk_mute_findings_request_meta

class BulkMuteFindingsRequestMeta(*args, **kwargs)

Bases: ModelNormal

Meta object containing the findings to be updated.

Parameters:

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

bulk_mute_findings_request_meta_findings

class BulkMuteFindingsRequestMetaFindings(*args, **kwargs)

Bases: ModelNormal

Finding object containing the finding information.

Parameters:

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

bulk_mute_findings_request_properties

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.

bulk_mute_findings_response

class BulkMuteFindingsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema.

Parameters:

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

bulk_mute_findings_response_data

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.

chargeback_breakdown

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.

ci_app_aggregate_bucket_value

class CIAppAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

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

ci_app_aggregate_bucket_value_timeseries

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.

ci_app_aggregate_bucket_value_timeseries_point

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.

ci_app_aggregate_sort

class CIAppAggregateSort(*args, **kwargs)

Bases: ModelNormal

A sort rule.

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.

ci_app_aggregate_sort_type

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.

ci_app_aggregation_function

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.

ci_app_ci_error

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.

ci_app_ci_error_domain

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.

ci_app_compute

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.

ci_app_compute_type

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.

ci_app_computes

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.

ci_app_create_pipeline_event_request

class CIAppCreatePipelineEventRequest(*args, **kwargs)

Bases: ModelNormal

Request object.

Parameters:

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

ci_app_create_pipeline_event_request_attributes

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.

ci_app_create_pipeline_event_request_attributes_resource

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

ci_app_create_pipeline_event_request_data

class CIAppCreatePipelineEventRequestData(*args, **kwargs)

Bases: ModelNormal

Data of the pipeline event to create.

Parameters:

• attributes (CIAppCreatePipelineEventRequestAttributes, optional) – Attributes of the pipeline event to create.

• type (CIAppCreatePipelineEventRequestDataType, optional) – Type of the event.

ci_app_create_pipeline_event_request_data_type

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.

ci_app_event_attributes

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.

ci_app_git_info

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

ci_app_group_by_histogram

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

ci_app_group_by_missing

class CIAppGroupByMissing(*args, **kwargs)

Bases: ModelComposed

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

ci_app_group_by_total

class CIAppGroupByTotal(*args, **kwargs)

Bases: ModelComposed

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

ci_app_host_info

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.

ci_app_pipeline_event

class CIAppPipelineEvent(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

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

• id (str, optional) – Unique ID of the event.

• type (CIAppPipelineEventTypeName, optional) – Type of the event.

ci_app_pipeline_event_attributes

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.

ci_app_pipeline_event_job

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.

ci_app_pipeline_event_job_level

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.

ci_app_pipeline_event_job_status

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.

ci_app_pipeline_event_parameters

class CIAppPipelineEventParameters(*args, **kwargs)

Bases: ModelNormal

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

ci_app_pipeline_event_parent_pipeline

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.

ci_app_pipeline_event_pipeline

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.

ci_app_pipeline_event_pipeline_level

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.

ci_app_pipeline_event_pipeline_status

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.

ci_app_pipeline_event_previous_pipeline

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.

ci_app_pipeline_event_stage

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.

ci_app_pipeline_event_stage_level

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.

ci_app_pipeline_event_stage_status

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.

ci_app_pipeline_event_step

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.

ci_app_pipeline_event_step_level

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.

ci_app_pipeline_event_step_status

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.

ci_app_pipeline_event_type_name

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.

ci_app_pipeline_events_request

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.

ci_app_pipeline_events_response

class CIAppPipelineEventsResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([CIAppPipelineEvent], optional) – Array of events matching the request.

• links (CIAppResponseLinks, optional) – Links attributes.

• meta (CIAppResponseMetadataWithPagination, optional) – The metadata associated with a request.

ci_app_pipeline_level

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.

ci_app_pipelines_aggregate_request

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.

ci_app_pipelines_aggregation_buckets_response

class CIAppPipelinesAggregationBucketsResponse(*args, **kwargs)

Bases: ModelNormal

The query results.

Parameters:

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

ci_app_pipelines_analytics_aggregate_response

class CIAppPipelinesAnalyticsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the pipeline events aggregate API endpoint.

Parameters:

• data (CIAppPipelinesAggregationBucketsResponse, optional) – The query results.

• links (CIAppResponseLinks, optional) – Links attributes.

• meta (CIAppResponseMetadata, optional) – The metadata associated with a request.

ci_app_pipelines_bucket_response

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.

ci_app_pipelines_group_by

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.

• total (CIAppGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

ci_app_pipelines_query_filter

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

ci_app_query_options

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

ci_app_query_page_options

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.

ci_app_response_links

class CIAppResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

ci_app_response_metadata

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.

ci_app_response_metadata_with_pagination

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.

ci_app_response_page

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

ci_app_response_status

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.

ci_app_sort

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.

ci_app_sort_order

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.

ci_app_test_event

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.

ci_app_test_event_type_name

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.

ci_app_test_events_request

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.

ci_app_test_events_response

class CIAppTestEventsResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([CIAppTestEvent], optional) – Array of events matching the request.

• links (CIAppResponseLinks, optional) – Links attributes.

• meta (CIAppResponseMetadataWithPagination, optional) – The metadata associated with a request.

ci_app_test_level

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.

ci_app_tests_aggregate_request

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.

ci_app_tests_aggregation_buckets_response

class CIAppTestsAggregationBucketsResponse(*args, **kwargs)

Bases: ModelNormal

The query results.

Parameters:

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

ci_app_tests_analytics_aggregate_response

class CIAppTestsAnalyticsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the test events aggregate API endpoint.

Parameters:

• data (CIAppTestsAggregationBucketsResponse, optional) – The query results.

• links (CIAppResponseLinks, optional) – Links attributes.

• meta (CIAppResponseMetadataWithPagination, optional) – The metadata associated with a request.

ci_app_tests_bucket_response

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.

ci_app_tests_group_by

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.

• total (CIAppGroupByTotal, optional) – A resulting object to put the given computes in over all the matching records.

ci_app_tests_query_filter

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

ci_app_warning

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.

cloud_configuration_compliance_rule_options

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.

cloud_configuration_rego_rule

class CloudConfigurationRegoRule(*args, **kwargs)

Bases: ModelNormal

Rule details.

Parameters:

• policy (str) – The policy written in rego , see: https://www.openpolicyagent.org/docs/latest/policy-language/

• resource_types ([str]) – List of resource types that will be evaluated upon. Must have at least one element.

cloud_configuration_rule_case_create

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.

cloud_configuration_rule_compliance_signal_options

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.

cloud_configuration_rule_create_payload

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.

cloud_configuration_rule_options

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.

cloud_configuration_rule_type

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.

cloud_cost_activity

class CloudCostActivity(*args, **kwargs)

Bases: ModelNormal

Cloud Cost Activity.

Parameters:

• attributes (CloudCostActivityAttributes) – Attributes for Cloud Cost activity.

• type (CloudCostActivityType) – Type of Cloud Cost Activity.

cloud_cost_activity_attributes

class CloudCostActivityAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for Cloud Cost activity.

Parameters:

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

cloud_cost_activity_response

class CloudCostActivityResponse(*args, **kwargs)

Bases: ModelNormal

Response for Cloud Cost activity.

Parameters:

data (CloudCostActivity, optional) – Cloud Cost Activity.

cloud_cost_activity_type

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.

cloud_workload_security_agent_rule_attributes

class CloudWorkloadSecurityAgentRuleAttributes(*args, **kwargs)

Bases: ModelNormal

A Cloud Workload Security Agent rule returned by the API.

Parameters:

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

cloud_workload_security_agent_rule_create_attributes

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.

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

cloud_workload_security_agent_rule_create_data

class CloudWorkloadSecurityAgentRuleCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule.

Parameters:

• attributes (CloudWorkloadSecurityAgentRuleCreateAttributes) – Create a new Cloud Workload Security Agent rule.

• type (CloudWorkloadSecurityAgentRuleType) – The type of the resource. The value should always be agent_rule.

cloud_workload_security_agent_rule_create_request

class CloudWorkloadSecurityAgentRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request object that includes the Agent rule to create.

Parameters:

data (CloudWorkloadSecurityAgentRuleCreateData) – Object for a single Agent rule.

cloud_workload_security_agent_rule_creator_attributes

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.

cloud_workload_security_agent_rule_data

class CloudWorkloadSecurityAgentRuleData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule.

Parameters:

• attributes (CloudWorkloadSecurityAgentRuleAttributes, optional) – A Cloud Workload Security Agent rule returned by the API.

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

• type (CloudWorkloadSecurityAgentRuleType, optional) – The type of the resource. The value should always be agent_rule.

cloud_workload_security_agent_rule_response

class CloudWorkloadSecurityAgentRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes an Agent rule.

Parameters:

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

cloud_workload_security_agent_rule_type

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.

cloud_workload_security_agent_rule_update_attributes

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.

cloud_workload_security_agent_rule_update_data

class CloudWorkloadSecurityAgentRuleUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single Agent rule.

Parameters:

• attributes (CloudWorkloadSecurityAgentRuleUpdateAttributes) – Update an existing Cloud Workload Security Agent rule.

• type (CloudWorkloadSecurityAgentRuleType) – The type of the resource. The value should always be agent_rule.

cloud_workload_security_agent_rule_update_request

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.

cloud_workload_security_agent_rule_updater_attributes

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.

cloud_workload_security_agent_rules_list_response

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.

cloudflare_account_create_request

class CloudflareAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when adding a Cloudflare account.

Parameters:

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

cloudflare_account_create_request_attributes

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.

• zones ([str], optional) – An allowlist of zones to restrict pulling metrics for.

cloudflare_account_create_request_data

class CloudflareAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for creating a Cloudflare account.

Parameters:

• attributes (CloudflareAccountCreateRequestAttributes) – Attributes object for creating a Cloudflare account.

• type (CloudflareAccountType) – The JSON:API type for this API. Should always be cloudflare-accounts.

cloudflare_account_response

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.

cloudflare_account_response_attributes

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 to restrict pulling metrics for.

• zones ([str], optional) – An allowlist of zones to restrict pulling metrics for.

cloudflare_account_response_data

class CloudflareAccountResponseData(*args, **kwargs)

Bases: ModelNormal

Data object of a Cloudflare account.

Parameters:

• attributes (CloudflareAccountResponseAttributes) – Attributes object of a Cloudflare account.

• id (str) – The ID of the Cloudflare account, a hash of the account name.

• type (CloudflareAccountType) – The JSON:API type for this API. Should always be cloudflare-accounts.

cloudflare_account_type

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.

cloudflare_account_update_request

class CloudflareAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when updating a Cloudflare account.

Parameters:

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

cloudflare_account_update_request_attributes

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.

• resources ([str], optional) – An allowlist of resources to restrict pulling metrics for.

• zones ([str], optional) – An allowlist of zones to restrict pulling metrics for.

cloudflare_account_update_request_data

class CloudflareAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Cloudflare account.

Parameters:

• attributes (CloudflareAccountUpdateRequestAttributes, optional) – Attributes object for updating a Cloudflare account.

• type (CloudflareAccountType, optional) – The JSON:API type for this API. Should always be cloudflare-accounts.

cloudflare_accounts_response

class CloudflareAccountsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Cloudflare accounts.

Parameters:

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

confluent_account_create_request

class ConfluentAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when adding a Confluent account.

Parameters:

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

confluent_account_create_request_attributes

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.

confluent_account_create_request_data

class ConfluentAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

The data body for adding a Confluent account.

Parameters:

• attributes (ConfluentAccountCreateRequestAttributes) – Attributes associated with the account creation request.

• type (ConfluentAccountType) – The JSON:API type for this API. Should always be confluent-cloud-accounts.

confluent_account_resource_attributes

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.

confluent_account_response

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.

confluent_account_response_attributes

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.

confluent_account_response_data

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.

confluent_account_type

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.

confluent_account_update_request

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.

confluent_account_update_request_attributes

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.

confluent_account_update_request_data

class ConfluentAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Confluent account.

Parameters:

• attributes (ConfluentAccountUpdateRequestAttributes) – Attributes object for updating a Confluent account.

• type (ConfluentAccountType) – The JSON:API type for this API. Should always be confluent-cloud-accounts.

confluent_accounts_response

class ConfluentAccountsResponse(*args, **kwargs)

Bases: ModelNormal

Confluent account returned by the API.

Parameters:

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

confluent_resource_request

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.

confluent_resource_request_attributes

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.

confluent_resource_request_data

class ConfluentResourceRequestData(*args, **kwargs)

Bases: ModelNormal

JSON:API request for updating a Confluent resource.

Parameters:

• attributes (ConfluentResourceRequestAttributes) – Attributes object for updating a Confluent resource.

• id (str) – The ID associated with a Confluent resource.

• type (ConfluentResourceType) – The JSON:API type for this request.

confluent_resource_response

class ConfluentResourceResponse(*args, **kwargs)

Bases: ModelNormal

Response schema when interacting with a Confluent resource.

Parameters:

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

confluent_resource_response_attributes

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.

confluent_resource_response_data

class ConfluentResourceResponseData(*args, **kwargs)

Bases: ModelNormal

Confluent Cloud resource data.

Parameters:

• attributes (ConfluentResourceResponseAttributes) – Model representation of a Confluent Cloud resource.

• id (str) – The ID associated with the Confluent resource.

• type (ConfluentResourceType) – The JSON:API type for this request.

confluent_resource_type

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.

confluent_resources_response

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.

container

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.

container_attributes

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.

container_group

class ContainerGroup(*args, **kwargs)

Bases: ModelNormal

Container group object.

Parameters:

• attributes (ContainerGroupAttributes, optional) – Attributes for a container group.

• id (str, optional) – Container Group ID.

• relationships (ContainerGroupRelationships, optional) – Relationships to containers inside a container group.

• type (ContainerGroupType, optional) – Type of container group.

container_group_attributes

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.

container_group_relationships

class ContainerGroupRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships to containers inside a container group.

Parameters:

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

container_group_relationships_link

class ContainerGroupRelationshipsLink(*args, **kwargs)

Bases: ModelNormal

Relationships to Containers inside a Container Group.

Parameters:

• data ([str], optional) – Links data.

• links (ContainerGroupRelationshipsLinks, optional) – Links attributes.

container_group_relationships_links

class ContainerGroupRelationshipsLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

container_group_type

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.

container_image

class ContainerImage(*args, **kwargs)

Bases: ModelNormal

Container Image object.

Parameters:

• attributes (ContainerImageAttributes, optional) – Attributes for a Container Image.

• id (str, optional) – Container Image ID.

• type (ContainerImageType, optional) – Type of Container Image.

container_image_attributes

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.

container_image_flavor

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.

container_image_group

class ContainerImageGroup(*args, **kwargs)

Bases: ModelNormal

Container Image Group object.

Parameters:

• attributes (ContainerImageGroupAttributes, optional) – Attributes for a Container Image Group.

• id (str, optional) – Container Image Group ID.

• relationships (ContainerImageGroupRelationships, optional) – Relationships inside a Container Image Group.

• type (ContainerImageGroupType, optional) – Type of Container Image Group.

container_image_group_attributes

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.

container_image_group_images_relationships_link

class ContainerImageGroupImagesRelationshipsLink(*args, **kwargs)

Bases: ModelNormal

Relationships to Container Images inside a Container Image Group.

Parameters:

• data ([str], optional) – Links data.

• links (ContainerImageGroupRelationshipsLinks, optional) – Links attributes.

container_image_group_relationships

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.

container_image_group_relationships_links

class ContainerImageGroupRelationshipsLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

container_image_group_type

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.

container_image_item

class ContainerImageItem(*args, **kwargs)

Bases: ModelComposed

Possible Container Image models.

Parameters:

• attributes (ContainerImageAttributes, optional) – Attributes for a Container Image.

• id (str, optional) – Container Image ID.

• type (ContainerImageType, optional) – Type of Container Image.

• relationships (ContainerImageGroupRelationships, optional) – Relationships inside a Container Image Group.

container_image_meta

class ContainerImageMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:

pagination (ContainerImageMetaPage, optional) – Paging attributes.

container_image_meta_page

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.

container_image_meta_page_type

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.

container_image_type

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.

container_image_vulnerabilities

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.

container_images_response

class ContainerImagesResponse(*args, **kwargs)

Bases: ModelNormal

List of Container Images.

Parameters:

• data ([ContainerImageItem], optional) – Array of Container Image objects.

• links (ContainerImagesResponseLinks, optional) – Pagination links.

• meta (ContainerImageMeta, optional) – Response metadata object.

container_images_response_links

class ContainerImagesResponseLinks(*args, **kwargs)

Bases: ModelNormal

Pagination links.

Parameters:

• first (str, optional) – Link to the first page.

• last (str, none_type, optional) – Link to the last page.

• next (str, none_type, optional) – Link to the next page.

• prev (str, none_type, optional) – Link to previous page.

• self (str, optional) – Link to current page.

container_item

class ContainerItem(*args, **kwargs)

Bases: ModelComposed

Possible Container models.

Parameters:

• attributes (ContainerAttributes, optional) – Attributes for a container.

• id (str, optional) – Container ID.

• type (ContainerType, optional) – Type of container.

• relationships (ContainerGroupRelationships, optional) – Relationships to containers inside a container group.

container_meta

class ContainerMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:

pagination (ContainerMetaPage, optional) – Paging attributes.

container_meta_page

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.

container_meta_page_type

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.

container_type

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.

containers_response

class ContainersResponse(*args, **kwargs)

Bases: ModelNormal

List of containers.

Parameters:

• data ([ContainerItem], optional) – Array of Container objects.

• links (ContainersResponseLinks, optional) – Pagination links.

• meta (ContainerMeta, optional) – Response metadata object.

containers_response_links

class ContainersResponseLinks(*args, **kwargs)

Bases: ModelNormal

Pagination links.

Parameters:

• first (str, optional) – Link to the first page.

• last (str, none_type, optional) – Link to the last page.

• next (str, none_type, optional) – Link to the next page.

• prev (str, none_type, optional) – Link to previous page.

• self (str, optional) – Link to current page.

content_encoding

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.

cost_attribution_aggregates_body

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.

cost_attribution_tag_names

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.

cost_attribution_type

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.

cost_by_org

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.

cost_by_org_attributes

class CostByOrgAttributes(*args, **kwargs)

Bases: ModelNormal

Cost attributes data.

Parameters:

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

cost_by_org_response

class CostByOrgResponse(*args, **kwargs)

Bases: ModelNormal

Chargeback Summary response.

Parameters:

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

cost_by_org_type

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.

create_open_api_response

class CreateOpenAPIResponse(*args, **kwargs)

Bases: ModelNormal

Response for CreateOpenAPI operation.

Parameters:

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

create_open_api_response_attributes

class CreateOpenAPIResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for CreateOpenAPI.

Parameters:

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

create_open_api_response_data

class CreateOpenAPIResponseData(*args, **kwargs)

Bases: ModelNormal

Data envelope for CreateOpenAPIResponse.

Parameters:

• attributes (CreateOpenAPIResponseAttributes, optional) – Attributes for CreateOpenAPI.

• id (UUID, optional) – API identifier.

create_rule_request

class CreateRuleRequest(*args, **kwargs)

Bases: ModelNormal

Scorecard create rule request.

Parameters:

data (CreateRuleRequestData, optional) – Scorecard create rule request data.

create_rule_request_data

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.

create_rule_response

class CreateRuleResponse(*args, **kwargs)

Bases: ModelNormal

Created rule in response.

Parameters:

data (CreateRuleResponseData, optional) – Create rule response data.

create_rule_response_data

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.

creator

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.

dashboard_list_add_items_request

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.

dashboard_list_add_items_response

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.

dashboard_list_delete_items_request

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.

dashboard_list_delete_items_response

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.

dashboard_list_item

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.

dashboard_list_item_request

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.

dashboard_list_item_response

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.

dashboard_list_items

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.

dashboard_list_update_items_request

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.

dashboard_list_update_items_response

class DashboardListUpdateItemsResponse(*args, **kwargs)

Bases: ModelNormal

Response containing a list of updated dashboards.

Parameters:

dashboards ([DashboardListItemResponse], optional) – List of dashboards in the dashboard list.

dashboard_type

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.

data_scalar_column

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.

detailed_finding

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.

detailed_finding_attributes

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.

detailed_finding_type

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.

dora_deployment_request

class DORADeploymentRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a DORA deployment event.

Parameters:

data (DORADeploymentRequestData) – The JSON:API data.

dora_deployment_request_attributes

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 in nanoseconds when the deployment finished. It should not be older than 3 hours.

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

• id (str, optional) – Deployment ID.

• service (str) – Service name from a service available in the Service Catalog.

• started_at (int) – Unix timestamp in nanoseconds when the deployment started.

• version (str, optional) – Version to correlate with APM Deployment Tracking.

dora_deployment_request_data

class DORADeploymentRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:

attributes (DORADeploymentRequestAttributes) – Attributes to create a DORA deployment event.

dora_deployment_response

class DORADeploymentResponse(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA deployment event.

Parameters:

data (DORADeploymentResponseData) – The JSON:API data.

dora_deployment_response_data

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.

dora_deployment_type

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.

dora_git_info

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

dora_incident_request

class DORAIncidentRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a DORA incident event.

Parameters:

data (DORAIncidentRequestData) – The JSON:API data.

dora_incident_request_attributes

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 in nanoseconds when the incident finished. It should not be older than 3 hours.

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

• id (str, optional) – Incident ID

• name (str, optional) – Incident name.

• service (str) – Service name from a service available in the Service Catalog.

• severity (str, optional) – Incident severity.

• started_at (int) – Unix timestamp in nanoseconds when the incident started.

• version (str, optional) –

  Version to correlate with APM Deployment Tracking.

dora_incident_request_data

class DORAIncidentRequestData(*args, **kwargs)

Bases: ModelNormal

The JSON:API data.

Parameters:

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

dora_incident_response

class DORAIncidentResponse(*args, **kwargs)

Bases: ModelNormal

Response after receiving a DORA incident event.

Parameters:

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

dora_incident_response_data

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.

dora_incident_type

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.

downtime_create_request

class DowntimeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a downtime.

Parameters:

data (DowntimeCreateRequestData) – Object to create a downtime.

downtime_create_request_attributes

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.

downtime_create_request_data

class DowntimeCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Object to create a downtime.

Parameters:

• attributes (DowntimeCreateRequestAttributes) – Downtime details.

• type (DowntimeResourceType) – Downtime resource type.

downtime_included_monitor_type

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.

downtime_meta

class DowntimeMeta(*args, **kwargs)

Bases: ModelNormal

Pagination metadata returned by the API.

Parameters:

page (DowntimeMetaPage, optional) – Object containing the total filtered count.

downtime_meta_page

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.

downtime_monitor_identifier

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.

downtime_monitor_identifier_id

class DowntimeMonitorIdentifierId(*args, **kwargs)

Bases: ModelNormal

Object of the monitor identifier.

Parameters:

monitor_id (int) – ID of the monitor to prevent notifications.

downtime_monitor_identifier_tags

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.

downtime_monitor_included_attributes

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.

downtime_monitor_included_item

class DowntimeMonitorIncludedItem(*args, **kwargs)

Bases: ModelNormal

Information about the monitor identified by the downtime.

Parameters:

• attributes (DowntimeMonitorIncludedAttributes, optional) – Attributes of the monitor identified by the downtime.

• id (int, optional) – ID of the monitor identified by the downtime.

• type (DowntimeIncludedMonitorType, optional) – Monitor resource type.

downtime_notify_end_state_actions

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.

downtime_notify_end_state_types

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.

downtime_relationships

class DowntimeRelationships(*args, **kwargs)

Bases: ModelNormal

All relationships associated with downtime.

Parameters:

• created_by (DowntimeRelationshipsCreatedBy, optional) – The user who created the downtime.

• monitor (DowntimeRelationshipsMonitor, optional) – The monitor identified by the downtime.

downtime_relationships_created_by

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.

downtime_relationships_created_by_data

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.

downtime_relationships_monitor

class DowntimeRelationshipsMonitor(*args, **kwargs)

Bases: ModelNormal

The monitor identified by the downtime.

Parameters:

data (DowntimeRelationshipsMonitorData, none_type, optional) – Data for the monitor.

downtime_relationships_monitor_data

class DowntimeRelationshipsMonitorData(*args, **kwargs)

Bases: ModelNormal

Data for the monitor.

Parameters:

• id (str, optional) – Monitor ID of the downtime.

• type (DowntimeIncludedMonitorType, optional) – Monitor resource type.

downtime_resource_type

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.

downtime_response

class DowntimeResponse(*args, **kwargs)

Bases: ModelNormal

Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags.

Parameters:

• data (DowntimeResponseData, optional) – Downtime data.

• included ([DowntimeResponseIncludedItem], optional) – Array of objects related to the downtime that the user requested.

downtime_response_attributes

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.

downtime_response_data

class DowntimeResponseData(*args, **kwargs)

Bases: ModelNormal

Downtime data.

Parameters:

• attributes (DowntimeResponseAttributes, optional) – Downtime details.

• id (str, optional) – The downtime ID.

• relationships (DowntimeRelationships, optional) – All relationships associated with downtime.

• type (DowntimeResourceType, optional) – Downtime resource type.

downtime_response_included_item

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.

downtime_schedule_create_request

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.

downtime_schedule_current_downtime_response

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.

downtime_schedule_one_time_create_update_request

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.

downtime_schedule_one_time_response

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.

downtime_schedule_recurrence_create_update_request

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.

downtime_schedule_recurrence_response

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.

downtime_schedule_recurrences_create_request

class DowntimeScheduleRecurrencesCreateRequest(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:

• recurrences ([DowntimeScheduleRecurrenceCreateUpdateRequest]) – A list of downtime recurrences.

• timezone (str, optional) – The timezone in which to schedule the downtime.

downtime_schedule_recurrences_response

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.

downtime_schedule_recurrences_update_request

class DowntimeScheduleRecurrencesUpdateRequest(*args, **kwargs)

Bases: ModelNormal

A recurring downtime schedule definition.

Parameters:

• recurrences ([DowntimeScheduleRecurrenceCreateUpdateRequest], optional) – A list of downtime recurrences.

• timezone (str, optional) – The timezone in which to schedule the downtime.

downtime_schedule_response

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.

downtime_schedule_update_request

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.

downtime_status

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.

downtime_update_request

class DowntimeUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Request for editing a downtime.

Parameters:

data (DowntimeUpdateRequestData) – Object to update a downtime.

downtime_update_request_attributes

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.

downtime_update_request_data

class DowntimeUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Object to update a downtime.

Parameters:

• attributes (DowntimeUpdateRequestAttributes) – Attributes of the downtime to update.

• id (str) – ID of this downtime.

• type (DowntimeResourceType) – Downtime resource type.

event

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.

event_attributes

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.

event_priority

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.

event_response

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.

event_response_attributes

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.

event_status_type

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.

event_type

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.

events_aggregation

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.

events_compute

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.

events_data_source

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.

events_group_by

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 number of groups to return.

• sort (EventsGroupBySort, optional) – The dimension by which to sort a query’s results.

events_group_by_sort

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.

events_list_request

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.

events_list_response

class EventsListResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([EventResponse], optional) – An array of events matching the request.

• links (EventsListResponseLinks, optional) – Links attributes.

• meta (EventsResponseMetadata, optional) – The metadata associated with a request.

events_list_response_links

class EventsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

events_query_filter

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.

events_query_group_bys

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.

events_query_options

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

events_request_page

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.

events_response_metadata

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.

events_response_metadata_page

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

events_scalar_query

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.

events_search

class EventsSearch(*args, **kwargs)

Bases: ModelNormal

Configuration of the search/filter for an events query.

Parameters:

query (str, optional) – The search/filter string for an events query.

events_sort

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.

events_sort_type

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.

events_timeseries_query

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.

events_warning

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.

fastly_accoun_response_attributes

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.

fastly_account_create_request

class FastlyAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when adding a Fastly account.

Parameters:

data (FastlyAccountCreateRequestData) – Data object for creating a Fastly account.

fastly_account_create_request_attributes

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.

fastly_account_create_request_data

class FastlyAccountCreateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for creating a Fastly account.

Parameters:

• attributes (FastlyAccountCreateRequestAttributes) – Attributes object for creating a Fastly account.

• type (FastlyAccountType) – The JSON:API type for this API. Should always be fastly-accounts.

fastly_account_response

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.

fastly_account_response_data

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.

fastly_account_type

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.

fastly_account_update_request

class FastlyAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema when updating a Fastly account.

Parameters:

data (FastlyAccountUpdateRequestData) – Data object for updating a Fastly account.

fastly_account_update_request_attributes

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.

fastly_account_update_request_data

class FastlyAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating a Fastly account.

Parameters:

• attributes (FastlyAccountUpdateRequestAttributes, optional) – Attributes object for updating a Fastly account.

• type (FastlyAccountType, optional) – The JSON:API type for this API. Should always be fastly-accounts.

fastly_accounts_response

class FastlyAccountsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Fastly accounts.

Parameters:

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

fastly_service

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.

fastly_service_attributes

class FastlyServiceAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes object for Fastly service requests.

Parameters:

tags ([str], optional) – A list of tags for the Fastly service.

fastly_service_data

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.

fastly_service_request

class FastlyServiceRequest(*args, **kwargs)

Bases: ModelNormal

Payload schema for Fastly service requests.

Parameters:

data (FastlyServiceData) – Data object for Fastly service requests.

fastly_service_response

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.

fastly_service_type

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.

fastly_services_response

class FastlyServicesResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Fastly services.

Parameters:

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

finding

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.

finding_attributes

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.

finding_evaluation

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.

finding_mute

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.

finding_mute_reason

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.

finding_rule

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.

finding_status

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.

finding_type

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.

formula_limit

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.

full_api_key

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.

full_api_key_attributes

class FullAPIKeyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a full API key.

Parameters:

• category (str, optional) – The category of the API key.

• created_at (str, 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 (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.

full_application_key

class FullApplicationKey(*args, **kwargs)

Bases: ModelNormal

Datadog application key.

Parameters:

• attributes (FullApplicationKeyAttributes, optional) – Attributes of a full application key.

• id (str, optional) – ID of the application key.

• relationships (ApplicationKeyRelationships, optional) – Resources related to the application key.

• type (ApplicationKeysType, optional) – Application Keys resource type.

full_application_key_attributes

class FullApplicationKeyAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of a full application key.

Parameters:

• created_at (str, 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.

gcp_service_account_meta

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.

gcp_service_account_type

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.

gcpsts_delegate_account

class GCPSTSDelegateAccount(*args, **kwargs)

Bases: ModelNormal

Datadog principal service account info.

Parameters:

• attributes (GCPSTSDelegateAccountAttributes, optional) – Your delegate account attributes.

• id (str, optional) – The ID of the delegate service account.

• type (GCPSTSDelegateAccountType, optional) – The type of account.

gcpsts_delegate_account_attributes

class GCPSTSDelegateAccountAttributes(*args, **kwargs)

Bases: ModelNormal

Your delegate account attributes.

Parameters:

delegate_account_email (str, optional) – Your organization’s Datadog principal email address.

gcpsts_delegate_account_response

class GCPSTSDelegateAccountResponse(*args, **kwargs)

Bases: ModelNormal

Your delegate service account response data.

Parameters:

data (GCPSTSDelegateAccount, optional) – Datadog principal service account info.

gcpsts_delegate_account_type

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.

gcpsts_service_account

class GCPSTSServiceAccount(*args, **kwargs)

Bases: ModelNormal

Info on your service account.

Parameters:

• attributes (GCPSTSServiceAccountAttributes, optional) – Attributes associated with your service account.

• id (str, optional) – Your service account’s unique ID.

• meta (GCPServiceAccountMeta, optional) – Additional information related to your service account.

• type (GCPServiceAccountType, optional) – The type of account.

gcpsts_service_account_attributes

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.

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

• resource_collection_enabled (bool, optional) – When enabled, Datadog scans for all resources in your GCP environment.

gcpsts_service_account_create_request

class GCPSTSServiceAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Data on your newly generated service account.

Parameters:

data (GCPSTSServiceAccountData, optional) – Additional metadata on your generated service account.

gcpsts_service_account_data

class GCPSTSServiceAccountData(*args, **kwargs)

Bases: ModelNormal

Additional metadata on your generated service account.

Parameters:

• attributes (GCPSTSServiceAccountAttributes, optional) – Attributes associated with your service account.

• type (GCPServiceAccountType, optional) – The type of account.

gcpsts_service_account_response

class GCPSTSServiceAccountResponse(*args, **kwargs)

Bases: ModelNormal

The account creation response.

Parameters:

data (GCPSTSServiceAccount, optional) – Info on your service account.

gcpsts_service_account_update_request

class GCPSTSServiceAccountUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Service account info.

Parameters:

data (GCPSTSServiceAccountUpdateRequestData, optional) – Data on your service account.

gcpsts_service_account_update_request_data

class GCPSTSServiceAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data on your service account.

Parameters:

• attributes (GCPSTSServiceAccountAttributes, optional) – Attributes associated with your service account.

• id (str, optional) – Your service account’s unique ID.

• type (GCPServiceAccountType, optional) – The type of account.

gcpsts_service_accounts_response

class GCPSTSServiceAccountsResponse(*args, **kwargs)

Bases: ModelNormal

Object containing all your STS enabled accounts.

Parameters:

data ([GCPSTSServiceAccount], optional) – Array of GCP STS enabled service accounts.

get_finding_response

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.

get_team_memberships_sort

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.

group_scalar_column

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.

group_tags

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.

hourly_usage

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.

hourly_usage_attributes

class HourlyUsageAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes of hourly usage for a product family for an org for a time period.

Parameters:

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

hourly_usage_measurement

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.

hourly_usage_metadata

class HourlyUsageMetadata(*args, **kwargs)

Bases: ModelNormal

The object containing document metadata.

Parameters:

pagination (HourlyUsagePagination, optional) – The metadata for the current pagination.

hourly_usage_pagination

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.

hourly_usage_response

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.

hourly_usage_type

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.

http_log

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.

http_log_error

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.

http_log_errors

class HTTPLogErrors(*args, **kwargs)

Bases: ModelNormal

Invalid query performed.

Parameters:

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

http_log_item

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.

httpci_app_error

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.

httpci_app_errors

class HTTPCIAppErrors(*args, **kwargs)

Bases: ModelNormal

Errors occurred.

Parameters:

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

idp_metadata_form_data

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

incident_attachment_attachment_type

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.

incident_attachment_attributes

class IncidentAttachmentAttributes(*args, **kwargs)

Bases: ModelComposed

The attributes object for an attachment.

Parameters:

• attachment (IncidentAttachmentsPostmortemAttributesAttachmentObject) – The postmortem attachment.

• attachment_type (IncidentAttachmentPostmortemAttachmentType) – The type of postmortem attachment attributes.

• modified (datetime, optional) – Timestamp when the incident attachment link was last modified.

incident_attachment_data

class IncidentAttachmentData(*args, **kwargs)

Bases: ModelNormal

A single incident attachment.

Parameters:

• attributes (IncidentAttachmentAttributes) – The attributes object for an attachment.

• id (str) – A unique identifier that represents the incident attachment.

• relationships (IncidentAttachmentRelationships) – The incident attachment’s relationships.

• type (IncidentAttachmentType) – The incident attachment resource type.

incident_attachment_link_attachment_type

class IncidentAttachmentLinkAttachmentType(*args, **kwargs)

Bases: ModelSimple

The type of link attachment attributes.

Parameters:

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

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

incident_attachment_link_attributes

class IncidentAttachmentLinkAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes object for a link attachment.

Parameters:

• attachment (IncidentAttachmentLinkAttributesAttachmentObject) – The link attachment.

• attachment_type (IncidentAttachmentLinkAttachmentType) – The type of link attachment attributes.

• modified (datetime, optional) – Timestamp when the incident attachment link was last modified.

incident_attachment_link_attributes_attachment_object

class IncidentAttachmentLinkAttributesAttachmentObject(*args, **kwargs)

Bases: ModelNormal

The link attachment.

Parameters:

• document_url (str) – The URL of this link attachment.

• title (str) – The title of this link attachment.

incident_attachment_postmortem_attachment_type

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.

incident_attachment_postmortem_attributes

class IncidentAttachmentPostmortemAttributes(*args, **kwargs)

Bases: ModelNormal

The attributes object for a postmortem attachment.

Parameters:

• attachment (IncidentAttachmentsPostmortemAttributesAttachmentObject) – The postmortem attachment.

• attachment_type (IncidentAttachmentPostmortemAttachmentType) – The type of postmortem attachment attributes.

incident_attachment_related_object

class IncidentAttachmentRelatedObject(*args, **kwargs)

Bases: ModelSimple

The object related to an incident attachment.

Parameters:

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

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

incident_attachment_relationships

class IncidentAttachmentRelationships(*args, **kwargs)

Bases: ModelNormal

The incident attachment’s relationships.

Parameters:

last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

incident_attachment_type

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.

incident_attachment_update_attributes

class IncidentAttachmentUpdateAttributes(*args, **kwargs)

Bases: ModelComposed

Incident attachment attributes.

Parameters:

• attachment (IncidentAttachmentsPostmortemAttributesAttachmentObject) – The postmortem attachment.

• attachment_type (IncidentAttachmentPostmortemAttachmentType) – The type of postmortem attachment attributes.

• modified (datetime, optional) – Timestamp when the incident attachment link was last modified.

incident_attachment_update_data

class IncidentAttachmentUpdateData(*args, **kwargs)

Bases: ModelNormal

A single incident attachment.

Parameters:

• attributes (IncidentAttachmentUpdateAttributes, optional) – Incident attachment attributes.

• id (str, optional) – A unique identifier that represents the incident attachment.

• type (IncidentAttachmentType) – The incident attachment resource type.

incident_attachment_update_request

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.

incident_attachment_update_response

class IncidentAttachmentUpdateResponse(*args, **kwargs)

Bases: ModelNormal

The response object containing the created or updated incident attachments.

Parameters:

• data ([IncidentAttachmentData]) – An array of incident attachments. Only the attachments that were created or updated by the request are returned.

• included ([IncidentAttachmentsResponseIncludedItem], optional) – Included related resources that the user requested.

incident_attachments_postmortem_attributes_attachment_object

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.

incident_attachments_response

class IncidentAttachmentsResponse(*args, **kwargs)

Bases: ModelNormal

The response object containing an incident’s attachments.

Parameters:

• data ([IncidentAttachmentData]) – An array of incident attachments.

• included ([IncidentAttachmentsResponseIncludedItem], optional) – Included related resources that the user requested.

incident_attachments_response_included_item

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.

incident_create_attributes

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.

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

incident_create_data

class IncidentCreateData(*args, **kwargs)

Bases: ModelNormal

Incident data for a create request.

Parameters:

• attributes (IncidentCreateAttributes) – The incident’s attributes for a create request.

• relationships (IncidentCreateRelationships, optional) – The relationships the incident will have with other resources once created.

• type (IncidentType) – Incident resource type.

incident_create_relationships

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.

incident_create_request

class IncidentCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident.

Parameters:

data (IncidentCreateData) – Incident data for a create request.

incident_field_attributes

class IncidentFieldAttributes(*args, **kwargs)

Bases: ModelComposed

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

Parameters:

• type (IncidentFieldAttributesSingleValueType, optional) – Type of the single value field definitions.

• value (str, none_type, optional) – The single value selected for this field.

incident_field_attributes_multiple_value

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.

incident_field_attributes_single_value

class IncidentFieldAttributesSingleValue(*args, **kwargs)

Bases: ModelNormal

A field with a single value selected.

Parameters:

• type (IncidentFieldAttributesSingleValueType, optional) – Type of the single value field definitions.

• value (str, none_type, optional) – The single value selected for this field.

incident_field_attributes_single_value_type

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.

incident_field_attributes_value_type

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.

incident_impacts_type

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.

incident_integration_metadata_attributes

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.

incident_integration_metadata_create_data

class IncidentIntegrationMetadataCreateData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata data for a create request.

Parameters:

• attributes (IncidentIntegrationMetadataAttributes) – Incident integration metadata’s attributes for a create request.

• type (IncidentIntegrationMetadataType) – Integration metadata resource type.

incident_integration_metadata_create_request

class IncidentIntegrationMetadataCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident integration metadata.

Parameters:

data (IncidentIntegrationMetadataCreateData) – Incident integration metadata data for a create request.

incident_integration_metadata_list_response

class IncidentIntegrationMetadataListResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident integration metadata.

Parameters:

• data ([IncidentIntegrationMetadataResponseData]) – An array of incident integration metadata.

• included ([IncidentIntegrationMetadataResponseIncludedItem], optional) – Included related resources that the user requested.

• meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

incident_integration_metadata_metadata

class IncidentIntegrationMetadataMetadata(*args, **kwargs)

Bases: ModelComposed

Incident integration metadata’s metadata attribute.

Parameters:

• channels ([SlackIntegrationMetadataChannelItem]) – Array of Slack channels in this integration metadata.

• issues ([JiraIntegrationMetadataIssuesItem]) – Array of Jira issues in this integration metadata.

incident_integration_metadata_patch_data

class IncidentIntegrationMetadataPatchData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata data for a patch request.

Parameters:

• attributes (IncidentIntegrationMetadataAttributes) – Incident integration metadata’s attributes for a create request.

• type (IncidentIntegrationMetadataType) – Integration metadata resource type.

incident_integration_metadata_patch_request

class IncidentIntegrationMetadataPatchRequest(*args, **kwargs)

Bases: ModelNormal

Patch request for an incident integration metadata.

Parameters:

data (IncidentIntegrationMetadataPatchData) – Incident integration metadata data for a patch request.

incident_integration_metadata_response

class IncidentIntegrationMetadataResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident integration metadata.

Parameters:

• data (IncidentIntegrationMetadataResponseData) – Incident integration metadata from a response.

• included ([IncidentIntegrationMetadataResponseIncludedItem], optional) – Included related resources that the user requested.

incident_integration_metadata_response_data

class IncidentIntegrationMetadataResponseData(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata from a response.

Parameters:

• attributes (IncidentIntegrationMetadataAttributes, optional) – Incident integration metadata’s attributes for a create request.

• id (str) – The incident integration metadata’s ID.

• relationships (IncidentIntegrationRelationships, optional) – The incident’s integration relationships from a response.

• type (IncidentIntegrationMetadataType) – Integration metadata resource type.

incident_integration_metadata_response_included_item

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.

incident_integration_metadata_type

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.

incident_integration_relationships

class IncidentIntegrationRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s integration relationships from a response.

Parameters:

• created_by_user (RelationshipToUser, optional) – Relationship to user.

• last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

incident_non_datadog_creator

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.

incident_notification_handle

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 email address used for the notification.

incident_postmortem_type

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.

incident_related_object

class IncidentRelatedObject(*args, **kwargs)

Bases: ModelSimple

Object related to an incident.

Parameters:

• value (str) – Must be one of [“users”, “attachments”].

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

incident_responders_type

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.

incident_response

class IncidentResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident.

Parameters:

• data (IncidentResponseData) – Incident data from a response.

• included ([IncidentResponseIncludedItem], optional) – Included related resources that the user requested.

incident_response_attributes

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.

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

incident_response_data

class IncidentResponseData(*args, **kwargs)

Bases: ModelNormal

Incident data from a response.

Parameters:

• attributes (IncidentResponseAttributes, optional) – The incident’s attributes from a response.

• id (str) – The incident’s ID.

• relationships (IncidentResponseRelationships, optional) – The incident’s relationships from a response.

• type (IncidentType) – Incident resource type.

incident_response_included_item

class IncidentResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to an incident 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.

incident_response_meta

class IncidentResponseMeta(*args, **kwargs)

Bases: ModelNormal

The metadata object containing pagination metadata.

Parameters:

pagination (IncidentResponseMetaPagination, optional) – Pagination properties.

incident_response_meta_pagination

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.

incident_response_relationships

class IncidentResponseRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships from a response.

Parameters:

• attachments (RelationshipToIncidentAttachment, optional) – A relationship reference for attachments.

• commander_user (NullableRelationshipToUser, none_type, optional) – Relationship to user.

• created_by_user (RelationshipToUser, optional) – Relationship to user.

• impacts (RelationshipToIncidentImpacts, optional) – Relationship to impacts.

• integrations (RelationshipToIncidentIntegrationMetadatas, optional) – A relationship reference for multiple integration metadata objects.

• last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

• responders (RelationshipToIncidentResponders, optional) – Relationship to incident responders.

• user_defined_fields (RelationshipToIncidentUserDefinedFields, optional) – Relationship to incident user defined fields.

incident_search_response

class IncidentSearchResponse(*args, **kwargs)

Bases: ModelNormal

Response with incidents and facets.

Parameters:

• data (IncidentSearchResponseData) – Data returned by an incident search.

• included ([IncidentResponseIncludedItem], optional) – Included related resources that the user requested.

• meta (IncidentSearchResponseMeta, optional) – The metadata object containing pagination metadata.

incident_search_response_attributes

class IncidentSearchResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes returned by an incident search.

Parameters:

• facets (IncidentSearchResponseFacetsData) – Facet data for incidents returned by a search query.

• incidents ([IncidentSearchResponseIncidentsData]) – Incidents returned by the search.

• total (int) – Number of incidents returned by the search.

incident_search_response_data

class IncidentSearchResponseData(*args, **kwargs)

Bases: ModelNormal

Data returned by an incident search.

Parameters:

• attributes (IncidentSearchResponseAttributes, optional) – Attributes returned by an incident search.

• type (IncidentSearchResultsType, optional) – Incident search result type.

incident_search_response_facets_data

class IncidentSearchResponseFacetsData(*args, **kwargs)

Bases: ModelNormal

Facet data for incidents returned by a search query.

Parameters:

• commander ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident commander users.

• created_by ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident creator users.

• fields ([IncidentSearchResponsePropertyFieldFacetData], optional) – Facet data for incident property fields.

• impact ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident impact attributes.

• last_modified_by ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident last modified by users.

• postmortem ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident postmortem existence.

• responder ([IncidentSearchResponseUserFacetData], optional) – Facet data for incident responder users.

• severity ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident severity attributes.

• state ([IncidentSearchResponseFieldFacetData], optional) – Facet data for incident state attributes.

• time_to_repair ([IncidentSearchResponseNumericFacetData], optional) – Facet data for incident time to repair metrics.

• time_to_resolve ([IncidentSearchResponseNumericFacetData], optional) – Facet data for incident time to resolve metrics.

incident_search_response_field_facet_data

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.

incident_search_response_incidents_data

class IncidentSearchResponseIncidentsData(*args, **kwargs)

Bases: ModelNormal

Incident returned by the search.

Parameters:

data (IncidentResponseData) – Incident data from a response.

incident_search_response_meta

class IncidentSearchResponseMeta(*args, **kwargs)

Bases: ModelNormal

The metadata object containing pagination metadata.

Parameters:

pagination (IncidentResponseMetaPagination, optional) – Pagination properties.

incident_search_response_numeric_facet_data

class IncidentSearchResponseNumericFacetData(*args, **kwargs)

Bases: ModelNormal

Facet data numeric attributes of an incident.

Parameters:

• aggregates (IncidentSearchResponseNumericFacetDataAggregates) – Aggregate information for numeric incident data.

• name (str) – Name of the incident property field.

incident_search_response_numeric_facet_data_aggregates

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.

incident_search_response_property_field_facet_data

class IncidentSearchResponsePropertyFieldFacetData(*args, **kwargs)

Bases: ModelNormal

Facet data for the incident property fields.

Parameters:

• aggregates (IncidentSearchResponseNumericFacetDataAggregates, optional) – Aggregate information for numeric incident data.

• facets ([IncidentSearchResponseFieldFacetData]) – Facet data for the property field of an incident.

• name (str) – Name of the incident property field.

incident_search_response_user_facet_data

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.

incident_search_results_type

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.

incident_search_sort_order

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.

incident_service_create_attributes

class IncidentServiceCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident service’s attributes for a create request.

Parameters:

name (str) – Name of the incident service.

incident_service_create_data

class IncidentServiceCreateData(*args, **kwargs)

Bases: ModelNormal

Incident Service payload for create requests.

Parameters:

• attributes (IncidentServiceCreateAttributes, optional) – The incident service’s attributes for a create request.

• relationships (IncidentServiceRelationships, optional) – The incident service’s relationships.

• type (IncidentServiceType) – Incident service resource type.

incident_service_create_request

class IncidentServiceCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request with an incident service payload.

Parameters:

data (IncidentServiceCreateData) – Incident Service payload for create requests.

incident_service_included_items

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.

incident_service_relationships

class IncidentServiceRelationships(*args, **kwargs)

Bases: ModelNormal

The incident service’s relationships.

Parameters:

• created_by (RelationshipToUser, optional) – Relationship to user.

• last_modified_by (RelationshipToUser, optional) – Relationship to user.

incident_service_response

class IncidentServiceResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident service payload.

Parameters:

• data (IncidentServiceResponseData) – Incident Service data from responses.

• included ([IncidentServiceIncludedItems], optional) – Included objects from relationships.

incident_service_response_attributes

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.

incident_service_response_data

class IncidentServiceResponseData(*args, **kwargs)

Bases: ModelNormal

Incident Service data from responses.

Parameters:

• attributes (IncidentServiceResponseAttributes, optional) – The incident service’s attributes from a response.

• id (str) – The incident service’s ID.

• relationships (IncidentServiceRelationships, optional) – The incident service’s relationships.

• type (IncidentServiceType) – Incident service resource type.

incident_service_type

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.

incident_service_update_attributes

class IncidentServiceUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident service’s attributes for an update request.

Parameters:

name (str) – Name of the incident service.

incident_service_update_data

class IncidentServiceUpdateData(*args, **kwargs)

Bases: ModelNormal

Incident Service payload for update requests.

Parameters:

• attributes (IncidentServiceUpdateAttributes, optional) – The incident service’s attributes for an update request.

• id (str, optional) – The incident service’s ID.

• relationships (IncidentServiceRelationships, optional) – The incident service’s relationships.

• type (IncidentServiceType) – Incident service resource type.

incident_service_update_request

class IncidentServiceUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request with an incident service payload.

Parameters:

data (IncidentServiceUpdateData) – Incident Service payload for update requests.

incident_services_response

class IncidentServicesResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident service payloads.

Parameters:

• data ([IncidentServiceResponseData]) – An array of incident services.

• included ([IncidentServiceIncludedItems], optional) – Included related resources which the user requested.

• meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

incident_severity

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.

incident_team_create_attributes

class IncidentTeamCreateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident team’s attributes for a create request.

Parameters:

name (str) – Name of the incident team.

incident_team_create_data

class IncidentTeamCreateData(*args, **kwargs)

Bases: ModelNormal

Incident Team data for a create request.

Parameters:

• attributes (IncidentTeamCreateAttributes, optional) – The incident team’s attributes for a create request.

• relationships (IncidentTeamRelationships, optional) – The incident team’s relationships.

• type (IncidentTeamType) – Incident Team resource type.

incident_team_create_request

class IncidentTeamCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request with an incident team payload.

Parameters:

data (IncidentTeamCreateData) – Incident Team data for a create request.

incident_team_included_items

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.

incident_team_relationships

class IncidentTeamRelationships(*args, **kwargs)

Bases: ModelNormal

The incident team’s relationships.

Parameters:

• created_by (RelationshipToUser, optional) – Relationship to user.

• last_modified_by (RelationshipToUser, optional) – Relationship to user.

incident_team_response

class IncidentTeamResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident team payload.

Parameters:

• data (IncidentTeamResponseData) – Incident Team data from a response.

• included ([IncidentTeamIncludedItems], optional) – Included objects from relationships.

incident_team_response_attributes

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.

incident_team_response_data

class IncidentTeamResponseData(*args, **kwargs)

Bases: ModelNormal

Incident Team data from a response.

Parameters:

• attributes (IncidentTeamResponseAttributes, optional) – The incident team’s attributes from a response.

• id (str, optional) – The incident team’s ID.

• relationships (IncidentTeamRelationships, optional) – The incident team’s relationships.

• type (IncidentTeamType, optional) – Incident Team resource type.

incident_team_type

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.

incident_team_update_attributes

class IncidentTeamUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The incident team’s attributes for an update request.

Parameters:

name (str) – Name of the incident team.

incident_team_update_data

class IncidentTeamUpdateData(*args, **kwargs)

Bases: ModelNormal

Incident Team data for an update request.

Parameters:

• attributes (IncidentTeamUpdateAttributes, optional) – The incident team’s attributes for an update request.

• id (str, optional) – The incident team’s ID.

• relationships (IncidentTeamRelationships, optional) – The incident team’s relationships.

• type (IncidentTeamType) – Incident Team resource type.

incident_team_update_request

class IncidentTeamUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request with an incident team payload.

Parameters:

data (IncidentTeamUpdateData) – Incident Team data for an update request.

incident_teams_response

class IncidentTeamsResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident team payloads.

Parameters:

• data ([IncidentTeamResponseData]) – An array of incident teams.

• included ([IncidentTeamIncludedItems], optional) – Included related resources which the user requested.

• meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

incident_timeline_cell_create_attributes

class IncidentTimelineCellCreateAttributes(*args, **kwargs)

Bases: ModelComposed

The timeline cell’s attributes for a create request.

Parameters:

• cell_type (IncidentTimelineCellMarkdownContentType) – Type of the Markdown timeline cell.

• content (IncidentTimelineCellMarkdownCreateAttributesContent) – The Markdown timeline cell contents.

• important (bool, optional) – A flag indicating whether the timeline cell is important and should be highlighted.

incident_timeline_cell_markdown_content_type

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.

incident_timeline_cell_markdown_create_attributes

class IncidentTimelineCellMarkdownCreateAttributes(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• cell_type (IncidentTimelineCellMarkdownContentType) – Type of the Markdown timeline cell.

• content (IncidentTimelineCellMarkdownCreateAttributesContent) – The Markdown timeline cell contents.

• important (bool, optional) – A flag indicating whether the timeline cell is important and should be highlighted.

incident_timeline_cell_markdown_create_attributes_content

class IncidentTimelineCellMarkdownCreateAttributesContent(*args, **kwargs)

Bases: ModelNormal

The Markdown timeline cell contents.

Parameters:

content (str, optional) – The Markdown content of the cell.

incident_todo_anonymous_assignee

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.

incident_todo_anonymous_assignee_source

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.

incident_todo_assignee

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.

incident_todo_assignee_array

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.

incident_todo_attributes

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.

incident_todo_create_data

class IncidentTodoCreateData(*args, **kwargs)

Bases: ModelNormal

Incident todo data for a create request.

Parameters:

• attributes (IncidentTodoAttributes) – Incident todo’s attributes.

• type (IncidentTodoType) – Todo resource type.

incident_todo_create_request

class IncidentTodoCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an incident todo.

Parameters:

data (IncidentTodoCreateData) – Incident todo data for a create request.

incident_todo_list_response

class IncidentTodoListResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incident todos.

Parameters:

• data ([IncidentTodoResponseData]) – An array of incident todos.

• included ([IncidentTodoResponseIncludedItem], optional) – Included related resources that the user requested.

• meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

incident_todo_patch_data

class IncidentTodoPatchData(*args, **kwargs)

Bases: ModelNormal

Incident todo data for a patch request.

Parameters:

• attributes (IncidentTodoAttributes) – Incident todo’s attributes.

• type (IncidentTodoType) – Todo resource type.

incident_todo_patch_request

class IncidentTodoPatchRequest(*args, **kwargs)

Bases: ModelNormal

Patch request for an incident todo.

Parameters:

data (IncidentTodoPatchData) – Incident todo data for a patch request.

incident_todo_relationships

class IncidentTodoRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships from a response.

Parameters:

• created_by_user (RelationshipToUser, optional) – Relationship to user.

• last_modified_by_user (RelationshipToUser, optional) – Relationship to user.

incident_todo_response

class IncidentTodoResponse(*args, **kwargs)

Bases: ModelNormal

Response with an incident todo.

Parameters:

• data (IncidentTodoResponseData) – Incident todo response data.

• included ([IncidentTodoResponseIncludedItem], optional) – Included related resources that the user requested.

incident_todo_response_data

class IncidentTodoResponseData(*args, **kwargs)

Bases: ModelNormal

Incident todo response data.

Parameters:

• attributes (IncidentTodoAttributes, optional) – Incident todo’s attributes.

• id (str) – The incident todo’s ID.

• relationships (IncidentTodoRelationships, optional) – The incident’s relationships from a response.

• type (IncidentTodoType) – Todo resource type.

incident_todo_response_included_item

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.

incident_todo_type

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.

incident_type

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.

incident_update_attributes

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.

incident_update_data

class IncidentUpdateData(*args, **kwargs)

Bases: ModelNormal

Incident data for an update request.

Parameters:

• attributes (IncidentUpdateAttributes, optional) – The incident’s attributes for an update request.

• id (str) – The incident’s ID.

• relationships (IncidentUpdateRelationships, optional) – The incident’s relationships for an update request.

• type (IncidentType) – Incident resource type.

incident_update_relationships

class IncidentUpdateRelationships(*args, **kwargs)

Bases: ModelNormal

The incident’s relationships for an update request.

Parameters:

• commander_user (NullableRelationshipToUser, none_type, optional) – Relationship to user.

• integrations (RelationshipToIncidentIntegrationMetadatas, optional) – A relationship reference for multiple integration metadata objects.

• postmortem (RelationshipToIncidentPostmortem, optional) – A relationship reference for postmortems.

incident_update_request

class IncidentUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for an incident.

Parameters:

data (IncidentUpdateData) – Incident data for an update request.

incident_user_defined_field_type

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.

incidents_response

class IncidentsResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of incidents.

Parameters:

• data ([IncidentResponseData]) – An array of incidents.

• included ([IncidentResponseIncludedItem], optional) – Included related resources that the user requested.

• meta (IncidentResponseMeta, optional) – The metadata object containing pagination metadata.

intake_payload_accepted

class IntakePayloadAccepted(*args, **kwargs)

Bases: ModelNormal

The payload accepted for intake.

Parameters:

errors ([str], optional) – A list of errors.

ip_allowlist_attributes

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.

ip_allowlist_data

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.

ip_allowlist_entry

class IPAllowlistEntry(*args, **kwargs)

Bases: ModelNormal

IP allowlist entry object.

Parameters:

data (IPAllowlistEntryData) – Data of the IP allowlist entry object.

ip_allowlist_entry_attributes

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.

ip_allowlist_entry_data

class IPAllowlistEntryData(*args, **kwargs)

Bases: ModelNormal

Data of the IP allowlist entry object.

Parameters:

• attributes (IPAllowlistEntryAttributes, optional) – Attributes of the IP allowlist entry.

• id (str, optional) – The unique identifier of the IP allowlist entry.

• type (IPAllowlistEntryType) – IP allowlist Entry type.

ip_allowlist_entry_type

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.

ip_allowlist_response

class IPAllowlistResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about the IP allowlist.

Parameters:

data (IPAllowlistData, optional) – IP allowlist data.

ip_allowlist_type

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.

ip_allowlist_update_request

class IPAllowlistUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update the IP allowlist.

Parameters:

data (IPAllowlistData) – IP allowlist data.

jira_integration_metadata

class JiraIntegrationMetadata(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata for the Jira integration.

Parameters:

issues ([JiraIntegrationMetadataIssuesItem]) – Array of Jira issues in this integration metadata.

jira_integration_metadata_issues_item

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.

jsonapi_error_item

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.

jsonapi_error_response

class JSONAPIErrorResponse(*args, **kwargs)

Bases: ModelNormal

API error response.

Parameters:

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

list_application_keys_response

class ListApplicationKeysResponse(*args, **kwargs)

Bases: ModelNormal

Response for a list of application keys.

Parameters:

• data ([PartialApplicationKey], optional) – Array of application keys.

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

• meta (ApplicationKeyResponseMeta, optional) – Additional information related to the application key response.

list_downtimes_response

class ListDowntimesResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all downtimes.

Parameters:

• data ([DowntimeResponseData], optional) – An array of downtimes.

• included ([DowntimeResponseIncludedItem], optional) – Array of objects related to the downtimes.

• meta (DowntimeMeta, optional) – Pagination metadata returned by the API.

list_findings_meta

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.

list_findings_page

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.

list_findings_response

class ListFindingsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when listing findings.

Parameters:

• data ([Finding]) – Array of findings.

• meta (ListFindingsMeta) – Metadata for pagination.

list_powerpacks_response

class ListPowerpacksResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes all powerpack configurations.

Parameters:

• data ([PowerpackData], optional) – List of powerpack definitions.

• included ([User], optional) – Array of objects related to the users.

• links (PowerpackResponseLinks, optional) – Links attributes.

• meta (PowerpacksResponseMeta, optional) – Powerpack response metadata.

list_rules_response

class ListRulesResponse(*args, **kwargs)

Bases: ModelNormal

Scorecard rules response.

Parameters:

• data ([ListRulesResponseDataItem], optional) – Array of rule details.

• links (ListRulesResponseLinks, optional) – Links attributes.

list_rules_response_data_item

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.

list_rules_response_links

class ListRulesResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

next (str, optional) – Link for the next set of rules.

list_teams_include

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.

list_teams_sort

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.

log

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.

log_attributes

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.

log_type

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.

logs_aggregate_bucket

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

logs_aggregate_bucket_value

class LogsAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

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

logs_aggregate_bucket_value_timeseries

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.

logs_aggregate_bucket_value_timeseries_point

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

logs_aggregate_request

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

logs_aggregate_request_page

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.

logs_aggregate_response

class LogsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the logs aggregate API endpoint

Parameters:

• data (LogsAggregateResponseData, optional) – The query results

• meta (LogsResponseMetadata, optional) – The metadata associated with a request

logs_aggregate_response_data

class LogsAggregateResponseData(*args, **kwargs)

Bases: ModelNormal

The query results

Parameters:

buckets ([LogsAggregateBucket], optional) – The list of matching buckets, one item per bucket

logs_aggregate_response_status

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.

logs_aggregate_sort

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

logs_aggregate_sort_type

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.

logs_aggregation_function

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.

logs_archive

class LogsArchive(*args, **kwargs)

Bases: ModelNormal

The logs archive.

Parameters:

data (LogsArchiveDefinition, optional) – The definition of an archive.

logs_archive_attributes

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.

logs_archive_create_request

class LogsArchiveCreateRequest(*args, **kwargs)

Bases: ModelNormal

The logs archive.

Parameters:

data (LogsArchiveCreateRequestDefinition, optional) – The definition of an archive.

logs_archive_create_request_attributes

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.

logs_archive_create_request_definition

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.

logs_archive_create_request_destination

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.

logs_archive_definition

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.

logs_archive_destination

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.

logs_archive_destination_azure

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.

logs_archive_destination_azure_type

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.

logs_archive_destination_gcs

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.

logs_archive_destination_gcs_type

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.

logs_archive_destination_s3

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.

logs_archive_destination_s3_type

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.

logs_archive_integration_azure

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.

logs_archive_integration_gcs

class LogsArchiveIntegrationGCS(*args, **kwargs)

Bases: ModelNormal

The GCS archive’s integration destination.

Parameters:

• client_email (str) – A client email.

• project_id (str) – A project ID.

logs_archive_integration_s3

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.

logs_archive_order

class LogsArchiveOrder(*args, **kwargs)

Bases: ModelNormal

A ordered list of archive IDs.

Parameters:

data (LogsArchiveOrderDefinition, optional) – The definition of an archive order.

logs_archive_order_attributes

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.

logs_archive_order_definition

class LogsArchiveOrderDefinition(*args, **kwargs)

Bases: ModelNormal

The definition of an archive order.

Parameters:

• attributes (LogsArchiveOrderAttributes) – The attributes associated with the archive order.

• type (LogsArchiveOrderDefinitionType) – Type of the archive order definition.

logs_archive_order_definition_type

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.

logs_archive_state

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.

logs_archives

class LogsArchives(*args, **kwargs)

Bases: ModelNormal

The available archives.

Parameters:

data ([LogsArchiveDefinition], optional) – A list of archives.

logs_compute

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

logs_compute_type

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.

logs_group_by

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.

logs_group_by_histogram

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)

logs_group_by_missing

class LogsGroupByMissing(*args, **kwargs)

Bases: ModelComposed

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

logs_group_by_total

class LogsGroupByTotal(*args, **kwargs)

Bases: ModelComposed

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

logs_list_request

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.

logs_list_request_page

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.

logs_list_response

class LogsListResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([Log], optional) – Array of logs matching the request.

• links (LogsListResponseLinks, optional) – Links attributes.

• meta (LogsResponseMetadata, optional) – The metadata associated with a request

logs_list_response_links

class LogsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

logs_metric_compute

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

logs_metric_compute_aggregation_type

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.

logs_metric_create_attributes

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.

logs_metric_create_data

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.

logs_metric_create_request

class LogsMetricCreateRequest(*args, **kwargs)

Bases: ModelNormal

The new log-based metric body.

Parameters:

data (LogsMetricCreateData) – The new log-based metric properties.

logs_metric_filter

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.

logs_metric_group_by

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.

logs_metric_response

class LogsMetricResponse(*args, **kwargs)

Bases: ModelNormal

The log-based metric object.

Parameters:

data (LogsMetricResponseData, optional) – The log-based metric properties.

logs_metric_response_attributes

class LogsMetricResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog log-based metric.

Parameters:

• compute (LogsMetricResponseCompute, optional) – The compute rule to compute the log-based metric.

• filter (LogsMetricResponseFilter, optional) – The log-based metric filter. Logs matching this filter will be aggregated in this metric.

• group_by ([LogsMetricResponseGroupBy], optional) – The rules for the group by.

logs_metric_response_compute

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

logs_metric_response_compute_aggregation_type

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.

logs_metric_response_data

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.

logs_metric_response_filter

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.

logs_metric_response_group_by

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.

logs_metric_type

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.

logs_metric_update_attributes

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.

logs_metric_update_compute

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.

logs_metric_update_data

class LogsMetricUpdateData(*args, **kwargs)

Bases: ModelNormal

The new log-based metric properties.

Parameters:

• attributes (LogsMetricUpdateAttributes) – The log-based metric properties that will be updated.

• type (LogsMetricType) – The type of the resource. The value should always be logs_metrics.

logs_metric_update_request

class LogsMetricUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new log-based metric body.

Parameters:

data (LogsMetricUpdateData) – The new log-based metric properties.

logs_metrics_response

class LogsMetricsResponse(*args, **kwargs)

Bases: ModelNormal

All the available log-based metric objects.

Parameters:

data ([LogsMetricResponseData], optional) – A list of log-based metric objects.

logs_query_filter

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 or online-archives

• to (str, optional) – The maximum time for the requested logs, supports date math and regular timestamps (milliseconds).

logs_query_options

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

logs_response_metadata

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.

logs_response_metadata_page

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

logs_sort

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.

logs_sort_order

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.

logs_storage_tier

class LogsStorageTier(*args, **kwargs)

Bases: ModelSimple

Specifies storage type as indexes or online-archives

Parameters:

• value (str) – If omitted defaults to “indexes”. Must be one of [“indexes”, “online-archives”].

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

logs_warning

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

metric

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.

metric_active_configuration_type

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.

metric_all_tags

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.

metric_all_tags_attributes

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.

metric_all_tags_response

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.

metric_bulk_configure_tags_type

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.

metric_bulk_tag_config_create

class MetricBulkTagConfigCreate(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• attributes (MetricBulkTagConfigCreateAttributes, optional) – Optional parameters for bulk creating metric tag configurations.

• id (str) – A text prefix to match against metric names.

• type (MetricBulkConfigureTagsType) – The metric bulk configure tags resource.

metric_bulk_tag_config_create_attributes

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.

metric_bulk_tag_config_create_request

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.

metric_bulk_tag_config_delete

class MetricBulkTagConfigDelete(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• attributes (MetricBulkTagConfigDeleteAttributes, optional) – Optional parameters for bulk deleting metric tag configurations.

• id (str) – A text prefix to match against metric names.

• type (MetricBulkConfigureTagsType) – The metric bulk configure tags resource.

metric_bulk_tag_config_delete_attributes

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.

metric_bulk_tag_config_delete_request

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.

metric_bulk_tag_config_email_list

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.

metric_bulk_tag_config_response

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.

metric_bulk_tag_config_status

class MetricBulkTagConfigStatus(*args, **kwargs)

Bases: ModelNormal

The status of a request to bulk configure metric tags. It contains the fields from the original request for reference.

Parameters:

• attributes (MetricBulkTagConfigStatusAttributes, optional) – Optional attributes for the status of a bulk tag configuration request.

• id (str) – A text prefix to match against metric names.

• type (MetricBulkConfigureTagsType) – The metric bulk configure tags resource.

metric_bulk_tag_config_status_attributes

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.

metric_bulk_tag_config_tag_name_list

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.

metric_content_encoding

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.

metric_custom_aggregation

class MetricCustomAggregation(*args, **kwargs)

Bases: ModelNormal

A time and space aggregation combination for use in query.

Parameters:

• space (MetricCustomSpaceAggregation) – A space aggregation for use in query.

• time (MetricCustomTimeAggregation) – A time aggregation for use in query.

metric_custom_aggregations

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

metric_custom_space_aggregation

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.

metric_custom_time_aggregation

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.

metric_distinct_volume

class MetricDistinctVolume(*args, **kwargs)

Bases: ModelNormal

Object for a single metric’s distinct volume.

Parameters:

• attributes (MetricDistinctVolumeAttributes, optional) – Object containing the definition of a metric’s distinct volume.

• id (str, optional) – The metric name for this resource.

• type (MetricDistinctVolumeType, optional) – The metric distinct volume type.

metric_distinct_volume_attributes

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.

metric_distinct_volume_type

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.

metric_estimate

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.

metric_estimate_attributes

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.

metric_estimate_resource_type

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.

metric_estimate_response

class MetricEstimateResponse(*args, **kwargs)

Bases: ModelNormal

Response object that includes metric cardinality estimates.

Parameters:

data (MetricEstimate, optional) – Object for a metric cardinality estimate.

metric_estimate_type

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.

metric_ingested_indexed_volume

class MetricIngestedIndexedVolume(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• attributes (MetricIngestedIndexedVolumeAttributes, optional) – Object containing the definition of a metric’s ingested and indexed volume.

• id (str, optional) – The metric name for this resource.

• type (MetricIngestedIndexedVolumeType, optional) – The metric ingested and indexed volume type.

metric_ingested_indexed_volume_attributes

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.

metric_ingested_indexed_volume_type

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.

metric_intake_type

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.

metric_metadata

class MetricMetadata(*args, **kwargs)

Bases: ModelNormal

Metadata for the metric.

Parameters:

origin (MetricOrigin, optional) – Metric origin information.

metric_origin

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

metric_payload

class MetricPayload(*args, **kwargs)

Bases: ModelNormal

The metrics’ payload.

Parameters:

series ([MetricSeries]) – A list of time series to submit to Datadog.

metric_point

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.

metric_resource

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.

metric_series

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.

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

metric_suggested_aggregations

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.

metric_suggested_tags_and_aggregations

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.

metric_suggested_tags_and_aggregations_response

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.

metric_suggested_tags_attributes

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.

metric_tag_configuration

class MetricTagConfiguration(*args, **kwargs)

Bases: ModelNormal

Object for a single metric tag configuration.

Parameters:

• attributes (MetricTagConfigurationAttributes, optional) – Object containing the definition of a metric tag configuration attributes.

• id (str, optional) – The metric name for this resource.

• type (MetricTagConfigurationType, optional) – The metric tag configuration resource type.

metric_tag_configuration_attributes

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

metric_tag_configuration_create_attributes

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

metric_tag_configuration_create_data

class MetricTagConfigurationCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single metric to be configure tags on.

Parameters:

• attributes (MetricTagConfigurationCreateAttributes, optional) – Object containing the definition of a metric tag configuration to be created.

• id (str) – The metric name for this resource.

• type (MetricTagConfigurationType) – The metric tag configuration resource type.

metric_tag_configuration_create_request

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.

metric_tag_configuration_metric_types

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.

metric_tag_configuration_response

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.

metric_tag_configuration_type

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.

metric_tag_configuration_update_attributes

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

metric_tag_configuration_update_data

class MetricTagConfigurationUpdateData(*args, **kwargs)

Bases: ModelNormal

Object for a single tag configuration to be edited.

Parameters:

• attributes (MetricTagConfigurationUpdateAttributes, optional) – Object containing the definition of a metric tag configuration to be updated.

• id (str) – The metric name for this resource.

• type (MetricTagConfigurationType) – The metric tag configuration resource type.

metric_tag_configuration_update_request

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.

metric_type

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.

metric_volumes

class MetricVolumes(*args, **kwargs)

Bases: ModelComposed

Possible response objects for a metric’s volume.

Parameters:

• attributes (MetricDistinctVolumeAttributes, optional) – Object containing the definition of a metric’s distinct volume.

• id (str, optional) – The metric name for this resource.

• type (MetricDistinctVolumeType, optional) – The metric distinct volume type.

metric_volumes_response

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.

metrics_aggregator

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.

metrics_and_metric_tag_configurations

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.

metrics_and_metric_tag_configurations_response

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.

metrics_data_source

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.

metrics_scalar_query

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.

metrics_timeseries_query

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.

monitor_config_policy_attribute_create_request

class MonitorConfigPolicyAttributeCreateRequest(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

• policy (MonitorConfigPolicyPolicyCreateRequest) – Configuration for the policy.

• policy_type (MonitorConfigPolicyType) – The monitor configuration policy type.

monitor_config_policy_attribute_edit_request

class MonitorConfigPolicyAttributeEditRequest(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

• policy (MonitorConfigPolicyPolicy) – Configuration for the policy.

• policy_type (MonitorConfigPolicyType) – The monitor configuration policy type.

monitor_config_policy_attribute_response

class MonitorConfigPolicyAttributeResponse(*args, **kwargs)

Bases: ModelNormal

Policy and policy type for a monitor configuration policy.

Parameters:

• policy (MonitorConfigPolicyPolicy, optional) – Configuration for the policy.

• policy_type (MonitorConfigPolicyType, optional) – The monitor configuration policy type.

monitor_config_policy_create_data

class MonitorConfigPolicyCreateData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

• attributes (MonitorConfigPolicyAttributeCreateRequest) – Policy and policy type for a monitor configuration policy.

• type (MonitorConfigPolicyResourceType) – Monitor configuration policy resource type.

monitor_config_policy_create_request

class MonitorConfigPolicyCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request for creating a monitor configuration policy.

Parameters:

data (MonitorConfigPolicyCreateData) – A monitor configuration policy data.

monitor_config_policy_edit_data

class MonitorConfigPolicyEditData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

• attributes (MonitorConfigPolicyAttributeEditRequest) – Policy and policy type for a monitor configuration policy.

• id (str) – ID of this monitor configuration policy.

• type (MonitorConfigPolicyResourceType) – Monitor configuration policy resource type.

monitor_config_policy_edit_request

class MonitorConfigPolicyEditRequest(*args, **kwargs)

Bases: ModelNormal

Request for editing a monitor configuration policy.

Parameters:

data (MonitorConfigPolicyEditData) – A monitor configuration policy data.

monitor_config_policy_list_response

class MonitorConfigPolicyListResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all monitor configuration policies.

Parameters:

data ([MonitorConfigPolicyResponseData], optional) – An array of monitor configuration policies.

monitor_config_policy_policy

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.

monitor_config_policy_policy_create_request

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.

monitor_config_policy_resource_type

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.

monitor_config_policy_response

class MonitorConfigPolicyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving a monitor configuration policy.

Parameters:

data (MonitorConfigPolicyResponseData, optional) – A monitor configuration policy data.

monitor_config_policy_response_data

class MonitorConfigPolicyResponseData(*args, **kwargs)

Bases: ModelNormal

A monitor configuration policy data.

Parameters:

• attributes (MonitorConfigPolicyAttributeResponse, optional) – Policy and policy type for a monitor configuration policy.

• id (str, optional) – ID of this monitor configuration policy.

• type (MonitorConfigPolicyResourceType, optional) – Monitor configuration policy resource type.

monitor_config_policy_tag_policy

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.

monitor_config_policy_tag_policy_create_request

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.

monitor_config_policy_type

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.

monitor_downtime_match_resource_type

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.

monitor_downtime_match_response

class MonitorDowntimeMatchResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving all downtime matches for a monitor.

Parameters:

• data ([MonitorDowntimeMatchResponseData], optional) – An array of downtime matches.

• meta (DowntimeMeta, optional) – Pagination metadata returned by the API.

monitor_downtime_match_response_attributes

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.

monitor_downtime_match_response_data

class MonitorDowntimeMatchResponseData(*args, **kwargs)

Bases: ModelNormal

A downtime match.

Parameters:

• attributes (MonitorDowntimeMatchResponseAttributes, optional) – Downtime match details.

• id (str, none_type, optional) – The downtime ID.

• type (MonitorDowntimeMatchResourceType, optional) – Monitor Downtime Match resource type.

monitor_type

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.

monthly_cost_attribution_attributes

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.

monthly_cost_attribution_body

class MonthlyCostAttributionBody(*args, **kwargs)

Bases: ModelNormal

Cost data.

Parameters:

• attributes (MonthlyCostAttributionAttributes, optional) – Cost Attribution by Tag for a given organization.

• id (str, optional) – Unique ID of the response.

• type (CostAttributionType, optional) – Type of cost attribution data.

monthly_cost_attribution_meta

class MonthlyCostAttributionMeta(*args, **kwargs)

Bases: ModelNormal

The object containing document metadata.

Parameters:

• aggregates ([CostAttributionAggregatesBody], optional) – An array of available aggregates.

• pagination (MonthlyCostAttributionPagination, optional) – The metadata for the current pagination.

monthly_cost_attribution_pagination

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.

monthly_cost_attribution_response

class MonthlyCostAttributionResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([MonthlyCostAttributionBody], optional) – Response containing cost attribution.

• meta (MonthlyCostAttributionMeta, optional) – The object containing document metadata.

nullable_relationship_to_user

class NullableRelationshipToUser(*args, **kwargs)

Bases: ModelNormal

Relationship to user.

Parameters:

data (NullableRelationshipToUserData, none_type) – Relationship to user object.

nullable_relationship_to_user_data

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.

okta_account

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.

okta_account_attributes

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.

okta_account_request

class OktaAccountRequest(*args, **kwargs)

Bases: ModelNormal

Request object for an Okta account.

Parameters:

data (OktaAccount) – Schema for an Okta account.

okta_account_response

class OktaAccountResponse(*args, **kwargs)

Bases: ModelNormal

Response object for an Okta account.

Parameters:

data (OktaAccount, optional) – Schema for an Okta account.

okta_account_response_data

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.

okta_account_type

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.

okta_account_update_request

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.

okta_account_update_request_attributes

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.

okta_account_update_request_data

class OktaAccountUpdateRequestData(*args, **kwargs)

Bases: ModelNormal

Data object for updating an Okta account.

Parameters:

• attributes (OktaAccountUpdateRequestAttributes, optional) – Attributes object for updating an Okta account.

• type (OktaAccountType, optional) – Account type for an Okta account.

okta_accounts_response

class OktaAccountsResponse(*args, **kwargs)

Bases: ModelNormal

The expected response schema when getting Okta accounts.

Parameters:

data ([OktaAccountResponseData], optional) – List of Okta accounts.

on_demand_concurrency_cap

class OnDemandConcurrencyCap(*args, **kwargs)

Bases: ModelNormal

On-demand concurrency cap.

Parameters:

• attributes (OnDemandConcurrencyCapAttributes, optional) – On-demand concurrency cap attributes.

• type (OnDemandConcurrencyCapType, optional) – On-demand concurrency cap type.

on_demand_concurrency_cap_attributes

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.

on_demand_concurrency_cap_response

class OnDemandConcurrencyCapResponse(*args, **kwargs)

Bases: ModelNormal

On-demand concurrency cap response.

Parameters:

data (OnDemandConcurrencyCap, optional) – On-demand concurrency cap.

on_demand_concurrency_cap_type

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.

open_api_endpoint

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.

open_api_file

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

opsgenie_service_create_attributes

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.

opsgenie_service_create_data

class OpsgenieServiceCreateData(*args, **kwargs)

Bases: ModelNormal

Opsgenie service data for a create request.

Parameters:

• attributes (OpsgenieServiceCreateAttributes) – The Opsgenie service attributes for a create request.

• type (OpsgenieServiceType) – Opsgenie service resource type.

opsgenie_service_create_request

class OpsgenieServiceCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create request for an Opsgenie service.

Parameters:

data (OpsgenieServiceCreateData) – Opsgenie service data for a create request.

opsgenie_service_region_type

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.

opsgenie_service_response

class OpsgenieServiceResponse(*args, **kwargs)

Bases: ModelNormal

Response of an Opsgenie service.

Parameters:

data (OpsgenieServiceResponseData) – Opsgenie service data from a response.

opsgenie_service_response_attributes

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.

opsgenie_service_response_data

class OpsgenieServiceResponseData(*args, **kwargs)

Bases: ModelNormal

Opsgenie service data from a response.

Parameters:

• attributes (OpsgenieServiceResponseAttributes) – The attributes from an Opsgenie service response.

• id (str) – The ID of the Opsgenie service.

• type (OpsgenieServiceType) – Opsgenie service resource type.

opsgenie_service_type

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.

opsgenie_service_update_attributes

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.

opsgenie_service_update_data

class OpsgenieServiceUpdateData(*args, **kwargs)

Bases: ModelNormal

Opsgenie service for an update request.

Parameters:

• attributes (OpsgenieServiceUpdateAttributes) – The Opsgenie service attributes for an update request.

• id (str) – The ID of the Opsgenie service.

• type (OpsgenieServiceType) – Opsgenie service resource type.

opsgenie_service_update_request

class OpsgenieServiceUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for an Opsgenie service.

Parameters:

data (OpsgenieServiceUpdateData) – Opsgenie service for an update request.

opsgenie_services_response

class OpsgenieServicesResponse(*args, **kwargs)

Bases: ModelNormal

Response with a list of Opsgenie services.

Parameters:

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

organization

class Organization(*args, **kwargs)

Bases: ModelNormal

Organization object.

Parameters:

• attributes (OrganizationAttributes, optional) – Attributes of the organization.

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

• type (OrganizationsType) – Organizations resource type.

organization_attributes

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.

organizations_type

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.

outcome_type

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.

outcomes_batch_attributes

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.

outcomes_batch_request

class OutcomesBatchRequest(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request.

Parameters:

data (OutcomesBatchRequestData, optional) – Scorecard outcomes batch request data.

outcomes_batch_request_data

class OutcomesBatchRequestData(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch request data.

Parameters:

• attributes (OutcomesBatchAttributes, optional) – The JSON:API attributes for a batched set of scorecard outcomes.

• type (OutcomesBatchType, optional) – The JSON:API type for scorecard outcomes.

outcomes_batch_request_item

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.

outcomes_batch_response

class OutcomesBatchResponse(*args, **kwargs)

Bases: ModelNormal

Scorecard outcomes batch response.

Parameters:

• data ([OutcomesResponseDataItem]) – List of rule outcomes which were affected during the bulk operation.

• meta (OutcomesBatchResponseMeta) – Metadata pertaining to the bulk operation.

outcomes_batch_response_attributes

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.

outcomes_batch_response_meta

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.

outcomes_batch_type

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.

outcomes_response

class OutcomesResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([OutcomesResponseDataItem], optional) – List of rule outcomes.

• included ([OutcomesResponseIncludedItem], optional) – Array of rule details.

• links (OutcomesResponseLinks, optional) – Links attributes.

outcomes_response_data_item

class OutcomesResponseDataItem(*args, **kwargs)

Bases: ModelNormal

A single rule outcome.

Parameters:

• attributes (OutcomesBatchResponseAttributes, optional) – The JSON:API attributes for an outcome.

• id (str, optional) – The unique ID for a rule outcome.

• relationships (RuleOutcomeRelationships, optional) – The JSON:API relationship to a scorecard rule.

• type (OutcomeType, optional) – The JSON:API type for an outcome.

outcomes_response_included_item

class OutcomesResponseIncludedItem(*args, **kwargs)

Bases: ModelNormal

Attributes of the included rule.

Parameters:

• attributes (OutcomesResponseIncludedRuleAttributes, optional) – Details of a rule.

• id (str, optional) – The unique ID for a scorecard rule.

• type (RuleType, optional) – The JSON:API type for scorecard rules.

outcomes_response_included_rule_attributes

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.

outcomes_response_links

class OutcomesResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

next (str, optional) – Link for the next set of results.

pagination

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.

partial_api_key

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.

partial_api_key_attributes

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.

partial_application_key

class PartialApplicationKey(*args, **kwargs)

Bases: ModelNormal

Partial Datadog application key.

Parameters:

• attributes (PartialApplicationKeyAttributes, optional) – Attributes of a partial application key.

• id (str, optional) – ID of the application key.

• relationships (ApplicationKeyRelationships, optional) – Resources related to the application key.

• type (ApplicationKeysType, optional) – Application Keys resource type.

partial_application_key_attributes

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.

partial_application_key_response

class PartialApplicationKeyResponse(*args, **kwargs)

Bases: ModelNormal

Response for retrieving a partial application key.

Parameters:

• data (PartialApplicationKey, optional) – Partial Datadog application key.

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

permission

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.

permission_attributes

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.

permissions_response

class PermissionsResponse(*args, **kwargs)

Bases: ModelNormal

Payload with API-returned permissions.

Parameters:

data ([Permission], optional) – Array of permissions.

permissions_type

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.

powerpack

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.

powerpack_attributes

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.

powerpack_data

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.

powerpack_group_widget

class PowerpackGroupWidget(*args, **kwargs)

Bases: ModelNormal

Powerpack group widget definition object.

Parameters:

• definition (PowerpackGroupWidgetDefinition) – Powerpack group widget object.

• layout (PowerpackGroupWidgetLayout, optional) – Powerpack group widget layout.

• live_span (WidgetLiveSpan, optional) – The available timeframes depend on the widget you are using.

powerpack_group_widget_definition

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.

powerpack_group_widget_layout

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.

powerpack_inner_widget_layout

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.

powerpack_inner_widgets

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.

powerpack_relationships

class PowerpackRelationships(*args, **kwargs)

Bases: ModelNormal

Powerpack relationship object.

Parameters:

author (RelationshipToUser, optional) – Relationship to user.

powerpack_response

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.

powerpack_response_links

class PowerpackResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

• first (str, optional) – Link to last page.

• last (str, none_type, optional) – Link to first page.

• next (str, optional) – Link for the next set of results.

• prev (str, none_type, optional) – Link for the previous set of results.

• self (str, optional) – Link to current page.

powerpack_template_variable

class PowerpackTemplateVariable(*args, **kwargs)

Bases: ModelNormal

Powerpack template variables.

Parameters:

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

powerpacks_response_meta

class PowerpacksResponseMeta(*args, **kwargs)

Bases: ModelNormal

Powerpack response metadata.

Parameters:

pagination (PowerpacksResponseMetaPagination, optional) – Powerpack response pagination metadata.

powerpacks_response_meta_pagination

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.

process_summaries_meta

class ProcessSummariesMeta(*args, **kwargs)

Bases: ModelNormal

Response metadata object.

Parameters:

page (ProcessSummariesMetaPage, optional) – Paging attributes.

process_summaries_meta_page

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.

process_summaries_response

class ProcessSummariesResponse(*args, **kwargs)

Bases: ModelNormal

List of process summaries.

Parameters:

• data ([ProcessSummary], optional) – Array of process summary objects.

• meta (ProcessSummariesMeta, optional) – Response metadata object.

process_summary

class ProcessSummary(*args, **kwargs)

Bases: ModelNormal

Process summary object.

Parameters:

• attributes (ProcessSummaryAttributes, optional) – Attributes for a process summary.

• id (str, optional) – Process ID.

• type (ProcessSummaryType, optional) – Type of process summary.

process_summary_attributes

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.

process_summary_type

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.

projected_cost

class ProjectedCost(*args, **kwargs)

Bases: ModelNormal

Projected Cost data.

Parameters:

• attributes (ProjectedCostAttributes, optional) – Projected Cost attributes data.

• id (str, optional) – Unique ID of the response.

• type (ProjectedCostType, optional) – Type of cost data.

projected_cost_attributes

class ProjectedCostAttributes(*args, **kwargs)

Bases: ModelNormal

Projected Cost attributes data.

Parameters:

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

projected_cost_response

class ProjectedCostResponse(*args, **kwargs)

Bases: ModelNormal

Projected Cost response.

Parameters:

data ([ProjectedCost], optional) – Response containing Projected Cost.

projected_cost_type

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.

query_formula

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.

query_sort_order

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.

relationship_to_incident_attachment

class RelationshipToIncidentAttachment(*args, **kwargs)

Bases: ModelNormal

A relationship reference for attachments.

Parameters:

data ([RelationshipToIncidentAttachmentData]) – An array of incident attachments.

relationship_to_incident_attachment_data

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.

relationship_to_incident_impact_data

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.

relationship_to_incident_impacts

class RelationshipToIncidentImpacts(*args, **kwargs)

Bases: ModelNormal

Relationship to impacts.

Parameters:

data ([RelationshipToIncidentImpactData]) – An array of incident impacts.

relationship_to_incident_integration_metadata_data

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.

relationship_to_incident_integration_metadatas

class RelationshipToIncidentIntegrationMetadatas(*args, **kwargs)

Bases: ModelNormal

A relationship reference for multiple integration metadata objects.

Parameters:

data ([RelationshipToIncidentIntegrationMetadataData]) – Integration metadata relationship array

relationship_to_incident_postmortem

class RelationshipToIncidentPostmortem(*args, **kwargs)

Bases: ModelNormal

A relationship reference for postmortems.

Parameters:

data (RelationshipToIncidentPostmortemData) – The postmortem relationship data.

relationship_to_incident_postmortem_data

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.

relationship_to_incident_responder_data

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.

relationship_to_incident_responders

class RelationshipToIncidentResponders(*args, **kwargs)

Bases: ModelNormal

Relationship to incident responders.

Parameters:

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

relationship_to_incident_user_defined_field_data

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.

relationship_to_incident_user_defined_fields

class RelationshipToIncidentUserDefinedFields(*args, **kwargs)

Bases: ModelNormal

Relationship to incident user defined fields.

Parameters:

data ([RelationshipToIncidentUserDefinedFieldData]) – An array of user defined fields.

relationship_to_organization

class RelationshipToOrganization(*args, **kwargs)

Bases: ModelNormal

Relationship to an organization.

Parameters:

data (RelationshipToOrganizationData) – Relationship to organization object.

relationship_to_organization_data

class RelationshipToOrganizationData(*args, **kwargs)

Bases: ModelNormal

Relationship to organization object.

Parameters:

• id (str) – ID of the organization.

• type (OrganizationsType) – Organizations resource type.

relationship_to_organizations

class RelationshipToOrganizations(*args, **kwargs)

Bases: ModelNormal

Relationship to organizations.

Parameters:

data ([RelationshipToOrganizationData]) – Relationships to organization objects.

relationship_to_outcome

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.

relationship_to_outcome_data

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.

relationship_to_permission

class RelationshipToPermission(*args, **kwargs)

Bases: ModelNormal

Relationship to a permissions object.

Parameters:

data (RelationshipToPermissionData, optional) – Relationship to permission object.

relationship_to_permission_data

class RelationshipToPermissionData(*args, **kwargs)

Bases: ModelNormal

Relationship to permission object.

Parameters:

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

• type (PermissionsType, optional) – Permissions resource type.

relationship_to_permissions

class RelationshipToPermissions(*args, **kwargs)

Bases: ModelNormal

Relationship to multiple permissions objects.

Parameters:

data ([RelationshipToPermissionData], optional) – Relationships to permission objects.

relationship_to_role

class RelationshipToRole(*args, **kwargs)

Bases: ModelNormal

Relationship to role.

Parameters:

data (RelationshipToRoleData, optional) – Relationship to role object.

relationship_to_role_data

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.

relationship_to_roles

class RelationshipToRoles(*args, **kwargs)

Bases: ModelNormal

Relationship to roles.

Parameters:

data ([RelationshipToRoleData], optional) – An array containing type and the unique identifier of a role.

relationship_to_rule

class RelationshipToRule(*args, **kwargs)

Bases: ModelNormal

Scorecard create rule response relationship.

Parameters:

scorecard (RelationshipToRuleData, optional) – Relationship data for a rule.

relationship_to_rule_data

class RelationshipToRuleData(*args, **kwargs)

Bases: ModelNormal

Relationship data for a rule.

Parameters:

data (RelationshipToRuleDataObject, optional) – Rule relationship data.

relationship_to_rule_data_object

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.

relationship_to_saml_assertion_attribute

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.

relationship_to_saml_assertion_attribute_data

class RelationshipToSAMLAssertionAttributeData(*args, **kwargs)

Bases: ModelNormal

Data of AuthN Mapping relationship to SAML Assertion Attribute.

Parameters:

• id (str) – The ID of the SAML assertion attribute.

• type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.

relationship_to_team_link_data

class RelationshipToTeamLinkData(*args, **kwargs)

Bases: ModelNormal

Relationship between a link and a team

Parameters:

• id (str) – The team link’s identifier

• type (TeamLinkType) – Team link type

relationship_to_team_links

class RelationshipToTeamLinks(*args, **kwargs)

Bases: ModelNormal

Relationship between a team and a team link

Parameters:

• data ([RelationshipToTeamLinkData], optional) – Related team links

• links (TeamRelationshipsLinks, optional) – Links attributes.

relationship_to_user

class RelationshipToUser(*args, **kwargs)

Bases: ModelNormal

Relationship to user.

Parameters:

data (RelationshipToUserData) – Relationship to user object.

relationship_to_user_data

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.

relationship_to_user_team_permission

class RelationshipToUserTeamPermission(*args, **kwargs)

Bases: ModelNormal

Relationship between a user team permission and a team

Parameters:

• data (RelationshipToUserTeamPermissionData, optional) – Related user team permission data

• links (TeamRelationshipsLinks, optional) – Links attributes.

relationship_to_user_team_permission_data

class RelationshipToUserTeamPermissionData(*args, **kwargs)

Bases: ModelNormal

Related user team permission data

Parameters:

• id (str) – The ID of the user team permission

• type (UserTeamPermissionType) – User team permission type

relationship_to_user_team_team

class RelationshipToUserTeamTeam(*args, **kwargs)

Bases: ModelNormal

Relationship between team membership and team

Parameters:

data (RelationshipToUserTeamTeamData) – The team associated with the membership

relationship_to_user_team_team_data

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

relationship_to_user_team_user

class RelationshipToUserTeamUser(*args, **kwargs)

Bases: ModelNormal

Relationship between team membership and user

Parameters:

data (RelationshipToUserTeamUserData) – A user’s relationship with a team

relationship_to_user_team_user_data

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

relationship_to_users

class RelationshipToUsers(*args, **kwargs)

Bases: ModelNormal

Relationship to users.

Parameters:

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

reorder_retention_filters_request

class ReorderRetentionFiltersRequest(*args, **kwargs)

Bases: ModelNormal

A list of retention filters to reorder.

Parameters:

data ([RetentionFilterWithoutAttributes]) – A list of retention filters objects.

response_meta_attributes

class ResponseMetaAttributes(*args, **kwargs)

Bases: ModelNormal

Object describing meta attributes of response.

Parameters:

page (Pagination, optional) – Pagination object.

restriction_policy

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.

restriction_policy_attributes

class RestrictionPolicyAttributes(*args, **kwargs)

Bases: ModelNormal

Restriction policy attributes.

Parameters:

bindings ([RestrictionPolicyBinding]) – An array of bindings.

restriction_policy_binding

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.

restriction_policy_response

class RestrictionPolicyResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a single restriction policy.

Parameters:

data (RestrictionPolicy) – Restriction policy object.

restriction_policy_type

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.

restriction_policy_update_request

class RestrictionPolicyUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update request for a restriction policy.

Parameters:

data (RestrictionPolicy) – Restriction policy object.

retention_filter

class RetentionFilter(*args, **kwargs)

Bases: ModelNormal

The definition of the retention filter.

Parameters:

• attributes (RetentionFilterAttributes) – The attributes of the retention filter.

• id (str) – The ID of the retention filter.

• type (ApmRetentionFilterType) – The type of the resource.

retention_filter_all

class RetentionFilterAll(*args, **kwargs)

Bases: ModelNormal

The definition of the retention filter.

Parameters:

• attributes (RetentionFilterAllAttributes) – The attributes of the retention filter.

• id (str) – The ID of the retention filter.

• type (ApmRetentionFilterType) – The type of the resource.

retention_filter_all_attributes

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.

retention_filter_all_type

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.

retention_filter_attributes

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.

retention_filter_create_attributes

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.

retention_filter_create_data

class RetentionFilterCreateData(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be created.

Parameters:

• attributes (RetentionFilterCreateAttributes) – The object describing the configuration of the retention filter to create/update.

• type (ApmRetentionFilterType) – The type of the resource.

retention_filter_create_request

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.

retention_filter_response

class RetentionFilterResponse(*args, **kwargs)

Bases: ModelNormal

The retention filters definition.

Parameters:

data (RetentionFilter, optional) – The definition of the retention filter.

retention_filter_type

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.

retention_filter_update_data

class RetentionFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

The body of the retention filter to be updated.

Parameters:

• attributes (RetentionFilterCreateAttributes) – The object describing the configuration of the retention filter to create/update.

• id (str) – The ID of the retention filter.

• type (ApmRetentionFilterType) – The type of the resource.

retention_filter_update_request

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.

retention_filter_without_attributes

class RetentionFilterWithoutAttributes(*args, **kwargs)

Bases: ModelNormal

The retention filter object .

Parameters:

• id (str) – The ID of the retention filter.

• type (ApmRetentionFilterType) – The type of the resource.

retention_filters_response

class RetentionFiltersResponse(*args, **kwargs)

Bases: ModelNormal

An ordered list of retention filters.

Parameters:

data ([RetentionFilterAll]) – A list of retention filters objects.

role

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.

role_attributes

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.

role_clone

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.

role_clone_attributes

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.

role_clone_request

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.

role_create_attributes

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.

role_create_data

class RoleCreateData(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a role.

Parameters:

• attributes (RoleCreateAttributes) – Attributes of the created role.

• relationships (RoleRelationships, optional) – Relationships of the role object.

• type (RolesType, optional) – Roles type.

role_create_request

class RoleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create a role.

Parameters:

data (RoleCreateData) – Data related to the creation of a role.

role_create_response

class RoleCreateResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a created role.

Parameters:

data (RoleCreateResponseData, optional) – Role object returned by the API.

role_create_response_data

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.

role_relationships

class RoleRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the role object.

Parameters:

• permissions (RelationshipToPermissions, optional) – Relationship to multiple permissions objects.

• users (RelationshipToUsers, optional) – Relationship to users.

role_response

class RoleResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about a single role.

Parameters:

data (Role, optional) – Role object returned by the API.

role_response_relationships

class RoleResponseRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the role object returned by the API.

Parameters:

permissions (RelationshipToPermissions, optional) – Relationship to multiple permissions objects.

role_update_attributes

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.

role_update_data

class RoleUpdateData(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a role.

Parameters:

• attributes (RoleUpdateAttributes) – Attributes of the role.

• id (str) – The unique identifier of the role.

• relationships (RoleRelationships, optional) – Relationships of the role object.

• type (RolesType) – Roles type.

role_update_request

class RoleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update a role.

Parameters:

data (RoleUpdateData) – Data related to the update of a role.

role_update_response

class RoleUpdateResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about an updated role.

Parameters:

data (RoleUpdateResponseData, optional) – Role object returned by the API.

role_update_response_data

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.

roles_response

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.

roles_sort

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.

roles_type

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.

rule_attributes

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.

rule_outcome_relationships

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.

rule_type

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.

rum_aggregate_bucket_value

class RUMAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

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

rum_aggregate_bucket_value_timeseries

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.

rum_aggregate_bucket_value_timeseries_point

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.

rum_aggregate_request

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.

rum_aggregate_sort

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.

rum_aggregate_sort_type

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.

rum_aggregation_buckets_response

class RUMAggregationBucketsResponse(*args, **kwargs)

Bases: ModelNormal

The query results.

Parameters:

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

rum_aggregation_function

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.

rum_analytics_aggregate_response

class RUMAnalyticsAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the RUM events aggregate API endpoint.

Parameters:

• data (RUMAggregationBucketsResponse, optional) – The query results.

• links (RUMResponseLinks, optional) – Links attributes.

• meta (RUMResponseMetadata, optional) – The metadata associated with a request.

rum_application

class RUMApplication(*args, **kwargs)

Bases: ModelNormal

RUM application.

Parameters:

• attributes (RUMApplicationAttributes) – RUM application attributes.

• id (str) – RUM application ID.

• type (RUMApplicationType) – RUM application response type.

rum_application_attributes

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.

• updated_at (int) – Timestamp in ms of the last update date.

• updated_by_handle (str) – Handle of the updater user.

rum_application_create

class RUMApplicationCreate(*args, **kwargs)

Bases: ModelNormal

RUM application creation.

Parameters:

• attributes (RUMApplicationCreateAttributes) – RUM application creation attributes.

• type (RUMApplicationCreateType) – RUM application creation type.

rum_application_create_attributes

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.

rum_application_create_request

class RUMApplicationCreateRequest(*args, **kwargs)

Bases: ModelNormal

RUM application creation request attributes.

Parameters:

data (RUMApplicationCreate) – RUM application creation.

rum_application_create_type

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.

rum_application_list

class RUMApplicationList(*args, **kwargs)

Bases: ModelNormal

RUM application list.

Parameters:

• attributes (RUMApplicationListAttributes) – RUM application list attributes.

• id (str, optional) – RUM application ID.

• type (RUMApplicationListType) – RUM application list type.

rum_application_list_attributes

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.

• updated_at (int) – Timestamp in ms of the last update date.

• updated_by_handle (str) – Handle of the updater user.

rum_application_list_type

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.

rum_application_response

class RUMApplicationResponse(*args, **kwargs)

Bases: ModelNormal

RUM application response.

Parameters:

data (RUMApplication, optional) – RUM application.

rum_application_type

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.

rum_application_update

class RUMApplicationUpdate(*args, **kwargs)

Bases: ModelNormal

RUM application update.

Parameters:

• attributes (RUMApplicationUpdateAttributes, optional) – RUM application update attributes.

• id (str) – RUM application ID.

• type (RUMApplicationUpdateType) – RUM application update type.

rum_application_update_attributes

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.

rum_application_update_request

class RUMApplicationUpdateRequest(*args, **kwargs)

Bases: ModelNormal

RUM application update request.

Parameters:

data (RUMApplicationUpdate) – RUM application update.

rum_application_update_type

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.

rum_applications_response

class RUMApplicationsResponse(*args, **kwargs)

Bases: ModelNormal

RUM applications response.

Parameters:

data ([RUMApplicationList], optional) – RUM applications array response.

rum_bucket_response

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.

rum_compute

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.

rum_compute_type

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.

rum_event

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.

rum_event_attributes

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.

rum_event_type

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.

rum_events_response

class RUMEventsResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([RUMEvent], optional) – Array of events matching the request.

• links (RUMResponseLinks, optional) – Links attributes.

• meta (RUMResponseMetadata, optional) – The metadata associated with a request.

rum_group_by

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.

rum_group_by_histogram

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

rum_group_by_missing

class RUMGroupByMissing(*args, **kwargs)

Bases: ModelComposed

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

rum_group_by_total

class RUMGroupByTotal(*args, **kwargs)

Bases: ModelComposed

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

rum_query_filter

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

rum_query_options

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

rum_query_page_options

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.

rum_response_links

class RUMResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

rum_response_metadata

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.

rum_response_page

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

rum_response_status

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.

rum_search_events_request

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.

rum_sort

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.

rum_sort_order

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.

rum_warning

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.

saml_assertion_attribute

class SAMLAssertionAttribute(*args, **kwargs)

Bases: ModelNormal

SAML assertion attribute.

Parameters:

• attributes (SAMLAssertionAttributeAttributes, optional) – Key/Value pair of attributes used in SAML assertion attributes.

• id (str) – The ID of the SAML assertion attribute.

• type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.

saml_assertion_attribute_attributes

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.

saml_assertion_attributes_type

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.

scalar_column

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.

scalar_column_type_group

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.

scalar_column_type_number

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.

scalar_formula_query_request

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.

scalar_formula_query_response

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.

scalar_formula_request

class ScalarFormulaRequest(*args, **kwargs)

Bases: ModelNormal

A single scalar query to be executed.

Parameters:

• attributes (ScalarFormulaRequestAttributes) – The object describing a scalar formula request.

• type (ScalarFormulaRequestType) – The type of the resource. The value should always be scalar_request.

scalar_formula_request_attributes

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.

scalar_formula_request_queries

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.

scalar_formula_request_type

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.

scalar_formula_response_atrributes

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.

scalar_formula_response_type

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.

scalar_meta

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.

scalar_query

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.

scalar_response

class ScalarResponse(*args, **kwargs)

Bases: ModelNormal

A message containing the response to a scalar query.

Parameters:

• attributes (ScalarFormulaResponseAtrributes, optional) – The object describing a scalar response.

• type (ScalarFormulaResponseType, optional) – The type of the resource. The value should always be scalar_response.

scorecard_type

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.

security_filter

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.

security_filter_attributes

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.

security_filter_create_attributes

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.

security_filter_create_data

class SecurityFilterCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single security filter.

Parameters:

• attributes (SecurityFilterCreateAttributes) – Object containing the attributes of the security filter to be created.

• type (SecurityFilterType) – The type of the resource. The value should always be security_filters.

security_filter_create_request

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.

security_filter_exclusion_filter

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.

security_filter_exclusion_filter_response

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.

security_filter_filtered_data_type

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.

security_filter_meta

class SecurityFilterMeta(*args, **kwargs)

Bases: ModelNormal

Optional metadata associated to the response.

Parameters:

warning (str, optional) – A warning message.

security_filter_response

class SecurityFilterResponse(*args, **kwargs)

Bases: ModelNormal

Response object which includes a single security filter.

Parameters:

• data (SecurityFilter, optional) – The security filter’s properties.

• meta (SecurityFilterMeta, optional) – Optional metadata associated to the response.

security_filter_type

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.

security_filter_update_attributes

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.

security_filter_update_data

class SecurityFilterUpdateData(*args, **kwargs)

Bases: ModelNormal

The new security filter properties.

Parameters:

• attributes (SecurityFilterUpdateAttributes) – The security filters properties to be updated.

• type (SecurityFilterType) – The type of the resource. The value should always be security_filters.

security_filter_update_request

class SecurityFilterUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new security filter body.

Parameters:

data (SecurityFilterUpdateData) – The new security filter properties.

security_filters_response

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.

security_monitoring_filter

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.

security_monitoring_filter_action

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.

security_monitoring_list_rules_response

class SecurityMonitoringListRulesResponse(*args, **kwargs)

Bases: ModelNormal

List of rules.

Parameters:

• data ([SecurityMonitoringRuleResponse], optional) – Array containing the list of rules.

• meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

security_monitoring_rule_case

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.

security_monitoring_rule_case_create

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.

security_monitoring_rule_create_payload

class SecurityMonitoringRuleCreatePayload(*args, **kwargs)

Bases: ModelComposed

Create a new rule.

Parameters:

• cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.

• filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed.

• 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 ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.

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

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

• type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.

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

security_monitoring_rule_detection_method

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

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

security_monitoring_rule_evaluation_window

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.

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.

security_monitoring_rule_hardcoded_evaluator_type

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.

security_monitoring_rule_impossible_travel_options

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.

security_monitoring_rule_keep_alive

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.

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.

security_monitoring_rule_max_signal_duration

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.

security_monitoring_rule_new_value_options

class SecurityMonitoringRuleNewValueOptions(*args, **kwargs)

Bases: ModelNormal

Options on new value rules.

Parameters:

• forget_after (SecurityMonitoringRuleNewValueOptionsForgetAfter, optional) – The duration in days after which a learned value is forgotten.

• learning_duration (SecurityMonitoringRuleNewValueOptionsLearningDuration, optional) – The duration in days during which values are learned, and after which signals will be generated for values that weren’t learned. If set to 0, a signal will be generated for all new values after the first value is learned.

• learning_method (SecurityMonitoringRuleNewValueOptionsLearningMethod, optional) – The learning method used to determine when signals should be generated for values that weren’t learned.

• learning_threshold (SecurityMonitoringRuleNewValueOptionsLearningThreshold, optional) – A number of occurrences after which signals will be generated for values that weren’t learned.

security_monitoring_rule_new_value_options_forget_after

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.

security_monitoring_rule_new_value_options_learning_duration

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.

security_monitoring_rule_new_value_options_learning_method

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.

security_monitoring_rule_new_value_options_learning_threshold

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.

security_monitoring_rule_options

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.

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

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

security_monitoring_rule_query

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.

security_monitoring_rule_query_aggregation

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.

security_monitoring_rule_response

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.

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

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

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

security_monitoring_rule_severity

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.

security_monitoring_rule_third_party_options

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.

security_monitoring_rule_type_create

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.

security_monitoring_rule_type_read

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.

security_monitoring_rule_update_payload

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.

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

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

security_monitoring_signal

class SecurityMonitoringSignal(*args, **kwargs)

Bases: ModelNormal

Object description of a security signal.

Parameters:

• attributes (SecurityMonitoringSignalAttributes, optional) – The object containing all signal attributes and their associated values.

• id (str, optional) – The unique ID of the security signal.

• type (SecurityMonitoringSignalType, optional) – The type of event.

security_monitoring_signal_archive_reason

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.

security_monitoring_signal_assignee_update_attributes

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.

security_monitoring_signal_assignee_update_data

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.

security_monitoring_signal_assignee_update_request

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.

security_monitoring_signal_attributes

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.

security_monitoring_signal_incident_ids

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.

security_monitoring_signal_incidents_update_attributes

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.

security_monitoring_signal_incidents_update_data

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.

security_monitoring_signal_incidents_update_request

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.

security_monitoring_signal_list_request

class SecurityMonitoringSignalListRequest(*args, **kwargs)

Bases: ModelNormal

The request for a security signal list.

Parameters:

• filter (SecurityMonitoringSignalListRequestFilter, optional) – Search filters for listing security signals.

• page (SecurityMonitoringSignalListRequestPage, optional) – The paging attributes for listing security signals.

• sort (SecurityMonitoringSignalsSort, optional) – The sort parameters used for querying security signals.

security_monitoring_signal_list_request_filter

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.

security_monitoring_signal_list_request_page

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.

security_monitoring_signal_metadata_type

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.

security_monitoring_signal_response

class SecurityMonitoringSignalResponse(*args, **kwargs)

Bases: ModelNormal

Security Signal response data object.

Parameters:

data (SecurityMonitoringSignal, optional) – Object description of a security signal.

security_monitoring_signal_rule_create_payload

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.

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

security_monitoring_signal_rule_query

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.

security_monitoring_signal_rule_response

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.

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

security_monitoring_signal_rule_response_query

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.

security_monitoring_signal_rule_type

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.

security_monitoring_signal_state

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.

security_monitoring_signal_state_update_attributes

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.

security_monitoring_signal_state_update_data

class SecurityMonitoringSignalStateUpdateData(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• attributes (SecurityMonitoringSignalStateUpdateAttributes) – Attributes describing the change of state of a security signal.

• id (bool, date, datetime, dict, float, int, list, str, UUID, none_type, optional) – The unique ID of the security signal.

• type (SecurityMonitoringSignalMetadataType, optional) – The type of event.

security_monitoring_signal_state_update_request

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.

security_monitoring_signal_triage_attributes

class SecurityMonitoringSignalTriageAttributes(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• archive_comment (str, optional) – Optional comment to display on archived signals.

• archive_comment_timestamp (int, optional) – Timestamp of the last edit to the comment.

• archive_comment_user (SecurityMonitoringTriageUser, optional) – Object representing a given user entity.

• archive_reason (SecurityMonitoringSignalArchiveReason, optional) – Reason a signal is archived.

• assignee (SecurityMonitoringTriageUser) – Object representing a given user entity.

• incident_ids (SecurityMonitoringSignalIncidentIds) – Array of incidents that are associated with this signal.

• state (SecurityMonitoringSignalState) – The new triage state of the signal.

• state_update_timestamp (int, optional) – Timestamp of the last update to the signal state.

• state_update_user (SecurityMonitoringTriageUser, optional) – Object representing a given user entity.

security_monitoring_signal_triage_update_data

class SecurityMonitoringSignalTriageUpdateData(*args, **kwargs)

Bases: ModelNormal

Data containing the updated triage attributes of the signal.

Parameters:

• attributes (SecurityMonitoringSignalTriageAttributes, optional) – Attributes describing a triage state update operation over a security signal.

• id (str, optional) – The unique ID of the security signal.

• type (SecurityMonitoringSignalMetadataType, optional) – The type of event.

security_monitoring_signal_triage_update_response

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.

security_monitoring_signal_type

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.

security_monitoring_signals_list_response

class SecurityMonitoringSignalsListResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([SecurityMonitoringSignal], optional) – An array of security signals matching the request.

• links (SecurityMonitoringSignalsListResponseLinks, optional) – Links attributes.

• meta (SecurityMonitoringSignalsListResponseMeta, optional) – Meta attributes.

security_monitoring_signals_list_response_links

class SecurityMonitoringSignalsListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

security_monitoring_signals_list_response_meta

class SecurityMonitoringSignalsListResponseMeta(*args, **kwargs)

Bases: ModelNormal

Meta attributes.

Parameters:

page (SecurityMonitoringSignalsListResponseMetaPage, optional) – Paging attributes.

security_monitoring_signals_list_response_meta_page

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

security_monitoring_signals_sort

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.

security_monitoring_standard_rule_create_payload

class SecurityMonitoringStandardRuleCreatePayload(*args, **kwargs)

Bases: ModelNormal

Create a new rule.

Parameters:

• cases ([SecurityMonitoringRuleCaseCreate]) – Cases for generating signals.

• filters ([SecurityMonitoringFilter], optional) – Additional queries to filter matched events before they are processed.

• 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 ([SecurityMonitoringStandardRuleQuery]) – Queries for selecting logs which are part of the rule.

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

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

• type (SecurityMonitoringRuleTypeCreate, optional) – The rule type.

security_monitoring_standard_rule_query

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.

security_monitoring_standard_rule_response

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.

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

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

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

security_monitoring_suppression

class SecurityMonitoringSuppression(*args, **kwargs)

Bases: ModelNormal

The suppression rule’s properties.

Parameters:

• attributes (SecurityMonitoringSuppressionAttributes, optional) – The attributes of the suppression rule.

• id (str, optional) – The ID of the suppression rule.

• type (SecurityMonitoringSuppressionType, optional) – The type of the resource. The value should always be suppressions.

security_monitoring_suppression_attributes

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.

• description (str, optional) – A description for the suppression rule.

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

security_monitoring_suppression_create_attributes

class SecurityMonitoringSuppressionCreateAttributes(*args, **kwargs)

Bases: ModelNormal

Object containing the attributes of the suppression rule to be created.

Parameters:

• 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) – The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered . Same syntax as the queries to search signals in the signal explorer.

security_monitoring_suppression_create_data

class SecurityMonitoringSuppressionCreateData(*args, **kwargs)

Bases: ModelNormal

Object for a single suppression rule.

Parameters:

• attributes (SecurityMonitoringSuppressionCreateAttributes) – Object containing the attributes of the suppression rule to be created.

• type (SecurityMonitoringSuppressionType) – The type of the resource. The value should always be suppressions.

security_monitoring_suppression_create_request

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.

security_monitoring_suppression_response

class SecurityMonitoringSuppressionResponse(*args, **kwargs)

Bases: ModelNormal

Response object containing a single suppression rule.

Parameters:

data (SecurityMonitoringSuppression, optional) – The suppression rule’s properties.

security_monitoring_suppression_type

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.

security_monitoring_suppression_update_attributes

class SecurityMonitoringSuppressionUpdateAttributes(*args, **kwargs)

Bases: ModelNormal

The suppression rule properties to be updated.

Parameters:

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

security_monitoring_suppression_update_data

class SecurityMonitoringSuppressionUpdateData(*args, **kwargs)

Bases: ModelNormal

The new suppression properties; partial updates are supported.

Parameters:

• attributes (SecurityMonitoringSuppressionUpdateAttributes) – The suppression rule properties to be updated.

• type (SecurityMonitoringSuppressionType) – The type of the resource. The value should always be suppressions.

security_monitoring_suppression_update_request

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.

security_monitoring_suppressions_response

class SecurityMonitoringSuppressionsResponse(*args, **kwargs)

Bases: ModelNormal

Response object containing the available suppression rules.

Parameters:

data ([SecurityMonitoringSuppression], optional) – A list of suppressions objects.

security_monitoring_third_party_root_query

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.

security_monitoring_third_party_rule_case

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.

security_monitoring_third_party_rule_case_create

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.

security_monitoring_triage_user

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.

security_monitoring_user

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.

sensitive_data_scanner_config_request

class SensitiveDataScannerConfigRequest(*args, **kwargs)

Bases: ModelNormal

Group reorder request.

Parameters:

• data (SensitiveDataScannerReorderConfig) – Data related to the reordering of scanning groups.

• meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

sensitive_data_scanner_configuration

class SensitiveDataScannerConfiguration(*args, **kwargs)

Bases: ModelNormal

A Sensitive Data Scanner configuration.

Parameters:

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

• type (SensitiveDataScannerConfigurationType, optional) – Sensitive Data Scanner configuration type.

sensitive_data_scanner_configuration_data

class SensitiveDataScannerConfigurationData(*args, **kwargs)

Bases: ModelNormal

A Sensitive Data Scanner configuration data.

Parameters:

data (SensitiveDataScannerConfiguration, optional) – A Sensitive Data Scanner configuration.

sensitive_data_scanner_configuration_relationships

class SensitiveDataScannerConfigurationRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the configuration.

Parameters:

groups (SensitiveDataScannerGroupList, optional) – List of groups, ordered.

sensitive_data_scanner_configuration_type

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.

sensitive_data_scanner_create_group_response

class SensitiveDataScannerCreateGroupResponse(*args, **kwargs)

Bases: ModelNormal

Create group response.

Parameters:

• data (SensitiveDataScannerGroupResponse, optional) – Response data related to the creation of a group.

• meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_create_rule_response

class SensitiveDataScannerCreateRuleResponse(*args, **kwargs)

Bases: ModelNormal

Create rule response.

Parameters:

• data (SensitiveDataScannerRuleResponse, optional) – Response data related to the creation of a rule.

• meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_filter

class SensitiveDataScannerFilter(*args, **kwargs)

Bases: ModelNormal

Filter for the Scanning Group.

Parameters:

query (str, optional) – Query to filter the events.

sensitive_data_scanner_get_config_included_array

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.

sensitive_data_scanner_get_config_included_item

class SensitiveDataScannerGetConfigIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to the configuration.

Parameters:

• attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.

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

• relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.

• type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

sensitive_data_scanner_get_config_response

class SensitiveDataScannerGetConfigResponse(*args, **kwargs)

Bases: ModelNormal

Get all groups response.

Parameters:

• data (SensitiveDataScannerGetConfigResponseData, optional) – Response data related to the scanning groups.

• included (SensitiveDataScannerGetConfigIncludedArray, optional) – Included objects from relationships.

• meta (SensitiveDataScannerMeta, optional) – Meta response containing information about the API.

sensitive_data_scanner_get_config_response_data

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.

sensitive_data_scanner_group

class SensitiveDataScannerGroup(*args, **kwargs)

Bases: ModelNormal

A scanning group.

Parameters:

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

• type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

sensitive_data_scanner_group_attributes

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.

sensitive_data_scanner_group_create

class SensitiveDataScannerGroupCreate(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a group.

Parameters:

• attributes (SensitiveDataScannerGroupAttributes) – Attributes of the Sensitive Data Scanner group.

• relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.

• type (SensitiveDataScannerGroupType) – Sensitive Data Scanner group type.

sensitive_data_scanner_group_create_request

class SensitiveDataScannerGroupCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create group request.

Parameters:

• data (SensitiveDataScannerGroupCreate, optional) – Data related to the creation of a group.

• meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_group_data

class SensitiveDataScannerGroupData(*args, **kwargs)

Bases: ModelNormal

A scanning group data.

Parameters:

data (SensitiveDataScannerGroup, optional) – A scanning group.

sensitive_data_scanner_group_delete_request

class SensitiveDataScannerGroupDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Delete group request.

Parameters:

meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

sensitive_data_scanner_group_delete_response

class SensitiveDataScannerGroupDeleteResponse(*args, **kwargs)

Bases: ModelNormal

Delete group response.

Parameters:

meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_group_included_item

class SensitiveDataScannerGroupIncludedItem(*args, **kwargs)

Bases: ModelNormal

A Scanning Group included item.

Parameters:

• attributes (SensitiveDataScannerGroupAttributes, optional) – Attributes of the Sensitive Data Scanner group.

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

• relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.

• type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

sensitive_data_scanner_group_item

class SensitiveDataScannerGroupItem(*args, **kwargs)

Bases: ModelNormal

Data related to a Sensitive Data Scanner Group.

Parameters:

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

• type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

sensitive_data_scanner_group_list

class SensitiveDataScannerGroupList(*args, **kwargs)

Bases: ModelNormal

List of groups, ordered.

Parameters:

data ([SensitiveDataScannerGroupItem], optional) – List of groups. The order is important.

sensitive_data_scanner_group_relationships

class SensitiveDataScannerGroupRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the group.

Parameters:

• configuration (SensitiveDataScannerConfigurationData, optional) – A Sensitive Data Scanner configuration data.

• rules (SensitiveDataScannerRuleData, optional) – Rules included in the group.

sensitive_data_scanner_group_response

class SensitiveDataScannerGroupResponse(*args, **kwargs)

Bases: ModelNormal

Response data related to the creation of a group.

Parameters:

• attributes (SensitiveDataScannerGroupAttributes, optional) – Attributes of the Sensitive Data Scanner group.

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

• relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.

• type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

sensitive_data_scanner_group_type

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.

sensitive_data_scanner_group_update

class SensitiveDataScannerGroupUpdate(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a group.

Parameters:

• attributes (SensitiveDataScannerGroupAttributes, optional) – Attributes of the Sensitive Data Scanner group.

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

• relationships (SensitiveDataScannerGroupRelationships, optional) – Relationships of the group.

• type (SensitiveDataScannerGroupType, optional) – Sensitive Data Scanner group type.

sensitive_data_scanner_group_update_request

class SensitiveDataScannerGroupUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update group request.

Parameters:

• data (SensitiveDataScannerGroupUpdate) – Data related to the update of a group.

• meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

sensitive_data_scanner_group_update_response

class SensitiveDataScannerGroupUpdateResponse(*args, **kwargs)

Bases: ModelNormal

Update group response.

Parameters:

meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_included_keyword_configuration

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

sensitive_data_scanner_meta

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) – Whether or not scanned events are highlighted in Logs or RUM for the org.

• has_multi_pass_enabled (bool, optional) – Whether or not scanned events have multi-pass enabled.

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

sensitive_data_scanner_meta_version_only

class SensitiveDataScannerMetaVersionOnly(*args, **kwargs)

Bases: ModelNormal

Meta payload containing information about the API.

Parameters:

version (int, optional) – Version of the API (optional).

sensitive_data_scanner_product

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.

sensitive_data_scanner_reorder_config

class SensitiveDataScannerReorderConfig(*args, **kwargs)

Bases: ModelNormal

Data related to the reordering of scanning groups.

Parameters:

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

• relationships (SensitiveDataScannerConfigurationRelationships, optional) – Relationships of the configuration.

• type (SensitiveDataScannerConfigurationType, optional) – Sensitive Data Scanner configuration type.

sensitive_data_scanner_reorder_groups_response

class SensitiveDataScannerReorderGroupsResponse(*args, **kwargs)

Bases: ModelNormal

Group reorder response.

Parameters:

meta (SensitiveDataScannerMeta, optional) – Meta response containing information about the API.

sensitive_data_scanner_rule

class SensitiveDataScannerRule(*args, **kwargs)

Bases: ModelNormal

Rule item included in the group.

Parameters:

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

• type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

sensitive_data_scanner_rule_attributes

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.

sensitive_data_scanner_rule_create

class SensitiveDataScannerRuleCreate(*args, **kwargs)

Bases: ModelNormal

Data related to the creation of a rule.

Parameters:

• attributes (SensitiveDataScannerRuleAttributes) – Attributes of the Sensitive Data Scanner rule.

• relationships (SensitiveDataScannerRuleRelationships) – Relationships of a scanning rule.

• type (SensitiveDataScannerRuleType) – Sensitive Data Scanner rule type.

sensitive_data_scanner_rule_create_request

class SensitiveDataScannerRuleCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create rule request.

Parameters:

• data (SensitiveDataScannerRuleCreate) – Data related to the creation of a rule.

• meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

sensitive_data_scanner_rule_data

class SensitiveDataScannerRuleData(*args, **kwargs)

Bases: ModelNormal

Rules included in the group.

Parameters:

data ([SensitiveDataScannerRule], optional) – Rules included in the group. The order is important.

sensitive_data_scanner_rule_delete_request

class SensitiveDataScannerRuleDeleteRequest(*args, **kwargs)

Bases: ModelNormal

Delete rule request.

Parameters:

meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

sensitive_data_scanner_rule_delete_response

class SensitiveDataScannerRuleDeleteResponse(*args, **kwargs)

Bases: ModelNormal

Delete rule response.

Parameters:

meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_rule_included_item

class SensitiveDataScannerRuleIncludedItem(*args, **kwargs)

Bases: ModelNormal

A Scanning Rule included item.

Parameters:

• attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.

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

• relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.

• type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

sensitive_data_scanner_rule_relationships

class SensitiveDataScannerRuleRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of a scanning rule.

Parameters:

• group (SensitiveDataScannerGroupData, optional) – A scanning group data.

• standard_pattern (SensitiveDataScannerStandardPatternData, optional) – A standard pattern.

sensitive_data_scanner_rule_response

class SensitiveDataScannerRuleResponse(*args, **kwargs)

Bases: ModelNormal

Response data related to the creation of a rule.

Parameters:

• attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.

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

• relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.

• type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

sensitive_data_scanner_rule_type

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.

sensitive_data_scanner_rule_update

class SensitiveDataScannerRuleUpdate(*args, **kwargs)

Bases: ModelNormal

Data related to the update of a rule.

Parameters:

• attributes (SensitiveDataScannerRuleAttributes, optional) – Attributes of the Sensitive Data Scanner rule.

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

• relationships (SensitiveDataScannerRuleRelationships, optional) – Relationships of a scanning rule.

• type (SensitiveDataScannerRuleType, optional) – Sensitive Data Scanner rule type.

sensitive_data_scanner_rule_update_request

class SensitiveDataScannerRuleUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update rule request.

Parameters:

• data (SensitiveDataScannerRuleUpdate) – Data related to the update of a rule.

• meta (SensitiveDataScannerMetaVersionOnly) – Meta payload containing information about the API.

sensitive_data_scanner_rule_update_response

class SensitiveDataScannerRuleUpdateResponse(*args, **kwargs)

Bases: ModelNormal

Update rule response.

Parameters:

meta (SensitiveDataScannerMetaVersionOnly, optional) – Meta payload containing information about the API.

sensitive_data_scanner_standard_pattern

class SensitiveDataScannerStandardPattern(*args, **kwargs)

Bases: ModelNormal

Data containing the standard pattern id.

Parameters:

• id (str, optional) – ID of the standard pattern.

• type (SensitiveDataScannerStandardPatternType, optional) – Sensitive Data Scanner standard pattern type.

sensitive_data_scanner_standard_pattern_attributes

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) – Regex to match.

• priority (int, optional) – Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.

• tags ([str], optional) – List of tags.

sensitive_data_scanner_standard_pattern_data

class SensitiveDataScannerStandardPatternData(*args, **kwargs)

Bases: ModelNormal

A standard pattern.

Parameters:

data (SensitiveDataScannerStandardPattern, optional) – Data containing the standard pattern id.

sensitive_data_scanner_standard_pattern_type

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.

sensitive_data_scanner_standard_patterns_response

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.

sensitive_data_scanner_standard_patterns_response_data

class SensitiveDataScannerStandardPatternsResponseData(*args, **kwargs)

Bases: ModelNormal

List Standard patterns response data.

Parameters:

data (SensitiveDataScannerStandardPatternsResponse, optional) – List Standard patterns response.

sensitive_data_scanner_standard_patterns_response_item

class SensitiveDataScannerStandardPatternsResponseItem(*args, **kwargs)

Bases: ModelNormal

Standard pattern item.

Parameters:

• attributes (SensitiveDataScannerStandardPatternAttributes, optional) – Attributes of the Sensitive Data Scanner standard pattern.

• id (str, optional) – ID of the standard pattern.

• type (SensitiveDataScannerStandardPatternType, optional) – Sensitive Data Scanner standard pattern type.

sensitive_data_scanner_text_replacement

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.

sensitive_data_scanner_text_replacement_type

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.

service_account_create_attributes

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.

service_account_create_data

class ServiceAccountCreateData(*args, **kwargs)

Bases: ModelNormal

Object to create a service account User.

Parameters:

• attributes (ServiceAccountCreateAttributes) – Attributes of the created user.

• relationships (UserRelationships, optional) – Relationships of the user object.

• type (UsersType) – Users resource type.

service_account_create_request

class ServiceAccountCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create a service account.

Parameters:

data (ServiceAccountCreateData) – Object to create a service account User.

service_definition_create_response

class ServiceDefinitionCreateResponse(*args, **kwargs)

Bases: ModelNormal

Create service definitions response.

Parameters:

data ([ServiceDefinitionData], optional) – Create service definitions response payload.

service_definition_data

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.

service_definition_data_attributes

class ServiceDefinitionDataAttributes(*args, **kwargs)

Bases: ModelNormal

Service definition attributes.

Parameters:

• meta (ServiceDefinitionMeta, optional) – Metadata about a service definition.

• schema (ServiceDefinitionSchema, optional) – Service definition schema.

service_definition_get_response

class ServiceDefinitionGetResponse(*args, **kwargs)

Bases: ModelNormal

Get service definition response.

Parameters:

data (ServiceDefinitionData, optional) – Service definition data.

service_definition_meta

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.

service_definition_meta_warnings

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.

service_definition_schema

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.

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

service_definition_schema_versions

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.

service_definition_v1

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.

service_definition_v1_contact

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.

service_definition_v1_info

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.

service_definition_v1_integrations

class ServiceDefinitionV1Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

pagerduty (str, optional) – PagerDuty service URL for the service.

service_definition_v1_org

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.

service_definition_v1_resource

class ServiceDefinitionV1Resource(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

• name (str) – Link name.

• type (ServiceDefinitionV1ResourceType) – Link type.

• url (str) – Link URL.

service_definition_v1_resource_type

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.

service_definition_v2

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.

service_definition_v2_contact

class ServiceDefinitionV2Contact(*args, **kwargs)

Bases: ModelComposed

Service owner’s contacts information.

Parameters:

• contact (str) – Contact value.

• name (str, optional) – Contact email.

• type (ServiceDefinitionV2EmailType) – Contact type.

service_definition_v2_doc

class ServiceDefinitionV2Doc(*args, **kwargs)

Bases: ModelNormal

Service documents.

Parameters:

• name (str) – Document name.

• provider (str, optional) – Document provider.

• url (str) – Document URL.

service_definition_v2_dot1

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.

service_definition_v2_dot1_contact

class ServiceDefinitionV2Dot1Contact(*args, **kwargs)

Bases: ModelComposed

Service owner’s contacts information.

Parameters:

• contact (str) – Contact value.

• name (str, optional) – Contact email.

• type (ServiceDefinitionV2Dot1EmailType) – Contact type.

service_definition_v2_dot1_email

class ServiceDefinitionV2Dot1Email(*args, **kwargs)

Bases: ModelNormal

Service owner’s email.

Parameters:

• contact (str) – Contact value.

• name (str, optional) – Contact email.

• type (ServiceDefinitionV2Dot1EmailType) – Contact type.

service_definition_v2_dot1_email_type

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.

service_definition_v2_dot1_integrations

class ServiceDefinitionV2Dot1Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

• opsgenie (ServiceDefinitionV2Dot1Opsgenie, optional) – Opsgenie integration for the service.

• pagerduty (ServiceDefinitionV2Dot1Pagerduty, optional) – PagerDuty integration for the service.

service_definition_v2_dot1_link

class ServiceDefinitionV2Dot1Link(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

• name (str) – Link name.

• provider (str, optional) – Link provider.

• type (ServiceDefinitionV2Dot1LinkType) – Link type.

• url (str) – Link URL.

service_definition_v2_dot1_link_type

class ServiceDefinitionV2Dot1LinkType(*args, **kwargs)

Bases: ModelSimple

Link type.

Parameters:

• value (str) – Must be one of [“doc”, “repo”, “runbook”, “dashboard”, “other”].

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

service_definition_v2_dot1_ms_teams

class ServiceDefinitionV2Dot1MSTeams(*args, **kwargs)

Bases: ModelNormal

Service owner’s Microsoft Teams.

Parameters:

• contact (str) – Contact value.

• name (str, optional) – Contact Microsoft Teams.

• type (ServiceDefinitionV2Dot1MSTeamsType) – Contact type.

service_definition_v2_dot1_ms_teams_type

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.

service_definition_v2_dot1_opsgenie

class ServiceDefinitionV2Dot1Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

• region (ServiceDefinitionV2Dot1OpsgenieRegion, optional) – Opsgenie instance region.

• service_url (str) – Opsgenie service url.

service_definition_v2_dot1_opsgenie_region

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.

service_definition_v2_dot1_pagerduty

class ServiceDefinitionV2Dot1Pagerduty(*args, **kwargs)

Bases: ModelNormal

PagerDuty integration for the service.

Parameters:

service_url (str, optional) – PagerDuty service url.

service_definition_v2_dot1_slack

class ServiceDefinitionV2Dot1Slack(*args, **kwargs)

Bases: ModelNormal

Service owner’s Slack channel.

Parameters:

• contact (str) – Slack Channel.

• name (str, optional) – Contact Slack.

• type (ServiceDefinitionV2Dot1SlackType) – Contact type.

service_definition_v2_dot1_slack_type

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.

service_definition_v2_dot2

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.

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

service_definition_v2_dot2_contact

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.

service_definition_v2_dot2_integrations

class ServiceDefinitionV2Dot2Integrations(*args, **kwargs)

Bases: ModelNormal

Third party integrations that Datadog supports.

Parameters:

• opsgenie (ServiceDefinitionV2Dot2Opsgenie, optional) – Opsgenie integration for the service.

• pagerduty (ServiceDefinitionV2Dot2Pagerduty, optional) – PagerDuty integration for the service.

service_definition_v2_dot2_link

class ServiceDefinitionV2Dot2Link(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

• name (str) – Link name.

• provider (str, optional) – Link provider.

• type (str) – Link type. Datadog recognizes the following types: runbook , doc , repo , dashboard , and other.

• url (str) – Link URL.

service_definition_v2_dot2_opsgenie

class ServiceDefinitionV2Dot2Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

• region (ServiceDefinitionV2Dot2OpsgenieRegion, optional) – Opsgenie instance region.

• service_url (str) – Opsgenie service url.

service_definition_v2_dot2_opsgenie_region

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.

service_definition_v2_dot2_pagerduty

class ServiceDefinitionV2Dot2Pagerduty(*args, **kwargs)

Bases: ModelNormal

PagerDuty integration for the service.

Parameters:

service_url (str, optional) – PagerDuty service url.

service_definition_v2_dot2_type

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.

service_definition_v2_email

class ServiceDefinitionV2Email(*args, **kwargs)

Bases: ModelNormal

Service owner’s email.

Parameters:

• contact (str) – Contact value.

• name (str, optional) – Contact email.

• type (ServiceDefinitionV2EmailType) – Contact type.

service_definition_v2_email_type

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.

service_definition_v2_integrations

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.

service_definition_v2_link

class ServiceDefinitionV2Link(*args, **kwargs)

Bases: ModelNormal

Service’s external links.

Parameters:

• name (str) – Link name.

• type (ServiceDefinitionV2LinkType) – Link type.

• url (str) – Link URL.

service_definition_v2_link_type

class ServiceDefinitionV2LinkType(*args, **kwargs)

Bases: ModelSimple

Link type.

Parameters:

• value (str) – Must be one of [“doc”, “wiki”, “runbook”, “url”, “repo”, “dashboard”, “oncall”, “code”, “link”].

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

service_definition_v2_ms_teams

class ServiceDefinitionV2MSTeams(*args, **kwargs)

Bases: ModelNormal

Service owner’s Microsoft Teams.

Parameters:

• contact (str) – Contact value.

• name (str, optional) – Contact Microsoft Teams.

• type (ServiceDefinitionV2MSTeamsType) – Contact type.

service_definition_v2_ms_teams_type

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.

service_definition_v2_opsgenie

class ServiceDefinitionV2Opsgenie(*args, **kwargs)

Bases: ModelNormal

Opsgenie integration for the service.

Parameters:

• region (ServiceDefinitionV2OpsgenieRegion, optional) – Opsgenie instance region.

• service_url (str) – Opsgenie service url.

service_definition_v2_opsgenie_region

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.

service_definition_v2_repo

class ServiceDefinitionV2Repo(*args, **kwargs)

Bases: ModelNormal

Service code repositories.

Parameters:

• name (str) – Repository name.

• provider (str, optional) – Repository provider.

• url (str) – Repository URL.

service_definition_v2_slack

class ServiceDefinitionV2Slack(*args, **kwargs)

Bases: ModelNormal

Service owner’s Slack channel.

Parameters:

• contact (str) – Slack Channel.

• name (str, optional) – Contact Slack.

• type (ServiceDefinitionV2SlackType) – Contact type.

service_definition_v2_slack_type

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.

service_definitions_create_request

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.

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

service_definitions_list_response

class ServiceDefinitionsListResponse(*args, **kwargs)

Bases: ModelNormal

Create service definitions response.

Parameters:

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

slack_integration_metadata

class SlackIntegrationMetadata(*args, **kwargs)

Bases: ModelNormal

Incident integration metadata for the Slack integration.

Parameters:

channels ([SlackIntegrationMetadataChannelItem]) – Array of Slack channels in this integration metadata.

slack_integration_metadata_channel_item

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.

sort_direction

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.

span

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.

spans_aggregate_bucket

class SpansAggregateBucket(*args, **kwargs)

Bases: ModelNormal

Spans aggregate.

Parameters:

• attributes (SpansAggregateBucketAttributes, optional) – A bucket values.

• id (str, optional) – ID of the spans aggregate.

• type (SpansAggregateBucketType, optional) – The spans aggregate bucket type.

spans_aggregate_bucket_attributes

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.

spans_aggregate_bucket_type

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.

spans_aggregate_bucket_value

class SpansAggregateBucketValue(*args, **kwargs)

Bases: ModelComposed

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

spans_aggregate_bucket_value_timeseries_point

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.

spans_aggregate_data

class SpansAggregateData(*args, **kwargs)

Bases: ModelNormal

The object containing the query content.

Parameters:

• attributes (SpansAggregateRequestAttributes, optional) – The object containing all the query parameters.

• type (SpansAggregateRequestType, optional) – The type of resource. The value should always be aggregate_request.

spans_aggregate_request

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.

spans_aggregate_request_attributes

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.

spans_aggregate_request_type

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.

spans_aggregate_response

class SpansAggregateResponse(*args, **kwargs)

Bases: ModelNormal

The response object for the spans aggregate API endpoint.

Parameters:

• data ([SpansAggregateBucket], optional) – The list of matching buckets, one item per bucket.

• meta (SpansAggregateResponseMetadata, optional) – The metadata associated with a request.

spans_aggregate_response_metadata

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.

spans_aggregate_response_status

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.

spans_aggregate_sort

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.

spans_aggregate_sort_type

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.

spans_aggregation_function

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.

spans_attributes

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.

spans_compute

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.

spans_compute_type

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.

spans_filter

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.

spans_filter_create

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.

spans_group_by

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.

spans_group_by_histogram

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

spans_group_by_missing

class SpansGroupByMissing(*args, **kwargs)

Bases: ModelComposed

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

spans_group_by_total

class SpansGroupByTotal(*args, **kwargs)

Bases: ModelComposed

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

spans_list_request

class SpansListRequest(*args, **kwargs)

Bases: ModelNormal

The request for a spans list.

Parameters:

data (SpansListRequestData, optional) – The object containing the query content.

spans_list_request_attributes

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.

spans_list_request_data

class SpansListRequestData(*args, **kwargs)

Bases: ModelNormal

The object containing the query content.

Parameters:

• attributes (SpansListRequestAttributes, optional) – The object containing all the query parameters.

• type (SpansListRequestType, optional) – The type of resource. The value should always be search_request.

spans_list_request_page

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.

spans_list_request_type

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.

spans_list_response

class SpansListResponse(*args, **kwargs)

Bases: ModelNormal

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

Parameters:

• data ([Span], optional) – Array of spans matching the request.

• links (SpansListResponseLinks, optional) – Links attributes.

• meta (SpansListResponseMetadata, optional) – The metadata associated with a request.

spans_list_response_links

class SpansListResponseLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

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

spans_list_response_metadata

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.

spans_metric_compute

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

spans_metric_compute_aggregation_type

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.

spans_metric_create_attributes

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.

spans_metric_create_data

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.

spans_metric_create_request

class SpansMetricCreateRequest(*args, **kwargs)

Bases: ModelNormal

The new span-based metric body.

Parameters:

data (SpansMetricCreateData) – The new span-based metric properties.

spans_metric_filter

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.

spans_metric_group_by

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.

spans_metric_response

class SpansMetricResponse(*args, **kwargs)

Bases: ModelNormal

The span-based metric object.

Parameters:

data (SpansMetricResponseData, optional) – The span-based metric properties.

spans_metric_response_attributes

class SpansMetricResponseAttributes(*args, **kwargs)

Bases: ModelNormal

The object describing a Datadog span-based metric.

Parameters:

• compute (SpansMetricResponseCompute, optional) – The compute rule to compute the span-based metric.

• filter (SpansMetricResponseFilter, optional) – The span-based metric filter. Spans matching this filter will be aggregated in this metric.

• group_by ([SpansMetricResponseGroupBy], optional) – The rules for the group by.

spans_metric_response_compute

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

spans_metric_response_data

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.

spans_metric_response_filter

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.

spans_metric_response_group_by

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.

spans_metric_type

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.

spans_metric_update_attributes

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.

spans_metric_update_compute

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.

spans_metric_update_data

class SpansMetricUpdateData(*args, **kwargs)

Bases: ModelNormal

The new span-based metric properties.

Parameters:

• attributes (SpansMetricUpdateAttributes) – The span-based metric properties that will be updated.

• type (SpansMetricType) – The type of resource. The value should always be spans_metrics.

spans_metric_update_request

class SpansMetricUpdateRequest(*args, **kwargs)

Bases: ModelNormal

The new span-based metric body.

Parameters:

data (SpansMetricUpdateData) – The new span-based metric properties.

spans_metrics_response

class SpansMetricsResponse(*args, **kwargs)

Bases: ModelNormal

All the available span-based metric objects.

Parameters:

data ([SpansMetricResponseData], optional) – A list of span-based metric objects.

spans_query_filter

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

spans_query_options

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

spans_response_metadata_page

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

spans_sort

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.

spans_sort_order

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.

spans_type

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.

spans_warning

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.

state

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.

tags_event_attribute

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.

team

class Team(*args, **kwargs)

Bases: ModelNormal

A team

Parameters:

• attributes (TeamAttributes) – Team attributes

• id (str) – The team’s identifier

• relationships (TeamRelationships, optional) – Resources related to a team

• type (TeamType) – Team type

team_attributes

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

team_create

class TeamCreate(*args, **kwargs)

Bases: ModelNormal

Team create

Parameters:

• attributes (TeamCreateAttributes) – Team creation attributes

• relationships (TeamCreateRelationships, optional) – Relationships formed with the team on creation

• type (TeamType) – Team type

team_create_attributes

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

team_create_relationships

class TeamCreateRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships formed with the team on creation

Parameters:

users (RelationshipToUsers, optional) – Relationship to users.

team_create_request

class TeamCreateRequest(*args, **kwargs)

Bases: ModelNormal

Request to create a team

Parameters:

data (TeamCreate) – Team create

team_included

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.

team_link

class TeamLink(*args, **kwargs)

Bases: ModelNormal

Team link

Parameters:

• attributes (TeamLinkAttributes) – Team link attributes

• id (str) – The team link’s identifier

• type (TeamLinkType) – Team link type

team_link_attributes

class TeamLinkAttributes(*args, **kwargs)

Bases: ModelNormal

Team link attributes

Parameters:

• label (str) – The link’s label

• position (int, optional) – The link’s position, used to sort links for the team

• team_id (str, optional) – ID of the team the link is associated with

• url (str) – The URL for the link

team_link_create

class TeamLinkCreate(*args, **kwargs)

Bases: ModelNormal

Team link create

Parameters:

• attributes (TeamLinkAttributes) – Team link attributes

• type (TeamLinkType) – Team link type

team_link_create_request

class TeamLinkCreateRequest(*args, **kwargs)

Bases: ModelNormal

Team link create request

Parameters:

data (TeamLinkCreate) – Team link create

team_link_response

class TeamLinkResponse(*args, **kwargs)

Bases: ModelNormal

Team link response

Parameters:

data (TeamLink, optional) – Team link

team_link_type

class TeamLinkType(*args, **kwargs)

Bases: ModelSimple

Team link type

Parameters:

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

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

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

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

• _configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

team_links_response

class TeamLinksResponse(*args, **kwargs)

Bases: ModelNormal

Team links response

Parameters:

data ([TeamLink], optional) – Team links response data

team_permission_setting

class TeamPermissionSetting(*args, **kwargs)

Bases: ModelNormal

Team permission setting

Parameters:

• attributes (TeamPermissionSettingAttributes, optional) – Team permission setting attributes

• id (str) – The team permission setting’s identifier

• type (TeamPermissionSettingType) – Team permission setting type

team_permission_setting_attributes

class TeamPermissionSettingAttributes(*args, **kwargs)

Bases: ModelNormal

Team permission setting attributes

Parameters:

• action (TeamPermissionSettingSerializerAction, optional) – The identifier for the action

• editable (bool, optional) – Whether or not the permission setting is editable by the current user

• options (TeamPermissionSettingValues, optional) – Possible values for action

• title (str, optional) – The team permission name

• value (TeamPermissionSettingValue, optional) – What type of user is allowed to perform the specified action

team_permission_setting_response

class TeamPermissionSettingResponse(*args, **kwargs)

Bases: ModelNormal

Team permission setting response

Parameters:

data (TeamPermissionSetting, optional) – Team permission setting

team_permission_setting_serializer_action

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.

team_permission_setting_type

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.

team_permission_setting_update

class TeamPermissionSettingUpdate(*args, **kwargs)

Bases: ModelNormal

Team permission setting update

Parameters:

• attributes (TeamPermissionSettingUpdateAttributes, optional) – Team permission setting update attributes

• type (TeamPermissionSettingType) – Team permission setting type

team_permission_setting_update_attributes

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

team_permission_setting_update_request

class TeamPermissionSettingUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Team permission setting update request

Parameters:

data (TeamPermissionSettingUpdate) – Team permission setting update

team_permission_setting_value

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.

team_permission_setting_values

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.

team_permission_settings_response

class TeamPermissionSettingsResponse(*args, **kwargs)

Bases: ModelNormal

Team permission settings response

Parameters:

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

team_relationships

class TeamRelationships(*args, **kwargs)

Bases: ModelNormal

Resources related to a team

Parameters:

• team_links (RelationshipToTeamLinks, optional) – Relationship between a team and a team link

• user_team_permissions (RelationshipToUserTeamPermission, optional) – Relationship between a user team permission and a team

team_relationships_links

class TeamRelationshipsLinks(*args, **kwargs)

Bases: ModelNormal

Links attributes.

Parameters:

related (str, optional) – Related link.

team_response

class TeamResponse(*args, **kwargs)

Bases: ModelNormal

Response with a team

Parameters:

data (Team, optional) – A team

team_type

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.

team_update

class TeamUpdate(*args, **kwargs)

Bases: ModelNormal

Team update request

Parameters:

• attributes (TeamUpdateAttributes) – Team update attributes

• relationships (TeamUpdateRelationships, optional) – Team update relationships

• type (TeamType) – Team type

team_update_attributes

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

• color (int, optional) – An identifier for the color representing 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

team_update_relationships

class TeamUpdateRelationships(*args, **kwargs)

Bases: ModelNormal

Team update relationships

Parameters:

team_links (RelationshipToTeamLinks, optional) – Relationship between a team and a team link

team_update_request

class TeamUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Team update request

Parameters:

data (TeamUpdate) – Team update request

teams_field

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.

teams_response

class TeamsResponse(*args, **kwargs)

Bases: ModelNormal

Response with multiple teams

Parameters:

• data ([Team], optional) – Teams response data

• included ([TeamIncluded], optional) – Resources related to the team

• links (TeamsResponseLinks, optional) – Teams response links.

• meta (TeamsResponseMeta, optional) – Teams response metadata.

teams_response_links

class TeamsResponseLinks(*args, **kwargs)

Bases: ModelNormal

Teams response links.

Parameters:

• first (str, optional) – First link.

• last (str, none_type, optional) – Last link.

• next (str, optional) – Next link.

• prev (str, none_type, optional) – Previous link.

• self (str, optional) – Current link.

teams_response_meta

class TeamsResponseMeta(*args, **kwargs)

Bases: ModelNormal

Teams response metadata.

Parameters:

pagination (TeamsResponseMetaPagination, optional) – Teams response metadata.

teams_response_meta_pagination

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.

timeseries_formula_query_request

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.

timeseries_formula_query_response

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.

timeseries_formula_request

class TimeseriesFormulaRequest(*args, **kwargs)

Bases: ModelNormal

A single timeseries query to be executed.

Parameters:

• attributes (TimeseriesFormulaRequestAttributes) – The object describing a timeseries formula request.

• type (TimeseriesFormulaRequestType) – The type of the resource. The value should always be timeseries_request.

timeseries_formula_request_attributes

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.

timeseries_formula_request_queries

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.

timeseries_formula_request_type

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.

timeseries_formula_response_type

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.

timeseries_query

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.

timeseries_response

class TimeseriesResponse(*args, **kwargs)

Bases: ModelNormal

A message containing the response to a timeseries query.

Parameters:

• attributes (TimeseriesResponseAttributes, optional) – The object describing a timeseries response.

• type (TimeseriesFormulaResponseType, optional) – The type of the resource. The value should always be timeseries_response.

timeseries_response_attributes

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.

timeseries_response_series

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

timeseries_response_series_list

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.

timeseries_response_times

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.

timeseries_response_values

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.

timeseries_response_values_list

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.

unit

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.

update_open_api_response

class UpdateOpenAPIResponse(*args, **kwargs)

Bases: ModelNormal

Response for UpdateOpenAPI.

Parameters:

data (UpdateOpenAPIResponseData, optional) – Data envelope for UpdateOpenAPIResponse.

update_open_api_response_attributes

class UpdateOpenAPIResponseAttributes(*args, **kwargs)

Bases: ModelNormal

Attributes for UpdateOpenAPI.

Parameters:

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

update_open_api_response_data

class UpdateOpenAPIResponseData(*args, **kwargs)

Bases: ModelNormal

Data envelope for UpdateOpenAPIResponse.

Parameters:

• attributes (UpdateOpenAPIResponseAttributes, optional) – Attributes for UpdateOpenAPI.

• id (UUID, optional) – API identifier.

usage_application_security_monitoring_response

class UsageApplicationSecurityMonitoringResponse(*args, **kwargs)

Bases: ModelNormal

Application Security Monitoring usage response.

Parameters:

data ([UsageDataObject], optional) – Response containing Application Security Monitoring usage.

usage_attributes_object

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.

usage_data_object

class UsageDataObject(*args, **kwargs)

Bases: ModelNormal

Usage data.

Parameters:

• attributes (UsageAttributesObject, optional) – Usage attributes data.

• id (str, optional) – Unique ID of the response.

• type (UsageTimeSeriesType, optional) – Type of usage data.

usage_lambda_traced_invocations_response

class UsageLambdaTracedInvocationsResponse(*args, **kwargs)

Bases: ModelNormal

Lambda Traced Invocations usage response.

Parameters:

data ([UsageDataObject], optional) – Response containing Lambda Traced Invocations usage.

usage_observability_pipelines_response

class UsageObservabilityPipelinesResponse(*args, **kwargs)

Bases: ModelNormal

Observability Pipelines usage response.

Parameters:

data ([UsageDataObject], optional) – Response containing Observability Pipelines usage.

usage_time_series_object

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.

usage_time_series_type

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.

user

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.

user_attributes

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.

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

user_create_attributes

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.

user_create_data

class UserCreateData(*args, **kwargs)

Bases: ModelNormal

Object to create a user.

Parameters:

• attributes (UserCreateAttributes) – Attributes of the created user.

• relationships (UserRelationships, optional) – Relationships of the user object.

• type (UsersType) – Users resource type.

user_create_request

class UserCreateRequest(*args, **kwargs)

Bases: ModelNormal

Create a user.

Parameters:

data (UserCreateData) – Object to create a user.

user_invitation_data

class UserInvitationData(*args, **kwargs)

Bases: ModelNormal

Object to create a user invitation.

Parameters:

• relationships (UserInvitationRelationships) – Relationships data for user invitation.

• type (UserInvitationsType) – User invitations type.

user_invitation_data_attributes

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.

user_invitation_relationships

class UserInvitationRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships data for user invitation.

Parameters:

user (RelationshipToUser) – Relationship to user.

user_invitation_response

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.

user_invitation_response_data

class UserInvitationResponseData(*args, **kwargs)

Bases: ModelNormal

Object of a user invitation returned by the API.

Parameters:

• attributes (UserInvitationDataAttributes, optional) – Attributes of a user invitation.

• id (str, optional) – ID of the user invitation.

• relationships (UserInvitationRelationships, optional) – Relationships data for user invitation.

• type (UserInvitationsType, optional) – User invitations type.

user_invitations_request

class UserInvitationsRequest(*args, **kwargs)

Bases: ModelNormal

Object to invite users to join the organization.

Parameters:

data ([UserInvitationData]) – List of user invitations.

user_invitations_response

class UserInvitationsResponse(*args, **kwargs)

Bases: ModelNormal

User invitations as returned by the API.

Parameters:

data ([UserInvitationResponseData], optional) – Array of user invitations.

user_invitations_type

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.

user_relationships

class UserRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the user object.

Parameters:

roles (RelationshipToRoles, optional) – Relationship to roles.

user_response

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.

user_response_included_item

class UserResponseIncludedItem(*args, **kwargs)

Bases: ModelComposed

An object related to a user.

Parameters:

• attributes (OrganizationAttributes, optional) – Attributes of the organization.

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

• type (OrganizationsType) – Organizations resource type.

• relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.

user_response_relationships

class UserResponseRelationships(*args, **kwargs)

Bases: ModelNormal

Relationships of the user object returned by the API.

Parameters:

• org (RelationshipToOrganization, optional) – Relationship to an organization.

• other_orgs (RelationshipToOrganizations, optional) – Relationship to organizations.

• other_users (RelationshipToUsers, optional) – Relationship to users.

• roles (RelationshipToRoles, optional) – Relationship to roles.

user_team

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

user_team_attributes

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

user_team_create

class UserTeamCreate(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

• attributes (UserTeamAttributes, optional) – Team membership attributes

• relationships (UserTeamRelationships, optional) – Relationship between membership and a user

• type (UserTeamType) – Team membership type

user_team_permission

class UserTeamPermission(*args, **kwargs)

Bases: ModelNormal

A user’s permissions for a given team

Parameters:

• attributes (UserTeamPermissionAttributes, optional) – User team permission attributes

• id (str) – The user team permission’s identifier

• type (UserTeamPermissionType) – User team permission type

user_team_permission_attributes

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.

user_team_permission_type

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.

user_team_relationships

class UserTeamRelationships(*args, **kwargs)

Bases: ModelNormal

Relationship between membership and a user

Parameters:

• team (RelationshipToUserTeamTeam, optional) – Relationship between team membership and team

• user (RelationshipToUserTeamUser, optional) – Relationship between team membership and user

user_team_request

class UserTeamRequest(*args, **kwargs)

Bases: ModelNormal

Team membership request

Parameters:

data (UserTeamCreate) – A user’s relationship with a team

user_team_response

class UserTeamResponse(*args, **kwargs)

Bases: ModelNormal

Team membership response

Parameters:

data (UserTeam, optional) – A user’s relationship with a team

user_team_role

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.

user_team_team_type

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.

user_team_type

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.

user_team_update

class UserTeamUpdate(*args, **kwargs)

Bases: ModelNormal

A user’s relationship with a team

Parameters:

• attributes (UserTeamAttributes, optional) – Team membership attributes

• type (UserTeamType) – Team membership type

user_team_update_request

class UserTeamUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Team membership request

Parameters:

data (UserTeamUpdate) – A user’s relationship with a team

user_team_user_type

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.

user_teams_response

class UserTeamsResponse(*args, **kwargs)

Bases: ModelNormal

Team memberships response

Parameters:

• data ([UserTeam], optional) – Team memberships response data

• links (TeamsResponseLinks, optional) – Teams response links.

• meta (TeamsResponseMeta, optional) – Teams response metadata.

user_update_attributes

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.

user_update_data

class UserUpdateData(*args, **kwargs)

Bases: ModelNormal

Object to update a user.

Parameters:

• attributes (UserUpdateAttributes) – Attributes of the edited user.

• id (str) – ID of the user.

• type (UsersType) – Users resource type.

user_update_request

class UserUpdateRequest(*args, **kwargs)

Bases: ModelNormal

Update a user.

Parameters:

data (UserUpdateData) – Object to update a user.

users_response

class UsersResponse(*args, **kwargs)

Bases: ModelNormal

Response containing information about multiple users.

Parameters:

• data ([User], optional) – Array of returned users.

• included ([UserResponseIncludedItem], optional) – Array of objects related to the users.

• meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

users_type

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.

widget_live_span

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.