aws-sdk-cloudwatchlogs 1.55.0 → 1.57.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchlogs/client.rb +515 -129
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +87 -0
- data/lib/aws-sdk-cloudwatchlogs/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-cloudwatchlogs/endpoint_provider.rb +84 -85
- data/lib/aws-sdk-cloudwatchlogs/endpoints.rb +42 -0
- data/lib/aws-sdk-cloudwatchlogs/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-cloudwatchlogs/types.rb +429 -104
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- metadata +2 -2
@@ -23,10 +23,10 @@ module Aws::CloudWatchLogs
|
|
23
23
|
# @return [String]
|
24
24
|
#
|
25
25
|
# @!attribute [rw] kms_key_id
|
26
|
-
# The Amazon Resource Name (ARN) of the
|
27
|
-
# data. This must be a symmetric
|
28
|
-
# [Amazon Resource Names
|
29
|
-
#
|
26
|
+
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
|
27
|
+
# log data. This must be a symmetric KMS key. For more information,
|
28
|
+
# see [Amazon Resource Names][1] and [Using Symmetric and Asymmetric
|
29
|
+
# Keys][2].
|
30
30
|
#
|
31
31
|
#
|
32
32
|
#
|
@@ -90,19 +90,22 @@ module Aws::CloudWatchLogs
|
|
90
90
|
#
|
91
91
|
# @!attribute [rw] from
|
92
92
|
# The start time of the range for the request, expressed as the number
|
93
|
-
# of milliseconds after Jan 1, 1970 00:00:00 UTC
|
93
|
+
# of milliseconds after `Jan 1, 1970 00:00:00 UTC`. Events with a
|
94
94
|
# timestamp earlier than this time are not exported.
|
95
95
|
# @return [Integer]
|
96
96
|
#
|
97
97
|
# @!attribute [rw] to
|
98
98
|
# The end time of the range for the request, expressed as the number
|
99
|
-
# of milliseconds after Jan 1, 1970 00:00:00 UTC
|
99
|
+
# of milliseconds after `Jan 1, 1970 00:00:00 UTC`. Events with a
|
100
100
|
# timestamp later than this time are not exported.
|
101
|
+
#
|
102
|
+
# You must specify a time that is not earlier than when this log group
|
103
|
+
# was created.
|
101
104
|
# @return [Integer]
|
102
105
|
#
|
103
106
|
# @!attribute [rw] destination
|
104
107
|
# The name of S3 bucket for the exported log data. The bucket must be
|
105
|
-
# in the same Amazon Web Services
|
108
|
+
# in the same Amazon Web Services Region.
|
106
109
|
# @return [String]
|
107
110
|
#
|
108
111
|
# @!attribute [rw] destination_prefix
|
@@ -152,9 +155,8 @@ module Aws::CloudWatchLogs
|
|
152
155
|
# @return [String]
|
153
156
|
#
|
154
157
|
# @!attribute [rw] kms_key_id
|
155
|
-
# The Amazon Resource Name (ARN) of the
|
156
|
-
# data. For more information, see [Amazon Resource Names
|
157
|
-
# Management Service][1].
|
158
|
+
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
|
159
|
+
# log data. For more information, see [Amazon Resource Names][1].
|
158
160
|
#
|
159
161
|
#
|
160
162
|
#
|
@@ -223,6 +225,26 @@ module Aws::CloudWatchLogs
|
|
223
225
|
include Aws::Structure
|
224
226
|
end
|
225
227
|
|
228
|
+
# @note When making an API call, you may pass DeleteDataProtectionPolicyRequest
|
229
|
+
# data as a hash:
|
230
|
+
#
|
231
|
+
# {
|
232
|
+
# log_group_identifier: "LogGroupIdentifier", # required
|
233
|
+
# }
|
234
|
+
#
|
235
|
+
# @!attribute [rw] log_group_identifier
|
236
|
+
# The name or ARN of the log group that you want to delete the data
|
237
|
+
# protection policy for.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteDataProtectionPolicyRequest AWS API Documentation
|
241
|
+
#
|
242
|
+
class DeleteDataProtectionPolicyRequest < Struct.new(
|
243
|
+
:log_group_identifier)
|
244
|
+
SENSITIVE = []
|
245
|
+
include Aws::Structure
|
246
|
+
end
|
247
|
+
|
226
248
|
# @note When making an API call, you may pass DeleteDestinationRequest
|
227
249
|
# data as a hash:
|
228
250
|
#
|
@@ -433,7 +455,7 @@ module Aws::CloudWatchLogs
|
|
433
455
|
#
|
434
456
|
# @!attribute [rw] limit
|
435
457
|
# The maximum number of items returned. If you don't specify a value,
|
436
|
-
# the default
|
458
|
+
# the default maximum value of 50 items is used.
|
437
459
|
# @return [Integer]
|
438
460
|
#
|
439
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinationsRequest AWS API Documentation
|
@@ -476,7 +498,7 @@ module Aws::CloudWatchLogs
|
|
476
498
|
#
|
477
499
|
# @!attribute [rw] task_id
|
478
500
|
# The ID of the export task. Specifying a task ID filters the results
|
479
|
-
# to
|
501
|
+
# to one or zero export tasks.
|
480
502
|
# @return [String]
|
481
503
|
#
|
482
504
|
# @!attribute [rw] status_code
|
@@ -527,13 +549,40 @@ module Aws::CloudWatchLogs
|
|
527
549
|
# data as a hash:
|
528
550
|
#
|
529
551
|
# {
|
552
|
+
# account_identifiers: ["AccountId"],
|
530
553
|
# log_group_name_prefix: "LogGroupName",
|
554
|
+
# log_group_name_pattern: "LogGroupNamePattern",
|
531
555
|
# next_token: "NextToken",
|
532
556
|
# limit: 1,
|
557
|
+
# include_linked_accounts: false,
|
533
558
|
# }
|
534
559
|
#
|
560
|
+
# @!attribute [rw] account_identifiers
|
561
|
+
# When `includeLinkedAccounts` is set to `True`, use this parameter to
|
562
|
+
# specify the list of accounts to search. You can specify as many as
|
563
|
+
# 20 account IDs in the array.
|
564
|
+
# @return [Array<String>]
|
565
|
+
#
|
535
566
|
# @!attribute [rw] log_group_name_prefix
|
536
567
|
# The prefix to match.
|
568
|
+
#
|
569
|
+
# <note markdown="1"> `logGroupNamePrefix` and `logGroupNamePattern` are mutually
|
570
|
+
# exclusive. Only one of these parameters can be passed.
|
571
|
+
#
|
572
|
+
# </note>
|
573
|
+
# @return [String]
|
574
|
+
#
|
575
|
+
# @!attribute [rw] log_group_name_pattern
|
576
|
+
# If you specify a string for this parameter, the operation returns
|
577
|
+
# only log groups that have names that match the string based on a
|
578
|
+
# case-sensitive substring search. For example, if you specify `Foo`,
|
579
|
+
# log groups named `FooBar`, `aws/Foo`, and `GroupFoo` would match,
|
580
|
+
# but `foo`, `F/o/o` and `Froo` would not match.
|
581
|
+
#
|
582
|
+
# <note markdown="1"> `logGroupNamePattern` and `logGroupNamePrefix` are mutually
|
583
|
+
# exclusive. Only one of these parameters can be passed.
|
584
|
+
#
|
585
|
+
# </note>
|
537
586
|
# @return [String]
|
538
587
|
#
|
539
588
|
# @!attribute [rw] next_token
|
@@ -546,12 +595,32 @@ module Aws::CloudWatchLogs
|
|
546
595
|
# the default is up to 50 items.
|
547
596
|
# @return [Integer]
|
548
597
|
#
|
598
|
+
# @!attribute [rw] include_linked_accounts
|
599
|
+
# If you are using a monitoring account, set this to `True` to have
|
600
|
+
# the operation return log groups in the accounts listed in
|
601
|
+
# `accountIdentifiers`.
|
602
|
+
#
|
603
|
+
# If this parameter is set to `true` and `accountIdentifiers` contains
|
604
|
+
# a null value, the operation returns all log groups in the monitoring
|
605
|
+
# account and all log groups in all source accounts that are linked to
|
606
|
+
# the monitoring account.
|
607
|
+
#
|
608
|
+
# <note markdown="1"> If you specify `includeLinkedAccounts` in your request, then
|
609
|
+
# `metricFilterCount`, `retentionInDays`, and `storedBytes` are not
|
610
|
+
# included in the response.
|
611
|
+
#
|
612
|
+
# </note>
|
613
|
+
# @return [Boolean]
|
614
|
+
#
|
549
615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeLogGroupsRequest AWS API Documentation
|
550
616
|
#
|
551
617
|
class DescribeLogGroupsRequest < Struct.new(
|
618
|
+
:account_identifiers,
|
552
619
|
:log_group_name_prefix,
|
620
|
+
:log_group_name_pattern,
|
553
621
|
:next_token,
|
554
|
-
:limit
|
622
|
+
:limit,
|
623
|
+
:include_linked_accounts)
|
555
624
|
SENSITIVE = []
|
556
625
|
include Aws::Structure
|
557
626
|
end
|
@@ -560,7 +629,7 @@ module Aws::CloudWatchLogs
|
|
560
629
|
# The log groups.
|
561
630
|
#
|
562
631
|
# If the `retentionInDays` value is not included for a log group, then
|
563
|
-
# that log group
|
632
|
+
# that log group's events do not expire.
|
564
633
|
# @return [Array<Types::LogGroup>]
|
565
634
|
#
|
566
635
|
# @!attribute [rw] next_token
|
@@ -582,6 +651,7 @@ module Aws::CloudWatchLogs
|
|
582
651
|
#
|
583
652
|
# {
|
584
653
|
# log_group_name: "LogGroupName", # required
|
654
|
+
# log_group_identifier: "LogGroupIdentifier",
|
585
655
|
# log_stream_name_prefix: "LogStreamName",
|
586
656
|
# order_by: "LogStreamName", # accepts LogStreamName, LastEventTime
|
587
657
|
# descending: false,
|
@@ -591,6 +661,22 @@ module Aws::CloudWatchLogs
|
|
591
661
|
#
|
592
662
|
# @!attribute [rw] log_group_name
|
593
663
|
# The name of the log group.
|
664
|
+
#
|
665
|
+
# <note markdown="1"> If you specify values for both `logGroupName` and
|
666
|
+
# `logGroupIdentifier`, the action returns an
|
667
|
+
# `InvalidParameterException` error.
|
668
|
+
#
|
669
|
+
# </note>
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] log_group_identifier
|
673
|
+
# Specify either the name or ARN of the log group to view. If the log
|
674
|
+
# group is in a source account and you are using a monitoring account,
|
675
|
+
# you must use the log group ARN.
|
676
|
+
#
|
677
|
+
# If you specify values for both `logGroupName` and
|
678
|
+
# `logGroupIdentifier`, the action returns an
|
679
|
+
# `InvalidParameterException` error.
|
594
680
|
# @return [String]
|
595
681
|
#
|
596
682
|
# @!attribute [rw] log_stream_name_prefix
|
@@ -609,7 +695,7 @@ module Aws::CloudWatchLogs
|
|
609
695
|
#
|
610
696
|
# `lastEventTimestamp` represents the time of the most recent log
|
611
697
|
# event in the log stream in CloudWatch Logs. This number is expressed
|
612
|
-
# as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
|
698
|
+
# as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
613
699
|
# `lastEventTimestamp` updates on an eventual consistency basis. It
|
614
700
|
# typically updates in less than an hour from ingestion, but in rare
|
615
701
|
# situations might take longer.
|
@@ -635,6 +721,7 @@ module Aws::CloudWatchLogs
|
|
635
721
|
#
|
636
722
|
class DescribeLogStreamsRequest < Struct.new(
|
637
723
|
:log_group_name,
|
724
|
+
:log_group_identifier,
|
638
725
|
:log_stream_name_prefix,
|
639
726
|
:order_by,
|
640
727
|
:descending,
|
@@ -679,8 +766,8 @@ module Aws::CloudWatchLogs
|
|
679
766
|
# @return [String]
|
680
767
|
#
|
681
768
|
# @!attribute [rw] filter_name_prefix
|
682
|
-
# The prefix to match. CloudWatch Logs uses the value you set
|
683
|
-
# only if you also include the `logGroupName` parameter in your
|
769
|
+
# The prefix to match. CloudWatch Logs uses the value that you set
|
770
|
+
# here only if you also include the `logGroupName` parameter in your
|
684
771
|
# request.
|
685
772
|
# @return [String]
|
686
773
|
#
|
@@ -1029,14 +1116,14 @@ module Aws::CloudWatchLogs
|
|
1029
1116
|
# @return [String]
|
1030
1117
|
#
|
1031
1118
|
# @!attribute [rw] from
|
1032
|
-
# The start time, expressed as the number of milliseconds after Jan
|
1033
|
-
# 1970 00:00:00 UTC
|
1034
|
-
# exported.
|
1119
|
+
# The start time, expressed as the number of milliseconds after `Jan
|
1120
|
+
# 1, 1970 00:00:00 UTC`. Events with a timestamp before this time are
|
1121
|
+
# not exported.
|
1035
1122
|
# @return [Integer]
|
1036
1123
|
#
|
1037
1124
|
# @!attribute [rw] to
|
1038
|
-
# The end time, expressed as the number of milliseconds after Jan 1,
|
1039
|
-
# 1970 00:00:00 UTC
|
1125
|
+
# The end time, expressed as the number of milliseconds after `Jan 1,
|
1126
|
+
# 1970 00:00:00 UTC`. Events with a timestamp later than this time are
|
1040
1127
|
# not exported.
|
1041
1128
|
# @return [Integer]
|
1042
1129
|
#
|
@@ -1077,12 +1164,12 @@ module Aws::CloudWatchLogs
|
|
1077
1164
|
#
|
1078
1165
|
# @!attribute [rw] creation_time
|
1079
1166
|
# The creation time of the export task, expressed as the number of
|
1080
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
1167
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
1081
1168
|
# @return [Integer]
|
1082
1169
|
#
|
1083
1170
|
# @!attribute [rw] completion_time
|
1084
1171
|
# The completion time of the export task, expressed as the number of
|
1085
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
1172
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
1086
1173
|
# @return [Integer]
|
1087
1174
|
#
|
1088
1175
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ExportTaskExecutionInfo AWS API Documentation
|
@@ -1118,6 +1205,7 @@ module Aws::CloudWatchLogs
|
|
1118
1205
|
#
|
1119
1206
|
# {
|
1120
1207
|
# log_group_name: "LogGroupName", # required
|
1208
|
+
# log_group_identifier: "LogGroupIdentifier",
|
1121
1209
|
# log_stream_names: ["LogStreamName"],
|
1122
1210
|
# log_stream_name_prefix: "LogStreamName",
|
1123
1211
|
# start_time: 1,
|
@@ -1126,10 +1214,27 @@ module Aws::CloudWatchLogs
|
|
1126
1214
|
# next_token: "NextToken",
|
1127
1215
|
# limit: 1,
|
1128
1216
|
# interleaved: false,
|
1217
|
+
# unmask: false,
|
1129
1218
|
# }
|
1130
1219
|
#
|
1131
1220
|
# @!attribute [rw] log_group_name
|
1132
1221
|
# The name of the log group to search.
|
1222
|
+
#
|
1223
|
+
# <note markdown="1"> If you specify values for both `logGroupName` and
|
1224
|
+
# `logGroupIdentifier`, the action returns an
|
1225
|
+
# `InvalidParameterException` error.
|
1226
|
+
#
|
1227
|
+
# </note>
|
1228
|
+
# @return [String]
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] log_group_identifier
|
1231
|
+
# Specify either the name or ARN of the log group to view log events
|
1232
|
+
# from. If the log group is in a source account and you are using a
|
1233
|
+
# monitoring account, you must use the log group ARN.
|
1234
|
+
#
|
1235
|
+
# If you specify values for both `logGroupName` and
|
1236
|
+
# `logGroupIdentifier`, the action returns an
|
1237
|
+
# `InvalidParameterException` error.
|
1133
1238
|
# @return [String]
|
1134
1239
|
#
|
1135
1240
|
# @!attribute [rw] log_stream_names
|
@@ -1152,13 +1257,13 @@ module Aws::CloudWatchLogs
|
|
1152
1257
|
#
|
1153
1258
|
# @!attribute [rw] start_time
|
1154
1259
|
# The start of the time range, expressed as the number of milliseconds
|
1155
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1156
|
-
# time are not returned.
|
1260
|
+
# after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp before
|
1261
|
+
# this time are not returned.
|
1157
1262
|
# @return [Integer]
|
1158
1263
|
#
|
1159
1264
|
# @!attribute [rw] end_time
|
1160
1265
|
# The end of the time range, expressed as the number of milliseconds
|
1161
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1266
|
+
# after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp later than
|
1162
1267
|
# this time are not returned.
|
1163
1268
|
# @return [Integer]
|
1164
1269
|
#
|
@@ -1184,23 +1289,30 @@ module Aws::CloudWatchLogs
|
|
1184
1289
|
# @return [Integer]
|
1185
1290
|
#
|
1186
1291
|
# @!attribute [rw] interleaved
|
1187
|
-
# If the value is true, the operation
|
1188
|
-
#
|
1189
|
-
#
|
1190
|
-
#
|
1191
|
-
#
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
#
|
1195
|
-
#
|
1196
|
-
#
|
1197
|
-
#
|
1292
|
+
# If the value is true, the operation attempts to provide responses
|
1293
|
+
# that contain events from multiple log streams within the log group,
|
1294
|
+
# interleaved in a single response. If the value is false, all the
|
1295
|
+
# matched log events in the first log stream are searched first, then
|
1296
|
+
# those in the next log stream, and so on.
|
1297
|
+
#
|
1298
|
+
# **Important** As of June 17, 2019, this parameter is ignored and the
|
1299
|
+
# value is assumed to be true. The response from this operation always
|
1300
|
+
# interleaves events from multiple log streams within a log group.
|
1301
|
+
# @return [Boolean]
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] unmask
|
1304
|
+
# Specify `true` to display the log event fields with all sensitive
|
1305
|
+
# data unmasked and visible. The default is `false`.
|
1306
|
+
#
|
1307
|
+
# To use this operation with this parameter, you must be signed into
|
1308
|
+
# an account with the `logs:Unmask` permission.
|
1198
1309
|
# @return [Boolean]
|
1199
1310
|
#
|
1200
1311
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEventsRequest AWS API Documentation
|
1201
1312
|
#
|
1202
1313
|
class FilterLogEventsRequest < Struct.new(
|
1203
1314
|
:log_group_name,
|
1315
|
+
:log_group_identifier,
|
1204
1316
|
:log_stream_names,
|
1205
1317
|
:log_stream_name_prefix,
|
1206
1318
|
:start_time,
|
@@ -1208,7 +1320,8 @@ module Aws::CloudWatchLogs
|
|
1208
1320
|
:filter_pattern,
|
1209
1321
|
:next_token,
|
1210
1322
|
:limit,
|
1211
|
-
:interleaved
|
1323
|
+
:interleaved,
|
1324
|
+
:unmask)
|
1212
1325
|
SENSITIVE = []
|
1213
1326
|
include Aws::Structure
|
1214
1327
|
end
|
@@ -1218,9 +1331,8 @@ module Aws::CloudWatchLogs
|
|
1218
1331
|
# @return [Array<Types::FilteredLogEvent>]
|
1219
1332
|
#
|
1220
1333
|
# @!attribute [rw] searched_log_streams
|
1221
|
-
# **
|
1222
|
-
#
|
1223
|
-
# deprecation occurs.
|
1334
|
+
# **Important** As of May 15, 2020, this parameter is no longer
|
1335
|
+
# supported. This parameter returns an empty list.
|
1224
1336
|
#
|
1225
1337
|
# Indicates which log streams have been searched and whether each has
|
1226
1338
|
# been searched completely.
|
@@ -1249,7 +1361,7 @@ module Aws::CloudWatchLogs
|
|
1249
1361
|
#
|
1250
1362
|
# @!attribute [rw] timestamp
|
1251
1363
|
# The time the event occurred, expressed as the number of milliseconds
|
1252
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1364
|
+
# after `Jan 1, 1970 00:00:00 UTC`.
|
1253
1365
|
# @return [Integer]
|
1254
1366
|
#
|
1255
1367
|
# @!attribute [rw] message
|
@@ -1258,7 +1370,7 @@ module Aws::CloudWatchLogs
|
|
1258
1370
|
#
|
1259
1371
|
# @!attribute [rw] ingestion_time
|
1260
1372
|
# The time the event was ingested, expressed as the number of
|
1261
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
1373
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
1262
1374
|
# @return [Integer]
|
1263
1375
|
#
|
1264
1376
|
# @!attribute [rw] event_id
|
@@ -1277,21 +1389,81 @@ module Aws::CloudWatchLogs
|
|
1277
1389
|
include Aws::Structure
|
1278
1390
|
end
|
1279
1391
|
|
1392
|
+
# @note When making an API call, you may pass GetDataProtectionPolicyRequest
|
1393
|
+
# data as a hash:
|
1394
|
+
#
|
1395
|
+
# {
|
1396
|
+
# log_group_identifier: "LogGroupIdentifier", # required
|
1397
|
+
# }
|
1398
|
+
#
|
1399
|
+
# @!attribute [rw] log_group_identifier
|
1400
|
+
# The name or ARN of the log group that contains the data protection
|
1401
|
+
# policy that you want to see.
|
1402
|
+
# @return [String]
|
1403
|
+
#
|
1404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDataProtectionPolicyRequest AWS API Documentation
|
1405
|
+
#
|
1406
|
+
class GetDataProtectionPolicyRequest < Struct.new(
|
1407
|
+
:log_group_identifier)
|
1408
|
+
SENSITIVE = []
|
1409
|
+
include Aws::Structure
|
1410
|
+
end
|
1411
|
+
|
1412
|
+
# @!attribute [rw] log_group_identifier
|
1413
|
+
# The log group name or ARN that you specified in your request.
|
1414
|
+
# @return [String]
|
1415
|
+
#
|
1416
|
+
# @!attribute [rw] policy_document
|
1417
|
+
# The data protection policy document for this log group.
|
1418
|
+
# @return [String]
|
1419
|
+
#
|
1420
|
+
# @!attribute [rw] last_updated_time
|
1421
|
+
# The date and time that this policy was most recently updated.
|
1422
|
+
# @return [Integer]
|
1423
|
+
#
|
1424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetDataProtectionPolicyResponse AWS API Documentation
|
1425
|
+
#
|
1426
|
+
class GetDataProtectionPolicyResponse < Struct.new(
|
1427
|
+
:log_group_identifier,
|
1428
|
+
:policy_document,
|
1429
|
+
:last_updated_time)
|
1430
|
+
SENSITIVE = []
|
1431
|
+
include Aws::Structure
|
1432
|
+
end
|
1433
|
+
|
1280
1434
|
# @note When making an API call, you may pass GetLogEventsRequest
|
1281
1435
|
# data as a hash:
|
1282
1436
|
#
|
1283
1437
|
# {
|
1284
1438
|
# log_group_name: "LogGroupName", # required
|
1439
|
+
# log_group_identifier: "LogGroupIdentifier",
|
1285
1440
|
# log_stream_name: "LogStreamName", # required
|
1286
1441
|
# start_time: 1,
|
1287
1442
|
# end_time: 1,
|
1288
1443
|
# next_token: "NextToken",
|
1289
1444
|
# limit: 1,
|
1290
1445
|
# start_from_head: false,
|
1446
|
+
# unmask: false,
|
1291
1447
|
# }
|
1292
1448
|
#
|
1293
1449
|
# @!attribute [rw] log_group_name
|
1294
1450
|
# The name of the log group.
|
1451
|
+
#
|
1452
|
+
# <note markdown="1"> If you specify values for both `logGroupName` and
|
1453
|
+
# `logGroupIdentifier`, the action returns an
|
1454
|
+
# `InvalidParameterException` error.
|
1455
|
+
#
|
1456
|
+
# </note>
|
1457
|
+
# @return [String]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] log_group_identifier
|
1460
|
+
# Specify either the name or ARN of the log group to view events from.
|
1461
|
+
# If the log group is in a source account and you are using a
|
1462
|
+
# monitoring account, you must use the log group ARN.
|
1463
|
+
#
|
1464
|
+
# If you specify values for both `logGroupName` and
|
1465
|
+
# `logGroupIdentifier`, the action returns an
|
1466
|
+
# `InvalidParameterException` error.
|
1295
1467
|
# @return [String]
|
1296
1468
|
#
|
1297
1469
|
# @!attribute [rw] log_stream_name
|
@@ -1300,15 +1472,15 @@ module Aws::CloudWatchLogs
|
|
1300
1472
|
#
|
1301
1473
|
# @!attribute [rw] start_time
|
1302
1474
|
# The start of the time range, expressed as the number of milliseconds
|
1303
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1475
|
+
# after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp equal to
|
1304
1476
|
# this time or later than this time are included. Events with a
|
1305
1477
|
# timestamp earlier than this time are not included.
|
1306
1478
|
# @return [Integer]
|
1307
1479
|
#
|
1308
1480
|
# @!attribute [rw] end_time
|
1309
1481
|
# The end of the time range, expressed as the number of milliseconds
|
1310
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1311
|
-
# later than this time are not included.
|
1482
|
+
# after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp equal to
|
1483
|
+
# or later than this time are not included.
|
1312
1484
|
# @return [Integer]
|
1313
1485
|
#
|
1314
1486
|
# @!attribute [rw] next_token
|
@@ -1318,8 +1490,8 @@ module Aws::CloudWatchLogs
|
|
1318
1490
|
#
|
1319
1491
|
# @!attribute [rw] limit
|
1320
1492
|
# The maximum number of log events returned. If you don't specify a
|
1321
|
-
#
|
1322
|
-
# size of 1 MB
|
1493
|
+
# limit, the default is as many log events as can fit in a response
|
1494
|
+
# size of 1 MB (up to 10,000 log events).
|
1323
1495
|
# @return [Integer]
|
1324
1496
|
#
|
1325
1497
|
# @!attribute [rw] start_from_head
|
@@ -1332,16 +1504,26 @@ module Aws::CloudWatchLogs
|
|
1332
1504
|
# `startFromHead`.
|
1333
1505
|
# @return [Boolean]
|
1334
1506
|
#
|
1507
|
+
# @!attribute [rw] unmask
|
1508
|
+
# Specify `true` to display the log event fields with all sensitive
|
1509
|
+
# data unmasked and visible. The default is `false`.
|
1510
|
+
#
|
1511
|
+
# To use this operation with this parameter, you must be signed into
|
1512
|
+
# an account with the `logs:Unmask` permission.
|
1513
|
+
# @return [Boolean]
|
1514
|
+
#
|
1335
1515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogEventsRequest AWS API Documentation
|
1336
1516
|
#
|
1337
1517
|
class GetLogEventsRequest < Struct.new(
|
1338
1518
|
:log_group_name,
|
1519
|
+
:log_group_identifier,
|
1339
1520
|
:log_stream_name,
|
1340
1521
|
:start_time,
|
1341
1522
|
:end_time,
|
1342
1523
|
:next_token,
|
1343
1524
|
:limit,
|
1344
|
-
:start_from_head
|
1525
|
+
:start_from_head,
|
1526
|
+
:unmask)
|
1345
1527
|
SENSITIVE = []
|
1346
1528
|
include Aws::Structure
|
1347
1529
|
end
|
@@ -1358,7 +1540,7 @@ module Aws::CloudWatchLogs
|
|
1358
1540
|
#
|
1359
1541
|
# @!attribute [rw] next_backward_token
|
1360
1542
|
# The token for the next set of items in the backward direction. The
|
1361
|
-
# token expires after 24 hours. This token is
|
1543
|
+
# token expires after 24 hours. This token is not null. If you have
|
1362
1544
|
# reached the end of the stream, it returns the same token you passed
|
1363
1545
|
# in.
|
1364
1546
|
# @return [String]
|
@@ -1379,26 +1561,42 @@ module Aws::CloudWatchLogs
|
|
1379
1561
|
# {
|
1380
1562
|
# log_group_name: "LogGroupName", # required
|
1381
1563
|
# time: 1,
|
1564
|
+
# log_group_identifier: "LogGroupIdentifier",
|
1382
1565
|
# }
|
1383
1566
|
#
|
1384
1567
|
# @!attribute [rw] log_group_name
|
1385
1568
|
# The name of the log group to search.
|
1569
|
+
#
|
1570
|
+
# If you specify values for both `logGroupName` and
|
1571
|
+
# `logGroupIdentifier`, the action returns an
|
1572
|
+
# `InvalidParameterException` error.
|
1386
1573
|
# @return [String]
|
1387
1574
|
#
|
1388
1575
|
# @!attribute [rw] time
|
1389
1576
|
# The time to set as the center of the query. If you specify `time`,
|
1390
|
-
# the 15 minutes before this time are queries. If you omit `time
|
1577
|
+
# the 15 minutes before this time are queries. If you omit `time`, the
|
1391
1578
|
# 8 minutes before and 8 minutes after this time are searched.
|
1392
1579
|
#
|
1393
|
-
# The `time` value is specified as epoch time, the number of
|
1394
|
-
# since January 1, 1970, 00:00:00 UTC
|
1580
|
+
# The `time` value is specified as epoch time, which is the number of
|
1581
|
+
# seconds since `January 1, 1970, 00:00:00 UTC`.
|
1395
1582
|
# @return [Integer]
|
1396
1583
|
#
|
1584
|
+
# @!attribute [rw] log_group_identifier
|
1585
|
+
# Specify either the name or ARN of the log group to view. If the log
|
1586
|
+
# group is in a source account and you are using a monitoring account,
|
1587
|
+
# you must specify the ARN.
|
1588
|
+
#
|
1589
|
+
# If you specify values for both `logGroupName` and
|
1590
|
+
# `logGroupIdentifier`, the action returns an
|
1591
|
+
# `InvalidParameterException` error.
|
1592
|
+
# @return [String]
|
1593
|
+
#
|
1397
1594
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogGroupFieldsRequest AWS API Documentation
|
1398
1595
|
#
|
1399
1596
|
class GetLogGroupFieldsRequest < Struct.new(
|
1400
1597
|
:log_group_name,
|
1401
|
-
:time
|
1598
|
+
:time,
|
1599
|
+
:log_group_identifier)
|
1402
1600
|
SENSITIVE = []
|
1403
1601
|
include Aws::Structure
|
1404
1602
|
end
|
@@ -1422,6 +1620,7 @@ module Aws::CloudWatchLogs
|
|
1422
1620
|
#
|
1423
1621
|
# {
|
1424
1622
|
# log_record_pointer: "LogRecordPointer", # required
|
1623
|
+
# unmask: false,
|
1425
1624
|
# }
|
1426
1625
|
#
|
1427
1626
|
# @!attribute [rw] log_record_pointer
|
@@ -1432,10 +1631,19 @@ module Aws::CloudWatchLogs
|
|
1432
1631
|
# complete log event record.
|
1433
1632
|
# @return [String]
|
1434
1633
|
#
|
1634
|
+
# @!attribute [rw] unmask
|
1635
|
+
# Specify `true` to display the log event fields with all sensitive
|
1636
|
+
# data unmasked and visible. The default is `false`.
|
1637
|
+
#
|
1638
|
+
# To use this operation with this parameter, you must be signed into
|
1639
|
+
# an account with the `logs:Unmask` permission.
|
1640
|
+
# @return [Boolean]
|
1641
|
+
#
|
1435
1642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogRecordRequest AWS API Documentation
|
1436
1643
|
#
|
1437
1644
|
class GetLogRecordRequest < Struct.new(
|
1438
|
-
:log_record_pointer
|
1645
|
+
:log_record_pointer,
|
1646
|
+
:unmask)
|
1439
1647
|
SENSITIVE = []
|
1440
1648
|
include Aws::Structure
|
1441
1649
|
end
|
@@ -1492,7 +1700,7 @@ module Aws::CloudWatchLogs
|
|
1492
1700
|
# are `Cancelled`, `Complete`, `Failed`, `Running`, `Scheduled`,
|
1493
1701
|
# `Timeout`, and `Unknown`.
|
1494
1702
|
#
|
1495
|
-
# Queries time out after 15 minutes of
|
1703
|
+
# Queries time out after 15 minutes of runtime. To avoid having your
|
1496
1704
|
# queries time out, reduce the time range being searched or partition
|
1497
1705
|
# your query into a number of queries.
|
1498
1706
|
# @return [String]
|
@@ -1520,7 +1728,7 @@ module Aws::CloudWatchLogs
|
|
1520
1728
|
#
|
1521
1729
|
# @!attribute [rw] timestamp
|
1522
1730
|
# The time the event occurred, expressed as the number of milliseconds
|
1523
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1731
|
+
# after `Jan 1, 1970 00:00:00 UTC`.
|
1524
1732
|
# @return [Integer]
|
1525
1733
|
#
|
1526
1734
|
# @!attribute [rw] message
|
@@ -1658,9 +1866,9 @@ module Aws::CloudWatchLogs
|
|
1658
1866
|
# @!attribute [rw] retention_in_days
|
1659
1867
|
# The number of days to retain the log events in the specified log
|
1660
1868
|
# group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150,
|
1661
|
-
# 180, 365, 400, 545, 731, 1827, and 3653.
|
1869
|
+
# 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
|
1662
1870
|
#
|
1663
|
-
# To set a log group
|
1871
|
+
# To set a log group so that its log events do not expire, use
|
1664
1872
|
# [DeleteRetentionPolicy][1].
|
1665
1873
|
#
|
1666
1874
|
#
|
@@ -1681,8 +1889,18 @@ module Aws::CloudWatchLogs
|
|
1681
1889
|
# @return [Integer]
|
1682
1890
|
#
|
1683
1891
|
# @!attribute [rw] kms_key_id
|
1684
|
-
# The Amazon Resource Name (ARN) of the
|
1685
|
-
# data.
|
1892
|
+
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
|
1893
|
+
# log data.
|
1894
|
+
# @return [String]
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] data_protection_status
|
1897
|
+
# Displays whether this log group has a protection policy, or whether
|
1898
|
+
# it had one in the past. For more information, see
|
1899
|
+
# [PutDataProtectionPolicy][1].
|
1900
|
+
#
|
1901
|
+
#
|
1902
|
+
#
|
1903
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html
|
1686
1904
|
# @return [String]
|
1687
1905
|
#
|
1688
1906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogGroup AWS API Documentation
|
@@ -1694,7 +1912,8 @@ module Aws::CloudWatchLogs
|
|
1694
1912
|
:metric_filter_count,
|
1695
1913
|
:arn,
|
1696
1914
|
:stored_bytes,
|
1697
|
-
:kms_key_id
|
1915
|
+
:kms_key_id,
|
1916
|
+
:data_protection_status)
|
1698
1917
|
SENSITIVE = []
|
1699
1918
|
include Aws::Structure
|
1700
1919
|
end
|
@@ -1729,18 +1948,18 @@ module Aws::CloudWatchLogs
|
|
1729
1948
|
#
|
1730
1949
|
# @!attribute [rw] creation_time
|
1731
1950
|
# The creation time of the stream, expressed as the number of
|
1732
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
1951
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
1733
1952
|
# @return [Integer]
|
1734
1953
|
#
|
1735
1954
|
# @!attribute [rw] first_event_timestamp
|
1736
1955
|
# The time of the first event, expressed as the number of milliseconds
|
1737
|
-
# after Jan 1, 1970 00:00:00 UTC
|
1956
|
+
# after `Jan 1, 1970 00:00:00 UTC`.
|
1738
1957
|
# @return [Integer]
|
1739
1958
|
#
|
1740
1959
|
# @!attribute [rw] last_event_timestamp
|
1741
1960
|
# The time of the most recent log event in the log stream in
|
1742
1961
|
# CloudWatch Logs. This number is expressed as the number of
|
1743
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
1962
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`. The `lastEventTime`
|
1744
1963
|
# value updates on an eventual consistency basis. It typically updates
|
1745
1964
|
# in less than an hour from ingestion, but in rare situations might
|
1746
1965
|
# take longer.
|
@@ -1748,7 +1967,7 @@ module Aws::CloudWatchLogs
|
|
1748
1967
|
#
|
1749
1968
|
# @!attribute [rw] last_ingestion_time
|
1750
1969
|
# The ingestion time, expressed as the number of milliseconds after
|
1751
|
-
# Jan 1, 1970 00:00:00 UTC
|
1970
|
+
# `Jan 1, 1970 00:00:00 UTC`.
|
1752
1971
|
# @return [Integer]
|
1753
1972
|
#
|
1754
1973
|
# @!attribute [rw] upload_sequence_token
|
@@ -1762,10 +1981,10 @@ module Aws::CloudWatchLogs
|
|
1762
1981
|
# @!attribute [rw] stored_bytes
|
1763
1982
|
# The number of bytes stored.
|
1764
1983
|
#
|
1765
|
-
# **Important:**
|
1766
|
-
# log streams, and is always reported as zero. This
|
1767
|
-
# only to log streams. The `storedBytes` parameter for
|
1768
|
-
# not affected.
|
1984
|
+
# **Important:** As of June 17, 2019, this parameter is no longer
|
1985
|
+
# supported for log streams, and is always reported as zero. This
|
1986
|
+
# change applies only to log streams. The `storedBytes` parameter for
|
1987
|
+
# log groups is not affected.
|
1769
1988
|
# @return [Integer]
|
1770
1989
|
#
|
1771
1990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/LogStream AWS API Documentation
|
@@ -1828,7 +2047,7 @@ module Aws::CloudWatchLogs
|
|
1828
2047
|
#
|
1829
2048
|
# @!attribute [rw] creation_time
|
1830
2049
|
# The creation time of the metric filter, expressed as the number of
|
1831
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
2050
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
1832
2051
|
# @return [Integer]
|
1833
2052
|
#
|
1834
2053
|
# @!attribute [rw] log_group_name
|
@@ -1922,9 +2141,10 @@ module Aws::CloudWatchLogs
|
|
1922
2141
|
# different value found for a dimension is treated as a separate
|
1923
2142
|
# metric and accrues charges as a separate custom metric.
|
1924
2143
|
#
|
1925
|
-
#
|
1926
|
-
#
|
1927
|
-
#
|
2144
|
+
# CloudWatch Logs disables a metric filter if it generates 1000
|
2145
|
+
# different name/value pairs for your specified dimensions within a
|
2146
|
+
# certain amount of time. This helps to prevent accidental high
|
2147
|
+
# charges.
|
1928
2148
|
#
|
1929
2149
|
# You can also set up a billing alarm to alert you if your charges
|
1930
2150
|
# are
|
@@ -1965,7 +2185,7 @@ module Aws::CloudWatchLogs
|
|
1965
2185
|
#
|
1966
2186
|
# @!attribute [rw] timestamp
|
1967
2187
|
# The time the event occurred, expressed as the number of milliseconds
|
1968
|
-
# after Jan 1, 1970 00:00:00 UTC
|
2188
|
+
# after `Jan 1, 1970 00:00:00 UTC`.
|
1969
2189
|
# @return [Integer]
|
1970
2190
|
#
|
1971
2191
|
# @!attribute [rw] message
|
@@ -1974,7 +2194,7 @@ module Aws::CloudWatchLogs
|
|
1974
2194
|
#
|
1975
2195
|
# @!attribute [rw] ingestion_time
|
1976
2196
|
# The time the event was ingested, expressed as the number of
|
1977
|
-
# milliseconds after Jan 1, 1970 00:00:00 UTC
|
2197
|
+
# milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
1978
2198
|
# @return [Integer]
|
1979
2199
|
#
|
1980
2200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OutputLogEvent AWS API Documentation
|
@@ -1987,6 +2207,87 @@ module Aws::CloudWatchLogs
|
|
1987
2207
|
include Aws::Structure
|
1988
2208
|
end
|
1989
2209
|
|
2210
|
+
# @note When making an API call, you may pass PutDataProtectionPolicyRequest
|
2211
|
+
# data as a hash:
|
2212
|
+
#
|
2213
|
+
# {
|
2214
|
+
# log_group_identifier: "LogGroupIdentifier", # required
|
2215
|
+
# policy_document: "DataProtectionPolicyDocument", # required
|
2216
|
+
# }
|
2217
|
+
#
|
2218
|
+
# @!attribute [rw] log_group_identifier
|
2219
|
+
# Specify either the log group name or log group ARN.
|
2220
|
+
# @return [String]
|
2221
|
+
#
|
2222
|
+
# @!attribute [rw] policy_document
|
2223
|
+
# Specify the data protection policy, in JSON.
|
2224
|
+
#
|
2225
|
+
# This policy must include two JSON blocks:
|
2226
|
+
#
|
2227
|
+
# * The first block must include both a `DataIdentifer` array and an
|
2228
|
+
# `Operation` property with an `Audit` action. The `DataIdentifer`
|
2229
|
+
# array lists the types of sensitive data that you want to mask. For
|
2230
|
+
# more information about the available options, see [Types of data
|
2231
|
+
# that you can mask][1].
|
2232
|
+
#
|
2233
|
+
# The `Operation` property with an `Audit` action is required to
|
2234
|
+
# find the sensitive data terms. This `Audit` action must contain a
|
2235
|
+
# `FindingsDestination` object. You can optionally use that
|
2236
|
+
# `FindingsDestination` object to list one or more destinations to
|
2237
|
+
# send audit findings to. If you specify destinations such as log
|
2238
|
+
# groups, Kinesis Data Firehose streams, and S3 buckets, they must
|
2239
|
+
# already exist.
|
2240
|
+
#
|
2241
|
+
# * The second block must include both a `DataIdentifer` array and an
|
2242
|
+
# `Operation` property with an `Deidentify` action. The
|
2243
|
+
# `DataIdentifer` array must exactly match the `DataIdentifer` array
|
2244
|
+
# in the first block of the policy.
|
2245
|
+
#
|
2246
|
+
# The `Operation` property with the `Deidentify` action is what
|
2247
|
+
# actually masks the data, and it must contain the ` "MaskConfig":
|
2248
|
+
# \{\}` object. The ` "MaskConfig": \{\}` object must be empty.
|
2249
|
+
#
|
2250
|
+
# For an example data protection policy, see the **Examples** section
|
2251
|
+
# on this page.
|
2252
|
+
#
|
2253
|
+
# The contents of two `DataIdentifer` arrays must match exactly.
|
2254
|
+
#
|
2255
|
+
#
|
2256
|
+
#
|
2257
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html
|
2258
|
+
# @return [String]
|
2259
|
+
#
|
2260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDataProtectionPolicyRequest AWS API Documentation
|
2261
|
+
#
|
2262
|
+
class PutDataProtectionPolicyRequest < Struct.new(
|
2263
|
+
:log_group_identifier,
|
2264
|
+
:policy_document)
|
2265
|
+
SENSITIVE = []
|
2266
|
+
include Aws::Structure
|
2267
|
+
end
|
2268
|
+
|
2269
|
+
# @!attribute [rw] log_group_identifier
|
2270
|
+
# The log group name or ARN that you specified in your request.
|
2271
|
+
# @return [String]
|
2272
|
+
#
|
2273
|
+
# @!attribute [rw] policy_document
|
2274
|
+
# The data protection policy used for this log group.
|
2275
|
+
# @return [String]
|
2276
|
+
#
|
2277
|
+
# @!attribute [rw] last_updated_time
|
2278
|
+
# The date and time that this policy was most recently updated.
|
2279
|
+
# @return [Integer]
|
2280
|
+
#
|
2281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutDataProtectionPolicyResponse AWS API Documentation
|
2282
|
+
#
|
2283
|
+
class PutDataProtectionPolicyResponse < Struct.new(
|
2284
|
+
:log_group_identifier,
|
2285
|
+
:policy_document,
|
2286
|
+
:last_updated_time)
|
2287
|
+
SENSITIVE = []
|
2288
|
+
include Aws::Structure
|
2289
|
+
end
|
2290
|
+
|
1990
2291
|
# @note When making an API call, you may pass PutDestinationPolicyRequest
|
1991
2292
|
# data as a hash:
|
1992
2293
|
#
|
@@ -2225,10 +2526,10 @@ module Aws::CloudWatchLogs
|
|
2225
2526
|
# }
|
2226
2527
|
#
|
2227
2528
|
# @!attribute [rw] name
|
2228
|
-
# A name for the query definition. If you are saving
|
2229
|
-
# definitions, we recommend that you name them
|
2230
|
-
#
|
2231
|
-
#
|
2529
|
+
# A name for the query definition. If you are saving numerous query
|
2530
|
+
# definitions, we recommend that you name them. This way, you can find
|
2531
|
+
# the ones you want by using the first part of the name as a filter in
|
2532
|
+
# the `queryDefinitionNamePrefix` parameter of
|
2232
2533
|
# [DescribeQueryDefinitions][1].
|
2233
2534
|
#
|
2234
2535
|
#
|
@@ -2318,8 +2619,8 @@ module Aws::CloudWatchLogs
|
|
2318
2619
|
#
|
2319
2620
|
# In the example resource policy, you would replace the value of
|
2320
2621
|
# `SourceArn` with the resource making the call from Route 53 to
|
2321
|
-
# CloudWatch Logs
|
2322
|
-
# Amazon Web Services account ID making that call.
|
2622
|
+
# CloudWatch Logs. You would also replace the value of `SourceAccount`
|
2623
|
+
# with the Amazon Web Services account ID making that call.
|
2323
2624
|
#
|
2324
2625
|
#
|
2325
2626
|
#
|
@@ -2373,9 +2674,9 @@ module Aws::CloudWatchLogs
|
|
2373
2674
|
# @!attribute [rw] retention_in_days
|
2374
2675
|
# The number of days to retain the log events in the specified log
|
2375
2676
|
# group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150,
|
2376
|
-
# 180, 365, 400, 545, 731, 1827, and 3653.
|
2677
|
+
# 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
|
2377
2678
|
#
|
2378
|
-
# To set a log group
|
2679
|
+
# To set a log group so that its log events do not expire, use
|
2379
2680
|
# [DeleteRetentionPolicy][1].
|
2380
2681
|
#
|
2381
2682
|
#
|
@@ -2433,12 +2734,12 @@ module Aws::CloudWatchLogs
|
|
2433
2734
|
# * A logical destination (specified using an ARN) belonging to a
|
2434
2735
|
# different account, for cross-account delivery.
|
2435
2736
|
#
|
2436
|
-
# If you
|
2437
|
-
# destination must have an IAM policy associated with it
|
2438
|
-
# the sender to send logs to the destination. For
|
2439
|
-
# see [PutDestinationPolicy][1].
|
2737
|
+
# If you're setting up a cross-account subscription, the
|
2738
|
+
# destination must have an IAM policy associated with it. The IAM
|
2739
|
+
# policy must allow the sender to send logs to the destination. For
|
2740
|
+
# more information, see [PutDestinationPolicy][1].
|
2440
2741
|
#
|
2441
|
-
# *
|
2742
|
+
# * A Kinesis Data Firehose delivery stream belonging to the same
|
2442
2743
|
# account as the subscription filter, for same-account delivery.
|
2443
2744
|
#
|
2444
2745
|
# * A Lambda function belonging to the same account as the
|
@@ -2460,7 +2761,7 @@ module Aws::CloudWatchLogs
|
|
2460
2761
|
# The method used to distribute log data to the destination. By
|
2461
2762
|
# default, log data is grouped by log stream, but the grouping can be
|
2462
2763
|
# set to random for a more even distribution. This property is only
|
2463
|
-
# applicable when the destination is an Amazon Kinesis stream.
|
2764
|
+
# applicable when the destination is an Amazon Kinesis data stream.
|
2464
2765
|
# @return [String]
|
2465
2766
|
#
|
2466
2767
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutSubscriptionFilterRequest AWS API Documentation
|
@@ -2625,7 +2926,7 @@ module Aws::CloudWatchLogs
|
|
2625
2926
|
# @return [Integer]
|
2626
2927
|
#
|
2627
2928
|
# @!attribute [rw] too_old_log_event_end_index
|
2628
|
-
# The log events that are too
|
2929
|
+
# The log events that are dated too far in the past.
|
2629
2930
|
# @return [Integer]
|
2630
2931
|
#
|
2631
2932
|
# @!attribute [rw] expired_log_event_end_index
|
@@ -2667,7 +2968,7 @@ module Aws::CloudWatchLogs
|
|
2667
2968
|
#
|
2668
2969
|
# @!attribute [rw] last_updated_time
|
2669
2970
|
# Timestamp showing when this policy was last updated, expressed as
|
2670
|
-
# the number of milliseconds after Jan 1, 1970 00:00:00 UTC
|
2971
|
+
# the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
2671
2972
|
# @return [Integer]
|
2672
2973
|
#
|
2673
2974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResourcePolicy AWS API Documentation
|
@@ -2738,6 +3039,7 @@ module Aws::CloudWatchLogs
|
|
2738
3039
|
# {
|
2739
3040
|
# log_group_name: "LogGroupName",
|
2740
3041
|
# log_group_names: ["LogGroupName"],
|
3042
|
+
# log_group_identifiers: ["LogGroupIdentifier"],
|
2741
3043
|
# start_time: 1, # required
|
2742
3044
|
# end_time: 1, # required
|
2743
3045
|
# query_string: "QueryString", # required
|
@@ -2747,29 +3049,51 @@ module Aws::CloudWatchLogs
|
|
2747
3049
|
# @!attribute [rw] log_group_name
|
2748
3050
|
# The log group on which to perform the query.
|
2749
3051
|
#
|
2750
|
-
# A `StartQuery` operation must include
|
2751
|
-
# `logGroupName`
|
3052
|
+
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
3053
|
+
# parameters: `logGroupName`, `logGroupNames` or
|
3054
|
+
# `logGroupIdentifiers`.
|
3055
|
+
#
|
3056
|
+
# </note>
|
2752
3057
|
# @return [String]
|
2753
3058
|
#
|
2754
3059
|
# @!attribute [rw] log_group_names
|
2755
|
-
# The list of log groups to be queried. You can include up to
|
3060
|
+
# The list of log groups to be queried. You can include up to 50 log
|
2756
3061
|
# groups.
|
2757
3062
|
#
|
2758
|
-
# A `StartQuery` operation must include
|
2759
|
-
# `logGroupName`
|
3063
|
+
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
3064
|
+
# parameters: `logGroupName`, `logGroupNames` or
|
3065
|
+
# `logGroupIdentifiers`.
|
3066
|
+
#
|
3067
|
+
# </note>
|
3068
|
+
# @return [Array<String>]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] log_group_identifiers
|
3071
|
+
# The list of log groups to query. You can include up to 50 log
|
3072
|
+
# groups.
|
3073
|
+
#
|
3074
|
+
# You can specify them by the log group name or ARN. If a log group
|
3075
|
+
# that you're querying is in a source account and you're using a
|
3076
|
+
# monitoring account, you must specify the ARN of the log group here.
|
3077
|
+
# The query definition must also be defined in the monitoring account.
|
3078
|
+
#
|
3079
|
+
# If you specify an ARN, the ARN can't end with an asterisk (*).
|
3080
|
+
#
|
3081
|
+
# A `StartQuery` operation must include exactly one of the following
|
3082
|
+
# parameters: `logGroupName`, `logGroupNames` or
|
3083
|
+
# `logGroupIdentifiers`.
|
2760
3084
|
# @return [Array<String>]
|
2761
3085
|
#
|
2762
3086
|
# @!attribute [rw] start_time
|
2763
3087
|
# The beginning of the time range to query. The range is inclusive, so
|
2764
3088
|
# the specified start time is included in the query. Specified as
|
2765
|
-
# epoch time, the number of seconds since January 1, 1970, 00:00:00
|
2766
|
-
# UTC
|
3089
|
+
# epoch time, the number of seconds since `January 1, 1970, 00:00:00
|
3090
|
+
# UTC`.
|
2767
3091
|
# @return [Integer]
|
2768
3092
|
#
|
2769
3093
|
# @!attribute [rw] end_time
|
2770
3094
|
# The end of the time range to query. The range is inclusive, so the
|
2771
3095
|
# specified end time is included in the query. Specified as epoch
|
2772
|
-
# time, the number of seconds since January 1, 1970, 00:00:00 UTC
|
3096
|
+
# time, the number of seconds since `January 1, 1970, 00:00:00 UTC`.
|
2773
3097
|
# @return [Integer]
|
2774
3098
|
#
|
2775
3099
|
# @!attribute [rw] query_string
|
@@ -2792,6 +3116,7 @@ module Aws::CloudWatchLogs
|
|
2792
3116
|
class StartQueryRequest < Struct.new(
|
2793
3117
|
:log_group_name,
|
2794
3118
|
:log_group_names,
|
3119
|
+
:log_group_identifiers,
|
2795
3120
|
:start_time,
|
2796
3121
|
:end_time,
|
2797
3122
|
:query_string,
|
@@ -2875,7 +3200,7 @@ module Aws::CloudWatchLogs
|
|
2875
3200
|
#
|
2876
3201
|
# @!attribute [rw] creation_time
|
2877
3202
|
# The creation time of the subscription filter, expressed as the
|
2878
|
-
# number of milliseconds after Jan 1, 1970 00:00:00 UTC
|
3203
|
+
# number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
|
2879
3204
|
# @return [Integer]
|
2880
3205
|
#
|
2881
3206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/SubscriptionFilter AWS API Documentation
|
@@ -3017,8 +3342,8 @@ module Aws::CloudWatchLogs
|
|
3017
3342
|
include Aws::Structure
|
3018
3343
|
end
|
3019
3344
|
|
3020
|
-
# The most likely cause is an
|
3021
|
-
#
|
3345
|
+
# The most likely cause is an Amazon Web Services access key ID or
|
3346
|
+
# secret key that's not valid.
|
3022
3347
|
#
|
3023
3348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/UnrecognizedClientException AWS API Documentation
|
3024
3349
|
#
|