Class: DatadogAPIClient::V2::AWSIntegrationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AWSIntegrationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/aws_integration_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/aws_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create an AWS integration.

See Also:



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

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

#create_aws_account_with_http_info(body, opts = {}) ⇒ Array<(AWSAccountResponse, Integer, Hash)>

Create an AWS integration.

Create a new AWS Account Integration Config.

Parameters:

Returns:

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

    AWSAccountResponse 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
92
93
94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 41

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.create_aws_account ...'
  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 AWSIntegrationAPI.create_aws_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/accounts'

  # 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] || 'AWSAccountResponse'

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

  new_options = opts.merge(
    :operation => :create_aws_account,
    :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: AWSIntegrationAPI#create_aws_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_new_aws_external_id(opts = {}) ⇒ Object

Generate a new external ID.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 102

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

#create_new_aws_external_id_with_http_info(opts = {}) ⇒ Array<(AWSNewExternalIDResponse, Integer, Hash)>

Generate a new external ID.

Generate a new external ID for AWS role-based authentication.

Parameters:

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

    the optional parameters

Returns:

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

    AWSNewExternalIDResponse data, response status code and response headers



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
159
160
161
162
163
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 113

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.create_new_aws_external_id ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/generate_new_external_id'

  # 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] || 'AWSNewExternalIDResponse'

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

  new_options = opts.merge(
    :operation => :create_new_aws_external_id,
    :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: AWSIntegrationAPI#create_new_aws_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_aws_account(aws_account_config_id, opts = {}) ⇒ Object

Delete an AWS integration.

See Also:



168
169
170
171
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 168

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

#delete_aws_account_with_http_info(aws_account_config_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an AWS integration.

Delete an AWS Account Integration Config by config ID.

Parameters:

  • aws_account_config_id (String) —

    Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the List all AWS integrations endpoint and query by AWS Account ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
226
227
228
229
230
231
232
233
234
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 180

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.delete_aws_account ...'
  end
  # verify the required parameter 'aws_account_config_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'aws_account_config_id' when calling AWSIntegrationAPI.delete_aws_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/accounts/{aws_account_config_id}'.sub('{aws_account_config_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]

  new_options = opts.merge(
    :operation => :delete_aws_account,
    :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: AWSIntegrationAPI#delete_aws_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_aws_account(aws_account_config_id, opts = {}) ⇒ Object

Get an AWS integration by config ID.

See Also:



239
240
241
242
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 239

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

#get_aws_account_with_http_info(aws_account_config_id, opts = {}) ⇒ Array<(AWSAccountResponse, Integer, Hash)>

Get an AWS integration by config ID.

Get an AWS Account Integration Config by config ID.

Parameters:

  • aws_account_config_id (String) —

    Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the List all AWS integrations endpoint and query by AWS Account ID.

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

    the optional parameters

Returns:

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

    AWSAccountResponse data, response status code and response headers



251
252
253
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
305
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 251

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.get_aws_account ...'
  end
  # verify the required parameter 'aws_account_config_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'aws_account_config_id' when calling AWSIntegrationAPI.get_aws_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/accounts/{aws_account_config_id}'.sub('{aws_account_config_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] || 'AWSAccountResponse'

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

  new_options = opts.merge(
    :operation => :get_aws_account,
    :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: AWSIntegrationAPI#get_aws_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aws_accounts(opts = {}) ⇒ Object

List all AWS integrations.

See Also:



310
311
312
313
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 310

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

#list_aws_accounts_with_http_info(opts = {}) ⇒ Array<(AWSAccountsResponse, Integer, Hash)>

List all AWS integrations.

Get a list of AWS Account Integration Configs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :aws_account_id (String) —

    Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.

Returns:

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

    AWSAccountsResponse data, response status code and response headers



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
372
373
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 322

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.list_aws_accounts ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/accounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'aws_account_id'] = opts[:'aws_account_id'] if !opts[:'aws_account_id'].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] || 'AWSAccountsResponse'

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

  new_options = opts.merge(
    :operation => :list_aws_accounts,
    :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: AWSIntegrationAPI#list_aws_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aws_namespaces(opts = {}) ⇒ Object

List available namespaces.

See Also:



378
379
380
381
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 378

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

#list_aws_namespaces_with_http_info(opts = {}) ⇒ Array<(AWSNamespacesResponse, Integer, Hash)>

List available namespaces.

Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.

Parameters:

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

    the optional parameters

Returns:

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

    AWSNamespacesResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 389

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.list_aws_namespaces ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/available_namespaces'

  # 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] || 'AWSNamespacesResponse'

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

  new_options = opts.merge(
    :operation => :list_aws_namespaces,
    :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: AWSIntegrationAPI#list_aws_namespaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_aws_account(aws_account_config_id, body, opts = {}) ⇒ Object

Update an AWS integration.

See Also:



444
445
446
447
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 444

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

#update_aws_account_with_http_info(aws_account_config_id, body, opts = {}) ⇒ Array<(AWSAccountResponse, Integer, Hash)>

Update an AWS integration.

Update an AWS Account Integration Config by config ID.

Parameters:

  • aws_account_config_id (String) —

    Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the List all AWS integrations endpoint and query by AWS Account ID.

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

    the optional parameters

Returns:

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

    AWSAccountResponse data, response status code and response headers



457
458
459
460
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
510
511
512
513
514
515
516
517
 
# File 'lib/datadog_api_client/v2/api/aws_integration_api.rb', line 457

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSIntegrationAPI.update_aws_account ...'
  end
  # verify the required parameter 'aws_account_config_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'aws_account_config_id' when calling AWSIntegrationAPI.update_aws_account"
  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 AWSIntegrationAPI.update_aws_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/aws/accounts/{aws_account_config_id}'.sub('{aws_account_config_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] || 'AWSAccountResponse'

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

  new_options = opts.merge(
    :operation => :update_aws_account,
    :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: AWSIntegrationAPI#update_aws_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end