aws-sdk-cloudwatchlogs 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- data/lib/aws-sdk-cloudwatchlogs/client.rb +290 -16
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +191 -0
- data/lib/aws-sdk-cloudwatchlogs/types.rb +440 -31
- metadata +2 -2
@@ -84,14 +84,14 @@ module Aws::CloudWatchLogs
|
|
84
84
|
#
|
85
85
|
# @!attribute [rw] from
|
86
86
|
# The start time of the range for the request, expressed as the number
|
87
|
-
# of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
|
88
|
-
#
|
87
|
+
# of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
|
88
|
+
# timestamp earlier than this time are not exported.
|
89
89
|
# @return [Integer]
|
90
90
|
#
|
91
91
|
# @!attribute [rw] to
|
92
92
|
# The end time of the range for the request, expressed as the number
|
93
|
-
# of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
|
94
|
-
#
|
93
|
+
# of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
|
94
|
+
# timestamp later than this time are not exported.
|
95
95
|
# @return [Integer]
|
96
96
|
#
|
97
97
|
# @!attribute [rw] destination
|
@@ -644,6 +644,63 @@ module Aws::CloudWatchLogs
|
|
644
644
|
include Aws::Structure
|
645
645
|
end
|
646
646
|
|
647
|
+
# @note When making an API call, you may pass DescribeQueriesRequest
|
648
|
+
# data as a hash:
|
649
|
+
#
|
650
|
+
# {
|
651
|
+
# log_group_name: "LogGroupName",
|
652
|
+
# status: "Scheduled", # accepts Scheduled, Running, Complete, Failed, Cancelled
|
653
|
+
# max_results: 1,
|
654
|
+
# next_token: "NextToken",
|
655
|
+
# }
|
656
|
+
#
|
657
|
+
# @!attribute [rw] log_group_name
|
658
|
+
# Limits the returned queries to only those for the specified log
|
659
|
+
# group.
|
660
|
+
# @return [String]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] status
|
663
|
+
# Limits the returned queries to only those that have the specified
|
664
|
+
# status. Valid values are `Cancelled`, `Complete`, `Failed`,
|
665
|
+
# `Running`, and `Scheduled`.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] max_results
|
669
|
+
# Limits the number of returned queries to the specified number.
|
670
|
+
# @return [Integer]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] next_token
|
673
|
+
# The token for the next set of items to return. The token expires
|
674
|
+
# after 24 hours.
|
675
|
+
# @return [String]
|
676
|
+
#
|
677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueriesRequest AWS API Documentation
|
678
|
+
#
|
679
|
+
class DescribeQueriesRequest < Struct.new(
|
680
|
+
:log_group_name,
|
681
|
+
:status,
|
682
|
+
:max_results,
|
683
|
+
:next_token)
|
684
|
+
include Aws::Structure
|
685
|
+
end
|
686
|
+
|
687
|
+
# @!attribute [rw] queries
|
688
|
+
# The list of queries that match the request.
|
689
|
+
# @return [Array<Types::QueryInfo>]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] next_token
|
692
|
+
# The token for the next set of items to return. The token expires
|
693
|
+
# after 24 hours.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueriesResponse AWS API Documentation
|
697
|
+
#
|
698
|
+
class DescribeQueriesResponse < Struct.new(
|
699
|
+
:queries,
|
700
|
+
:next_token)
|
701
|
+
include Aws::Structure
|
702
|
+
end
|
703
|
+
|
647
704
|
# @note When making an API call, you may pass DescribeResourcePoliciesRequest
|
648
705
|
# data as a hash:
|
649
706
|
#
|
@@ -820,13 +877,13 @@ module Aws::CloudWatchLogs
|
|
820
877
|
#
|
821
878
|
# @!attribute [rw] from
|
822
879
|
# The start time, expressed as the number of milliseconds after Jan 1,
|
823
|
-
# 1970 00:00:00 UTC. Events with a
|
880
|
+
# 1970 00:00:00 UTC. Events with a timestamp before this time are not
|
824
881
|
# exported.
|
825
882
|
# @return [Integer]
|
826
883
|
#
|
827
884
|
# @!attribute [rw] to
|
828
885
|
# The end time, expressed as the number of milliseconds after Jan 1,
|
829
|
-
# 1970 00:00:00 UTC. Events with a
|
886
|
+
# 1970 00:00:00 UTC. Events with a timestamp later than this time are
|
830
887
|
# not exported.
|
831
888
|
# @return [Integer]
|
832
889
|
#
|
@@ -923,9 +980,8 @@ module Aws::CloudWatchLogs
|
|
923
980
|
# Filters the results to only logs from the log streams in this list.
|
924
981
|
#
|
925
982
|
# If you specify a value for both `logStreamNamePrefix` and
|
926
|
-
# `logStreamNames`,
|
927
|
-
#
|
928
|
-
# returns an `InvalidParameterException` error.
|
983
|
+
# `logStreamNames`, the action returns an `InvalidParameterException`
|
984
|
+
# error.
|
929
985
|
# @return [Array<String>]
|
930
986
|
#
|
931
987
|
# @!attribute [rw] log_stream_name_prefix
|
@@ -940,13 +996,13 @@ module Aws::CloudWatchLogs
|
|
940
996
|
#
|
941
997
|
# @!attribute [rw] start_time
|
942
998
|
# The start of the time range, expressed as the number of milliseconds
|
943
|
-
# after Jan 1, 1970 00:00:00 UTC. Events with a
|
999
|
+
# after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this
|
944
1000
|
# time are not returned.
|
945
1001
|
# @return [Integer]
|
946
1002
|
#
|
947
1003
|
# @!attribute [rw] end_time
|
948
1004
|
# The end of the time range, expressed as the number of milliseconds
|
949
|
-
# after Jan 1, 1970 00:00:00 UTC. Events with a
|
1005
|
+
# after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than
|
950
1006
|
# this time are not returned.
|
951
1007
|
# @return [Integer]
|
952
1008
|
#
|
@@ -1021,7 +1077,7 @@ module Aws::CloudWatchLogs
|
|
1021
1077
|
# Represents a matched event.
|
1022
1078
|
#
|
1023
1079
|
# @!attribute [rw] log_stream_name
|
1024
|
-
# The name of the log stream this event belongs
|
1080
|
+
# The name of the log stream to which this event belongs.
|
1025
1081
|
# @return [String]
|
1026
1082
|
#
|
1027
1083
|
# @!attribute [rw] timestamp
|
@@ -1076,14 +1132,14 @@ module Aws::CloudWatchLogs
|
|
1076
1132
|
#
|
1077
1133
|
# @!attribute [rw] start_time
|
1078
1134
|
# The start of the time range, expressed as the number of milliseconds
|
1079
|
-
# after Jan 1, 1970 00:00:00 UTC. Events with a
|
1080
|
-
# this time or later than this time are included. Events with a
|
1081
|
-
#
|
1135
|
+
# after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to
|
1136
|
+
# this time or later than this time are included. Events with a
|
1137
|
+
# timestamp earlier than this time are not included.
|
1082
1138
|
# @return [Integer]
|
1083
1139
|
#
|
1084
1140
|
# @!attribute [rw] end_time
|
1085
1141
|
# The end of the time range, expressed as the number of milliseconds
|
1086
|
-
# after Jan 1, 1970 00:00:00 UTC. Events with a
|
1142
|
+
# after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or
|
1087
1143
|
# later than this time are not included.
|
1088
1144
|
# @return [Integer]
|
1089
1145
|
#
|
@@ -1143,6 +1199,129 @@ module Aws::CloudWatchLogs
|
|
1143
1199
|
include Aws::Structure
|
1144
1200
|
end
|
1145
1201
|
|
1202
|
+
# @note When making an API call, you may pass GetLogGroupFieldsRequest
|
1203
|
+
# data as a hash:
|
1204
|
+
#
|
1205
|
+
# {
|
1206
|
+
# log_group_name: "LogGroupName", # required
|
1207
|
+
# time: 1,
|
1208
|
+
# }
|
1209
|
+
#
|
1210
|
+
# @!attribute [rw] log_group_name
|
1211
|
+
# The name of the log group to search.
|
1212
|
+
# @return [String]
|
1213
|
+
#
|
1214
|
+
# @!attribute [rw] time
|
1215
|
+
# The time to set as the center of the query. If you specify `time`,
|
1216
|
+
# the 8 minutes before and 8 minutes after this time are searched. If
|
1217
|
+
# you omit `time`, the past 15 minutes are queried.
|
1218
|
+
#
|
1219
|
+
# The `time` value is specified as epoch time, the number of seconds
|
1220
|
+
# since January 1, 1970, 00:00:00 UTC.
|
1221
|
+
# @return [Integer]
|
1222
|
+
#
|
1223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFieldsRequest AWS API Documentation
|
1224
|
+
#
|
1225
|
+
class GetLogGroupFieldsRequest < Struct.new(
|
1226
|
+
:log_group_name,
|
1227
|
+
:time)
|
1228
|
+
include Aws::Structure
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# @!attribute [rw] log_group_fields
|
1232
|
+
# The array of fields found in the query. Each object in the array
|
1233
|
+
# contains the name of the field, along with the percentage of time it
|
1234
|
+
# appeared in the log events that were queried.
|
1235
|
+
# @return [Array<Types::LogGroupField>]
|
1236
|
+
#
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFieldsResponse AWS API Documentation
|
1238
|
+
#
|
1239
|
+
class GetLogGroupFieldsResponse < Struct.new(
|
1240
|
+
:log_group_fields)
|
1241
|
+
include Aws::Structure
|
1242
|
+
end
|
1243
|
+
|
1244
|
+
# @note When making an API call, you may pass GetLogRecordRequest
|
1245
|
+
# data as a hash:
|
1246
|
+
#
|
1247
|
+
# {
|
1248
|
+
# log_record_pointer: "LogRecordPointer", # required
|
1249
|
+
# }
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] log_record_pointer
|
1252
|
+
# The pointer corresponding to the log event record you want to
|
1253
|
+
# retrieve. You get this from the response of a `GetQueryResults`
|
1254
|
+
# operation. In that response, the value of the `@ptr` field for a log
|
1255
|
+
# event is the value to use as `logRecordPointer` to retrieve that
|
1256
|
+
# complete log event record.
|
1257
|
+
# @return [String]
|
1258
|
+
#
|
1259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecordRequest AWS API Documentation
|
1260
|
+
#
|
1261
|
+
class GetLogRecordRequest < Struct.new(
|
1262
|
+
:log_record_pointer)
|
1263
|
+
include Aws::Structure
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# @!attribute [rw] log_record
|
1267
|
+
# The requested log event, as a JSON string.
|
1268
|
+
# @return [Hash<String,String>]
|
1269
|
+
#
|
1270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecordResponse AWS API Documentation
|
1271
|
+
#
|
1272
|
+
class GetLogRecordResponse < Struct.new(
|
1273
|
+
:log_record)
|
1274
|
+
include Aws::Structure
|
1275
|
+
end
|
1276
|
+
|
1277
|
+
# @note When making an API call, you may pass GetQueryResultsRequest
|
1278
|
+
# data as a hash:
|
1279
|
+
#
|
1280
|
+
# {
|
1281
|
+
# query_id: "QueryId", # required
|
1282
|
+
# }
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] query_id
|
1285
|
+
# The ID number of the query.
|
1286
|
+
# @return [String]
|
1287
|
+
#
|
1288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResultsRequest AWS API Documentation
|
1289
|
+
#
|
1290
|
+
class GetQueryResultsRequest < Struct.new(
|
1291
|
+
:query_id)
|
1292
|
+
include Aws::Structure
|
1293
|
+
end
|
1294
|
+
|
1295
|
+
# @!attribute [rw] results
|
1296
|
+
# The log events that matched the query criteria during the most
|
1297
|
+
# recent time it ran.
|
1298
|
+
#
|
1299
|
+
# The `results` value is an array of arrays. Each log event is one
|
1300
|
+
# object in the top-level array. Each of these log event objects is an
|
1301
|
+
# array of `field`/`value` pairs.
|
1302
|
+
# @return [Array<Array<Types::ResultField>>]
|
1303
|
+
#
|
1304
|
+
# @!attribute [rw] statistics
|
1305
|
+
# Includes the number of log events scanned by the query, the number
|
1306
|
+
# of log events that matched the query criteria, and the total number
|
1307
|
+
# of bytes in the log events that were scanned.
|
1308
|
+
# @return [Types::QueryStatistics]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] status
|
1311
|
+
# The status of the most recent running of the query. Possible values
|
1312
|
+
# are `Cancelled`, `Complete`, `Failed`, `Running`, `Scheduled`, and
|
1313
|
+
# `Unknown`.
|
1314
|
+
# @return [String]
|
1315
|
+
#
|
1316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResultsResponse AWS API Documentation
|
1317
|
+
#
|
1318
|
+
class GetQueryResultsResponse < Struct.new(
|
1319
|
+
:results,
|
1320
|
+
:statistics,
|
1321
|
+
:status)
|
1322
|
+
include Aws::Structure
|
1323
|
+
end
|
1324
|
+
|
1146
1325
|
# Represents a log event, which is a record of activity that was
|
1147
1326
|
# recorded by the application or resource being monitored.
|
1148
1327
|
#
|
@@ -1247,6 +1426,26 @@ module Aws::CloudWatchLogs
|
|
1247
1426
|
include Aws::Structure
|
1248
1427
|
end
|
1249
1428
|
|
1429
|
+
# The fields contained in log events found by a `GetLogGroupFields`
|
1430
|
+
# operation, along with the percentage of queried log events in which
|
1431
|
+
# each field appears.
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] name
|
1434
|
+
# The name of a log field.
|
1435
|
+
# @return [String]
|
1436
|
+
#
|
1437
|
+
# @!attribute [rw] percent
|
1438
|
+
# The percentage of log events queried that contained the field.
|
1439
|
+
# @return [Integer]
|
1440
|
+
#
|
1441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogGroupField AWS API Documentation
|
1442
|
+
#
|
1443
|
+
class LogGroupField < Struct.new(
|
1444
|
+
:name,
|
1445
|
+
:percent)
|
1446
|
+
include Aws::Structure
|
1447
|
+
end
|
1448
|
+
|
1250
1449
|
# Represents a log stream, which is a sequence of log events from a
|
1251
1450
|
# single emitter of logs.
|
1252
1451
|
#
|
@@ -1265,11 +1464,12 @@ module Aws::CloudWatchLogs
|
|
1265
1464
|
# @return [Integer]
|
1266
1465
|
#
|
1267
1466
|
# @!attribute [rw] last_event_timestamp
|
1268
|
-
#
|
1467
|
+
# The time of the most recent log event in the log stream in
|
1269
1468
|
# CloudWatch Logs. This number is expressed as the number of
|
1270
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTime
|
1271
|
-
# on an eventual consistency basis. It typically updates
|
1272
|
-
# an hour from ingestion, but may take longer in some
|
1469
|
+
# milliseconds after Jan 1, 1970 00:00:00 UTC. The `lastEventTime`
|
1470
|
+
# value updates on an eventual consistency basis. It typically updates
|
1471
|
+
# in less than an hour from ingestion, but may take longer in some
|
1472
|
+
# rare situations.
|
1273
1473
|
# @return [Integer]
|
1274
1474
|
#
|
1275
1475
|
# @!attribute [rw] last_ingestion_time
|
@@ -1313,9 +1513,9 @@ module Aws::CloudWatchLogs
|
|
1313
1513
|
#
|
1314
1514
|
# @!attribute [rw] filter_pattern
|
1315
1515
|
# A symbolic description of how CloudWatch Logs should interpret the
|
1316
|
-
# data in each log event. For example, a log event may contain
|
1317
|
-
#
|
1318
|
-
# to specify what to look for in the log event message.
|
1516
|
+
# data in each log event. For example, a log event may contain
|
1517
|
+
# timestamps, IP addresses, strings, and so on. You use the filter
|
1518
|
+
# pattern to specify what to look for in the log event message.
|
1319
1519
|
# @return [String]
|
1320
1520
|
#
|
1321
1521
|
# @!attribute [rw] metric_transformations
|
@@ -1365,7 +1565,7 @@ module Aws::CloudWatchLogs
|
|
1365
1565
|
include Aws::Structure
|
1366
1566
|
end
|
1367
1567
|
|
1368
|
-
# Indicates how to transform ingested log
|
1568
|
+
# Indicates how to transform ingested log eventsto metric data in a
|
1369
1569
|
# CloudWatch metric.
|
1370
1570
|
#
|
1371
1571
|
# @note When making an API call, you may pass MetricTransformation
|
@@ -1751,6 +1951,103 @@ module Aws::CloudWatchLogs
|
|
1751
1951
|
include Aws::Structure
|
1752
1952
|
end
|
1753
1953
|
|
1954
|
+
# Reserved.
|
1955
|
+
#
|
1956
|
+
# @!attribute [rw] location
|
1957
|
+
# Reserved.
|
1958
|
+
# @return [Types::QueryCompileErrorLocation]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] message
|
1961
|
+
# Reserved.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryCompileError AWS API Documentation
|
1965
|
+
#
|
1966
|
+
class QueryCompileError < Struct.new(
|
1967
|
+
:location,
|
1968
|
+
:message)
|
1969
|
+
include Aws::Structure
|
1970
|
+
end
|
1971
|
+
|
1972
|
+
# Reserved.
|
1973
|
+
#
|
1974
|
+
# @!attribute [rw] start_char_offset
|
1975
|
+
# Reserved.
|
1976
|
+
# @return [Integer]
|
1977
|
+
#
|
1978
|
+
# @!attribute [rw] end_char_offset
|
1979
|
+
# Reserved.
|
1980
|
+
# @return [Integer]
|
1981
|
+
#
|
1982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryCompileErrorLocation AWS API Documentation
|
1983
|
+
#
|
1984
|
+
class QueryCompileErrorLocation < Struct.new(
|
1985
|
+
:start_char_offset,
|
1986
|
+
:end_char_offset)
|
1987
|
+
include Aws::Structure
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
# Information about one CloudWatch Logs Insights query that matches the
|
1991
|
+
# request in a `DescribeQueries` operation.
|
1992
|
+
#
|
1993
|
+
# @!attribute [rw] query_id
|
1994
|
+
# The unique ID number of this query.
|
1995
|
+
# @return [String]
|
1996
|
+
#
|
1997
|
+
# @!attribute [rw] query_string
|
1998
|
+
# The query string used in this query.
|
1999
|
+
# @return [String]
|
2000
|
+
#
|
2001
|
+
# @!attribute [rw] status
|
2002
|
+
# The status of this query. Possible values are `Cancelled`,
|
2003
|
+
# `Complete`, `Failed`, `Running`, `Scheduled`, and `Unknown`.
|
2004
|
+
# @return [String]
|
2005
|
+
#
|
2006
|
+
# @!attribute [rw] create_time
|
2007
|
+
# The date and time that this query was created.
|
2008
|
+
# @return [Integer]
|
2009
|
+
#
|
2010
|
+
# @!attribute [rw] log_group_name
|
2011
|
+
# The name of the log group scanned by this query.
|
2012
|
+
# @return [String]
|
2013
|
+
#
|
2014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryInfo AWS API Documentation
|
2015
|
+
#
|
2016
|
+
class QueryInfo < Struct.new(
|
2017
|
+
:query_id,
|
2018
|
+
:query_string,
|
2019
|
+
:status,
|
2020
|
+
:create_time,
|
2021
|
+
:log_group_name)
|
2022
|
+
include Aws::Structure
|
2023
|
+
end
|
2024
|
+
|
2025
|
+
# Contains the number of log events scanned by the query, the number of
|
2026
|
+
# log events that matched the query criteria, and the total number of
|
2027
|
+
# bytes in the log events that were scanned.
|
2028
|
+
#
|
2029
|
+
# @!attribute [rw] records_matched
|
2030
|
+
# The number of log events that matched the query string.
|
2031
|
+
# @return [Float]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] records_scanned
|
2034
|
+
# The total number of log events scanned during the query.
|
2035
|
+
# @return [Float]
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] bytes_scanned
|
2038
|
+
# The total number of bytes in the log events scanned during the
|
2039
|
+
# query.
|
2040
|
+
# @return [Float]
|
2041
|
+
#
|
2042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryStatistics AWS API Documentation
|
2043
|
+
#
|
2044
|
+
class QueryStatistics < Struct.new(
|
2045
|
+
:records_matched,
|
2046
|
+
:records_scanned,
|
2047
|
+
:bytes_scanned)
|
2048
|
+
include Aws::Structure
|
2049
|
+
end
|
2050
|
+
|
1754
2051
|
# Represents the rejected events.
|
1755
2052
|
#
|
1756
2053
|
# @!attribute [rw] too_new_log_event_start_index
|
@@ -1786,7 +2083,7 @@ module Aws::CloudWatchLogs
|
|
1786
2083
|
# @return [String]
|
1787
2084
|
#
|
1788
2085
|
# @!attribute [rw] last_updated_time
|
1789
|
-
#
|
2086
|
+
# Timestamp showing when this policy was last updated, expressed as
|
1790
2087
|
# the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
1791
2088
|
# @return [Integer]
|
1792
2089
|
#
|
@@ -1799,6 +2096,25 @@ module Aws::CloudWatchLogs
|
|
1799
2096
|
include Aws::Structure
|
1800
2097
|
end
|
1801
2098
|
|
2099
|
+
# Contains one field from one log event returned by a CloudWatch Logs
|
2100
|
+
# Insights query, along with the value of that field.
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] field
|
2103
|
+
# The log event field.
|
2104
|
+
# @return [String]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] value
|
2107
|
+
# The value of this field.
|
2108
|
+
# @return [String]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResultField AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class ResultField < Struct.new(
|
2113
|
+
:field,
|
2114
|
+
:value)
|
2115
|
+
include Aws::Structure
|
2116
|
+
end
|
2117
|
+
|
1802
2118
|
# Represents the search status of a log stream.
|
1803
2119
|
#
|
1804
2120
|
# @!attribute [rw] log_stream_name
|
@@ -1817,6 +2133,99 @@ module Aws::CloudWatchLogs
|
|
1817
2133
|
include Aws::Structure
|
1818
2134
|
end
|
1819
2135
|
|
2136
|
+
# @note When making an API call, you may pass StartQueryRequest
|
2137
|
+
# data as a hash:
|
2138
|
+
#
|
2139
|
+
# {
|
2140
|
+
# log_group_name: "LogGroupName", # required
|
2141
|
+
# start_time: 1, # required
|
2142
|
+
# end_time: 1, # required
|
2143
|
+
# query_string: "QueryString", # required
|
2144
|
+
# limit: 1,
|
2145
|
+
# }
|
2146
|
+
#
|
2147
|
+
# @!attribute [rw] log_group_name
|
2148
|
+
# The log group on which to perform the query.
|
2149
|
+
# @return [String]
|
2150
|
+
#
|
2151
|
+
# @!attribute [rw] start_time
|
2152
|
+
# The time to start the query. Specified as epoch time, the number of
|
2153
|
+
# seconds since January 1, 1970, 00:00:00 UTC.
|
2154
|
+
# @return [Integer]
|
2155
|
+
#
|
2156
|
+
# @!attribute [rw] end_time
|
2157
|
+
# The time to end this query, if it is still running. Specified as
|
2158
|
+
# epoch time, the number of seconds since January 1, 1970, 00:00:00
|
2159
|
+
# UTC.
|
2160
|
+
# @return [Integer]
|
2161
|
+
#
|
2162
|
+
# @!attribute [rw] query_string
|
2163
|
+
# The query string to use. For more information, see [CloudWatch Logs
|
2164
|
+
# Insights Query Syntax][1].
|
2165
|
+
#
|
2166
|
+
#
|
2167
|
+
#
|
2168
|
+
# [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
|
2169
|
+
# @return [String]
|
2170
|
+
#
|
2171
|
+
# @!attribute [rw] limit
|
2172
|
+
# The maximum number of log events to return in the query. If the
|
2173
|
+
# query string uses the `fields` command, only the specified fields
|
2174
|
+
# and their values are returned.
|
2175
|
+
# @return [Integer]
|
2176
|
+
#
|
2177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQueryRequest AWS API Documentation
|
2178
|
+
#
|
2179
|
+
class StartQueryRequest < Struct.new(
|
2180
|
+
:log_group_name,
|
2181
|
+
:start_time,
|
2182
|
+
:end_time,
|
2183
|
+
:query_string,
|
2184
|
+
:limit)
|
2185
|
+
include Aws::Structure
|
2186
|
+
end
|
2187
|
+
|
2188
|
+
# @!attribute [rw] query_id
|
2189
|
+
# The unique ID of the query.
|
2190
|
+
# @return [String]
|
2191
|
+
#
|
2192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQueryResponse AWS API Documentation
|
2193
|
+
#
|
2194
|
+
class StartQueryResponse < Struct.new(
|
2195
|
+
:query_id)
|
2196
|
+
include Aws::Structure
|
2197
|
+
end
|
2198
|
+
|
2199
|
+
# @note When making an API call, you may pass StopQueryRequest
|
2200
|
+
# data as a hash:
|
2201
|
+
#
|
2202
|
+
# {
|
2203
|
+
# query_id: "QueryId", # required
|
2204
|
+
# }
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] query_id
|
2207
|
+
# The ID number of the query to stop. If necessary, you can use
|
2208
|
+
# `DescribeQueries` to find this ID number.
|
2209
|
+
# @return [String]
|
2210
|
+
#
|
2211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQueryRequest AWS API Documentation
|
2212
|
+
#
|
2213
|
+
class StopQueryRequest < Struct.new(
|
2214
|
+
:query_id)
|
2215
|
+
include Aws::Structure
|
2216
|
+
end
|
2217
|
+
|
2218
|
+
# @!attribute [rw] success
|
2219
|
+
# This is true if the query was stopped by the `StopQuery` operation.
|
2220
|
+
# @return [Boolean]
|
2221
|
+
#
|
2222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StopQueryResponse AWS API Documentation
|
2223
|
+
#
|
2224
|
+
class StopQueryResponse < Struct.new(
|
2225
|
+
:success)
|
2226
|
+
include Aws::Structure
|
2227
|
+
end
|
2228
|
+
|
1820
2229
|
# Represents a subscription filter.
|
1821
2230
|
#
|
1822
2231
|
# @!attribute [rw] filter_name
|
@@ -1829,9 +2238,9 @@ module Aws::CloudWatchLogs
|
|
1829
2238
|
#
|
1830
2239
|
# @!attribute [rw] filter_pattern
|
1831
2240
|
# A symbolic description of how CloudWatch Logs should interpret the
|
1832
|
-
# data in each log event. For example, a log event may contain
|
1833
|
-
#
|
1834
|
-
# to specify what to look for in the log event message.
|
2241
|
+
# data in each log event. For example, a log event may contain
|
2242
|
+
# timestamps, IP addresses, strings, and so on. You use the filter
|
2243
|
+
# pattern to specify what to look for in the log event message.
|
1835
2244
|
# @return [String]
|
1836
2245
|
#
|
1837
2246
|
# @!attribute [rw] destination_arn
|
@@ -1900,9 +2309,9 @@ module Aws::CloudWatchLogs
|
|
1900
2309
|
#
|
1901
2310
|
# @!attribute [rw] filter_pattern
|
1902
2311
|
# A symbolic description of how CloudWatch Logs should interpret the
|
1903
|
-
# data in each log event. For example, a log event may contain
|
1904
|
-
#
|
1905
|
-
# to specify what to look for in the log event message.
|
2312
|
+
# data in each log event. For example, a log event may contain
|
2313
|
+
# timestamps, IP addresses, strings, and so on. You use the filter
|
2314
|
+
# pattern to specify what to look for in the log event message.
|
1906
2315
|
# @return [String]
|
1907
2316
|
#
|
1908
2317
|
# @!attribute [rw] log_event_messages
|