aws-sdk-cloudwatchlogs 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-cloudwatchlogs.rb +47 -0
- data/lib/aws-sdk-cloudwatchlogs/client.rb +1128 -0
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +789 -0
- data/lib/aws-sdk-cloudwatchlogs/customizations.rb +7 -0
- data/lib/aws-sdk-cloudwatchlogs/errors.rb +23 -0
- data/lib/aws-sdk-cloudwatchlogs/resource.rb +25 -0
- data/lib/aws-sdk-cloudwatchlogs/types.rb +1387 -0
- metadata +80 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module CloudWatchLogs
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
14
|
+
# Raised when calling #load or #data on a resource class that can not be
|
15
|
+
# loaded. This can happen when:
|
16
|
+
#
|
17
|
+
# * A resource class has identifiers, but no data attributes.
|
18
|
+
# * Resource data is only available when making an API call that
|
19
|
+
# enumerates all resources of that type.
|
20
|
+
class ResourceNotLoadable < RuntimeError; end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module CloudWatchLogs
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,1387 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module CloudWatchLogs
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# @note When making an API call, pass CancelExportTaskRequest
|
13
|
+
# data as a hash:
|
14
|
+
#
|
15
|
+
# {
|
16
|
+
# task_id: "ExportTaskId", # required
|
17
|
+
# }
|
18
|
+
# @!attribute [rw] task_id
|
19
|
+
# The ID of the export task.
|
20
|
+
# @return [String]
|
21
|
+
class CancelExportTaskRequest < Struct.new(
|
22
|
+
:task_id)
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# @note When making an API call, pass CreateExportTaskRequest
|
27
|
+
# data as a hash:
|
28
|
+
#
|
29
|
+
# {
|
30
|
+
# task_name: "ExportTaskName",
|
31
|
+
# log_group_name: "LogGroupName", # required
|
32
|
+
# log_stream_name_prefix: "LogStreamName",
|
33
|
+
# from: 1, # required
|
34
|
+
# to: 1, # required
|
35
|
+
# destination: "ExportDestinationBucket", # required
|
36
|
+
# destination_prefix: "ExportDestinationPrefix",
|
37
|
+
# }
|
38
|
+
# @!attribute [rw] task_name
|
39
|
+
# The name of the export task.
|
40
|
+
# @return [String]
|
41
|
+
#
|
42
|
+
# @!attribute [rw] log_group_name
|
43
|
+
# The name of the log group.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] log_stream_name_prefix
|
47
|
+
# Export only log streams that match the provided prefix. If you
|
48
|
+
# don't specify a value, no prefix filter is applied.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @!attribute [rw] from
|
52
|
+
# The start time of the range for the request, expressed as the number
|
53
|
+
# of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a
|
54
|
+
# timestamp earlier than this time are not exported.
|
55
|
+
# @return [Integer]
|
56
|
+
#
|
57
|
+
# @!attribute [rw] to
|
58
|
+
# The end time of the range for the request, expressed as the number
|
59
|
+
# of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a
|
60
|
+
# timestamp later than this time are not exported.
|
61
|
+
# @return [Integer]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] destination
|
64
|
+
# The name of S3 bucket for the exported log data. The bucket must be
|
65
|
+
# in the same AWS region.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] destination_prefix
|
69
|
+
# The prefix used as the start of the key for every object exported.
|
70
|
+
# If you don't specify a value, the default is `exportedlogs`.
|
71
|
+
# @return [String]
|
72
|
+
class CreateExportTaskRequest < Struct.new(
|
73
|
+
:task_name,
|
74
|
+
:log_group_name,
|
75
|
+
:log_stream_name_prefix,
|
76
|
+
:from,
|
77
|
+
:to,
|
78
|
+
:destination,
|
79
|
+
:destination_prefix)
|
80
|
+
include Aws::Structure
|
81
|
+
end
|
82
|
+
|
83
|
+
# @!attribute [rw] task_id
|
84
|
+
# The ID of the export task.
|
85
|
+
# @return [String]
|
86
|
+
class CreateExportTaskResponse < Struct.new(
|
87
|
+
:task_id)
|
88
|
+
include Aws::Structure
|
89
|
+
end
|
90
|
+
|
91
|
+
# @note When making an API call, pass CreateLogGroupRequest
|
92
|
+
# data as a hash:
|
93
|
+
#
|
94
|
+
# {
|
95
|
+
# log_group_name: "LogGroupName", # required
|
96
|
+
# }
|
97
|
+
# @!attribute [rw] log_group_name
|
98
|
+
# The name of the log group.
|
99
|
+
# @return [String]
|
100
|
+
class CreateLogGroupRequest < Struct.new(
|
101
|
+
:log_group_name)
|
102
|
+
include Aws::Structure
|
103
|
+
end
|
104
|
+
|
105
|
+
# @note When making an API call, pass CreateLogStreamRequest
|
106
|
+
# data as a hash:
|
107
|
+
#
|
108
|
+
# {
|
109
|
+
# log_group_name: "LogGroupName", # required
|
110
|
+
# log_stream_name: "LogStreamName", # required
|
111
|
+
# }
|
112
|
+
# @!attribute [rw] log_group_name
|
113
|
+
# The name of the log group.
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] log_stream_name
|
117
|
+
# The name of the log stream.
|
118
|
+
# @return [String]
|
119
|
+
class CreateLogStreamRequest < Struct.new(
|
120
|
+
:log_group_name,
|
121
|
+
:log_stream_name)
|
122
|
+
include Aws::Structure
|
123
|
+
end
|
124
|
+
|
125
|
+
# @note When making an API call, pass DeleteDestinationRequest
|
126
|
+
# data as a hash:
|
127
|
+
#
|
128
|
+
# {
|
129
|
+
# destination_name: "DestinationName", # required
|
130
|
+
# }
|
131
|
+
# @!attribute [rw] destination_name
|
132
|
+
# The name of the destination.
|
133
|
+
# @return [String]
|
134
|
+
class DeleteDestinationRequest < Struct.new(
|
135
|
+
:destination_name)
|
136
|
+
include Aws::Structure
|
137
|
+
end
|
138
|
+
|
139
|
+
# @note When making an API call, pass DeleteLogGroupRequest
|
140
|
+
# data as a hash:
|
141
|
+
#
|
142
|
+
# {
|
143
|
+
# log_group_name: "LogGroupName", # required
|
144
|
+
# }
|
145
|
+
# @!attribute [rw] log_group_name
|
146
|
+
# The name of the log group.
|
147
|
+
# @return [String]
|
148
|
+
class DeleteLogGroupRequest < Struct.new(
|
149
|
+
:log_group_name)
|
150
|
+
include Aws::Structure
|
151
|
+
end
|
152
|
+
|
153
|
+
# @note When making an API call, pass DeleteLogStreamRequest
|
154
|
+
# data as a hash:
|
155
|
+
#
|
156
|
+
# {
|
157
|
+
# log_group_name: "LogGroupName", # required
|
158
|
+
# log_stream_name: "LogStreamName", # required
|
159
|
+
# }
|
160
|
+
# @!attribute [rw] log_group_name
|
161
|
+
# The name of the log group.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] log_stream_name
|
165
|
+
# The name of the log stream.
|
166
|
+
# @return [String]
|
167
|
+
class DeleteLogStreamRequest < Struct.new(
|
168
|
+
:log_group_name,
|
169
|
+
:log_stream_name)
|
170
|
+
include Aws::Structure
|
171
|
+
end
|
172
|
+
|
173
|
+
# @note When making an API call, pass DeleteMetricFilterRequest
|
174
|
+
# data as a hash:
|
175
|
+
#
|
176
|
+
# {
|
177
|
+
# log_group_name: "LogGroupName", # required
|
178
|
+
# filter_name: "FilterName", # required
|
179
|
+
# }
|
180
|
+
# @!attribute [rw] log_group_name
|
181
|
+
# The name of the log group.
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] filter_name
|
185
|
+
# The name of the metric filter.
|
186
|
+
# @return [String]
|
187
|
+
class DeleteMetricFilterRequest < Struct.new(
|
188
|
+
:log_group_name,
|
189
|
+
:filter_name)
|
190
|
+
include Aws::Structure
|
191
|
+
end
|
192
|
+
|
193
|
+
# @note When making an API call, pass DeleteRetentionPolicyRequest
|
194
|
+
# data as a hash:
|
195
|
+
#
|
196
|
+
# {
|
197
|
+
# log_group_name: "LogGroupName", # required
|
198
|
+
# }
|
199
|
+
# @!attribute [rw] log_group_name
|
200
|
+
# The name of the log group.
|
201
|
+
# @return [String]
|
202
|
+
class DeleteRetentionPolicyRequest < Struct.new(
|
203
|
+
:log_group_name)
|
204
|
+
include Aws::Structure
|
205
|
+
end
|
206
|
+
|
207
|
+
# @note When making an API call, pass DeleteSubscriptionFilterRequest
|
208
|
+
# data as a hash:
|
209
|
+
#
|
210
|
+
# {
|
211
|
+
# log_group_name: "LogGroupName", # required
|
212
|
+
# filter_name: "FilterName", # required
|
213
|
+
# }
|
214
|
+
# @!attribute [rw] log_group_name
|
215
|
+
# The name of the log group.
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] filter_name
|
219
|
+
# The name of the subscription filter.
|
220
|
+
# @return [String]
|
221
|
+
class DeleteSubscriptionFilterRequest < Struct.new(
|
222
|
+
:log_group_name,
|
223
|
+
:filter_name)
|
224
|
+
include Aws::Structure
|
225
|
+
end
|
226
|
+
|
227
|
+
# @note When making an API call, pass DescribeDestinationsRequest
|
228
|
+
# data as a hash:
|
229
|
+
#
|
230
|
+
# {
|
231
|
+
# destination_name_prefix: "DestinationName",
|
232
|
+
# next_token: "NextToken",
|
233
|
+
# limit: 1,
|
234
|
+
# }
|
235
|
+
# @!attribute [rw] destination_name_prefix
|
236
|
+
# The prefix to match. If you don't specify a value, no prefix filter
|
237
|
+
# is applied.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] next_token
|
241
|
+
# The token for the next set of items to return. (You received this
|
242
|
+
# token from a previous call.)
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] limit
|
246
|
+
# The maximum number of items returned. If you don't specify a value,
|
247
|
+
# the default is up to 50 items.
|
248
|
+
# @return [Integer]
|
249
|
+
class DescribeDestinationsRequest < Struct.new(
|
250
|
+
:destination_name_prefix,
|
251
|
+
:next_token,
|
252
|
+
:limit)
|
253
|
+
include Aws::Structure
|
254
|
+
end
|
255
|
+
|
256
|
+
# @!attribute [rw] destinations
|
257
|
+
# The destinations.
|
258
|
+
# @return [Array<Types::Destination>]
|
259
|
+
#
|
260
|
+
# @!attribute [rw] next_token
|
261
|
+
# The token for the next set of items to return. The token expires
|
262
|
+
# after 24 hours.
|
263
|
+
# @return [String]
|
264
|
+
class DescribeDestinationsResponse < Struct.new(
|
265
|
+
:destinations,
|
266
|
+
:next_token)
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
270
|
+
# @note When making an API call, pass DescribeExportTasksRequest
|
271
|
+
# data as a hash:
|
272
|
+
#
|
273
|
+
# {
|
274
|
+
# task_id: "ExportTaskId",
|
275
|
+
# status_code: "CANCELLED", # accepts CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING
|
276
|
+
# next_token: "NextToken",
|
277
|
+
# limit: 1,
|
278
|
+
# }
|
279
|
+
# @!attribute [rw] task_id
|
280
|
+
# The ID of the export task. Specifying a task ID filters the results
|
281
|
+
# to zero or one export tasks.
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @!attribute [rw] status_code
|
285
|
+
# The status code of the export task. Specifying a status code filters
|
286
|
+
# the results to zero or more export tasks.
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] next_token
|
290
|
+
# The token for the next set of items to return. (You received this
|
291
|
+
# token from a previous call.)
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] limit
|
295
|
+
# The maximum number of items returned. If you don't specify a value,
|
296
|
+
# the default is up to 50 items.
|
297
|
+
# @return [Integer]
|
298
|
+
class DescribeExportTasksRequest < Struct.new(
|
299
|
+
:task_id,
|
300
|
+
:status_code,
|
301
|
+
:next_token,
|
302
|
+
:limit)
|
303
|
+
include Aws::Structure
|
304
|
+
end
|
305
|
+
|
306
|
+
# @!attribute [rw] export_tasks
|
307
|
+
# The export tasks.
|
308
|
+
# @return [Array<Types::ExportTask>]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] next_token
|
311
|
+
# The token for the next set of items to return. The token expires
|
312
|
+
# after 24 hours.
|
313
|
+
# @return [String]
|
314
|
+
class DescribeExportTasksResponse < Struct.new(
|
315
|
+
:export_tasks,
|
316
|
+
:next_token)
|
317
|
+
include Aws::Structure
|
318
|
+
end
|
319
|
+
|
320
|
+
# @note When making an API call, pass DescribeLogGroupsRequest
|
321
|
+
# data as a hash:
|
322
|
+
#
|
323
|
+
# {
|
324
|
+
# log_group_name_prefix: "LogGroupName",
|
325
|
+
# next_token: "NextToken",
|
326
|
+
# limit: 1,
|
327
|
+
# }
|
328
|
+
# @!attribute [rw] log_group_name_prefix
|
329
|
+
# The prefix to match.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] next_token
|
333
|
+
# The token for the next set of items to return. (You received this
|
334
|
+
# token from a previous call.)
|
335
|
+
# @return [String]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] limit
|
338
|
+
# The maximum number of items returned. If you don't specify a value,
|
339
|
+
# the default is up to 50 items.
|
340
|
+
# @return [Integer]
|
341
|
+
class DescribeLogGroupsRequest < Struct.new(
|
342
|
+
:log_group_name_prefix,
|
343
|
+
:next_token,
|
344
|
+
:limit)
|
345
|
+
include Aws::Structure
|
346
|
+
end
|
347
|
+
|
348
|
+
# @!attribute [rw] log_groups
|
349
|
+
# The log groups.
|
350
|
+
# @return [Array<Types::LogGroup>]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] next_token
|
353
|
+
# The token for the next set of items to return. The token expires
|
354
|
+
# after 24 hours.
|
355
|
+
# @return [String]
|
356
|
+
class DescribeLogGroupsResponse < Struct.new(
|
357
|
+
:log_groups,
|
358
|
+
:next_token)
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
362
|
+
# @note When making an API call, pass DescribeLogStreamsRequest
|
363
|
+
# data as a hash:
|
364
|
+
#
|
365
|
+
# {
|
366
|
+
# log_group_name: "LogGroupName", # required
|
367
|
+
# log_stream_name_prefix: "LogStreamName",
|
368
|
+
# order_by: "LogStreamName", # accepts LogStreamName, LastEventTime
|
369
|
+
# descending: false,
|
370
|
+
# next_token: "NextToken",
|
371
|
+
# limit: 1,
|
372
|
+
# }
|
373
|
+
# @!attribute [rw] log_group_name
|
374
|
+
# The name of the log group.
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @!attribute [rw] log_stream_name_prefix
|
378
|
+
# The prefix to match.
|
379
|
+
#
|
380
|
+
# You cannot specify this parameter if `orderBy` is `LastEventTime`.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] order_by
|
384
|
+
# If the value is `LogStreamName`, the results are ordered by log
|
385
|
+
# stream name. If the value is `LastEventTime`, the results are
|
386
|
+
# ordered by the event time. The default value is `LogStreamName`.
|
387
|
+
#
|
388
|
+
# If you order the results by event time, you cannot specify the
|
389
|
+
# `logStreamNamePrefix` parameter.
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] descending
|
393
|
+
# If the value is true, results are returned in descending order. If
|
394
|
+
# the value is to false, results are returned in ascending order. The
|
395
|
+
# default value is false.
|
396
|
+
# @return [Boolean]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] next_token
|
399
|
+
# The token for the next set of items to return. (You received this
|
400
|
+
# token from a previous call.)
|
401
|
+
# @return [String]
|
402
|
+
#
|
403
|
+
# @!attribute [rw] limit
|
404
|
+
# The maximum number of items returned. If you don't specify a value,
|
405
|
+
# the default is up to 50 items.
|
406
|
+
# @return [Integer]
|
407
|
+
class DescribeLogStreamsRequest < Struct.new(
|
408
|
+
:log_group_name,
|
409
|
+
:log_stream_name_prefix,
|
410
|
+
:order_by,
|
411
|
+
:descending,
|
412
|
+
:next_token,
|
413
|
+
:limit)
|
414
|
+
include Aws::Structure
|
415
|
+
end
|
416
|
+
|
417
|
+
# @!attribute [rw] log_streams
|
418
|
+
# The log streams.
|
419
|
+
# @return [Array<Types::LogStream>]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] next_token
|
422
|
+
# The token for the next set of items to return. The token expires
|
423
|
+
# after 24 hours.
|
424
|
+
# @return [String]
|
425
|
+
class DescribeLogStreamsResponse < Struct.new(
|
426
|
+
:log_streams,
|
427
|
+
:next_token)
|
428
|
+
include Aws::Structure
|
429
|
+
end
|
430
|
+
|
431
|
+
# @note When making an API call, pass DescribeMetricFiltersRequest
|
432
|
+
# data as a hash:
|
433
|
+
#
|
434
|
+
# {
|
435
|
+
# log_group_name: "LogGroupName",
|
436
|
+
# filter_name_prefix: "FilterName",
|
437
|
+
# next_token: "NextToken",
|
438
|
+
# limit: 1,
|
439
|
+
# metric_name: "MetricName",
|
440
|
+
# metric_namespace: "MetricNamespace",
|
441
|
+
# }
|
442
|
+
# @!attribute [rw] log_group_name
|
443
|
+
# The name of the log group.
|
444
|
+
# @return [String]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] filter_name_prefix
|
447
|
+
# The prefix to match.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] next_token
|
451
|
+
# The token for the next set of items to return. (You received this
|
452
|
+
# token from a previous call.)
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] limit
|
456
|
+
# The maximum number of items returned. If you don't specify a value,
|
457
|
+
# the default is up to 50 items.
|
458
|
+
# @return [Integer]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] metric_name
|
461
|
+
# The name of the CloudWatch metric.
|
462
|
+
# @return [String]
|
463
|
+
#
|
464
|
+
# @!attribute [rw] metric_namespace
|
465
|
+
# The namespace of the CloudWatch metric.
|
466
|
+
# @return [String]
|
467
|
+
class DescribeMetricFiltersRequest < Struct.new(
|
468
|
+
:log_group_name,
|
469
|
+
:filter_name_prefix,
|
470
|
+
:next_token,
|
471
|
+
:limit,
|
472
|
+
:metric_name,
|
473
|
+
:metric_namespace)
|
474
|
+
include Aws::Structure
|
475
|
+
end
|
476
|
+
|
477
|
+
# @!attribute [rw] metric_filters
|
478
|
+
# The metric filters.
|
479
|
+
# @return [Array<Types::MetricFilter>]
|
480
|
+
#
|
481
|
+
# @!attribute [rw] next_token
|
482
|
+
# The token for the next set of items to return. The token expires
|
483
|
+
# after 24 hours.
|
484
|
+
# @return [String]
|
485
|
+
class DescribeMetricFiltersResponse < Struct.new(
|
486
|
+
:metric_filters,
|
487
|
+
:next_token)
|
488
|
+
include Aws::Structure
|
489
|
+
end
|
490
|
+
|
491
|
+
# @note When making an API call, pass DescribeSubscriptionFiltersRequest
|
492
|
+
# data as a hash:
|
493
|
+
#
|
494
|
+
# {
|
495
|
+
# log_group_name: "LogGroupName", # required
|
496
|
+
# filter_name_prefix: "FilterName",
|
497
|
+
# next_token: "NextToken",
|
498
|
+
# limit: 1,
|
499
|
+
# }
|
500
|
+
# @!attribute [rw] log_group_name
|
501
|
+
# The name of the log group.
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] filter_name_prefix
|
505
|
+
# The prefix to match. If you don't specify a value, no prefix filter
|
506
|
+
# is applied.
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] next_token
|
510
|
+
# The token for the next set of items to return. (You received this
|
511
|
+
# token from a previous call.)
|
512
|
+
# @return [String]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] limit
|
515
|
+
# The maximum number of items returned. If you don't specify a value,
|
516
|
+
# the default is up to 50 items.
|
517
|
+
# @return [Integer]
|
518
|
+
class DescribeSubscriptionFiltersRequest < Struct.new(
|
519
|
+
:log_group_name,
|
520
|
+
:filter_name_prefix,
|
521
|
+
:next_token,
|
522
|
+
:limit)
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
526
|
+
# @!attribute [rw] subscription_filters
|
527
|
+
# The subscription filters.
|
528
|
+
# @return [Array<Types::SubscriptionFilter>]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] next_token
|
531
|
+
# The token for the next set of items to return. The token expires
|
532
|
+
# after 24 hours.
|
533
|
+
# @return [String]
|
534
|
+
class DescribeSubscriptionFiltersResponse < Struct.new(
|
535
|
+
:subscription_filters,
|
536
|
+
:next_token)
|
537
|
+
include Aws::Structure
|
538
|
+
end
|
539
|
+
|
540
|
+
# Represents a cross-account destination that receives subscription log
|
541
|
+
# events.
|
542
|
+
# @!attribute [rw] destination_name
|
543
|
+
# The name of the destination.
|
544
|
+
# @return [String]
|
545
|
+
#
|
546
|
+
# @!attribute [rw] target_arn
|
547
|
+
# The Amazon Resource Name (ARN) of the physical target where the log
|
548
|
+
# events will be delivered (for example, a Kinesis stream).
|
549
|
+
# @return [String]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] role_arn
|
552
|
+
# A role for impersonation, used when delivering log events to the
|
553
|
+
# target.
|
554
|
+
# @return [String]
|
555
|
+
#
|
556
|
+
# @!attribute [rw] access_policy
|
557
|
+
# An IAM policy document that governs which AWS accounts can create
|
558
|
+
# subscription filters against this destination.
|
559
|
+
# @return [String]
|
560
|
+
#
|
561
|
+
# @!attribute [rw] arn
|
562
|
+
# The ARN of this destination.
|
563
|
+
# @return [String]
|
564
|
+
#
|
565
|
+
# @!attribute [rw] creation_time
|
566
|
+
# The creation time of the destination.
|
567
|
+
# @return [Integer]
|
568
|
+
class Destination < Struct.new(
|
569
|
+
:destination_name,
|
570
|
+
:target_arn,
|
571
|
+
:role_arn,
|
572
|
+
:access_policy,
|
573
|
+
:arn,
|
574
|
+
:creation_time)
|
575
|
+
include Aws::Structure
|
576
|
+
end
|
577
|
+
|
578
|
+
# Represents an export task.
|
579
|
+
# @!attribute [rw] task_id
|
580
|
+
# The ID of the export task.
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] task_name
|
584
|
+
# The name of the export task.
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] log_group_name
|
588
|
+
# The name of the log group from which logs data was exported.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] from
|
592
|
+
# The start time. Events with a timestamp prior to this time are not
|
593
|
+
# exported.
|
594
|
+
# @return [Integer]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] to
|
597
|
+
# The end time. Events with a timestamp later than this time are not
|
598
|
+
# exported.
|
599
|
+
# @return [Integer]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] destination
|
602
|
+
# The name of Amazon S3 bucket to which the log data was exported.
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] destination_prefix
|
606
|
+
# The prefix that was used as the start of Amazon S3 key for every
|
607
|
+
# object exported.
|
608
|
+
# @return [String]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] status
|
611
|
+
# The status of the export task.
|
612
|
+
# @return [Types::ExportTaskStatus]
|
613
|
+
#
|
614
|
+
# @!attribute [rw] execution_info
|
615
|
+
# Execution info about the export task.
|
616
|
+
# @return [Types::ExportTaskExecutionInfo]
|
617
|
+
class ExportTask < Struct.new(
|
618
|
+
:task_id,
|
619
|
+
:task_name,
|
620
|
+
:log_group_name,
|
621
|
+
:from,
|
622
|
+
:to,
|
623
|
+
:destination,
|
624
|
+
:destination_prefix,
|
625
|
+
:status,
|
626
|
+
:execution_info)
|
627
|
+
include Aws::Structure
|
628
|
+
end
|
629
|
+
|
630
|
+
# Represents the status of an export task.
|
631
|
+
# @!attribute [rw] creation_time
|
632
|
+
# The creation time of the export task.
|
633
|
+
# @return [Integer]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] completion_time
|
636
|
+
# The completion time of the export task.
|
637
|
+
# @return [Integer]
|
638
|
+
class ExportTaskExecutionInfo < Struct.new(
|
639
|
+
:creation_time,
|
640
|
+
:completion_time)
|
641
|
+
include Aws::Structure
|
642
|
+
end
|
643
|
+
|
644
|
+
# Represents the status of an export task.
|
645
|
+
# @!attribute [rw] code
|
646
|
+
# The status code of the export task.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
|
+
# @!attribute [rw] message
|
650
|
+
# The status message related to the status code.
|
651
|
+
# @return [String]
|
652
|
+
class ExportTaskStatus < Struct.new(
|
653
|
+
:code,
|
654
|
+
:message)
|
655
|
+
include Aws::Structure
|
656
|
+
end
|
657
|
+
|
658
|
+
# @note When making an API call, pass FilterLogEventsRequest
|
659
|
+
# data as a hash:
|
660
|
+
#
|
661
|
+
# {
|
662
|
+
# log_group_name: "LogGroupName", # required
|
663
|
+
# log_stream_names: ["LogStreamName"],
|
664
|
+
# start_time: 1,
|
665
|
+
# end_time: 1,
|
666
|
+
# filter_pattern: "FilterPattern",
|
667
|
+
# next_token: "NextToken",
|
668
|
+
# limit: 1,
|
669
|
+
# interleaved: false,
|
670
|
+
# }
|
671
|
+
# @!attribute [rw] log_group_name
|
672
|
+
# The name of the log group.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] log_stream_names
|
676
|
+
# Optional list of log stream names.
|
677
|
+
# @return [Array<String>]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] start_time
|
680
|
+
# The start of the time range. Events with a timestamp prior to this
|
681
|
+
# time are not returned.
|
682
|
+
# @return [Integer]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] end_time
|
685
|
+
# The end of the time range. Events with a timestamp later than this
|
686
|
+
# time are not returned.
|
687
|
+
# @return [Integer]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] filter_pattern
|
690
|
+
# The filter pattern to use. If not provided, all the events are
|
691
|
+
# matched.
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] next_token
|
695
|
+
# The token for the next set of events to return. (You received this
|
696
|
+
# token from a previous call.)
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] limit
|
700
|
+
# The maximum number of events to return. The default is 10,000
|
701
|
+
# events.
|
702
|
+
# @return [Integer]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] interleaved
|
705
|
+
# If the value is true, the operation makes a best effort to provide
|
706
|
+
# responses that contain events from multiple log streams within the
|
707
|
+
# log group interleaved in a single response. If the value is false
|
708
|
+
# all the matched log events in the first log stream are searched
|
709
|
+
# first, then those in the next log stream, and so on. The default is
|
710
|
+
# false.
|
711
|
+
# @return [Boolean]
|
712
|
+
class FilterLogEventsRequest < Struct.new(
|
713
|
+
:log_group_name,
|
714
|
+
:log_stream_names,
|
715
|
+
:start_time,
|
716
|
+
:end_time,
|
717
|
+
:filter_pattern,
|
718
|
+
:next_token,
|
719
|
+
:limit,
|
720
|
+
:interleaved)
|
721
|
+
include Aws::Structure
|
722
|
+
end
|
723
|
+
|
724
|
+
# @!attribute [rw] events
|
725
|
+
# The matched events.
|
726
|
+
# @return [Array<Types::FilteredLogEvent>]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] searched_log_streams
|
729
|
+
# Indicates which log streams have been searched and whether each has
|
730
|
+
# been searched completely.
|
731
|
+
# @return [Array<Types::SearchedLogStream>]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] next_token
|
734
|
+
# The token to use when requesting the next set of items. The token
|
735
|
+
# expires after 24 hours.
|
736
|
+
# @return [String]
|
737
|
+
class FilterLogEventsResponse < Struct.new(
|
738
|
+
:events,
|
739
|
+
:searched_log_streams,
|
740
|
+
:next_token)
|
741
|
+
include Aws::Structure
|
742
|
+
end
|
743
|
+
|
744
|
+
# Represents a matched event.
|
745
|
+
# @!attribute [rw] log_stream_name
|
746
|
+
# The name of the log stream this event belongs to.
|
747
|
+
# @return [String]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] timestamp
|
750
|
+
# The time the event occurred.
|
751
|
+
# @return [Integer]
|
752
|
+
#
|
753
|
+
# @!attribute [rw] message
|
754
|
+
# The data contained in the log event.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] ingestion_time
|
758
|
+
# The time the event was ingested.
|
759
|
+
# @return [Integer]
|
760
|
+
#
|
761
|
+
# @!attribute [rw] event_id
|
762
|
+
# The ID of the event.
|
763
|
+
# @return [String]
|
764
|
+
class FilteredLogEvent < Struct.new(
|
765
|
+
:log_stream_name,
|
766
|
+
:timestamp,
|
767
|
+
:message,
|
768
|
+
:ingestion_time,
|
769
|
+
:event_id)
|
770
|
+
include Aws::Structure
|
771
|
+
end
|
772
|
+
|
773
|
+
# @note When making an API call, pass GetLogEventsRequest
|
774
|
+
# data as a hash:
|
775
|
+
#
|
776
|
+
# {
|
777
|
+
# log_group_name: "LogGroupName", # required
|
778
|
+
# log_stream_name: "LogStreamName", # required
|
779
|
+
# start_time: 1,
|
780
|
+
# end_time: 1,
|
781
|
+
# next_token: "NextToken",
|
782
|
+
# limit: 1,
|
783
|
+
# start_from_head: false,
|
784
|
+
# }
|
785
|
+
# @!attribute [rw] log_group_name
|
786
|
+
# The name of the log group.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] log_stream_name
|
790
|
+
# The name of the log stream.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @!attribute [rw] start_time
|
794
|
+
# The start of the time range. Events with a timestamp earlier than
|
795
|
+
# this time are not included.
|
796
|
+
# @return [Integer]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] end_time
|
799
|
+
# The end of the time range. Events with a timestamp later than this
|
800
|
+
# time are not included.
|
801
|
+
# @return [Integer]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] next_token
|
804
|
+
# The token for the next set of items to return. (You received this
|
805
|
+
# token from a previous call.)
|
806
|
+
# @return [String]
|
807
|
+
#
|
808
|
+
# @!attribute [rw] limit
|
809
|
+
# The maximum number of log events returned. If you don't specify a
|
810
|
+
# value, the maximum is as many log events as can fit in a response
|
811
|
+
# size of 1MB, up to 10,000 log events.
|
812
|
+
# @return [Integer]
|
813
|
+
#
|
814
|
+
# @!attribute [rw] start_from_head
|
815
|
+
# If the value is true, the earliest log events are returned first. If
|
816
|
+
# the value is false, the latest log events are returned first. The
|
817
|
+
# default value is false.
|
818
|
+
# @return [Boolean]
|
819
|
+
class GetLogEventsRequest < Struct.new(
|
820
|
+
:log_group_name,
|
821
|
+
:log_stream_name,
|
822
|
+
:start_time,
|
823
|
+
:end_time,
|
824
|
+
:next_token,
|
825
|
+
:limit,
|
826
|
+
:start_from_head)
|
827
|
+
include Aws::Structure
|
828
|
+
end
|
829
|
+
|
830
|
+
# @!attribute [rw] events
|
831
|
+
# The events.
|
832
|
+
# @return [Array<Types::OutputLogEvent>]
|
833
|
+
#
|
834
|
+
# @!attribute [rw] next_forward_token
|
835
|
+
# The token for the next set of items in the forward direction. The
|
836
|
+
# token expires after 24 hours.
|
837
|
+
# @return [String]
|
838
|
+
#
|
839
|
+
# @!attribute [rw] next_backward_token
|
840
|
+
# The token for the next set of items in the backward direction. The
|
841
|
+
# token expires after 24 hours.
|
842
|
+
# @return [String]
|
843
|
+
class GetLogEventsResponse < Struct.new(
|
844
|
+
:events,
|
845
|
+
:next_forward_token,
|
846
|
+
:next_backward_token)
|
847
|
+
include Aws::Structure
|
848
|
+
end
|
849
|
+
|
850
|
+
# Represents a log event, which is a record of activity that was
|
851
|
+
# recorded by the application or resource being monitored.
|
852
|
+
# @note When making an API call, pass InputLogEvent
|
853
|
+
# data as a hash:
|
854
|
+
#
|
855
|
+
# {
|
856
|
+
# timestamp: 1, # required
|
857
|
+
# message: "EventMessage", # required
|
858
|
+
# }
|
859
|
+
# @!attribute [rw] timestamp
|
860
|
+
# The time the event occurred.
|
861
|
+
# @return [Integer]
|
862
|
+
#
|
863
|
+
# @!attribute [rw] message
|
864
|
+
# The raw event message.
|
865
|
+
# @return [String]
|
866
|
+
class InputLogEvent < Struct.new(
|
867
|
+
:timestamp,
|
868
|
+
:message)
|
869
|
+
include Aws::Structure
|
870
|
+
end
|
871
|
+
|
872
|
+
# Represents a log group.
|
873
|
+
# @!attribute [rw] log_group_name
|
874
|
+
# The name of the log group.
|
875
|
+
# @return [String]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] creation_time
|
878
|
+
# The creation time of the log group.
|
879
|
+
# @return [Integer]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] retention_in_days
|
882
|
+
# The number of days to retain the log events in the specified log
|
883
|
+
# group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150,
|
884
|
+
# 180, 365, 400, 545, 731, 1827, and 3653.
|
885
|
+
# @return [Integer]
|
886
|
+
#
|
887
|
+
# @!attribute [rw] metric_filter_count
|
888
|
+
# The number of metric filters.
|
889
|
+
# @return [Integer]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] arn
|
892
|
+
# The Amazon Resource Name (ARN) of the log group.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] stored_bytes
|
896
|
+
# The number of bytes stored.
|
897
|
+
# @return [Integer]
|
898
|
+
class LogGroup < Struct.new(
|
899
|
+
:log_group_name,
|
900
|
+
:creation_time,
|
901
|
+
:retention_in_days,
|
902
|
+
:metric_filter_count,
|
903
|
+
:arn,
|
904
|
+
:stored_bytes)
|
905
|
+
include Aws::Structure
|
906
|
+
end
|
907
|
+
|
908
|
+
# Represents a log stream, which is a sequence of log events from a
|
909
|
+
# single emitter of logs.
|
910
|
+
# @!attribute [rw] log_stream_name
|
911
|
+
# The name of the log stream.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] creation_time
|
915
|
+
# The creation time of the stream.
|
916
|
+
# @return [Integer]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] first_event_timestamp
|
919
|
+
# The time of the first event.
|
920
|
+
# @return [Integer]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] last_event_timestamp
|
923
|
+
# The time of the last event.
|
924
|
+
# @return [Integer]
|
925
|
+
#
|
926
|
+
# @!attribute [rw] last_ingestion_time
|
927
|
+
# The ingestion time.
|
928
|
+
# @return [Integer]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] upload_sequence_token
|
931
|
+
# The sequence token.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] arn
|
935
|
+
# The Amazon Resource Name (ARN) of the log stream.
|
936
|
+
# @return [String]
|
937
|
+
#
|
938
|
+
# @!attribute [rw] stored_bytes
|
939
|
+
# The number of bytes stored.
|
940
|
+
# @return [Integer]
|
941
|
+
class LogStream < Struct.new(
|
942
|
+
:log_stream_name,
|
943
|
+
:creation_time,
|
944
|
+
:first_event_timestamp,
|
945
|
+
:last_event_timestamp,
|
946
|
+
:last_ingestion_time,
|
947
|
+
:upload_sequence_token,
|
948
|
+
:arn,
|
949
|
+
:stored_bytes)
|
950
|
+
include Aws::Structure
|
951
|
+
end
|
952
|
+
|
953
|
+
# Metric filters express how CloudWatch Logs would extract metric
|
954
|
+
# observations from ingested log events and transform them into metric
|
955
|
+
# data in a CloudWatch metric.
|
956
|
+
# @!attribute [rw] filter_name
|
957
|
+
# The name of the metric filter.
|
958
|
+
# @return [String]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] filter_pattern
|
961
|
+
# A symbolic description of how CloudWatch Logs should interpret the
|
962
|
+
# data in each log event. For example, a log event may contain
|
963
|
+
# timestamps, IP addresses, strings, and so on. You use the filter
|
964
|
+
# pattern to specify what to look for in the log event message.
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] metric_transformations
|
968
|
+
# The metric transformations.
|
969
|
+
# @return [Array<Types::MetricTransformation>]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] creation_time
|
972
|
+
# The creation time of the metric filter.
|
973
|
+
# @return [Integer]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] log_group_name
|
976
|
+
# The name of the log group.
|
977
|
+
# @return [String]
|
978
|
+
class MetricFilter < Struct.new(
|
979
|
+
:filter_name,
|
980
|
+
:filter_pattern,
|
981
|
+
:metric_transformations,
|
982
|
+
:creation_time,
|
983
|
+
:log_group_name)
|
984
|
+
include Aws::Structure
|
985
|
+
end
|
986
|
+
|
987
|
+
# Represents a matched event.
|
988
|
+
# @!attribute [rw] event_number
|
989
|
+
# The event number.
|
990
|
+
# @return [Integer]
|
991
|
+
#
|
992
|
+
# @!attribute [rw] event_message
|
993
|
+
# The raw event data.
|
994
|
+
# @return [String]
|
995
|
+
#
|
996
|
+
# @!attribute [rw] extracted_values
|
997
|
+
# The values extracted from the event data by the filter.
|
998
|
+
# @return [Hash<String,String>]
|
999
|
+
class MetricFilterMatchRecord < Struct.new(
|
1000
|
+
:event_number,
|
1001
|
+
:event_message,
|
1002
|
+
:extracted_values)
|
1003
|
+
include Aws::Structure
|
1004
|
+
end
|
1005
|
+
|
1006
|
+
# Indicates how to transform ingested log events into metric data in a
|
1007
|
+
# CloudWatch metric.
|
1008
|
+
# @note When making an API call, pass MetricTransformation
|
1009
|
+
# data as a hash:
|
1010
|
+
#
|
1011
|
+
# {
|
1012
|
+
# metric_name: "MetricName", # required
|
1013
|
+
# metric_namespace: "MetricNamespace", # required
|
1014
|
+
# metric_value: "MetricValue", # required
|
1015
|
+
# default_value: 1.0,
|
1016
|
+
# }
|
1017
|
+
# @!attribute [rw] metric_name
|
1018
|
+
# The name of the CloudWatch metric.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] metric_namespace
|
1022
|
+
# The namespace of the CloudWatch metric.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] metric_value
|
1026
|
+
# The value to publish to the CloudWatch metric when a filter pattern
|
1027
|
+
# matches a log event.
|
1028
|
+
# @return [String]
|
1029
|
+
#
|
1030
|
+
# @!attribute [rw] default_value
|
1031
|
+
# (Optional) The value to emit when a filter pattern does not match a
|
1032
|
+
# log event. This value can be null.
|
1033
|
+
# @return [Float]
|
1034
|
+
class MetricTransformation < Struct.new(
|
1035
|
+
:metric_name,
|
1036
|
+
:metric_namespace,
|
1037
|
+
:metric_value,
|
1038
|
+
:default_value)
|
1039
|
+
include Aws::Structure
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
# Represents a log event.
|
1043
|
+
# @!attribute [rw] timestamp
|
1044
|
+
# The time the event occurred.
|
1045
|
+
# @return [Integer]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] message
|
1048
|
+
# The data contained in the log event.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] ingestion_time
|
1052
|
+
# The time the event was ingested.
|
1053
|
+
# @return [Integer]
|
1054
|
+
class OutputLogEvent < Struct.new(
|
1055
|
+
:timestamp,
|
1056
|
+
:message,
|
1057
|
+
:ingestion_time)
|
1058
|
+
include Aws::Structure
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# @note When making an API call, pass PutDestinationPolicyRequest
|
1062
|
+
# data as a hash:
|
1063
|
+
#
|
1064
|
+
# {
|
1065
|
+
# destination_name: "DestinationName", # required
|
1066
|
+
# access_policy: "AccessPolicy", # required
|
1067
|
+
# }
|
1068
|
+
# @!attribute [rw] destination_name
|
1069
|
+
# A name for an existing destination.
|
1070
|
+
# @return [String]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] access_policy
|
1073
|
+
# An IAM policy document that authorizes cross-account users to
|
1074
|
+
# deliver their log events to the associated destination.
|
1075
|
+
# @return [String]
|
1076
|
+
class PutDestinationPolicyRequest < Struct.new(
|
1077
|
+
:destination_name,
|
1078
|
+
:access_policy)
|
1079
|
+
include Aws::Structure
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# @note When making an API call, pass PutDestinationRequest
|
1083
|
+
# data as a hash:
|
1084
|
+
#
|
1085
|
+
# {
|
1086
|
+
# destination_name: "DestinationName", # required
|
1087
|
+
# target_arn: "TargetArn", # required
|
1088
|
+
# role_arn: "RoleArn", # required
|
1089
|
+
# }
|
1090
|
+
# @!attribute [rw] destination_name
|
1091
|
+
# A name for the destination.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] target_arn
|
1095
|
+
# The ARN of an Amazon Kinesis stream to deliver matching log events
|
1096
|
+
# to.
|
1097
|
+
# @return [String]
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] role_arn
|
1100
|
+
# The ARN of an IAM role that grants CloudWatch Logs permissions to
|
1101
|
+
# call Amazon Kinesis PutRecord on the destination stream.
|
1102
|
+
# @return [String]
|
1103
|
+
class PutDestinationRequest < Struct.new(
|
1104
|
+
:destination_name,
|
1105
|
+
:target_arn,
|
1106
|
+
:role_arn)
|
1107
|
+
include Aws::Structure
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
# @!attribute [rw] destination
|
1111
|
+
# The destination.
|
1112
|
+
# @return [Types::Destination]
|
1113
|
+
class PutDestinationResponse < Struct.new(
|
1114
|
+
:destination)
|
1115
|
+
include Aws::Structure
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
# @note When making an API call, pass PutLogEventsRequest
|
1119
|
+
# data as a hash:
|
1120
|
+
#
|
1121
|
+
# {
|
1122
|
+
# log_group_name: "LogGroupName", # required
|
1123
|
+
# log_stream_name: "LogStreamName", # required
|
1124
|
+
# log_events: [ # required
|
1125
|
+
# {
|
1126
|
+
# timestamp: 1, # required
|
1127
|
+
# message: "EventMessage", # required
|
1128
|
+
# },
|
1129
|
+
# ],
|
1130
|
+
# sequence_token: "SequenceToken",
|
1131
|
+
# }
|
1132
|
+
# @!attribute [rw] log_group_name
|
1133
|
+
# The name of the log group.
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] log_stream_name
|
1137
|
+
# The name of the log stream.
|
1138
|
+
# @return [String]
|
1139
|
+
#
|
1140
|
+
# @!attribute [rw] log_events
|
1141
|
+
# The log events.
|
1142
|
+
# @return [Array<Types::InputLogEvent>]
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] sequence_token
|
1145
|
+
# The sequence token.
|
1146
|
+
# @return [String]
|
1147
|
+
class PutLogEventsRequest < Struct.new(
|
1148
|
+
:log_group_name,
|
1149
|
+
:log_stream_name,
|
1150
|
+
:log_events,
|
1151
|
+
:sequence_token)
|
1152
|
+
include Aws::Structure
|
1153
|
+
end
|
1154
|
+
|
1155
|
+
# @!attribute [rw] next_sequence_token
|
1156
|
+
# The next sequence token.
|
1157
|
+
# @return [String]
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] rejected_log_events_info
|
1160
|
+
# The rejected events.
|
1161
|
+
# @return [Types::RejectedLogEventsInfo]
|
1162
|
+
class PutLogEventsResponse < Struct.new(
|
1163
|
+
:next_sequence_token,
|
1164
|
+
:rejected_log_events_info)
|
1165
|
+
include Aws::Structure
|
1166
|
+
end
|
1167
|
+
|
1168
|
+
# @note When making an API call, pass PutMetricFilterRequest
|
1169
|
+
# data as a hash:
|
1170
|
+
#
|
1171
|
+
# {
|
1172
|
+
# log_group_name: "LogGroupName", # required
|
1173
|
+
# filter_name: "FilterName", # required
|
1174
|
+
# filter_pattern: "FilterPattern", # required
|
1175
|
+
# metric_transformations: [ # required
|
1176
|
+
# {
|
1177
|
+
# metric_name: "MetricName", # required
|
1178
|
+
# metric_namespace: "MetricNamespace", # required
|
1179
|
+
# metric_value: "MetricValue", # required
|
1180
|
+
# default_value: 1.0,
|
1181
|
+
# },
|
1182
|
+
# ],
|
1183
|
+
# }
|
1184
|
+
# @!attribute [rw] log_group_name
|
1185
|
+
# The name of the log group.
|
1186
|
+
# @return [String]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] filter_name
|
1189
|
+
# A name for the metric filter.
|
1190
|
+
# @return [String]
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] filter_pattern
|
1193
|
+
# A filter pattern for extracting metric data out of ingested log
|
1194
|
+
# events.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] metric_transformations
|
1198
|
+
# A collection of information needed to define how metric data gets
|
1199
|
+
# emitted.
|
1200
|
+
# @return [Array<Types::MetricTransformation>]
|
1201
|
+
class PutMetricFilterRequest < Struct.new(
|
1202
|
+
:log_group_name,
|
1203
|
+
:filter_name,
|
1204
|
+
:filter_pattern,
|
1205
|
+
:metric_transformations)
|
1206
|
+
include Aws::Structure
|
1207
|
+
end
|
1208
|
+
|
1209
|
+
# @note When making an API call, pass PutRetentionPolicyRequest
|
1210
|
+
# data as a hash:
|
1211
|
+
#
|
1212
|
+
# {
|
1213
|
+
# log_group_name: "LogGroupName", # required
|
1214
|
+
# retention_in_days: 1, # required
|
1215
|
+
# }
|
1216
|
+
# @!attribute [rw] log_group_name
|
1217
|
+
# The name of the log group.
|
1218
|
+
# @return [String]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] retention_in_days
|
1221
|
+
# The number of days to retain the log events in the specified log
|
1222
|
+
# group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150,
|
1223
|
+
# 180, 365, 400, 545, 731, 1827, and 3653.
|
1224
|
+
# @return [Integer]
|
1225
|
+
class PutRetentionPolicyRequest < Struct.new(
|
1226
|
+
:log_group_name,
|
1227
|
+
:retention_in_days)
|
1228
|
+
include Aws::Structure
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# @note When making an API call, pass PutSubscriptionFilterRequest
|
1232
|
+
# data as a hash:
|
1233
|
+
#
|
1234
|
+
# {
|
1235
|
+
# log_group_name: "LogGroupName", # required
|
1236
|
+
# filter_name: "FilterName", # required
|
1237
|
+
# filter_pattern: "FilterPattern", # required
|
1238
|
+
# destination_arn: "DestinationArn", # required
|
1239
|
+
# role_arn: "RoleArn",
|
1240
|
+
# }
|
1241
|
+
# @!attribute [rw] log_group_name
|
1242
|
+
# The name of the log group.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] filter_name
|
1246
|
+
# A name for the subscription filter.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] filter_pattern
|
1250
|
+
# A filter pattern for subscribing to a filtered stream of log events.
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] destination_arn
|
1254
|
+
# The ARN of the destination to deliver matching log events to.
|
1255
|
+
# Currently, the supported destinations are:
|
1256
|
+
#
|
1257
|
+
# * An Amazon Kinesis stream belonging to the same account as the
|
1258
|
+
# subscription filter, for same-account delivery.
|
1259
|
+
#
|
1260
|
+
# * A logical destination (specified using an ARN) belonging to a
|
1261
|
+
# different account, for cross-account delivery.
|
1262
|
+
#
|
1263
|
+
# * An Amazon Kinesis Firehose stream belonging to the same account as
|
1264
|
+
# the subscription filter, for same-account delivery.
|
1265
|
+
#
|
1266
|
+
# * An AWS Lambda function belonging to the same account as the
|
1267
|
+
# subscription filter, for same-account delivery.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] role_arn
|
1271
|
+
# The ARN of an IAM role that grants CloudWatch Logs permissions to
|
1272
|
+
# deliver ingested log events to the destination stream. You don't
|
1273
|
+
# need to provide the ARN when you are working with a logical
|
1274
|
+
# destination for cross-account delivery.
|
1275
|
+
# @return [String]
|
1276
|
+
class PutSubscriptionFilterRequest < Struct.new(
|
1277
|
+
:log_group_name,
|
1278
|
+
:filter_name,
|
1279
|
+
:filter_pattern,
|
1280
|
+
:destination_arn,
|
1281
|
+
:role_arn)
|
1282
|
+
include Aws::Structure
|
1283
|
+
end
|
1284
|
+
|
1285
|
+
# Represents the rejected events.
|
1286
|
+
# @!attribute [rw] too_new_log_event_start_index
|
1287
|
+
# The log events that are too new.
|
1288
|
+
# @return [Integer]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] too_old_log_event_end_index
|
1291
|
+
# The log events that are too old.
|
1292
|
+
# @return [Integer]
|
1293
|
+
#
|
1294
|
+
# @!attribute [rw] expired_log_event_end_index
|
1295
|
+
# The expired log events.
|
1296
|
+
# @return [Integer]
|
1297
|
+
class RejectedLogEventsInfo < Struct.new(
|
1298
|
+
:too_new_log_event_start_index,
|
1299
|
+
:too_old_log_event_end_index,
|
1300
|
+
:expired_log_event_end_index)
|
1301
|
+
include Aws::Structure
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Represents the search status of a log stream.
|
1305
|
+
# @!attribute [rw] log_stream_name
|
1306
|
+
# The name of the log stream.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] searched_completely
|
1310
|
+
# Indicates whether all the events in this log stream were searched.
|
1311
|
+
# @return [Boolean]
|
1312
|
+
class SearchedLogStream < Struct.new(
|
1313
|
+
:log_stream_name,
|
1314
|
+
:searched_completely)
|
1315
|
+
include Aws::Structure
|
1316
|
+
end
|
1317
|
+
|
1318
|
+
# Represents a subscription filter.
|
1319
|
+
# @!attribute [rw] filter_name
|
1320
|
+
# The name of the subscription filter.
|
1321
|
+
# @return [String]
|
1322
|
+
#
|
1323
|
+
# @!attribute [rw] log_group_name
|
1324
|
+
# The name of the log group.
|
1325
|
+
# @return [String]
|
1326
|
+
#
|
1327
|
+
# @!attribute [rw] filter_pattern
|
1328
|
+
# A symbolic description of how CloudWatch Logs should interpret the
|
1329
|
+
# data in each log event. For example, a log event may contain
|
1330
|
+
# timestamps, IP addresses, strings, and so on. You use the filter
|
1331
|
+
# pattern to specify what to look for in the log event message.
|
1332
|
+
# @return [String]
|
1333
|
+
#
|
1334
|
+
# @!attribute [rw] destination_arn
|
1335
|
+
# The Amazon Resource Name (ARN) of the destination.
|
1336
|
+
# @return [String]
|
1337
|
+
#
|
1338
|
+
# @!attribute [rw] role_arn
|
1339
|
+
# @return [String]
|
1340
|
+
#
|
1341
|
+
# @!attribute [rw] creation_time
|
1342
|
+
# The creation time of the subscription filter.
|
1343
|
+
# @return [Integer]
|
1344
|
+
class SubscriptionFilter < Struct.new(
|
1345
|
+
:filter_name,
|
1346
|
+
:log_group_name,
|
1347
|
+
:filter_pattern,
|
1348
|
+
:destination_arn,
|
1349
|
+
:role_arn,
|
1350
|
+
:creation_time)
|
1351
|
+
include Aws::Structure
|
1352
|
+
end
|
1353
|
+
|
1354
|
+
# @note When making an API call, pass TestMetricFilterRequest
|
1355
|
+
# data as a hash:
|
1356
|
+
#
|
1357
|
+
# {
|
1358
|
+
# filter_pattern: "FilterPattern", # required
|
1359
|
+
# log_event_messages: ["EventMessage"], # required
|
1360
|
+
# }
|
1361
|
+
# @!attribute [rw] filter_pattern
|
1362
|
+
# A symbolic description of how CloudWatch Logs should interpret the
|
1363
|
+
# data in each log event. For example, a log event may contain
|
1364
|
+
# timestamps, IP addresses, strings, and so on. You use the filter
|
1365
|
+
# pattern to specify what to look for in the log event message.
|
1366
|
+
# @return [String]
|
1367
|
+
#
|
1368
|
+
# @!attribute [rw] log_event_messages
|
1369
|
+
# The log event messages to test.
|
1370
|
+
# @return [Array<String>]
|
1371
|
+
class TestMetricFilterRequest < Struct.new(
|
1372
|
+
:filter_pattern,
|
1373
|
+
:log_event_messages)
|
1374
|
+
include Aws::Structure
|
1375
|
+
end
|
1376
|
+
|
1377
|
+
# @!attribute [rw] matches
|
1378
|
+
# The matched events.
|
1379
|
+
# @return [Array<Types::MetricFilterMatchRecord>]
|
1380
|
+
class TestMetricFilterResponse < Struct.new(
|
1381
|
+
:matches)
|
1382
|
+
include Aws::Structure
|
1383
|
+
end
|
1384
|
+
|
1385
|
+
end
|
1386
|
+
end
|
1387
|
+
end
|