Class: DatadogAPIClient::V1::AWSLogsIntegrationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/aws_logs_integration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of AWSLogsIntegrationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/aws_logs_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/v1/api/aws_logs_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Check that an AWS Lambda Function exists.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 29

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

#check_aws_logs_lambda_async_with_http_info(body, opts = {}) ⇒ Array<(AWSLogsAsyncResponse, Integer, Hash)>

Check that an AWS Lambda Function exists.

Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking.

  • Returns a status of ‘created’ when it’s checking if the Lambda exists in the account.

  • Returns a status of ‘waiting’ while checking.

  • Returns a status of ‘checked and ok’ if the Lambda exists.

  • Returns a status of ‘error’ if the Lambda does not exist.

Parameters:

  • body (AWSAccountAndLambdaRequest) —

    Check AWS Log Lambda Async request body.

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

    the optional parameters

Returns:

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

    AWSLogsAsyncResponse data, response status code and response headers



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
98
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 48

def check_aws_logs_lambda_async_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.check_aws_logs_lambda_async ...'
  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 AWSLogsIntegrationAPI.check_aws_logs_lambda_async"
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs/check_async'

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

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

  new_options = opts.merge(
    :operation => :check_aws_logs_lambda_async,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#check_aws_logs_lambda_async\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Check permissions for log services.

See Also:



103
104
105
106
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 103

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

#check_aws_logs_services_async_with_http_info(body, opts = {}) ⇒ Array<(AWSLogsAsyncResponse, Integer, Hash)>

Check permissions for log services.

Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for ‘EnableAWSLogServices`. Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes.

  • Returns a status of ‘created` when it’s checking if the permissions exists in the AWS account.

  • Returns a status of ‘waiting` while checking.

  • Returns a status of ‘checked and ok` if the Lambda exists.

  • Returns a status of ‘error` if the Lambda does not exist.

Parameters:

  • body (AWSLogsServicesRequest) —

    Check AWS Logs Async Services request body.

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

    the optional parameters

Returns:

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

    AWSLogsAsyncResponse data, response status code and response headers



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
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 124

def check_aws_logs_services_async_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.check_aws_logs_services_async ...'
  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 AWSLogsIntegrationAPI.check_aws_logs_services_async"
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs/services_async'

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

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

  new_options = opts.merge(
    :operation => :check_aws_logs_services_async,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#check_aws_logs_services_async\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Add AWS Log Lambda ARN.

See Also:



179
180
181
182
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 179

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

#create_aws_lambda_arn_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add AWS Log Lambda ARN.

Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.

Parameters:

  • body (AWSAccountAndLambdaRequest) —

    AWS Log Lambda Async request body.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
235
236
237
238
239
240
241
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 191

def create_aws_lambda_arn_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.create_aws_lambda_arn ...'
  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 AWSLogsIntegrationAPI.create_aws_lambda_arn"
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs'

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

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

  new_options = opts.merge(
    :operation => :create_aws_lambda_arn,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#create_aws_lambda_arn\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an AWS Logs integration.

See Also:



246
247
248
249
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 246

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

#delete_aws_lambda_arn_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete an AWS Logs integration.

Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account.

Parameters:

  • body (AWSAccountAndLambdaRequest) —

    Delete AWS Lambda ARN request body.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
306
307
308
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 258

def delete_aws_lambda_arn_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.delete_aws_lambda_arn ...'
  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 AWSLogsIntegrationAPI.delete_aws_lambda_arn"
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs'

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

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

  new_options = opts.merge(
    :operation => :delete_aws_lambda_arn,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#delete_aws_lambda_arn\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Enable an AWS Logs integration.

See Also:



313
314
315
316
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 313

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

#enable_aws_log_services_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Enable an AWS Logs integration.

Enable automatic log collection for a list of services. This should be run after running ‘CreateAWSLambdaARN` to save the configuration.

Parameters:

  • body (AWSLogsServicesRequest) —

    Enable AWS Log Services request body.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
374
375
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 325

def enable_aws_log_services_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.enable_aws_log_services ...'
  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 AWSLogsIntegrationAPI.enable_aws_log_services"
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs/services'

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

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

  new_options = opts.merge(
    :operation => :enable_aws_log_services,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#enable_aws_log_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aws_logs_integrations(opts = {}) ⇒ Object

List all AWS Logs integrations.

See Also:



380
381
382
383
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 380

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

#list_aws_logs_integrations_with_http_info(opts = {}) ⇒ Array<(Array<AWSLogsListResponse>, Integer, Hash)>

List all AWS Logs integrations.

List all Datadog-AWS Logs integrations configured in your Datadog account.

Parameters:

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

    the optional parameters

Returns:

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

    Array<AWSLogsListResponse> data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 391

def list_aws_logs_integrations_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.list_aws_logs_integrations ...'
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs'

  # 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] || 'Array<AWSLogsListResponse>'

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

  new_options = opts.merge(
    :operation => :list_aws_logs_integrations,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#list_aws_logs_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_aws_logs_services(opts = {}) ⇒ Object

Get list of AWS log ready services.

See Also:



440
441
442
443
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 440

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

#list_aws_logs_services_with_http_info(opts = {}) ⇒ Array<(Array<AWSLogsListServicesResponse>, Integer, Hash)>

Get list of AWS log ready services.

Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.

Parameters:

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

    the optional parameters

Returns:

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

    Array<AWSLogsListServicesResponse> data, response status code and response headers



451
452
453
454
455
456
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
 
# File 'lib/datadog_api_client/v1/api/aws_logs_integration_api.rb', line 451

def list_aws_logs_services_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AWSLogsIntegrationAPI.list_aws_logs_services ...'
  end
  # resource path
  local_var_path = '/api/v1/integration/aws/logs/services'

  # 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] || 'Array<AWSLogsListServicesResponse>'

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

  new_options = opts.merge(
    :operation => :list_aws_logs_services,
    :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 => "V1"
  )

  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: AWSLogsIntegrationAPI#list_aws_logs_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end