datadog_api_client.v1.model

access_role

class AccessRole(*args, **kwargs)

Bases: ModelSimple

The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).

Parameters:
  • value (str) – Must be one of [“st”, “adm”, “ro”, “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.

add_signal_to_incident_request

class AddSignalToIncidentRequest(*args, **kwargs)

Bases: ModelNormal

Attributes describing which incident to add the signal to.

Parameters:
  • add_to_signal_timeline (bool, optional) – Whether to post the signal on the incident timeline.

  • incident_id (int) – Public ID attribute of the incident to which the signal will be added.

  • version (int, optional) – Version of the updated signal. If server side version is higher, update will be rejected.

agent_check

class AgentCheck(*args, **kwargs)

Bases: ModelSimple

Array of strings.

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.

alert_graph_widget_definition

class AlertGraphWidgetDefinition(*args, **kwargs)

Bases: ModelNormal

Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.

Parameters:
  • alert_id (str) – ID of the alert to use in the widget.

  • time (WidgetTime, optional) – Time setting for the widget.

  • title (str, optional) – The title of the widget.

  • title_align (WidgetTextAlign, optional) – How to align the text on the widget.

  • title_size (str, optional) – Size of the title.

  • type (AlertGraphWidgetDefinitionType) – Type of the alert graph widget.

  • viz_type (WidgetVizType) – Whether to display the Alert Graph as a timeseries or a top list.

alert_graph_widget_definition_type

class AlertGraphWidgetDefinitionType(*args, **kwargs)

Bases: ModelSimple

Type of the alert graph widget.

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

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

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

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

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

alert_value_widget_definition

class AlertValueWidgetDefinition(*args, **kwargs)

Bases: ModelNormal

Alert values are query values showing the current value of the metric in any monitor defined on your system.

Parameters:
  • alert_id (str) – ID of the alert to use in the widget.

  • precision (int, optional) – Number of decimal to show. If not defined, will use the raw value.

  • text_align (WidgetTextAlign, optional) – How to align the text on the widget.

  • title (str, optional) – Title of the widget.

  • title_align (WidgetTextAlign, optional) – How to align the text on the widget.

  • title_size (str, optional) – Size of value in the widget.

  • type (AlertValueWidgetDefinitionType) – Type of the alert value widget.

  • unit (str, optional) – Unit to display with the value.

alert_value_widget_definition_type

class AlertValueWidgetDefinitionType(*args, **kwargs)

Bases: ModelSimple

Type of the alert value widget.

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

api_error_response

class APIErrorResponse(*args, **kwargs)

Bases: ModelNormal

Error response object.

Parameters:

errors ([str]) – Array of errors returned by the API.

api_key

class ApiKey(*args, **kwargs)

Bases: ModelNormal

Datadog API key.

Parameters:
  • created (str, optional) – Date of creation of the API key.

  • created_by (str, optional) – Datadog user handle that created the API key.

  • key (str, optional) – API key.

  • name (str, optional) – Name of your API key.

api_key_list_response

class ApiKeyListResponse(*args, **kwargs)

Bases: ModelNormal

List of API and application keys available for a given organization.

Parameters:

api_keys ([ApiKey], optional) – Array of API keys.

api_key_response

class ApiKeyResponse(*args, **kwargs)

Bases: ModelNormal

An API key with its associated metadata.

Parameters:

api_key (ApiKey, optional) – Datadog API key.

apm_stats_query_column_type

class ApmStatsQueryColumnType(*args, **kwargs)

Bases: ModelNormal

Column properties.

Parameters:
  • alias (str, optional) – A user-assigned alias for the column.

  • cell_display_mode (TableWidgetCellDisplayMode, optional) – Define a display mode for the table cell.

  • name (str) – Column name.

  • order (WidgetSort, optional) – Widget sorting methods.

apm_stats_query_definition

class ApmStatsQueryDefinition(*args, **kwargs)

Bases: ModelNormal

The APM stats query for table and distributions widgets.

Parameters:
  • columns ([ApmStatsQueryColumnType], optional) – Column properties used by the front end for display.

  • env (str) – Environment name.

  • name (str) – Operation name associated with service.

  • primary_tag (str) – The organization’s host group name and value.

  • resource (str, optional) – Resource name.

  • row_type (ApmStatsQueryRowType) – The level of detail for the request.

  • service (str) – Service name.

apm_stats_query_row_type

class ApmStatsQueryRowType(*args, **kwargs)

Bases: ModelSimple

The level of detail for the request.

Parameters:
  • value (str) – Must be one of [“service”, “resource”, “span”].

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

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

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

  • _configuration (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

class ApplicationKey(*args, **kwargs)

Bases: ModelNormal

An application key with its associated metadata.

Parameters:
  • hash (str, optional) – Hash of an application key.

  • name (str, optional) – Name of an application key.

  • owner (str, optional) – Owner of an application key.

application_key_list_response

class ApplicationKeyListResponse(*args, **kwargs)

Bases: ModelNormal

An application key response.

Parameters:

application_keys ([ApplicationKey], optional) – Array of application keys.

application_key_response

class ApplicationKeyResponse(*args, **kwargs)

Bases: ModelNormal

An application key response.

Parameters:

application_key (ApplicationKey, optional) – An application key with its associated metadata.

authentication_validation_response

class AuthenticationValidationResponse(*args, **kwargs)

Bases: ModelNormal

Represent validation endpoint responses.

Parameters:

valid (bool, optional) – Return true if the authentication response is valid.

aws_account

class AWSAccount(*args, **kwargs)

Bases: ModelNormal

Returns the AWS account associated with this integration.

Parameters:
  • access_key_id (str, optional) – Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.

  • account_id (str, optional) – Your AWS Account ID without dashes.

  • account_specific_namespace_rules ({str: (bool,)}, optional) – An object, (in the form {"namespace1":true/false, "namespace2":true/false} ), that enables or disables metric collection for specific AWS namespaces for this AWS account only.

  • cspm_resource_collection_enabled (bool, optional) – Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general resource_collection.

  • excluded_regions ([str], optional) – An array of AWS regions to exclude from metrics collection.

  • filter_tags ([str], optional) – The array of EC2 tags (in the form key:value ) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding ! before the tag. For example, env:production,instance-type:c1.*,!region:us-east-1

  • host_tags ([str], optional) – Array of tags (in the form key:value ) to add to all hosts and metrics reporting through this integration.

  • metrics_collection_enabled (bool, optional) – Whether Datadog collects metrics for this AWS account.

  • resource_collection_enabled (bool, optional) – Whether Datadog collects a standard set of resources from your AWS account.

  • role_name (str, optional) – Your Datadog role delegation name.

  • secret_access_key (str, optional) – Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.

aws_account_and_lambda_request

class AWSAccountAndLambdaRequest(*args, **kwargs)

Bases: ModelNormal

AWS account ID and Lambda ARN.

Parameters:
  • account_id (str) – Your AWS Account ID without dashes.

  • lambda_arn (str) – ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.

aws_account_create_response

class AWSAccountCreateResponse(*args, **kwargs)

Bases: ModelNormal

The Response returned by the AWS Create Account call.

Parameters:

external_id (str, optional) – AWS external_id.

aws_account_delete_request

class AWSAccountDeleteRequest(*args, **kwargs)

Bases: ModelNormal

List of AWS accounts to delete.

Parameters:
  • access_key_id (str, optional) – Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.

  • account_id (str, optional) – Your AWS Account ID without dashes.

  • role_name (str, optional) – Your Datadog role delegation name.

aws_account_list_response

class AWSAccountListResponse(*args, **kwargs)

Bases: ModelNormal

List of enabled AWS accounts.

Parameters:

accounts ([AWSAccount], optional) – List of enabled AWS accounts.

aws_event_bridge_account_configuration

class AWSEventBridgeAccountConfiguration(*args, **kwargs)

Bases: ModelNormal

The EventBridge configuration for one AWS account.

Parameters:
  • account_id (str, optional) – Your AWS Account ID without dashes.

  • event_hubs ([AWSEventBridgeSource], optional) – Array of AWS event sources associated with this account.

  • tags ([str], optional) – Array of tags (in the form key:value ) which are added to all hosts and metrics reporting through the main AWS integration.

aws_event_bridge_create_request

class AWSEventBridgeCreateRequest(*args, **kwargs)

Bases: ModelNormal

An object used to create an EventBridge source.

Parameters:
  • account_id (str, optional) – Your AWS Account ID without dashes.

  • create_event_bus (bool, optional) – True if Datadog should create the event bus in addition to the event source. Requires the events:CreateEventBus permission.

  • event_generator_name (str, optional) – The given part of the event source name, which is then combined with an assigned suffix to form the full name.

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

aws_event_bridge_create_response

class AWSEventBridgeCreateResponse(*args, **kwargs)

Bases: ModelNormal

A created EventBridge source.

Parameters:
  • event_source_name (str, optional) – The event source name.

  • has_bus (bool, optional) – True if the event bus was created in addition to the source.

  • region (str, optional) –

    The event source’s AWS region.

  • status (AWSEventBridgeCreateStatus, optional) – The event source status “created”.

aws_event_bridge_create_status

class AWSEventBridgeCreateStatus(*args, **kwargs)

Bases: ModelSimple

The event source status “created”.

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

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

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

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

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

aws_event_bridge_delete_request

class AWSEventBridgeDeleteRequest(*args, **kwargs)

Bases: ModelNormal

An object used to delete an EventBridge source.

Parameters:
  • account_id (str, optional) – Your AWS Account ID without dashes.

  • event_generator_name (str, optional) – The event source name.

  • region (str, optional) –

    The event source’s AWS region.

aws_event_bridge_delete_response

class AWSEventBridgeDeleteResponse(*args, **kwargs)

Bases: ModelNormal

An indicator of the successful deletion of an EventBridge source.

Parameters:

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

aws_event_bridge_delete_status

class AWSEventBridgeDeleteStatus(*args, **kwargs)

Bases: ModelSimple

The event source status “empty”.

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

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

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

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

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

aws_event_bridge_list_response

class AWSEventBridgeListResponse(*args, **kwargs)

Bases: ModelNormal

An object describing the EventBridge configuration for multiple accounts.

Parameters:
  • accounts ([AWSEventBridgeAccountConfiguration], optional) – List of accounts with their event sources.

  • is_installed (bool, optional) – True if the EventBridge sub-integration is enabled for your organization.

aws_event_bridge_source

class AWSEventBridgeSource(*args, **kwargs)

Bases: ModelNormal

An EventBridge source.

Parameters:
  • name (str, optional) – The event source name.

  • region (str, optional) –

    The event source’s AWS region.

aws_logs_async_error

class AWSLogsAsyncError(*args, **kwargs)

Bases: ModelNormal

Description of errors.

Parameters:
  • code (str, optional) – Code properties

  • message (str, optional) – Message content.

aws_logs_async_response

class AWSLogsAsyncResponse(*args, **kwargs)

Bases: ModelNormal

A list of all Datadog-AWS logs integrations available in your Datadog organization.

Parameters:
  • errors ([AWSLogsAsyncError], optional) – List of errors.

  • status (str, optional) – Status of the properties.

aws_logs_lambda

class AWSLogsLambda(*args, **kwargs)

Bases: ModelNormal

Description of the Lambdas.

Parameters:

arn (str, optional) – Available ARN IDs.

aws_logs_list_response

class AWSLogsListResponse(*args, **kwargs)

Bases: ModelNormal

A list of all Datadog-AWS logs integrations available in your Datadog organization.

Parameters:
  • account_id (str, optional) – Your AWS Account ID without dashes.

  • lambdas ([AWSLogsLambda], optional) – List of ARNs configured in your Datadog account.

  • services ([str], optional) – Array of services IDs.

aws_logs_list_services_response

class AWSLogsListServicesResponse(*args, **kwargs)

Bases: ModelNormal

The list of current AWS services for which Datadog offers automatic log collection.

Parameters:
  • id (str, optional) – Key value in returned object.

  • label (str, optional) – Name of service available for configuration with Datadog logs.

aws_logs_services_request

class AWSLogsServicesRequest(*args, **kwargs)

Bases: ModelNormal

A list of current AWS services for which Datadog offers automatic log collection.

Parameters:
  • account_id (str) – Your AWS Account ID without dashes.

  • services ([str]) – Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint.

aws_namespace

class AWSNamespace(*args, **kwargs)

Bases: ModelSimple

The namespace associated with the tag filter entry.

Parameters:
  • value (str) – Must be one of [“elb”, “application_elb”, “sqs”, “rds”, “custom”, “network_elb”, “lambda”].

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

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

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

  • _configuration (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_tag_filter

class AWSTagFilter(*args, **kwargs)

Bases: ModelNormal

A tag filter.

Parameters:
  • namespace (AWSNamespace, optional) – The namespace associated with the tag filter entry.

  • tag_filter_str (str, optional) – The tag filter string.

aws_tag_filter_create_request

class AWSTagFilterCreateRequest(*args, **kwargs)

Bases: ModelNormal

The objects used to set an AWS tag filter.

Parameters:
  • account_id (str, optional) – Your AWS Account ID without dashes.

  • namespace (AWSNamespace, optional) – The namespace associated with the tag filter entry.

  • tag_filter_str (str, optional) – The tag filter string.

aws_tag_filter_delete_request

class AWSTagFilterDeleteRequest(*args, **kwargs)

Bases: ModelNormal

The objects used to delete an AWS tag filter entry.

Parameters:
  • account_id (str, optional) – The unique identifier of your AWS account.

  • namespace (AWSNamespace, optional) – The namespace associated with the tag filter entry.

aws_tag_filter_list_response

class AWSTagFilterListResponse(*args, **kwargs)

Bases: ModelNormal

An array of tag filter rules by namespace and tag filter string.

Parameters:

filters ([AWSTagFilter], optional) – An array of tag filters.

azure_account

class AzureAccount(*args, **kwargs)

Bases: ModelNormal

Datadog-Azure integrations configured for your organization.

Parameters:
  • app_service_plan_filters (str, optional) – Limit the Azure app service plans that are pulled into Datadog using tags. Only app service plans that match one of the defined tags are imported into Datadog.

  • automute (bool, optional) – Silence monitors for expected Azure VM shutdowns.

  • client_id (str, optional) – Your Azure web application ID.

  • client_secret (str, optional) – Your Azure web application secret key.

  • container_app_filters (str, optional) – Limit the Azure container apps that are pulled into Datadog using tags. Only container apps that match one of the defined tags are imported into Datadog.

  • cspm_enabled (bool, optional) – When enabled, Datadog’s Cloud Security Management product scans resource configurations monitored by this app registration. Note: This requires resource_collection_enabled to be set to true.

  • custom_metrics_enabled (bool, optional) – Enable custom metrics for your organization.

  • errors ([str], optional) – Errors in your configuration.

  • host_filters (str, optional) – Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog.

  • new_client_id (str, optional) – Your New Azure web application ID.

  • new_tenant_name (str, optional) – Your New Azure Active Directory ID.

  • resource_collection_enabled (bool, optional) – When enabled, Datadog collects metadata and configuration info from cloud resources (compute instances, databases, load balancers, etc.) monitored by this app registration.

  • tenant_name (str, optional) – Your Azure Active Directory ID.

azure_account_list_response

class AzureAccountListResponse(*args, **kwargs)

Bases: ModelSimple

Accounts configured for your organization.

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.

cancel_downtimes_by_scope_request

class CancelDowntimesByScopeRequest(*args, **kwargs)

Bases: ModelNormal

Cancel downtimes according to scope.

Parameters:

scope (str) – The scope(s) to which the downtime applies and must be in key:value format. For example, host:app2. Provide multiple scopes as a comma-separated list like env:dev,env:prod. The resulting downtime applies to sources that matches ALL provided scopes ( env:dev AND env:prod ).

canceled_downtimes_ids

class CanceledDowntimesIds(*args, **kwargs)

Bases: ModelNormal

Object containing array of IDs of canceled downtimes.

Parameters:

cancelled_ids ([int], optional) – ID of downtimes that were canceled.

change_widget_definition

class ChangeWidgetDefinition(*args, **kwargs)

Bases: ModelNormal

The Change graph shows you the change in a value over the time period chosen.

Parameters:

change_widget_definition_type

class ChangeWidgetDefinitionType(*args, **kwargs)

Bases: ModelSimple

Type of the change widget.

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

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

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

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

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

change_widget_request

class ChangeWidgetRequest(*args, **kwargs)

Bases: ModelNormal

Updated change widget.

Parameters:

check_can_delete_monitor_response

class CheckCanDeleteMonitorResponse(*args, **kwargs)

Bases: ModelNormal

Response of monitor IDs that can or can’t be safely deleted.

Parameters:
  • data (CheckCanDeleteMonitorResponseData) – Wrapper object with the list of monitor IDs.

  • errors ({str: ([str],)}, none_type, optional) – A mapping of Monitor ID to strings denoting where it’s used.

check_can_delete_monitor_response_data