Class: DatadogAPIClient::V2::CloudCostManagementAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/cloud_cost_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ CloudCostManagementAPI

Returns a new instance of CloudCostManagementAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_cost_awscur_config(body, opts = {}) ⇒ Object

Create Cloud Cost Management AWS CUR config.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 29

def create_cost_awscur_config(body, opts = {})
  data, _status_code, _headers = create_cost_awscur_config_with_http_info(body, opts)
  data
end

#create_cost_awscur_config_with_http_info(body, opts = {}) ⇒ Array<(AwsCurConfigResponse, Integer, Hash)>

Create Cloud Cost Management AWS CUR config.

Create a Cloud Cost Management account for an AWS CUR config.

Parameters:

Returns:

  • (Array<(AwsCurConfigResponse, Integer, Hash)>) —

    AwsCurConfigResponse data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 41

def create_cost_awscur_config_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_cost_awscur_config ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.create_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'AwsCurConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_cost_awscur_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_cost_azure_uc_configs(body, opts = {}) ⇒ Object

Create Cloud Cost Management Azure configs.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 96

def create_cost_azure_uc_configs(body, opts = {})
  data, _status_code, _headers = create_cost_azure_uc_configs_with_http_info(body, opts)
  data
end

#create_cost_azure_uc_configs_with_http_info(body, opts = {}) ⇒ Array<(AzureUCConfigPairsResponse, Integer, Hash)>

Create Cloud Cost Management Azure configs.

Create a Cloud Cost Management account for an Azure config.

Parameters:

Returns:

  • (Array<(AzureUCConfigPairsResponse, Integer, Hash)>) —

    AzureUCConfigPairsResponse data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 108

def create_cost_azure_uc_configs_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_cost_azure_uc_configs ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.create_cost_azure_uc_configs"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'AzureUCConfigPairsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_cost_azure_uc_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_cost_azure_uc_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_cost_gcp_usage_cost_config(body, opts = {}) ⇒ Object

Create Google Cloud Usage Cost config.

See Also:



163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 163

def create_cost_gcp_usage_cost_config(body, opts = {})
  data, _status_code, _headers = create_cost_gcp_usage_cost_config_with_http_info(body, opts)
  data
end

#create_cost_gcp_usage_cost_config_with_http_info(body, opts = {}) ⇒ Array<(GCPUsageCostConfigResponse, Integer, Hash)>

Create Google Cloud Usage Cost config.

Create a Cloud Cost Management account for an Google Cloud Usage Cost config.

Parameters:

Returns:

  • (Array<(GCPUsageCostConfigResponse, Integer, Hash)>) —

    GCPUsageCostConfigResponse data, response status code and response headers



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 175

def create_cost_gcp_usage_cost_config_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.create_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'GCPUsageCostConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_cost_gcp_usage_cost_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_custom_allocation_rule(body, opts = {}) ⇒ Object

Create custom allocation rule.

See Also:



230
231
232
233
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 230

def create_custom_allocation_rule(body, opts = {})
  data, _status_code, _headers = create_custom_allocation_rule_with_http_info(body, opts)
  data
end

#create_custom_allocation_rule_with_http_info(body, opts = {}) ⇒ Array<(ArbitraryRuleResponse, Integer, Hash)>

Create custom allocation rule.

Create a new custom allocation rule with the specified filters and allocation strategy.

Strategy Methods:

  • PROPORTIONAL/EVEN: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters.
  • PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys.
  • PERCENT: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations).

Filter Conditions:

  • Use value for single-value conditions: "is", "is not", "contains", "=", "!=", "like", "not like"
  • Use values for multi-value conditions: "in", "not in"
  • Cannot use both value and values simultaneously.

Supported operators: is, is not, contains, in, not in, =, !=, like, not like

Parameters:

Returns:

  • (Array<(ArbitraryRuleResponse, Integer, Hash)>) —

    ArbitraryRuleResponse data, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 254

def create_custom_allocation_rule_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_custom_allocation_rule ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.create_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ArbitraryRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_custom_allocation_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_tag_pipelines_ruleset(body, opts = {}) ⇒ Object

Create tag pipeline ruleset.

See Also:



309
310
311
312
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 309

def create_tag_pipelines_ruleset(body, opts = {})
  data, _status_code, _headers = create_tag_pipelines_ruleset_with_http_info(body, opts)
  data
end

#create_tag_pipelines_ruleset_with_http_info(body, opts = {}) ⇒ Array<(RulesetResp, Integer, Hash)>

Create tag pipeline ruleset.

Create a new tag pipeline ruleset with the specified rules and configuration

Parameters:

Returns:

  • (Array<(RulesetResp, Integer, Hash)>) —

    RulesetResp data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 321

def create_tag_pipelines_ruleset_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.create_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'RulesetResp'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_tag_pipelines_ruleset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_unit_cost(body, opts = {}) ⇒ Object

Create a unit cost.

See Also:



376
377
378
379
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 376

def create_unit_cost(body, opts = {})
  data, _status_code, _headers = create_unit_cost_with_http_info(body, opts)
  data
end

#create_unit_cost_with_http_info(body, opts = {}) ⇒ Array<(UnitCostResponse, Integer, Hash)>

Create a unit cost.

Create an ROI metric (unit cost) using the given numerator and denominator queries.

Parameters:

Returns:

  • (Array<(UnitCostResponse, Integer, Hash)>) —

    UnitCostResponse data, response status code and response headers



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 388

def create_unit_cost_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_unit_cost".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_unit_cost")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_unit_cost"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.create_unit_cost ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.create_unit_cost"
  end
  # resource path
  local_var_path = '/api/v2/cost/unit_costs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'UnitCostResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_unit_cost,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#create_unit_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_budget(budget_id, opts = {}) ⇒ Object

Delete budget.

See Also:



449
450
451
452
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 449

def delete_budget(budget_id, opts = {})
  delete_budget_with_http_info(budget_id, opts)
  nil
end

#delete_budget_with_http_info(budget_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete budget.

Delete a budget

Parameters:

  • budget_id (String) —

    Budget id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 461

def delete_budget_with_http_info(budget_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_budget ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.delete_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/{budget_id}'.sub('{budget_id}', CGI.escape(budget_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_budget,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_awscur_config(cloud_account_id, opts = {}) ⇒ Object

Delete Cloud Cost Management AWS CUR config.

See Also:



514
515
516
517
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 514

def delete_cost_awscur_config(, opts = {})
  delete_cost_awscur_config_with_http_info(, opts)
  nil
end

#delete_cost_awscur_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Cloud Cost Management AWS CUR config.

Archive a Cloud Cost Management Account.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 526

def delete_cost_awscur_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_awscur_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.delete_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_cost_awscur_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_azure_uc_config(cloud_account_id, opts = {}) ⇒ Object

Delete Cloud Cost Management Azure config.

See Also:



579
580
581
582
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 579

def delete_cost_azure_uc_config(, opts = {})
  delete_cost_azure_uc_config_with_http_info(, opts)
  nil
end

#delete_cost_azure_uc_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Cloud Cost Management Azure config.

Archive a Cloud Cost Management Account.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 591

def delete_cost_azure_uc_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_azure_uc_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.delete_cost_azure_uc_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_cost_azure_uc_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_azure_uc_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_gcp_usage_cost_config(cloud_account_id, opts = {}) ⇒ Object

Delete Google Cloud Usage Cost config.

See Also:



644
645
646
647
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 644

def delete_cost_gcp_usage_cost_config(, opts = {})
  delete_cost_gcp_usage_cost_config_with_http_info(, opts)
  nil
end

#delete_cost_gcp_usage_cost_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Google Cloud Usage Cost config.

Archive a Cloud Cost Management account.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 656

def delete_cost_gcp_usage_cost_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.delete_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_cost_gcp_usage_cost_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_cost_tag_description_by_key(tag_key, opts = {}) ⇒ Object

Delete a Cloud Cost Management tag description.

See Also:



709
710
711
712
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 709

def delete_cost_tag_description_by_key(tag_key, opts = {})
  delete_cost_tag_description_by_key_with_http_info(tag_key, opts)
  nil
end

#delete_cost_tag_description_by_key_with_http_info(tag_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Cloud Cost Management tag description.

Delete a Cloud Cost Management tag key description. When cloud is omitted, deletes every description for the tag key, falling back to Datadog's global default when available. When cloud is provided, deletes only the description scoped to that cloud provider.

Parameters:

  • tag_key (String) —

    The tag key whose description is being deleted.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cloud (String) —

    Cloud provider to scope the deletion to (for example, aws). Omit to delete every description for the tag key.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 722

def delete_cost_tag_description_by_key_with_http_info(tag_key, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_cost_tag_description_by_key ...'
  end
  # verify the required parameter 'tag_key' is set
  if @api_client.config.client_side_validation && tag_key.nil?
    fail ArgumentError, "Missing the required parameter 'tag_key' when calling CloudCostManagementAPI.delete_cost_tag_description_by_key"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_descriptions/{tag_key}'.sub('{tag_key}', CGI.escape(tag_key.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cloud'] = opts[:'cloud'] if !opts[:'cloud'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_cost_tag_description_by_key,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_cost_tag_description_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_allocation_rule(rule_id, opts = {}) ⇒ Object

Delete custom allocation rule.

See Also:



776
777
778
779
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 776

def delete_custom_allocation_rule(rule_id, opts = {})
  delete_custom_allocation_rule_with_http_info(rule_id, opts)
  nil
end

#delete_custom_allocation_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete custom allocation rule.

Delete a custom allocation rule - Delete an existing custom allocation rule by its ID

Parameters:

  • rule_id (Integer) —

    The unique identifier of the custom allocation rule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 788

def delete_custom_allocation_rule_with_http_info(rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_custom_allocation_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling CloudCostManagementAPI.delete_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_custom_allocation_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_costs_file(file_id, opts = {}) ⇒ Object

Delete Custom Costs file.

See Also:



841
842
843
844
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 841

def delete_custom_costs_file(file_id, opts = {})
  delete_custom_costs_file_with_http_info(file_id, opts)
  nil
end

#delete_custom_costs_file_with_http_info(file_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Custom Costs file.

Delete the specified Custom Costs file.

Parameters:

  • file_id (String) —

    File ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 853

def delete_custom_costs_file_with_http_info(file_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_custom_costs_file ...'
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling CloudCostManagementAPI.delete_custom_costs_file"
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs/{file_id}'.sub('{file_id}', CGI.escape(file_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_custom_costs_file,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_custom_costs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_custom_forecast(budget_id, opts = {}) ⇒ Object

Delete a budget's custom forecast.

See Also:



906
907
908
909
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 906

def delete_custom_forecast(budget_id, opts = {})
  delete_custom_forecast_with_http_info(budget_id, opts)
  nil
end

#delete_custom_forecast_with_http_info(budget_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a budget's custom forecast.

Delete the custom forecast for a budget.

Parameters:

  • budget_id (String) —

    Budget id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 918

def delete_custom_forecast_with_http_info(budget_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_custom_forecast ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.delete_custom_forecast"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/{budget_id}/custom-forecast'.sub('{budget_id}', CGI.escape(budget_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_custom_forecast,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_custom_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tag_pipelines_ruleset(ruleset_id, opts = {}) ⇒ Object

Delete tag pipeline ruleset.

See Also:



971
972
973
974
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 971

def delete_tag_pipelines_ruleset(ruleset_id, opts = {})
  delete_tag_pipelines_ruleset_with_http_info(ruleset_id, opts)
  nil
end

#delete_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete tag pipeline ruleset.

Delete a tag pipeline ruleset - Delete an existing tag pipeline ruleset by its ID

Parameters:

  • ruleset_id (String) —

    The unique identifier of the ruleset

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 983

def delete_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling CloudCostManagementAPI.delete_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/{ruleset_id}'.sub('{ruleset_id}', CGI.escape(ruleset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_tag_pipelines_ruleset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_unit_cost(unit_cost_id, opts = {}) ⇒ Object

Delete a unit cost.

See Also:



1036
1037
1038
1039
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1036

def delete_unit_cost(unit_cost_id, opts = {})
  delete_unit_cost_with_http_info(unit_cost_id, opts)
  nil
end

#delete_unit_cost_with_http_info(unit_cost_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a unit cost.

Delete an ROI metric (unit cost).

Parameters:

  • unit_cost_id (UUID) —

    The UUID of the unit cost.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1048

def delete_unit_cost_with_http_info(unit_cost_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_unit_cost".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_unit_cost")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_unit_cost"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.delete_unit_cost ...'
  end
  # verify the required parameter 'unit_cost_id' is set
  if @api_client.config.client_side_validation && unit_cost_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_cost_id' when calling CloudCostManagementAPI.delete_unit_cost"
  end
  # resource path
  local_var_path = '/api/v2/cost/unit_costs/{unit_cost_id}'.sub('{unit_cost_id}', CGI.escape(unit_cost_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_unit_cost,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#delete_unit_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_cost_tag_description_by_key(tag_key, opts = {}) ⇒ Object

Generate a Cloud Cost Management tag description.

See Also:



1107
1108
1109
1110
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1107

def generate_cost_tag_description_by_key(tag_key, opts = {})
  data, _status_code, _headers = generate_cost_tag_description_by_key_with_http_info(tag_key, opts)
  data
end

#generate_cost_tag_description_by_key_with_http_info(tag_key, opts = {}) ⇒ Array<(GenerateCostTagDescriptionResponse, Integer, Hash)>

Generate a Cloud Cost Management tag description.

Use AI to draft a Cloud Cost Management tag key description based on associated cost data. The generated description is returned in the response and is not persisted by this endpoint; follow up with UpsertCostTagDescriptionByKey to save it.

Parameters:

  • tag_key (String) —

    The tag key to generate an AI description for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1119

def generate_cost_tag_description_by_key_with_http_info(tag_key, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.generate_cost_tag_description_by_key ...'
  end
  # verify the required parameter 'tag_key' is set
  if @api_client.config.client_side_validation && tag_key.nil?
    fail ArgumentError, "Missing the required parameter 'tag_key' when calling CloudCostManagementAPI.generate_cost_tag_description_by_key"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_descriptions/{tag_key}/generate'.sub('{tag_key}', CGI.escape(tag_key.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GenerateCostTagDescriptionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :generate_cost_tag_description_by_key,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#generate_cost_tag_description_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_budget(budget_id, opts = {}) ⇒ Object

Get budget.

See Also:



1172
1173
1174
1175
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1172

def get_budget(budget_id, opts = {})
  data, _status_code, _headers = get_budget_with_http_info(budget_id, opts)
  data
end

#get_budget_with_http_info(budget_id, opts = {}) ⇒ Array<(BudgetWithEntries, Integer, Hash)>

Get budget.

Get a budget by ID. Pass actual=true or forecast=true to include cost data in the response. Use start and end (millisecond epochs, both required) to set the cost window. When forecast=true, each entry also includes ootb_forecast (the ML forecast before overrides) and custom_forecast (null if no override is set, a number if one is).

Parameters:

  • budget_id (String) —

    Budget id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :actual (Boolean) —

    When true, includes actual cost data in the response.

  • :forecast (Boolean) —

    When true, includes forecast cost data in the response, including ootb_forecast and custom_forecast per entry.

  • :start (Integer) —

    Start of the cost window in milliseconds since epoch. Must be used together with end.

  • :_end (Integer) —

    End of the cost window in milliseconds since epoch. Must be used together with start.

Returns:

  • (Array<(BudgetWithEntries, Integer, Hash)>) —

    BudgetWithEntries data, response status code and response headers



1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1188

def get_budget_with_http_info(budget_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_budget ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.get_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/{budget_id}'.sub('{budget_id}', CGI.escape(budget_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'actual'] = opts[:'actual'] if !opts[:'actual'].nil?
  query_params[:'forecast'] = opts[:'forecast'] if !opts[:'forecast'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetWithEntries'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_budget,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_commitment_list(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments list.

See Also:



1245
1246
1247
1248
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1245

def get_commitments_commitment_list(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_commitment_list_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_commitment_list_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsListResponse, Integer, Hash)>

Get commitments list.

Get a list of individual cloud commitments (Reserved Instances or Savings Plans) with their utilization details. The response schema varies based on the provider, product, and commitment type.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

  • :commitment_type (CommitmentsCommitmentType) —

    Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Returns:

  • (Array<(CommitmentsListResponse, Integer, Hash)>) —

    CommitmentsListResponse data, response status code and response headers



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1262

def get_commitments_commitment_list_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_commitment_list".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_commitment_list")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_commitment_list"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_commitment_list ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_commitment_list"
  end
  allowable_values = ['ri', 'sp']
  if @api_client.config.client_side_validation && opts[:'commitment_type'] && !allowable_values.include?(opts[:'commitment_type'])
    fail ArgumentError, "invalid value for \"commitment_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/commitment-list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'commitmentType'] = opts[:'commitment_type'] if !opts[:'commitment_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_commitment_list,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_commitment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_coverage_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments coverage (scalar).

See Also:



1348
1349
1350
1351
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1348

def get_commitments_coverage_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_coverage_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_coverage_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsCoverageScalarResponse, Integer, Hash)>

Get commitments coverage (scalar).

Get scalar coverage metrics for cloud commitment programs, including hours and cost coverage percentages.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1364

def get_commitments_coverage_scalar_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_coverage_scalar".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_coverage_scalar")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_coverage_scalar"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_coverage_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_coverage_scalar"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/coverage/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsCoverageScalarResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_coverage_scalar,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_coverage_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_coverage_timeseries(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments coverage (timeseries).

See Also:



1445
1446
1447
1448
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1445

def get_commitments_coverage_timeseries(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_coverage_timeseries_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_coverage_timeseries_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsCoverageTimeseriesResponse, Integer, Hash)>

Get commitments coverage (timeseries).

Get timeseries coverage metrics for cloud commitment programs, broken down by coverage type (Reserved Instances, Savings Plans, On-Demand, and Spot) for both hours and cost.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1461

def get_commitments_coverage_timeseries_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_coverage_timeseries".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_coverage_timeseries")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_coverage_timeseries"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_coverage_timeseries ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_coverage_timeseries"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/coverage/timeseries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsCoverageTimeseriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_coverage_timeseries,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_coverage_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_on_demand_hotspots_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments on-demand hot spots (scalar).

See Also:



1542
1543
1544
1545
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1542

def get_commitments_on_demand_hotspots_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_on_demand_hotspots_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_on_demand_hotspots_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsOnDemandHotspotsScalarResponse, Integer, Hash)>

Get commitments on-demand hot spots (scalar).

Get scalar on-demand hot-spots data for cloud commitment programs, showing per-dimension breakdowns of on-demand spending with coverage metrics and potential savings.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1558

def get_commitments_on_demand_hotspots_scalar_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_on_demand_hotspots_scalar".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_on_demand_hotspots_scalar")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_on_demand_hotspots_scalar"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_on_demand_hotspots_scalar"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/on-demand-hot-spots/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsOnDemandHotspotsScalarResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_on_demand_hotspots_scalar,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_on_demand_hotspots_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_savings_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments savings (scalar).

See Also:



1639
1640
1641
1642
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1639

def get_commitments_savings_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_savings_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_savings_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsSavingsScalarResponse, Integer, Hash)>

Get commitments savings (scalar).

Get scalar savings metrics for cloud commitment programs, including realized savings and effective savings rate.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1655

def get_commitments_savings_scalar_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_savings_scalar".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_savings_scalar")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_savings_scalar"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_savings_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_savings_scalar"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/savings/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsSavingsScalarResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_savings_scalar,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_savings_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_savings_timeseries(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments savings (timeseries).

See Also:



1736
1737
1738
1739
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1736

def get_commitments_savings_timeseries(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_savings_timeseries_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_savings_timeseries_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsSavingsTimeseriesResponse, Integer, Hash)>

Get commitments savings (timeseries).

Get timeseries savings metrics for cloud commitment programs, including actual cost, on-demand equivalent cost, realized savings, and effective savings rate over time.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

Returns:



1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1752

def get_commitments_savings_timeseries_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_savings_timeseries".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_savings_timeseries")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_savings_timeseries"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_savings_timeseries ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_savings_timeseries"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/savings/timeseries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsSavingsTimeseriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_savings_timeseries,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_savings_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_utilization_scalar(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments utilization (scalar).

See Also:



1833
1834
1835
1836
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1833

def get_commitments_utilization_scalar(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_utilization_scalar_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_utilization_scalar_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsUtilizationScalarResponse, Integer, Hash)>

Get commitments utilization (scalar).

Get scalar utilization metrics for cloud commitment programs, including utilization percentage and unused cost.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

  • :commitment_type (CommitmentsCommitmentType) —

    Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Returns:



1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1850

def get_commitments_utilization_scalar_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_utilization_scalar".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_utilization_scalar")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_utilization_scalar"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_utilization_scalar ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_utilization_scalar"
  end
  allowable_values = ['ri', 'sp']
  if @api_client.config.client_side_validation && opts[:'commitment_type'] && !allowable_values.include?(opts[:'commitment_type'])
    fail ArgumentError, "invalid value for \"commitment_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/utilization/scalar'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'commitmentType'] = opts[:'commitment_type'] if !opts[:'commitment_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsUtilizationScalarResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_utilization_scalar,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_utilization_scalar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_commitments_utilization_timeseries(provider, product, start, _end, opts = {}) ⇒ Object

Get commitments utilization (timeseries).

See Also:



1936
1937
1938
1939
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1936

def get_commitments_utilization_timeseries(provider, product, start, _end, opts = {})
  data, _status_code, _headers = get_commitments_utilization_timeseries_with_http_info(provider, product, start, _end, opts)
  data
end

#get_commitments_utilization_timeseries_with_http_info(provider, product, start, _end, opts = {}) ⇒ Array<(CommitmentsUtilizationTimeseriesResponse, Integer, Hash)>

Get commitments utilization (timeseries).

Get timeseries utilization metrics for cloud commitment programs, including used and unused cost series over time.

Parameters:

  • provider (CommitmentsProvider) —

    Cloud provider for commitment programs (aws or azure).

  • product (String) —

    Cloud product identifier (for example, ec2, rds, virtualmachines).

  • start (Integer) —

    Start of the query time range in Unix milliseconds.

  • _end (Integer) —

    End of the query time range in Unix milliseconds.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_by (String) —

    Optional filter expression to narrow down results.

  • :commitment_type (CommitmentsCommitmentType) —

    Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Returns:



1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 1953

def get_commitments_utilization_timeseries_with_http_info(provider, product, start, _end, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_commitments_utilization_timeseries".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_commitments_utilization_timeseries")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_commitments_utilization_timeseries"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_commitments_utilization_timeseries ...'
  end
  # verify the required parameter 'provider' is set
  if @api_client.config.client_side_validation && provider.nil?
    fail ArgumentError, "Missing the required parameter 'provider' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  # verify enum value
  allowable_values = ['aws', 'azure']
  if @api_client.config.client_side_validation && !allowable_values.include?(provider)
    fail ArgumentError, "invalid value for \"provider\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'product' is set
  if @api_client.config.client_side_validation && product.nil?
    fail ArgumentError, "Missing the required parameter 'product' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling CloudCostManagementAPI.get_commitments_utilization_timeseries"
  end
  allowable_values = ['ri', 'sp']
  if @api_client.config.client_side_validation && opts[:'commitment_type'] && !allowable_values.include?(opts[:'commitment_type'])
    fail ArgumentError, "invalid value for \"commitment_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/commitments/utilization/timeseries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'provider'] = provider
  query_params[:'product'] = product
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'commitmentType'] = opts[:'commitment_type'] if !opts[:'commitment_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CommitmentsUtilizationTimeseriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_commitments_utilization_timeseries,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_commitments_utilization_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_account_filters(cloud_account_id, opts = {}) ⇒ Object

Get account filters.

See Also:



2039
2040
2041
2042
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2039

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#get_cost_account_filters_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(AccountFiltersResponse, Integer, Hash)>

Get account filters.

Get the account filters for a cloud account (AWS CUR 1.0/2.0, OCI, and other clouds).

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountFiltersResponse, Integer, Hash)>) —

    AccountFiltersResponse data, response status code and response headers



2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2051

def (, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_account_filters ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_account_filters"
  end
  # resource path
  local_var_path = '/api/v2/cost/account_filters/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AccountFiltersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_account_filters,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_account_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_anomaly(anomaly_id, opts = {}) ⇒ Object

Get cost anomaly.

See Also:



2104
2105
2106
2107
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2104

def get_cost_anomaly(anomaly_id, opts = {})
  data, _status_code, _headers = get_cost_anomaly_with_http_info(anomaly_id, opts)
  data
end

#get_cost_anomaly_with_http_info(anomaly_id, opts = {}) ⇒ Array<(CostAnomalyResponse, Integer, Hash)>

Get cost anomaly.

Get a detected Cloud Cost Management anomaly by UUID.

Parameters:

  • anomaly_id (String) —

    The UUID of the cost anomaly.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CostAnomalyResponse, Integer, Hash)>) —

    CostAnomalyResponse data, response status code and response headers



2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2116

def get_cost_anomaly_with_http_info(anomaly_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_cost_anomaly".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_cost_anomaly")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_cost_anomaly"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_anomaly ...'
  end
  # verify the required parameter 'anomaly_id' is set
  if @api_client.config.client_side_validation && anomaly_id.nil?
    fail ArgumentError, "Missing the required parameter 'anomaly_id' when calling CloudCostManagementAPI.get_cost_anomaly"
  end
  # resource path
  local_var_path = '/api/v2/cost/anomalies/{anomaly_id}'.sub('{anomaly_id}', CGI.escape(anomaly_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostAnomalyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_anomaly,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_anomaly\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_awscur_config(cloud_account_id, opts = {}) ⇒ Object

Get cost AWS CUR config.

See Also:



2175
2176
2177
2178
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2175

def get_cost_awscur_config(, opts = {})
  data, _status_code, _headers = get_cost_awscur_config_with_http_info(, opts)
  data
end

#get_cost_awscur_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(AwsCurConfigResponse, Integer, Hash)>

Get cost AWS CUR config.

Get a specific AWS CUR config.

Parameters:

  • cloud_account_id (Integer) —

    The unique identifier of the cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AwsCurConfigResponse, Integer, Hash)>) —

    AwsCurConfigResponse data, response status code and response headers



2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2187

def get_cost_awscur_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_awscur_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AwsCurConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_awscur_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_azure_uc_config(cloud_account_id, opts = {}) ⇒ Object

Get cost Azure UC config.

See Also:



2240
2241
2242
2243
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2240

def get_cost_azure_uc_config(, opts = {})
  data, _status_code, _headers = get_cost_azure_uc_config_with_http_info(, opts)
  data
end

#get_cost_azure_uc_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(UCConfigPair, Integer, Hash)>

Get cost Azure UC config.

Get a specific Azure config.

Parameters:

  • cloud_account_id (Integer) —

    The unique identifier of the cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UCConfigPair, Integer, Hash)>) —

    UCConfigPair data, response status code and response headers



2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2252

def get_cost_azure_uc_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_azure_uc_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_azure_uc_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UCConfigPair'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_azure_uc_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_azure_uc_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_gcp_usage_cost_config(cloud_account_id, opts = {}) ⇒ Object

Get Google Cloud Usage Cost config.

See Also:



2305
2306
2307
2308
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2305

def get_cost_gcp_usage_cost_config(, opts = {})
  data, _status_code, _headers = get_cost_gcp_usage_cost_config_with_http_info(, opts)
  data
end

#get_cost_gcp_usage_cost_config_with_http_info(cloud_account_id, opts = {}) ⇒ Array<(GcpUcConfigResponse, Integer, Hash)>

Get Google Cloud Usage Cost config.

Get a specific Google Cloud Usage Cost config.

Parameters:

  • cloud_account_id (Integer) —

    The unique identifier of the cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GcpUcConfigResponse, Integer, Hash)>) —

    GcpUcConfigResponse data, response status code and response headers



2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2317

def get_cost_gcp_usage_cost_config_with_http_info(, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.get_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GcpUcConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_gcp_usage_cost_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_tag_description_by_key(tag_key, opts = {}) ⇒ Object

Get a Cloud Cost Management tag description.

See Also:



2370
2371
2372
2373
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2370

def get_cost_tag_description_by_key(tag_key, opts = {})
  data, _status_code, _headers = get_cost_tag_description_by_key_with_http_info(tag_key, opts)
  data
end

#get_cost_tag_description_by_key_with_http_info(tag_key, opts = {}) ⇒ Array<(CostTagDescriptionResponse, Integer, Hash)>

Get a Cloud Cost Management tag description.

Get the Cloud Cost Management description for a single tag key. Use filter[cloud] to scope the lookup to a specific cloud provider; when omitted, the response resolves the description in fallback order (cloud-specific organization override, then cloudless organization default, then Datadog's global default).

Parameters:

  • tag_key (String) —

    The tag key whose description is being fetched.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_cloud (String) —

    Cloud provider to scope the lookup to (for example, aws). Omit to use the resolved fallback.

Returns:

  • (Array<(CostTagDescriptionResponse, Integer, Hash)>) —

    CostTagDescriptionResponse data, response status code and response headers



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2383

def get_cost_tag_description_by_key_with_http_info(tag_key, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_tag_description_by_key ...'
  end
  # verify the required parameter 'tag_key' is set
  if @api_client.config.client_side_validation && tag_key.nil?
    fail ArgumentError, "Missing the required parameter 'tag_key' when calling CloudCostManagementAPI.get_cost_tag_description_by_key"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_descriptions/{tag_key}'.sub('{tag_key}', CGI.escape(tag_key.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[cloud]'] = opts[:'filter_cloud'] if !opts[:'filter_cloud'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagDescriptionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_tag_description_by_key,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_tag_description_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_tag_key(tag_key, opts = {}) ⇒ Object

Get a Cloud Cost Management tag key.

See Also:



2437
2438
2439
2440
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2437

def get_cost_tag_key(tag_key, opts = {})
  data, _status_code, _headers = get_cost_tag_key_with_http_info(tag_key, opts)
  data
end

#get_cost_tag_key_with_http_info(tag_key, opts = {}) ⇒ Array<(CostTagKeyResponse, Integer, Hash)>

Get a Cloud Cost Management tag key.

Get details for a specific Cloud Cost Management tag key, including example tag values and description.

Parameters:

  • tag_key (String) —

    The Cloud Cost Management tag key. Tag keys can contain forward slashes (for example, kubernetes/instance).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_metric (String) —

    The Cloud Cost Management metric to scope the tag key details to. When omitted, returns details across all metrics.

  • :page_size (Integer) —

    Controls the size of the internal tag value search scope. This does not restrict the number of example tag values returned in the response. Defaults to 50, maximum 10000.

Returns:

  • (Array<(CostTagKeyResponse, Integer, Hash)>) —

    CostTagKeyResponse data, response status code and response headers



2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2451

def get_cost_tag_key_with_http_info(tag_key, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_tag_key ...'
  end
  # verify the required parameter 'tag_key' is set
  if @api_client.config.client_side_validation && tag_key.nil?
    fail ArgumentError, "Missing the required parameter 'tag_key' when calling CloudCostManagementAPI.get_cost_tag_key"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CloudCostManagementAPI.get_cost_tag_key, must be smaller than or equal to 10000.'
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_keys/{tag_key}'.sub('{tag_key}', CGI.escape(tag_key.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagKeyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_tag_key,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_tag_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_cost_tag_metadata_currency(filter_month, opts = {}) ⇒ Object

Get the Cloud Cost Management billing currency.

See Also:



2509
2510
2511
2512
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2509

def get_cost_tag_metadata_currency(filter_month, opts = {})
  data, _status_code, _headers = get_cost_tag_metadata_currency_with_http_info(filter_month, opts)
  data
end

#get_cost_tag_metadata_currency_with_http_info(filter_month, opts = {}) ⇒ Array<(CostCurrencyResponse, Integer, Hash)>

Get the Cloud Cost Management billing currency.

Get the dominant billing currency observed in Cloud Cost Management data for the requested period. The response wraps the currency in a JSON:API data array containing at most one entry; the array is empty when no currency data is available.

Parameters:

  • filter_month (String) —

    The month to scope the query to, in YYYY-MM format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_provider (String) —

    Filter results to a specific provider. Common cloud values are aws, azure, gcp, Oracle (OCI), and custom. SaaS billing integrations (for example, Snowflake, MongoDB, Databricks) are also accepted using their display-name string. Values are case-sensitive.

Returns:

  • (Array<(CostCurrencyResponse, Integer, Hash)>) —

    CostCurrencyResponse data, response status code and response headers



2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2522

def get_cost_tag_metadata_currency_with_http_info(filter_month, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_cost_tag_metadata_currency".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_cost_tag_metadata_currency")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_cost_tag_metadata_currency"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_cost_tag_metadata_currency ...'
  end
  # verify the required parameter 'filter_month' is set
  if @api_client.config.client_side_validation && filter_month.nil?
    fail ArgumentError, "Missing the required parameter 'filter_month' when calling CloudCostManagementAPI.get_cost_tag_metadata_currency"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_metadata/currency'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[month]'] = filter_month
  query_params[:'filter[provider]'] = opts[:'filter_provider'] if !opts[:'filter_provider'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostCurrencyResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_cost_tag_metadata_currency,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_cost_tag_metadata_currency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_allocation_rule(rule_id, opts = {}) ⇒ Object

Get custom allocation rule.

See Also:



2583
2584
2585
2586
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2583

def get_custom_allocation_rule(rule_id, opts = {})
  data, _status_code, _headers = get_custom_allocation_rule_with_http_info(rule_id, opts)
  data
end

#get_custom_allocation_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(ArbitraryRuleResponse, Integer, Hash)>

Get custom allocation rule.

Get a specific custom allocation rule - Retrieve a specific custom allocation rule by its ID

Parameters:

  • rule_id (Integer) —

    The unique identifier of the custom allocation rule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ArbitraryRuleResponse, Integer, Hash)>) —

    ArbitraryRuleResponse data, response status code and response headers



2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2595

def get_custom_allocation_rule_with_http_info(rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_custom_allocation_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling CloudCostManagementAPI.get_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ArbitraryRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_custom_allocation_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_costs_file(file_id, opts = {}) ⇒ Object

Get Custom Costs file.

See Also:



2648
2649
2650
2651
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2648

def get_custom_costs_file(file_id, opts = {})
  data, _status_code, _headers = get_custom_costs_file_with_http_info(file_id, opts)
  data
end

#get_custom_costs_file_with_http_info(file_id, opts = {}) ⇒ Array<(CustomCostsFileGetResponse, Integer, Hash)>

Get Custom Costs file.

Fetch the specified Custom Costs file.

Parameters:

  • file_id (String) —

    File ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomCostsFileGetResponse, Integer, Hash)>) —

    CustomCostsFileGetResponse data, response status code and response headers



2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2660

def get_custom_costs_file_with_http_info(file_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_custom_costs_file ...'
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling CloudCostManagementAPI.get_custom_costs_file"
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs/{file_id}'.sub('{file_id}', CGI.escape(file_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomCostsFileGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_custom_costs_file,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_custom_costs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_forecast(budget_id, opts = {}) ⇒ Object

Get a budget's custom forecast.

See Also:



2713
2714
2715
2716
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2713

def get_custom_forecast(budget_id, opts = {})
  data, _status_code, _headers = get_custom_forecast_with_http_info(budget_id, opts)
  data
end

#get_custom_forecast_with_http_info(budget_id, opts = {}) ⇒ Array<(CustomForecastResponse, Integer, Hash)>

Get a budget's custom forecast.

Get the custom forecast for a budget.

Parameters:

  • budget_id (String) —

    Budget id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomForecastResponse, Integer, Hash)>) —

    CustomForecastResponse data, response status code and response headers



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2725

def get_custom_forecast_with_http_info(budget_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_custom_forecast ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling CloudCostManagementAPI.get_custom_forecast"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/{budget_id}/custom-forecast'.sub('{budget_id}', CGI.escape(budget_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomForecastResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_custom_forecast,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_custom_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_pipelines_ruleset(ruleset_id, opts = {}) ⇒ Object

Get a tag pipeline ruleset.

See Also:



2778
2779
2780
2781
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2778

def get_tag_pipelines_ruleset(ruleset_id, opts = {})
  data, _status_code, _headers = get_tag_pipelines_ruleset_with_http_info(ruleset_id, opts)
  data
end

#get_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {}) ⇒ Array<(RulesetResp, Integer, Hash)>

Get a tag pipeline ruleset.

Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline ruleset by its ID

Parameters:

  • ruleset_id (String) —

    The unique identifier of the ruleset

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RulesetResp, Integer, Hash)>) —

    RulesetResp data, response status code and response headers



2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2790

def get_tag_pipelines_ruleset_with_http_info(ruleset_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling CloudCostManagementAPI.get_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/{ruleset_id}'.sub('{ruleset_id}', CGI.escape(ruleset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RulesetResp'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_tag_pipelines_ruleset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_unit_cost(unit_cost_id, opts = {}) ⇒ Object

Get a unit cost.

See Also:



2843
2844
2845
2846
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2843

def get_unit_cost(unit_cost_id, opts = {})
  data, _status_code, _headers = get_unit_cost_with_http_info(unit_cost_id, opts)
  data
end

#get_unit_cost_with_http_info(unit_cost_id, opts = {}) ⇒ Array<(UnitCostResponse, Integer, Hash)>

Get a unit cost.

Retrieve an ROI metric (unit cost) by UUID.

Parameters:

  • unit_cost_id (UUID) —

    The UUID of the unit cost.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UnitCostResponse, Integer, Hash)>) —

    UnitCostResponse data, response status code and response headers



2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2855

def get_unit_cost_with_http_info(unit_cost_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_unit_cost".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_unit_cost")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_unit_cost"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.get_unit_cost ...'
  end
  # verify the required parameter 'unit_cost_id' is set
  if @api_client.config.client_side_validation && unit_cost_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_cost_id' when calling CloudCostManagementAPI.get_unit_cost"
  end
  # resource path
  local_var_path = '/api/v2/cost/unit_costs/{unit_cost_id}'.sub('{unit_cost_id}', CGI.escape(unit_cost_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnitCostResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_unit_cost,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#get_unit_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_budgets(opts = {}) ⇒ Object

List budgets.

See Also:



2914
2915
2916
2917
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2914

def list_budgets(opts = {})
  data, _status_code, _headers = list_budgets_with_http_info(opts)
  data
end

#list_budgets_with_http_info(opts = {}) ⇒ Array<(BudgetArray, Integer, Hash)>

List budgets.

List budgets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BudgetArray, Integer, Hash)>) —

    BudgetArray data, response status code and response headers



2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2925

def list_budgets_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_budgets ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/budgets'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_budgets,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_anomalies(opts = {}) ⇒ Object

List cost anomalies.

See Also:



2974
2975
2976
2977
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2974

def list_cost_anomalies(opts = {})
  data, _status_code, _headers = list_cost_anomalies_with_http_info(opts)
  data
end

#list_cost_anomalies_with_http_info(opts = {}) ⇒ Array<(CostAnomaliesResponse, Integer, Hash)>

List cost anomalies.

List detected Cloud Cost Management anomalies for the organization.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start (Integer) —

    Start time as Unix milliseconds. Defaults to the start of the latest stable seven-day window.

  • :_end (Integer) —

    End time as Unix milliseconds. Defaults to the end of the latest stable seven-day window.

  • :filter (String) —

    Optional JSON object mapping cost tag keys to allowed values, for example {"team":["payments"],"env":["prod"]}. Filters match anomaly dimensions or correlated tags.

  • :min_anomalous_threshold (String) —

    Minimum absolute anomalous cost change to include. Numeric value; defaults to 1.

  • :min_cost_threshold (String) —

    Minimum absolute actual cost to include. Numeric value; defaults to 0.

  • :dismissal_cause (String) —

    Filter by resolution state. Use none for unresolved anomalies, all or * for resolved anomalies, or a comma-separated list of causes.

  • :order_by (String) —

    Sort field. One of start_date, end_date, duration, max_cost, anomalous_cost, or dismissal_date. Defaults to anomalous_cost.

  • :order (String) —

    Sort direction. One of asc or desc. Defaults to desc.

  • :limit (Integer) —

    Maximum number of anomalies to return. Defaults to 200.

  • :offset (Integer) —

    Pagination offset. Defaults to 0.

  • :provider_ids (Array<String>) —

    Optional repeated cloud or SaaS provider filters, such as aws, gcp, azure, Oracle, datadog, OpenAI, or Anthropic.

Returns:

  • (Array<(CostAnomaliesResponse, Integer, Hash)>) —

    CostAnomaliesResponse data, response status code and response headers



2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 2996

def list_cost_anomalies_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_cost_anomalies".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_cost_anomalies")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_cost_anomalies"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_anomalies ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/anomalies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'min_anomalous_threshold'] = opts[:'min_anomalous_threshold'] if !opts[:'min_anomalous_threshold'].nil?
  query_params[:'min_cost_threshold'] = opts[:'min_cost_threshold'] if !opts[:'min_cost_threshold'].nil?
  query_params[:'dismissal_cause'] = opts[:'dismissal_cause'] if !opts[:'dismissal_cause'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'provider_ids'] = @api_client.build_collection_param(opts[:'provider_ids'], :multi) if !opts[:'provider_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostAnomaliesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_anomalies,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_anomalies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_awscur_configs(opts = {}) ⇒ Object

List Cloud Cost Management AWS CUR configs.

See Also:



3063
3064
3065
3066
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3063

def list_cost_awscur_configs(opts = {})
  data, _status_code, _headers = list_cost_awscur_configs_with_http_info(opts)
  data
end

#list_cost_awscur_configs_with_http_info(opts = {}) ⇒ Array<(AwsCURConfigsResponse, Integer, Hash)>

List Cloud Cost Management AWS CUR configs.

List the AWS CUR configs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AwsCURConfigsResponse, Integer, Hash)>) —

    AwsCURConfigsResponse data, response status code and response headers



3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3074

def list_cost_awscur_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_awscur_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AwsCURConfigsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_awscur_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_awscur_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_azure_uc_configs(opts = {}) ⇒ Object

List Cloud Cost Management Azure configs.

See Also:



3123
3124
3125
3126
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3123

def list_cost_azure_uc_configs(opts = {})
  data, _status_code, _headers = list_cost_azure_uc_configs_with_http_info(opts)
  data
end

#list_cost_azure_uc_configs_with_http_info(opts = {}) ⇒ Array<(AzureUCConfigsResponse, Integer, Hash)>

List Cloud Cost Management Azure configs.

List the Azure configs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AzureUCConfigsResponse, Integer, Hash)>) —

    AzureUCConfigsResponse data, response status code and response headers



3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3134

def list_cost_azure_uc_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_azure_uc_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AzureUCConfigsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_azure_uc_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_azure_uc_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_gcp_usage_cost_configs(opts = {}) ⇒ Object

List Google Cloud Usage Cost configs.

See Also:



3183
3184
3185
3186
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3183

def list_cost_gcp_usage_cost_configs(opts = {})
  data, _status_code, _headers = list_cost_gcp_usage_cost_configs_with_http_info(opts)
  data
end

#list_cost_gcp_usage_cost_configs_with_http_info(opts = {}) ⇒ Array<(GCPUsageCostConfigsResponse, Integer, Hash)>

List Google Cloud Usage Cost configs.

List the Google Cloud Usage Cost configs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GCPUsageCostConfigsResponse, Integer, Hash)>) —

    GCPUsageCostConfigsResponse data, response status code and response headers



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3194

def list_cost_gcp_usage_cost_configs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_gcp_usage_cost_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GCPUsageCostConfigsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_gcp_usage_cost_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_gcp_usage_cost_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_oci_configs(opts = {}) ⇒ Object

List Cloud Cost Management OCI configs.

See Also:



3243
3244
3245
3246
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3243

def list_cost_oci_configs(opts = {})
  data, _status_code, _headers = list_cost_oci_configs_with_http_info(opts)
  data
end

#list_cost_oci_configs_with_http_info(opts = {}) ⇒ Array<(OCIConfigsResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

List Cloud Cost Management OCI configs.

Note: This endpoint is deprecated. View OCI accounts in Cloud Cost Settings in the Datadog web application instead.

List the OCI configs.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OCIConfigsResponse, Integer, Hash)>) —

    OCIConfigsResponse data, response status code and response headers



3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3258

def list_cost_oci_configs_with_http_info(opts = {})
  warn "[DEPRECATION] `ListCostOCIConfigs` is deprecated."

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_oci_configs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/oci_config'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OCIConfigsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_oci_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_oci_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_descriptions(opts = {}) ⇒ Object

List Cloud Cost Management tag descriptions.

See Also:



3308
3309
3310
3311
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3308

def list_cost_tag_descriptions(opts = {})
  data, _status_code, _headers = list_cost_tag_descriptions_with_http_info(opts)
  data
end

#list_cost_tag_descriptions_with_http_info(opts = {}) ⇒ Array<(CostTagDescriptionsResponse, Integer, Hash)>

List Cloud Cost Management tag descriptions.

List Cloud Cost Management tag key descriptions for the organization. Use filter[cloud] to scope the result to a single cloud provider; when omitted, both cross-cloud defaults and cloud-specific descriptions are returned.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_cloud (String) —

    Filter descriptions to a specific cloud provider (for example, aws). Omit to return descriptions across all clouds.

Returns:

  • (Array<(CostTagDescriptionsResponse, Integer, Hash)>) —

    CostTagDescriptionsResponse data, response status code and response headers



3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3320

def list_cost_tag_descriptions_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_descriptions ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_descriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[cloud]'] = opts[:'filter_cloud'] if !opts[:'filter_cloud'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagDescriptionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_descriptions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_descriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_key_sources(filter_month, opts = {}) ⇒ Object

List Cloud Cost Management tag sources.

See Also:



3435
3436
3437
3438
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3435

def list_cost_tag_key_sources(filter_month, opts = {})
  data, _status_code, _headers = list_cost_tag_key_sources_with_http_info(filter_month, opts)
  data
end

#list_cost_tag_key_sources_with_http_info(filter_month, opts = {}) ⇒ Array<(CostTagKeySourcesResponse, Integer, Hash)>

List Cloud Cost Management tag sources.

List Cloud Cost Management tag keys observed for the requested period, along with the origin sources that produced them (for example, aws-user-defined, custom).

Parameters:

  • filter_month (String) —

    The month to scope the query to, in YYYY-MM format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_provider (String) —

    Filter results to a specific provider. Common cloud values are aws, azure, gcp, Oracle (OCI), and custom. SaaS billing integrations (for example, Snowflake, MongoDB, Databricks) are also accepted using their display-name string. Values are case-sensitive.

  • :filter_metric (String) —

    Filter results to tag keys that have data for a specific Cloud Cost Management metric (for example, aws.cost.net.amortized). When omitted, all tag keys for the requested period are returned.

Returns:

  • (Array<(CostTagKeySourcesResponse, Integer, Hash)>) —

    CostTagKeySourcesResponse data, response status code and response headers



3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3449

def list_cost_tag_key_sources_with_http_info(filter_month, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_cost_tag_key_sources".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_cost_tag_key_sources")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_cost_tag_key_sources"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_key_sources ...'
  end
  # verify the required parameter 'filter_month' is set
  if @api_client.config.client_side_validation && filter_month.nil?
    fail ArgumentError, "Missing the required parameter 'filter_month' when calling CloudCostManagementAPI.list_cost_tag_key_sources"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_metadata/tag_sources'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[month]'] = filter_month
  query_params[:'filter[provider]'] = opts[:'filter_provider'] if !opts[:'filter_provider'].nil?
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagKeySourcesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_key_sources,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_key_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_keys(opts = {}) ⇒ Object

List Cloud Cost Management tag keys.

See Also:



3370
3371
3372
3373
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3370

def list_cost_tag_keys(opts = {})
  data, _status_code, _headers = list_cost_tag_keys_with_http_info(opts)
  data
end

#list_cost_tag_keys_with_http_info(opts = {}) ⇒ Array<(CostTagKeysResponse, Integer, Hash)>

List Cloud Cost Management tag keys.

List Cloud Cost Management tag keys.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_metric (String) —

    The Cloud Cost Management metric to scope the tag keys to. When omitted, returns tag keys across all metrics.

  • :filter_tags (Array<String>) —

    Filter to return only tag keys that appear with the given key:value tag values. For example, filter[tags]=providername:aws returns tag keys found on the same cost data, such as is_aws_ec2_compute and aws_instance_type.

Returns:

  • (Array<(CostTagKeysResponse, Integer, Hash)>) —

    CostTagKeysResponse data, response status code and response headers



3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3383

def list_cost_tag_keys_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_keys ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_keys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'filter[tags]'] = @api_client.build_collection_param(opts[:'filter_tags'], :multi) if !opts[:'filter_tags'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagKeysResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_keys,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_metadata(filter_month, opts = {}) ⇒ Object

List Cloud Cost Management tag key metadata.

See Also:



3511
3512
3513
3514
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3511

def list_cost_tag_metadata(filter_month, opts = {})
  data, _status_code, _headers = list_cost_tag_metadata_with_http_info(filter_month, opts)
  data
end

#list_cost_tag_metadata_metrics(filter_month, opts = {}) ⇒ Object

List available Cloud Cost Management metrics.

See Also:



3595
3596
3597
3598
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3595

def list_cost_tag_metadata_metrics(filter_month, opts = {})
  data, _status_code, _headers = list_cost_tag_metadata_metrics_with_http_info(filter_month, opts)
  data
end

#list_cost_tag_metadata_metrics_with_http_info(filter_month, opts = {}) ⇒ Array<(CostMetricsResponse, Integer, Hash)>

List available Cloud Cost Management metrics.

List Cloud Cost Management metrics that have data for the requested period.

Parameters:

  • filter_month (String) —

    The month to scope the query to, in YYYY-MM format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_provider (String) —

    Filter results to a specific provider. Common cloud values are aws, azure, gcp, Oracle (OCI), and custom. SaaS billing integrations (for example, Snowflake, MongoDB, Databricks) are also accepted using their display-name string. Values are case-sensitive.

Returns:

  • (Array<(CostMetricsResponse, Integer, Hash)>) —

    CostMetricsResponse data, response status code and response headers



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3608

def list_cost_tag_metadata_metrics_with_http_info(filter_month, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_cost_tag_metadata_metrics".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_cost_tag_metadata_metrics")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_cost_tag_metadata_metrics"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_metadata_metrics ...'
  end
  # verify the required parameter 'filter_month' is set
  if @api_client.config.client_side_validation && filter_month.nil?
    fail ArgumentError, "Missing the required parameter 'filter_month' when calling CloudCostManagementAPI.list_cost_tag_metadata_metrics"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_metadata/metrics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[month]'] = filter_month
  query_params[:'filter[provider]'] = opts[:'filter_provider'] if !opts[:'filter_provider'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostMetricsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_metadata_metrics,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_metadata_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_metadata_months(filter_provider, opts = {}) ⇒ Object

List Cloud Cost Management tag metadata months.

See Also:



3669
3670
3671
3672
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3669

def list_cost_tag_metadata_months(filter_provider, opts = {})
  data, _status_code, _headers = list_cost_tag_metadata_months_with_http_info(filter_provider, opts)
  data
end

#list_cost_tag_metadata_months_with_http_info(filter_provider, opts = {}) ⇒ Array<(CostTagMetadataMonthsResponse, Integer, Hash)>

List Cloud Cost Management tag metadata months.

List months that have Cloud Cost Management tag metadata for a given provider, ordered most-recent first. The response is capped at 36 months.

Parameters:

  • filter_provider (String) —

    Provider to scope the query to. Use the value of the providername tag in CCM (for example, aws, azure, gcp, Oracle, Confluent Cloud, Snowflake). For costs uploaded through the Custom Costs API, use custom. Values are case-sensitive.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3682

def list_cost_tag_metadata_months_with_http_info(filter_provider, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_cost_tag_metadata_months".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_cost_tag_metadata_months")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_cost_tag_metadata_months"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_metadata_months ...'
  end
  # verify the required parameter 'filter_provider' is set
  if @api_client.config.client_side_validation && filter_provider.nil?
    fail ArgumentError, "Missing the required parameter 'filter_provider' when calling CloudCostManagementAPI.list_cost_tag_metadata_months"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_metadata/months'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[provider]'] = filter_provider

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagMetadataMonthsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_metadata_months,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_metadata_months\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_metadata_orchestrators(filter_month, opts = {}) ⇒ Object

List Cloud Cost Management orchestrators.

See Also:



3742
3743
3744
3745
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3742

def list_cost_tag_metadata_orchestrators(filter_month, opts = {})
  data, _status_code, _headers = list_cost_tag_metadata_orchestrators_with_http_info(filter_month, opts)
  data
end

#list_cost_tag_metadata_orchestrators_with_http_info(filter_month, opts = {}) ⇒ Array<(CostOrchestratorsResponse, Integer, Hash)>

List Cloud Cost Management orchestrators.

List container orchestrators (for example, kubernetes, ecs) detected in Cloud Cost Management data for the requested period.

Parameters:

  • filter_month (String) —

    The month to scope the query to, in YYYY-MM format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_provider (String) —

    Filter results to a specific provider. Common cloud values are aws, azure, gcp, Oracle (OCI), and custom. SaaS billing integrations (for example, Snowflake, MongoDB, Databricks) are also accepted using their display-name string. Values are case-sensitive.

Returns:

  • (Array<(CostOrchestratorsResponse, Integer, Hash)>) —

    CostOrchestratorsResponse data, response status code and response headers



3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3755

def list_cost_tag_metadata_orchestrators_with_http_info(filter_month, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_cost_tag_metadata_orchestrators".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_cost_tag_metadata_orchestrators")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_cost_tag_metadata_orchestrators"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_metadata_orchestrators ...'
  end
  # verify the required parameter 'filter_month' is set
  if @api_client.config.client_side_validation && filter_month.nil?
    fail ArgumentError, "Missing the required parameter 'filter_month' when calling CloudCostManagementAPI.list_cost_tag_metadata_orchestrators"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_metadata/orchestrators'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[month]'] = filter_month
  query_params[:'filter[provider]'] = opts[:'filter_provider'] if !opts[:'filter_provider'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostOrchestratorsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_metadata_orchestrators,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_metadata_orchestrators\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tag_metadata_with_http_info(filter_month, opts = {}) ⇒ Array<(CostTagKeyMetadataResponse, Integer, Hash)>

List Cloud Cost Management tag key metadata.

List Cloud Cost Management tag key metadata, including row counts, cost covered, cardinality, and a sample of top tag values per cloud account. Use filter[daily]=true to return daily rows instead of the default monthly roll-up.

Parameters:

  • filter_month (String) —

    The month to scope the query to, in YYYY-MM format.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_provider (String) —

    Filter results to a specific provider. Common cloud values are aws, azure, gcp, Oracle (OCI), and custom. SaaS billing integrations (for example, Snowflake, MongoDB, Databricks) are also accepted using their display-name string. Values are case-sensitive.

  • :filter_metric (String) —

    Filter results to a specific Cloud Cost Management metric (for example, aws.cost.net.amortized). When omitted, every available metric for the requested period is returned.

  • :filter_tag_key (String) —

    Restrict results to a single tag key.

  • :filter_daily (CostTagMetadataDailyFilter) —

    When true, return one row per day with the day in the date attribute. Defaults to the monthly roll-up when omitted.

Returns:

  • (Array<(CostTagKeyMetadataResponse, Integer, Hash)>) —

    CostTagKeyMetadataResponse data, response status code and response headers



3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3527

def list_cost_tag_metadata_with_http_info(filter_month, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_cost_tag_metadata".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_cost_tag_metadata")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_cost_tag_metadata"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tag_metadata ...'
  end
  # verify the required parameter 'filter_month' is set
  if @api_client.config.client_side_validation && filter_month.nil?
    fail ArgumentError, "Missing the required parameter 'filter_month' when calling CloudCostManagementAPI.list_cost_tag_metadata"
  end
  allowable_values = ['true', 'false']
  if @api_client.config.client_side_validation && opts[:'filter_daily'] && !allowable_values.include?(opts[:'filter_daily'])
    fail ArgumentError, "invalid value for \"filter_daily\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_metadata'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[month]'] = filter_month
  query_params[:'filter[provider]'] = opts[:'filter_provider'] if !opts[:'filter_provider'].nil?
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'filter[tag_key]'] = opts[:'filter_tag_key'] if !opts[:'filter_tag_key'].nil?
  query_params[:'filter[daily]'] = opts[:'filter_daily'] if !opts[:'filter_daily'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagKeyMetadataResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tag_metadata,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tag_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_cost_tags(opts = {}) ⇒ Object

List Cloud Cost Management tags.

See Also:



3816
3817
3818
3819
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3816

def list_cost_tags(opts = {})
  data, _status_code, _headers = list_cost_tags_with_http_info(opts)
  data
end

#list_cost_tags_with_http_info(opts = {}) ⇒ Array<(CostTagsResponse, Integer, Hash)>

List Cloud Cost Management tags.

List Cloud Cost Management tags for a given metric.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_metric (String) —

    The Cloud Cost Management metric to scope the tags to. When omitted, returns tags across all metrics.

  • :filter_match (String) —

    A substring used to filter the returned tags by name.

  • :filter_tags (Array<String>) —

    Filter to return only tags that appear with the given key:value tag values. For example, filter[tags]=providername:aws returns tags found on the same cost data, such as aws_instance_type:t3.micro and aws_instance_type:m5.large.

  • :filter_tag_keys (Array<String>) —

    Restrict the returned tags to those whose key matches one of the given tag keys.

  • :page_size (Integer) —

    Controls the size of the internal tag search scope. This does not restrict the number of tags returned in the response. Defaults to 50, maximum 10000.

Returns:

  • (Array<(CostTagsResponse, Integer, Hash)>) —

    CostTagsResponse data, response status code and response headers



3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3832

def list_cost_tags_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_cost_tags ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CloudCostManagementAPI.list_cost_tags, must be smaller than or equal to 10000.'
  end
  # resource path
  local_var_path = '/api/v2/cost/tags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[metric]'] = opts[:'filter_metric'] if !opts[:'filter_metric'].nil?
  query_params[:'filter[match]'] = opts[:'filter_match'] if !opts[:'filter_match'].nil?
  query_params[:'filter[tags]'] = @api_client.build_collection_param(opts[:'filter_tags'], :multi) if !opts[:'filter_tags'].nil?
  query_params[:'filter[tag_keys]'] = @api_client.build_collection_param(opts[:'filter_tag_keys'], :multi) if !opts[:'filter_tag_keys'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CostTagsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_cost_tags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_cost_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_allocation_rules(opts = {}) ⇒ Object

List custom allocation rules.

See Also:



3890
3891
3892
3893
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3890

def list_custom_allocation_rules(opts = {})
  data, _status_code, _headers = list_custom_allocation_rules_with_http_info(opts)
  data
end

#list_custom_allocation_rules_status(opts = {}) ⇒ Object

List custom allocation rule statuses.

See Also:



3950
3951
3952
3953
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3950

def list_custom_allocation_rules_status(opts = {})
  data, _status_code, _headers = list_custom_allocation_rules_status_with_http_info(opts)
  data
end

#list_custom_allocation_rules_status_with_http_info(opts = {}) ⇒ Array<(ArbitraryRuleStatusResponseArray, Integer, Hash)>

List custom allocation rule statuses.

List the processing status of all custom allocation rules. Returns only the ID and processing status for each rule.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3961

def list_custom_allocation_rules_status_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_custom_allocation_rules_status ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/status'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ArbitraryRuleStatusResponseArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_custom_allocation_rules_status,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_custom_allocation_rules_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_allocation_rules_with_http_info(opts = {}) ⇒ Array<(ArbitraryRuleResponseArray, Integer, Hash)>

List custom allocation rules.

List all custom allocation rules - Retrieve a list of all custom allocation rules for the organization

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ArbitraryRuleResponseArray, Integer, Hash)>) —

    ArbitraryRuleResponseArray data, response status code and response headers



3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 3901

def list_custom_allocation_rules_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_custom_allocation_rules ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ArbitraryRuleResponseArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_custom_allocation_rules,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_custom_allocation_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_custom_costs_files(opts = {}) ⇒ Object

List Custom Costs files.

See Also:



4010
4011
4012
4013
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4010

def list_custom_costs_files(opts = {})
  data, _status_code, _headers = list_custom_costs_files_with_http_info(opts)
  data
end

#list_custom_costs_files_with_http_info(opts = {}) ⇒ Array<(CustomCostsFileListResponse, Integer, Hash)>

List Custom Costs files.

List the Custom Costs files.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number for pagination

  • :page_size (Integer) —

    Page size for pagination

  • :filter_status (String) —

    Filter by file status

  • :filter_name (String) —

    Filter files by name with case-insensitive substring matching.

  • :filter_provider (Array<String>) —

    Filter by provider.

  • :sort (String) —

    Sort key with optional descending prefix

Returns:

  • (Array<(CustomCostsFileListResponse, Integer, Hash)>) —

    CustomCostsFileListResponse data, response status code and response headers



4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4027

def list_custom_costs_files_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_custom_costs_files ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter[name]'] = opts[:'filter_name'] if !opts[:'filter_name'].nil?
  query_params[:'filter[provider]'] = @api_client.build_collection_param(opts[:'filter_provider'], :multi) if !opts[:'filter_provider'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomCostsFileListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_custom_costs_files,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_custom_costs_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tag_pipelines_rulesets(opts = {}) ⇒ Object

List tag pipeline rulesets.

See Also:



4083
4084
4085
4086
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4083

def list_tag_pipelines_rulesets(opts = {})
  data, _status_code, _headers = list_tag_pipelines_rulesets_with_http_info(opts)
  data
end

#list_tag_pipelines_rulesets_status(opts = {}) ⇒ Object

List tag pipeline ruleset statuses.

See Also:



4143
4144
4145
4146
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4143

def list_tag_pipelines_rulesets_status(opts = {})
  data, _status_code, _headers = list_tag_pipelines_rulesets_status_with_http_info(opts)
  data
end

#list_tag_pipelines_rulesets_status_with_http_info(opts = {}) ⇒ Array<(RulesetStatusRespArray, Integer, Hash)>

List tag pipeline ruleset statuses.

List the processing status of all tag pipeline rulesets. Returns only the ID and processing status for each ruleset.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RulesetStatusRespArray, Integer, Hash)>) —

    RulesetStatusRespArray data, response status code and response headers



4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4154

def list_tag_pipelines_rulesets_status_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_tag_pipelines_rulesets_status ...'
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/status'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RulesetStatusRespArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_tag_pipelines_rulesets_status,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_tag_pipelines_rulesets_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tag_pipelines_rulesets_with_http_info(opts = {}) ⇒ Array<(RulesetRespArray, Integer, Hash)>

List tag pipeline rulesets.

List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RulesetRespArray, Integer, Hash)>) —

    RulesetRespArray data, response status code and response headers



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4094

def list_tag_pipelines_rulesets_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_tag_pipelines_rulesets ...'
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RulesetRespArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_tag_pipelines_rulesets,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_tag_pipelines_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_unit_costs(opts = {}) ⇒ Object

List unit costs.

See Also:



4203
4204
4205
4206
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4203

def list_unit_costs(opts = {})
  data, _status_code, _headers = list_unit_costs_with_http_info(opts)
  data
end

#list_unit_costs_with_http_info(opts = {}) ⇒ Array<(UnitCostsResponse, Integer, Hash)>

List unit costs.

List the ROI metrics (unit costs) for the authenticated organization.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UnitCostsResponse, Integer, Hash)>) —

    UnitCostsResponse data, response status code and response headers



4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4214

def list_unit_costs_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_unit_costs".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_unit_costs")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_unit_costs"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.list_unit_costs ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/unit_costs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UnitCostsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_unit_costs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#list_unit_costs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reorder_custom_allocation_rules(body, opts = {}) ⇒ Object

Reorder custom allocation rules.

See Also:



4269
4270
4271
4272
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4269

def reorder_custom_allocation_rules(body, opts = {})
  reorder_custom_allocation_rules_with_http_info(body, opts)
  nil
end

#reorder_custom_allocation_rules_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reorder custom allocation rules.

Reorder custom allocation rules - Change the execution order of custom allocation rules.

Important: You must provide the complete list of all rule IDs in the desired execution order. The API will reorder ALL rules according to the provided sequence.

Rules are executed in the order specified, with lower indices (earlier in the array) having higher priority.

Example: If you have rules with IDs [123, 456, 789] and want to change order from 123→456→789 to 456→123→789, send: ["456", "123", "789"]

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4287

def reorder_custom_allocation_rules_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.reorder_custom_allocation_rules ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.reorder_custom_allocation_rules"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/reorder'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :reorder_custom_allocation_rules,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#reorder_custom_allocation_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reorder_tag_pipelines_rulesets(body, opts = {}) ⇒ Object

Reorder tag pipeline rulesets.

See Also:



4342
4343
4344
4345
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4342

def reorder_tag_pipelines_rulesets(body, opts = {})
  reorder_tag_pipelines_rulesets_with_http_info(body, opts)
  nil
end

#reorder_tag_pipelines_rulesets_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reorder tag pipeline rulesets.

Reorder tag pipeline rulesets - Change the execution order of tag pipeline rulesets

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4354

def reorder_tag_pipelines_rulesets_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.reorder_tag_pipelines_rulesets ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.reorder_tag_pipelines_rulesets"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/reorder'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :reorder_tag_pipelines_rulesets,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#reorder_tag_pipelines_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_cost_recommendations(body, opts = {}) ⇒ Object

Search cost recommendations.

See Also:



4409
4410
4411
4412
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4409

def search_cost_recommendations(body, opts = {})
  data, _status_code, _headers = search_cost_recommendations_with_http_info(body, opts)
  data
end

#search_cost_recommendations_with_http_info(body, opts = {}) ⇒ Array<(CostRecommendationArray, Integer, Hash)>

Search cost recommendations.

List cost recommendations matching a filter, with pagination and sorting.

Parameters:

Options Hash (opts):

  • :page_size (String) —

    Number of results per page (1–10000).

  • :page_token (String) —

    Pagination token from a previous response.

Returns:

  • (Array<(CostRecommendationArray, Integer, Hash)>) —

    CostRecommendationArray data, response status code and response headers



4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4423

def search_cost_recommendations_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.search_cost_recommendations".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.search_cost_recommendations")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.search_cost_recommendations"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.search_cost_recommendations ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.search_cost_recommendations"
  end
  # resource path
  local_var_path = '/api/v2/cost/recommendations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[token]'] = opts[:'page_token'] if !opts[:'page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CostRecommendationArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :search_cost_recommendations,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#search_cost_recommendations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_account_filters(cloud_account_id, body, opts = {}) ⇒ Object

Update account filters.

See Also:



4486
4487
4488
4489
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4486

def (, body, opts = {})
  data, _status_code, _headers = (, body, opts)
  data
end

#update_cost_account_filters_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(AccountFiltersResponse, Integer, Hash)>

Update account filters.

Update the account filters for a cloud account (AWS CUR 1.0/2.0, OCI, and other clouds).

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • body (AccountFiltersPatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AccountFiltersResponse, Integer, Hash)>) —

    AccountFiltersResponse data, response status code and response headers



4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4499

def (, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_account_filters ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_account_filters"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_cost_account_filters"
  end
  # resource path
  local_var_path = '/api/v2/cost/account_filters/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'AccountFiltersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_cost_account_filters,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_account_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_awscur_config(cloud_account_id, body, opts = {}) ⇒ Object

Update Cloud Cost Management AWS CUR config.

See Also:



4558
4559
4560
4561
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4558

def update_cost_awscur_config(, body, opts = {})
  data, _status_code, _headers = update_cost_awscur_config_with_http_info(, body, opts)
  data
end

#update_cost_awscur_config_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(AwsCURConfigsResponse, Integer, Hash)>

Update Cloud Cost Management AWS CUR config.

Update the status (active/archived) and/or account filtering configuration of an AWS CUR config.

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • body (AwsCURConfigPatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AwsCURConfigsResponse, Integer, Hash)>) —

    AwsCURConfigsResponse data, response status code and response headers



4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4571

def update_cost_awscur_config_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_awscur_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_awscur_config"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_cost_awscur_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/aws_cur_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'AwsCURConfigsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_cost_awscur_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_awscur_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_azure_uc_configs(cloud_account_id, body, opts = {}) ⇒ Object

Update Cloud Cost Management Azure config.

See Also:



4630
4631
4632
4633
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4630

def update_cost_azure_uc_configs(, body, opts = {})
  data, _status_code, _headers = update_cost_azure_uc_configs_with_http_info(, body, opts)
  data
end

#update_cost_azure_uc_configs_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(AzureUCConfigPairsResponse, Integer, Hash)>

Update Cloud Cost Management Azure config.

Update the status of an Azure config (active/archived).

Parameters:

  • cloud_account_id (Integer) —

    Cloud Account id.

  • body (AzureUCConfigPatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AzureUCConfigPairsResponse, Integer, Hash)>) —

    AzureUCConfigPairsResponse data, response status code and response headers



4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4643

def update_cost_azure_uc_configs_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_azure_uc_configs ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_azure_uc_configs"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_cost_azure_uc_configs"
  end
  # resource path
  local_var_path = '/api/v2/cost/azure_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'AzureUCConfigPairsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_cost_azure_uc_configs,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_azure_uc_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_cost_gcp_usage_cost_config(cloud_account_id, body, opts = {}) ⇒ Object

Update Google Cloud Usage Cost config.

See Also:



4702
4703
4704
4705
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4702

def update_cost_gcp_usage_cost_config(, body, opts = {})
  data, _status_code, _headers = update_cost_gcp_usage_cost_config_with_http_info(, body, opts)
  data
end

#update_cost_gcp_usage_cost_config_with_http_info(cloud_account_id, body, opts = {}) ⇒ Array<(GCPUsageCostConfigResponse, Integer, Hash)>

Update Google Cloud Usage Cost config.

Update the status of an Google Cloud Usage Cost config (active/archived).

Parameters:

Returns:

  • (Array<(GCPUsageCostConfigResponse, Integer, Hash)>) —

    GCPUsageCostConfigResponse data, response status code and response headers



4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4715

def update_cost_gcp_usage_cost_config_with_http_info(, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_cost_gcp_usage_cost_config ...'
  end
  # verify the required parameter 'cloud_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'cloud_account_id' when calling CloudCostManagementAPI.update_cost_gcp_usage_cost_config"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_cost_gcp_usage_cost_config"
  end
  # resource path
  local_var_path = '/api/v2/cost/gcp_uc_config/{cloud_account_id}'.sub('{cloud_account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'GCPUsageCostConfigResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_cost_gcp_usage_cost_config,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_cost_gcp_usage_cost_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_custom_allocation_rule(rule_id, body, opts = {}) ⇒ Object

Update custom allocation rule.

See Also:



4774
4775
4776
4777
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4774

def update_custom_allocation_rule(rule_id, body, opts = {})
  data, _status_code, _headers = update_custom_allocation_rule_with_http_info(rule_id, body, opts)
  data
end

#update_custom_allocation_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(ArbitraryRuleResponse, Integer, Hash)>

Update custom allocation rule.

Update an existing custom allocation rule with new filters and allocation strategy.

Strategy Methods:

  • PROPORTIONAL/EVEN: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters.
  • PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys.
  • PERCENT: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations).
  • USAGE_METRIC: Allocates based on usage metrics (implementation varies).

Filter Conditions:

  • Use value for single-value conditions: "is", "is not", "contains", "=", "!=", "like", "not like"
  • Use values for multi-value conditions: "in", "not in"
  • Cannot use both value and values simultaneously.

Supported operators: is, is not, contains, in, not in, =, !=, like, not like

Parameters:

  • rule_id (Integer) —

    The unique identifier of the custom allocation rule

  • body (ArbitraryCostUpsertRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ArbitraryRuleResponse, Integer, Hash)>) —

    ArbitraryRuleResponse data, response status code and response headers



4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4800

def update_custom_allocation_rule_with_http_info(rule_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_custom_allocation_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling CloudCostManagementAPI.update_custom_allocation_rule"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_custom_allocation_rule"
  end
  # resource path
  local_var_path = '/api/v2/cost/arbitrary_rule/{rule_id}'.sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'ArbitraryRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_custom_allocation_rule,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_custom_allocation_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tag_pipelines_ruleset(ruleset_id, body, opts = {}) ⇒ Object

Update tag pipeline ruleset.

See Also:



4859
4860
4861
4862
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4859

def update_tag_pipelines_ruleset(ruleset_id, body, opts = {})
  data, _status_code, _headers = update_tag_pipelines_ruleset_with_http_info(ruleset_id, body, opts)
  data
end

#update_tag_pipelines_ruleset_with_http_info(ruleset_id, body, opts = {}) ⇒ Array<(RulesetResp, Integer, Hash)>

Update tag pipeline ruleset.

Update a tag pipeline ruleset - Update an existing tag pipeline ruleset with new rules and configuration

Parameters:

  • ruleset_id (String) —

    The unique identifier of the ruleset

  • body (UpdateRulesetRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RulesetResp, Integer, Hash)>) —

    RulesetResp data, response status code and response headers



4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4872

def update_tag_pipelines_ruleset_with_http_info(ruleset_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_tag_pipelines_ruleset ...'
  end
  # verify the required parameter 'ruleset_id' is set
  if @api_client.config.client_side_validation && ruleset_id.nil?
    fail ArgumentError, "Missing the required parameter 'ruleset_id' when calling CloudCostManagementAPI.update_tag_pipelines_ruleset"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_tag_pipelines_ruleset"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/{ruleset_id}'.sub('{ruleset_id}', CGI.escape(ruleset_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'RulesetResp'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_tag_pipelines_ruleset,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_tag_pipelines_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_unit_cost(unit_cost_id, body, opts = {}) ⇒ Object

Update a unit cost.

See Also:



4931
4932
4933
4934
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4931

def update_unit_cost(unit_cost_id, body, opts = {})
  data, _status_code, _headers = update_unit_cost_with_http_info(unit_cost_id, body, opts)
  data
end

#update_unit_cost_with_http_info(unit_cost_id, body, opts = {}) ⇒ Array<(UnitCostResponse, Integer, Hash)>

Update a unit cost.

Replace an ROI metric (unit cost) with a new set of attributes.

Parameters:

  • unit_cost_id (UUID) —

    The UUID of the unit cost.

  • body (UnitCostUpdateRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UnitCostResponse, Integer, Hash)>) —

    UnitCostResponse data, response status code and response headers



4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 4944

def update_unit_cost_with_http_info(unit_cost_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_unit_cost".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_unit_cost")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_unit_cost"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.update_unit_cost ...'
  end
  # verify the required parameter 'unit_cost_id' is set
  if @api_client.config.client_side_validation && unit_cost_id.nil?
    fail ArgumentError, "Missing the required parameter 'unit_cost_id' when calling CloudCostManagementAPI.update_unit_cost"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.update_unit_cost"
  end
  # resource path
  local_var_path = '/api/v2/cost/unit_costs/{unit_cost_id}'.sub('{unit_cost_id}', CGI.escape(unit_cost_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'UnitCostResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_unit_cost,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#update_unit_cost\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_custom_costs_file(body, opts = {}) ⇒ Object

Upload Custom Costs file.

See Also:



5009
5010
5011
5012
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5009

def upload_custom_costs_file(body, opts = {})
  data, _status_code, _headers = upload_custom_costs_file_with_http_info(body, opts)
  data
end

#upload_custom_costs_file_with_http_info(body, opts = {}) ⇒ Array<(CustomCostsFileUploadResponse, Integer, Hash)>

Upload Custom Costs file.

Upload a Custom Costs file.

Parameters:

Returns:



5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5021

def upload_custom_costs_file_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upload_custom_costs_file ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.upload_custom_costs_file"
  end
  # resource path
  local_var_path = '/api/v2/cost/custom_costs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CustomCostsFileUploadResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :upload_custom_costs_file,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#upload_custom_costs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_budget(body, opts = {}) ⇒ Object

Create or update a budget.

See Also:



5076
5077
5078
5079
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5076

def upsert_budget(body, opts = {})
  data, _status_code, _headers = upsert_budget_with_http_info(body, opts)
  data
end

#upsert_budget_with_http_info(body, opts = {}) ⇒ Array<(BudgetWithEntries, Integer, Hash)>

Create or update a budget.

Create a new budget or update an existing one.

Parameters:

Returns:

  • (Array<(BudgetWithEntries, Integer, Hash)>) —

    BudgetWithEntries data, response status code and response headers



5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5088

def upsert_budget_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upsert_budget ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.upsert_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetWithEntries'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :upsert_budget,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#upsert_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_cost_tag_description_by_key(tag_key, body, opts = {}) ⇒ Object

Upsert a Cloud Cost Management tag description.

See Also:



5143
5144
5145
5146
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5143

def upsert_cost_tag_description_by_key(tag_key, body, opts = {})
  upsert_cost_tag_description_by_key_with_http_info(tag_key, body, opts)
  nil
end

#upsert_cost_tag_description_by_key_with_http_info(tag_key, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upsert a Cloud Cost Management tag description.

Create or update a Cloud Cost Management tag key description. The new description and optional cloud scoping are supplied in the request body. Omit cloud to set a cross-cloud default for the tag key.

Parameters:

  • tag_key (String) —

    The tag key whose description is being upserted.

  • body (CostTagDescriptionUpsertRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5156

def upsert_cost_tag_description_by_key_with_http_info(tag_key, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upsert_cost_tag_description_by_key ...'
  end
  # verify the required parameter 'tag_key' is set
  if @api_client.config.client_side_validation && tag_key.nil?
    fail ArgumentError, "Missing the required parameter 'tag_key' when calling CloudCostManagementAPI.upsert_cost_tag_description_by_key"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.upsert_cost_tag_description_by_key"
  end
  # resource path
  local_var_path = '/api/v2/cost/tag_descriptions/{tag_key}'.sub('{tag_key}', CGI.escape(tag_key.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :upsert_cost_tag_description_by_key,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#upsert_cost_tag_description_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_custom_forecast(body, opts = {}) ⇒ Object

Create or replace a budget's custom forecast.

See Also:



5215
5216
5217
5218
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5215

def upsert_custom_forecast(body, opts = {})
  data, _status_code, _headers = upsert_custom_forecast_with_http_info(body, opts)
  data
end

#upsert_custom_forecast_with_http_info(body, opts = {}) ⇒ Array<(CustomForecastResponse, Integer, Hash)>

Create or replace a budget's custom forecast.

Create or replace the custom forecast for an existing budget. Pass an empty entries list to delete the custom forecast for the budget.

Parameters:

Returns:

  • (Array<(CustomForecastResponse, Integer, Hash)>) —

    CustomForecastResponse data, response status code and response headers



5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5228

def upsert_custom_forecast_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.upsert_custom_forecast ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.upsert_custom_forecast"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/custom-forecast'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CustomForecastResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :upsert_custom_forecast,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#upsert_custom_forecast\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_budget(body, opts = {}) ⇒ Object

Validate budget.

See Also:



5283
5284
5285
5286
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5283

def validate_budget(body, opts = {})
  data, _status_code, _headers = validate_budget_with_http_info(body, opts)
  data
end

#validate_budget_with_http_info(body, opts = {}) ⇒ Array<(BudgetValidationResponse, Integer, Hash)>

Validate budget.

Validate a budget configuration without creating or modifying it

Parameters:

Returns:

  • (Array<(BudgetValidationResponse, Integer, Hash)>) —

    BudgetValidationResponse data, response status code and response headers



5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5295

def validate_budget_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.validate_budget ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.validate_budget"
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetValidationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :validate_budget,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#validate_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_csv_budget(opts = {}) ⇒ Object

Validate CSV budget.

See Also:



5350
5351
5352
5353
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5350

def validate_csv_budget(opts = {})
  data, _status_code, _headers = validate_csv_budget_with_http_info(opts)
  data
end

#validate_csv_budget_with_http_info(opts = {}) ⇒ Array<(ValidationResponse, Integer, Hash)>

Validate CSV budget.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ValidationResponse, Integer, Hash)>) —

    ValidationResponse data, response status code and response headers



5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5358

def validate_csv_budget_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.validate_csv_budget ...'
  end
  # resource path
  local_var_path = '/api/v2/cost/budget/csv/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ValidationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :validate_csv_budget,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#validate_csv_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_query(body, opts = {}) ⇒ Object

Validate query.

See Also:



5407
5408
5409
5410
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5407

def validate_query(body, opts = {})
  data, _status_code, _headers = validate_query_with_http_info(body, opts)
  data
end

#validate_query_with_http_info(body, opts = {}) ⇒ Array<(RulesValidateQueryResponse, Integer, Hash)>

Validate query.

Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query

Parameters:

Returns:

  • (Array<(RulesValidateQueryResponse, Integer, Hash)>) —

    RulesValidateQueryResponse data, response status code and response headers



5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
 
# File 'lib/datadog_api_client/v2/api/cloud_cost_management_api.rb', line 5419

def validate_query_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudCostManagementAPI.validate_query ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CloudCostManagementAPI.validate_query"
  end
  # resource path
  local_var_path = '/api/v2/tags/enrichment/validate-query'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'RulesValidateQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :validate_query,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudCostManagementAPI#validate_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end