aws-sdk-cloudwatchlogs 1.133.0 → 1.134.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchlogs/client.rb +495 -135
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +195 -0
- data/lib/aws-sdk-cloudwatchlogs/types.rb +554 -152
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- data/sig/client.rbs +79 -1
- data/sig/types.rbs +112 -0
- metadata +1 -1
|
@@ -621,6 +621,46 @@ module Aws::CloudWatchLogs
|
|
|
621
621
|
req.send_request(options)
|
|
622
622
|
end
|
|
623
623
|
|
|
624
|
+
# Associates a data source with an S3 Table Integration for query access
|
|
625
|
+
# in the 'logs' namespace. This enables querying log data using
|
|
626
|
+
# analytics engines that support Iceberg such as Amazon Athena, Amazon
|
|
627
|
+
# Redshift, and Apache Spark.
|
|
628
|
+
#
|
|
629
|
+
# @option params [required, String] :integration_arn
|
|
630
|
+
# The Amazon Resource Name (ARN) of the S3 Table Integration to
|
|
631
|
+
# associate the data source with.
|
|
632
|
+
#
|
|
633
|
+
# @option params [required, Types::DataSource] :data_source
|
|
634
|
+
# The data source to associate with the S3 Table Integration. Contains
|
|
635
|
+
# the name and type of the data source.
|
|
636
|
+
#
|
|
637
|
+
# @return [Types::AssociateSourceToS3TableIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
638
|
+
#
|
|
639
|
+
# * {Types::AssociateSourceToS3TableIntegrationResponse#identifier #identifier} => String
|
|
640
|
+
#
|
|
641
|
+
# @example Request syntax with placeholder values
|
|
642
|
+
#
|
|
643
|
+
# resp = client.associate_source_to_s3_table_integration({
|
|
644
|
+
# integration_arn: "Arn", # required
|
|
645
|
+
# data_source: { # required
|
|
646
|
+
# name: "DataSourceName", # required
|
|
647
|
+
# type: "DataSourceType",
|
|
648
|
+
# },
|
|
649
|
+
# })
|
|
650
|
+
#
|
|
651
|
+
# @example Response structure
|
|
652
|
+
#
|
|
653
|
+
# resp.identifier #=> String
|
|
654
|
+
#
|
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateSourceToS3TableIntegration AWS API Documentation
|
|
656
|
+
#
|
|
657
|
+
# @overload associate_source_to_s3_table_integration(params = {})
|
|
658
|
+
# @param [Hash] params ({})
|
|
659
|
+
def associate_source_to_s3_table_integration(params = {}, options = {})
|
|
660
|
+
req = build_request(:associate_source_to_s3_table_integration, params)
|
|
661
|
+
req.send_request(options)
|
|
662
|
+
end
|
|
663
|
+
|
|
624
664
|
# Cancels the specified export task.
|
|
625
665
|
#
|
|
626
666
|
# The task must be in the `PENDING` or `RUNNING` state.
|
|
@@ -1162,82 +1202,73 @@ module Aws::CloudWatchLogs
|
|
|
1162
1202
|
req.send_request(options)
|
|
1163
1203
|
end
|
|
1164
1204
|
|
|
1165
|
-
# Creates a
|
|
1166
|
-
#
|
|
1205
|
+
# Creates a scheduled query that runs CloudWatch Logs Insights queries
|
|
1206
|
+
# at regular intervals. Scheduled queries enable proactive monitoring by
|
|
1207
|
+
# automatically executing queries to detect patterns and anomalies in
|
|
1208
|
+
# your log data. Query results can be delivered to Amazon S3 for
|
|
1209
|
+
# analysis or further processing.
|
|
1167
1210
|
#
|
|
1168
1211
|
# @option params [required, String] :name
|
|
1169
|
-
#
|
|
1170
|
-
# account
|
|
1171
|
-
#
|
|
1212
|
+
# The name of the scheduled query. The name must be unique within your
|
|
1213
|
+
# account and region. Valid characters are alphanumeric characters,
|
|
1214
|
+
# hyphens, underscores, and periods. Length must be between 1 and 255
|
|
1215
|
+
# characters.
|
|
1172
1216
|
#
|
|
1173
1217
|
# @option params [String] :description
|
|
1174
1218
|
# An optional description for the scheduled query to help identify its
|
|
1175
|
-
# purpose.
|
|
1219
|
+
# purpose and functionality.
|
|
1176
1220
|
#
|
|
1177
1221
|
# @option params [required, String] :query_language
|
|
1178
1222
|
# The query language to use for the scheduled query. Valid values are
|
|
1179
|
-
# LogsQL
|
|
1180
|
-
# Service Piped Processing Language), and SQL (OpenSearch Service
|
|
1181
|
-
# Structured Query Language).
|
|
1223
|
+
# `LogsQL`, `PPL`, and `SQL`.
|
|
1182
1224
|
#
|
|
1183
1225
|
# @option params [required, String] :query_string
|
|
1184
|
-
# The
|
|
1185
|
-
#
|
|
1186
|
-
# schedule.
|
|
1226
|
+
# The query string to execute. This is the same query syntax used in
|
|
1227
|
+
# CloudWatch Logs Insights. Maximum length is 10,000 characters.
|
|
1187
1228
|
#
|
|
1188
1229
|
# @option params [Array<String>] :log_group_identifiers
|
|
1189
|
-
#
|
|
1190
|
-
#
|
|
1191
|
-
# monitoring account, you must specify the ARN of the log group.
|
|
1230
|
+
# An array of log group names or ARNs to query. You can specify between
|
|
1231
|
+
# 1 and 50 log groups. Log groups can be identified by name or full ARN.
|
|
1192
1232
|
#
|
|
1193
1233
|
# @option params [required, String] :schedule_expression
|
|
1194
1234
|
# A cron expression that defines when the scheduled query runs. The
|
|
1195
|
-
#
|
|
1196
|
-
#
|
|
1235
|
+
# expression uses standard cron syntax and supports minute-level
|
|
1236
|
+
# precision. Maximum length is 256 characters.
|
|
1197
1237
|
#
|
|
1198
1238
|
# @option params [String] :timezone
|
|
1199
|
-
# The timezone
|
|
1200
|
-
#
|
|
1239
|
+
# The timezone for evaluating the schedule expression. This determines
|
|
1240
|
+
# when the scheduled query executes relative to the specified timezone.
|
|
1201
1241
|
#
|
|
1202
1242
|
# @option params [Integer] :start_time_offset
|
|
1203
|
-
#
|
|
1204
|
-
# query
|
|
1205
|
-
#
|
|
1243
|
+
# The time offset in seconds that defines the lookback period for the
|
|
1244
|
+
# query. This determines how far back in time the query searches from
|
|
1245
|
+
# the execution time.
|
|
1206
1246
|
#
|
|
1207
1247
|
# @option params [Types::DestinationConfiguration] :destination_configuration
|
|
1208
|
-
# Configuration for
|
|
1209
|
-
#
|
|
1210
|
-
# buckets or EventBridge event buses.
|
|
1248
|
+
# Configuration for where to deliver query results. Currently supports
|
|
1249
|
+
# Amazon S3 destinations for storing query output.
|
|
1211
1250
|
#
|
|
1212
1251
|
# @option params [Integer] :schedule_start_time
|
|
1213
|
-
# The start time for the query
|
|
1214
|
-
#
|
|
1215
|
-
# starts immediately.
|
|
1252
|
+
# The start time for the scheduled query in Unix epoch format. The query
|
|
1253
|
+
# will not execute before this time.
|
|
1216
1254
|
#
|
|
1217
1255
|
# @option params [Integer] :schedule_end_time
|
|
1218
|
-
# The end time for the query
|
|
1219
|
-
#
|
|
1220
|
-
# indefinitely.
|
|
1256
|
+
# The end time for the scheduled query in Unix epoch format. The query
|
|
1257
|
+
# will stop executing after this time.
|
|
1221
1258
|
#
|
|
1222
1259
|
# @option params [required, String] :execution_role_arn
|
|
1223
|
-
# The
|
|
1224
|
-
#
|
|
1225
|
-
# specified
|
|
1260
|
+
# The ARN of the IAM role that grants permissions to execute the query
|
|
1261
|
+
# and deliver results to the specified destination. The role must have
|
|
1262
|
+
# permissions to read from the specified log groups and write to the
|
|
1263
|
+
# destination.
|
|
1226
1264
|
#
|
|
1227
1265
|
# @option params [String] :state
|
|
1228
|
-
# The initial state of the scheduled query. Valid values are ENABLED
|
|
1229
|
-
#
|
|
1230
|
-
# is paused and will not run). If not provided, defaults to ENABLED.
|
|
1266
|
+
# The initial state of the scheduled query. Valid values are `ENABLED`
|
|
1267
|
+
# and `DISABLED`. Default is `ENABLED`.
|
|
1231
1268
|
#
|
|
1232
1269
|
# @option params [Hash<String,String>] :tags
|
|
1233
|
-
#
|
|
1234
|
-
#
|
|
1235
|
-
# For more information about tagging, see [Tagging Amazon Web Services
|
|
1236
|
-
# resources][1]
|
|
1237
|
-
#
|
|
1238
|
-
#
|
|
1239
|
-
#
|
|
1240
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
|
1270
|
+
# Key-value pairs to associate with the scheduled query for resource
|
|
1271
|
+
# management and cost allocation.
|
|
1241
1272
|
#
|
|
1242
1273
|
# @return [Types::CreateScheduledQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1243
1274
|
#
|
|
@@ -1285,9 +1316,12 @@ module Aws::CloudWatchLogs
|
|
|
1285
1316
|
end
|
|
1286
1317
|
|
|
1287
1318
|
# Deletes a CloudWatch Logs account policy. This stops the account-wide
|
|
1288
|
-
# policy from applying to log groups in the account. If
|
|
1289
|
-
# data protection policy or subscription filter policy, any
|
|
1290
|
-
# level policies of those types remain in effect.
|
|
1319
|
+
# policy from applying to log groups or data sources in the account. If
|
|
1320
|
+
# you delete a data protection policy or subscription filter policy, any
|
|
1321
|
+
# log-group level policies of those types remain in effect. This
|
|
1322
|
+
# operation supports deletion of data source-based field index policies,
|
|
1323
|
+
# including facet configurations, in addition to log group-based
|
|
1324
|
+
# policies.
|
|
1291
1325
|
#
|
|
1292
1326
|
# To use this operation, you must be signed on with the correct
|
|
1293
1327
|
# permissions depending on the type of policy that you are deleting.
|
|
@@ -1306,6 +1340,11 @@ module Aws::CloudWatchLogs
|
|
|
1306
1340
|
# * To delete a field index policy, you must have the
|
|
1307
1341
|
# `logs:DeleteIndexPolicy` and `logs:DeleteAccountPolicy` permissions.
|
|
1308
1342
|
#
|
|
1343
|
+
# If you delete a field index policy that included facet
|
|
1344
|
+
# configurations, those facets will no longer be available for
|
|
1345
|
+
# interactive exploration in the CloudWatch Logs Insights console.
|
|
1346
|
+
# However, facet data is retained for up to 30 days.
|
|
1347
|
+
#
|
|
1309
1348
|
# If you delete a field index policy, the indexing of the log events
|
|
1310
1349
|
# that happened before you deleted the policy will still be used for up
|
|
1311
1350
|
# to 30 days to improve CloudWatch Logs Insights queries.
|
|
@@ -1522,13 +1561,20 @@ module Aws::CloudWatchLogs
|
|
|
1522
1561
|
# you delete the policy will still be used for as many as 30 days to
|
|
1523
1562
|
# improve CloudWatch Logs Insights queries.
|
|
1524
1563
|
#
|
|
1564
|
+
# If the deleted policy included facet configurations, those facets will
|
|
1565
|
+
# no longer be available for interactive exploration in the CloudWatch
|
|
1566
|
+
# Logs Insights console for this log group. However, facet data is
|
|
1567
|
+
# retained for up to 30 days.
|
|
1568
|
+
#
|
|
1525
1569
|
# You can't use this operation to delete an account-level index policy.
|
|
1526
1570
|
# Instead, use [DeletAccountPolicy][1].
|
|
1527
1571
|
#
|
|
1528
1572
|
# If you delete a log-group level field index policy and there is an
|
|
1529
1573
|
# account-level field index policy, in a few minutes the log group
|
|
1530
1574
|
# begins using that account-wide policy to index new incoming log
|
|
1531
|
-
# events.
|
|
1575
|
+
# events. This operation only affects log group-level policies,
|
|
1576
|
+
# including any facet configurations, and preserves any data
|
|
1577
|
+
# source-based account policies that may apply to the log group.
|
|
1532
1578
|
#
|
|
1533
1579
|
#
|
|
1534
1580
|
#
|
|
@@ -1798,12 +1844,12 @@ module Aws::CloudWatchLogs
|
|
|
1798
1844
|
req.send_request(options)
|
|
1799
1845
|
end
|
|
1800
1846
|
|
|
1801
|
-
# Deletes
|
|
1802
|
-
#
|
|
1803
|
-
#
|
|
1847
|
+
# Deletes a scheduled query and stops all future executions. This
|
|
1848
|
+
# operation also removes any configured actions and associated
|
|
1849
|
+
# resources.
|
|
1804
1850
|
#
|
|
1805
1851
|
# @option params [required, String] :identifier
|
|
1806
|
-
# The
|
|
1852
|
+
# The ARN or name of the scheduled query to delete.
|
|
1807
1853
|
#
|
|
1808
1854
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1809
1855
|
#
|
|
@@ -2351,6 +2397,7 @@ module Aws::CloudWatchLogs
|
|
|
2351
2397
|
# resp.field_indexes[0].last_scan_time #=> Integer
|
|
2352
2398
|
# resp.field_indexes[0].first_event_time #=> Integer
|
|
2353
2399
|
# resp.field_indexes[0].last_event_time #=> Integer
|
|
2400
|
+
# resp.field_indexes[0].type #=> String, one of "FACET", "FIELD_INDEX"
|
|
2354
2401
|
# resp.next_token #=> String
|
|
2355
2402
|
#
|
|
2356
2403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeFieldIndexes AWS API Documentation
|
|
@@ -2419,9 +2466,10 @@ module Aws::CloudWatchLogs
|
|
|
2419
2466
|
req.send_request(options)
|
|
2420
2467
|
end
|
|
2421
2468
|
|
|
2422
|
-
# Returns information about log groups
|
|
2423
|
-
#
|
|
2424
|
-
# by
|
|
2469
|
+
# Returns information about log groups, including data sources that
|
|
2470
|
+
# ingest into each log group. You can return all your log groups or
|
|
2471
|
+
# filter the results by prefix. The results are ASCII-sorted by log
|
|
2472
|
+
# group name.
|
|
2425
2473
|
#
|
|
2426
2474
|
# CloudWatch Logs doesn't support IAM policies that control access to
|
|
2427
2475
|
# the `DescribeLogGroups` action by using the `aws:ResourceTag/key-name
|
|
@@ -2767,6 +2815,12 @@ module Aws::CloudWatchLogs
|
|
|
2767
2815
|
# all queries or limit it to queries of a specific log group or queries
|
|
2768
2816
|
# with a certain status.
|
|
2769
2817
|
#
|
|
2818
|
+
# This operation includes both interactive queries started directly by
|
|
2819
|
+
# users and automated queries executed by scheduled query
|
|
2820
|
+
# configurations. Scheduled query executions appear in the results
|
|
2821
|
+
# alongside manually initiated queries, providing visibility into all
|
|
2822
|
+
# query activity in your account.
|
|
2823
|
+
#
|
|
2770
2824
|
# @option params [String] :log_group_name
|
|
2771
2825
|
# Limits the returned queries to only those for the specified log group.
|
|
2772
2826
|
#
|
|
@@ -3079,6 +3133,36 @@ module Aws::CloudWatchLogs
|
|
|
3079
3133
|
req.send_request(options)
|
|
3080
3134
|
end
|
|
3081
3135
|
|
|
3136
|
+
# Disassociates a data source from an S3 Table Integration, removing
|
|
3137
|
+
# query access and deleting all associated data from the integration.
|
|
3138
|
+
#
|
|
3139
|
+
# @option params [required, String] :identifier
|
|
3140
|
+
# The unique identifier of the association to remove between the data
|
|
3141
|
+
# source and S3 Table Integration.
|
|
3142
|
+
#
|
|
3143
|
+
# @return [Types::DisassociateSourceFromS3TableIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3144
|
+
#
|
|
3145
|
+
# * {Types::DisassociateSourceFromS3TableIntegrationResponse#identifier #identifier} => String
|
|
3146
|
+
#
|
|
3147
|
+
# @example Request syntax with placeholder values
|
|
3148
|
+
#
|
|
3149
|
+
# resp = client.disassociate_source_from_s3_table_integration({
|
|
3150
|
+
# identifier: "S3TableIntegrationSourceIdentifier", # required
|
|
3151
|
+
# })
|
|
3152
|
+
#
|
|
3153
|
+
# @example Response structure
|
|
3154
|
+
#
|
|
3155
|
+
# resp.identifier #=> String
|
|
3156
|
+
#
|
|
3157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateSourceFromS3TableIntegration AWS API Documentation
|
|
3158
|
+
#
|
|
3159
|
+
# @overload disassociate_source_from_s3_table_integration(params = {})
|
|
3160
|
+
# @param [Hash] params ({})
|
|
3161
|
+
def disassociate_source_from_s3_table_integration(params = {}, options = {})
|
|
3162
|
+
req = build_request(:disassociate_source_from_s3_table_integration, params)
|
|
3163
|
+
req.send_request(options)
|
|
3164
|
+
end
|
|
3165
|
+
|
|
3082
3166
|
# Lists log events from the specified log group. You can list all the
|
|
3083
3167
|
# log events or filter the results using one or more of the following:
|
|
3084
3168
|
#
|
|
@@ -3720,11 +3804,53 @@ module Aws::CloudWatchLogs
|
|
|
3720
3804
|
req.send_request(options)
|
|
3721
3805
|
end
|
|
3722
3806
|
|
|
3807
|
+
# Discovers available fields for a specific data source and type. The
|
|
3808
|
+
# response includes any field modifications introduced through
|
|
3809
|
+
# pipelines, such as new fields or changed field types.
|
|
3810
|
+
#
|
|
3811
|
+
# @option params [required, String] :data_source_name
|
|
3812
|
+
# The name of the data source to retrieve log fields for.
|
|
3813
|
+
#
|
|
3814
|
+
# @option params [required, String] :data_source_type
|
|
3815
|
+
# The type of the data source to retrieve log fields for.
|
|
3816
|
+
#
|
|
3817
|
+
# @return [Types::GetLogFieldsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3818
|
+
#
|
|
3819
|
+
# * {Types::GetLogFieldsResponse#log_fields #log_fields} => Array<Types::LogFieldsListItem>
|
|
3820
|
+
#
|
|
3821
|
+
# @example Request syntax with placeholder values
|
|
3822
|
+
#
|
|
3823
|
+
# resp = client.get_log_fields({
|
|
3824
|
+
# data_source_name: "DataSourceName", # required
|
|
3825
|
+
# data_source_type: "DataSourceType", # required
|
|
3826
|
+
# })
|
|
3827
|
+
#
|
|
3828
|
+
# @example Response structure
|
|
3829
|
+
#
|
|
3830
|
+
# resp.log_fields #=> Array
|
|
3831
|
+
# resp.log_fields[0].log_field_name #=> String
|
|
3832
|
+
# resp.log_fields[0].log_field_type.type #=> String
|
|
3833
|
+
# resp.log_fields[0].log_field_type.element #=> Types::LogFieldType
|
|
3834
|
+
# resp.log_fields[0].log_field_type.fields #=> Types::LogFieldsList
|
|
3835
|
+
#
|
|
3836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetLogFields AWS API Documentation
|
|
3837
|
+
#
|
|
3838
|
+
# @overload get_log_fields(params = {})
|
|
3839
|
+
# @param [Hash] params ({})
|
|
3840
|
+
def get_log_fields(params = {}, options = {})
|
|
3841
|
+
req = build_request(:get_log_fields, params)
|
|
3842
|
+
req.send_request(options)
|
|
3843
|
+
end
|
|
3844
|
+
|
|
3723
3845
|
# Returns a list of the fields that are included in log events in the
|
|
3724
3846
|
# specified log group. Includes the percentage of log events that
|
|
3725
3847
|
# contain each field. The search is limited to a time period that you
|
|
3726
3848
|
# specify.
|
|
3727
3849
|
#
|
|
3850
|
+
# This operation is used for discovering fields within log group events.
|
|
3851
|
+
# For discovering fields across data sources, use the GetLogFields
|
|
3852
|
+
# operation.
|
|
3853
|
+
#
|
|
3728
3854
|
# You can specify the log group to search by using either
|
|
3729
3855
|
# `logGroupIdentifier` or `logGroupName`. You must specify one of these
|
|
3730
3856
|
# parameters, but you can't specify both.
|
|
@@ -4037,6 +4163,11 @@ module Aws::CloudWatchLogs
|
|
|
4037
4163
|
# `Scheduled` or `Running` for the status, you can retry the operation
|
|
4038
4164
|
# later to see the final results.
|
|
4039
4165
|
#
|
|
4166
|
+
# This operation is used both for retrieving results from interactive
|
|
4167
|
+
# queries and from automated scheduled query executions. Scheduled
|
|
4168
|
+
# queries use `GetQueryResults` internally to retrieve query results for
|
|
4169
|
+
# processing and delivery to configured destinations.
|
|
4170
|
+
#
|
|
4040
4171
|
# If you are using CloudWatch cross-account observability, you can use
|
|
4041
4172
|
# this operation in a monitoring account to start queries in linked
|
|
4042
4173
|
# source accounts. For more information, see [CloudWatch cross-account
|
|
@@ -4091,11 +4222,11 @@ module Aws::CloudWatchLogs
|
|
|
4091
4222
|
req.send_request(options)
|
|
4092
4223
|
end
|
|
4093
4224
|
|
|
4094
|
-
#
|
|
4095
|
-
#
|
|
4225
|
+
# Retrieves details about a specific scheduled query, including its
|
|
4226
|
+
# configuration, execution status, and metadata.
|
|
4096
4227
|
#
|
|
4097
4228
|
# @option params [required, String] :identifier
|
|
4098
|
-
# The
|
|
4229
|
+
# The ARN or name of the scheduled query to retrieve.
|
|
4099
4230
|
#
|
|
4100
4231
|
# @return [Types::GetScheduledQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4101
4232
|
#
|
|
@@ -4157,24 +4288,25 @@ module Aws::CloudWatchLogs
|
|
|
4157
4288
|
end
|
|
4158
4289
|
|
|
4159
4290
|
# Retrieves the execution history of a scheduled query within a
|
|
4160
|
-
# specified time range, including
|
|
4161
|
-
# processing
|
|
4291
|
+
# specified time range, including query results and destination
|
|
4292
|
+
# processing status.
|
|
4162
4293
|
#
|
|
4163
4294
|
# @option params [required, String] :identifier
|
|
4164
|
-
# The
|
|
4295
|
+
# The ARN or name of the scheduled query to retrieve history for.
|
|
4165
4296
|
#
|
|
4166
4297
|
# @option params [required, Integer] :start_time
|
|
4167
|
-
# The start time for the history
|
|
4298
|
+
# The start time for the history query in Unix epoch format.
|
|
4168
4299
|
#
|
|
4169
4300
|
# @option params [required, Integer] :end_time
|
|
4170
|
-
# The end time for the history
|
|
4301
|
+
# The end time for the history query in Unix epoch format.
|
|
4171
4302
|
#
|
|
4172
4303
|
# @option params [Array<String>] :execution_statuses
|
|
4173
|
-
#
|
|
4174
|
-
#
|
|
4304
|
+
# An array of execution statuses to filter the history results. Only
|
|
4305
|
+
# executions with the specified statuses are returned.
|
|
4175
4306
|
#
|
|
4176
4307
|
# @option params [Integer] :max_results
|
|
4177
|
-
# The maximum number of history records to return
|
|
4308
|
+
# The maximum number of history records to return. Valid range is 1 to
|
|
4309
|
+
# 1000.
|
|
4178
4310
|
#
|
|
4179
4311
|
# @option params [String] :next_token
|
|
4180
4312
|
# The token for the next set of items to return. The token expires after
|
|
@@ -4344,6 +4476,122 @@ module Aws::CloudWatchLogs
|
|
|
4344
4476
|
req.send_request(options)
|
|
4345
4477
|
end
|
|
4346
4478
|
|
|
4479
|
+
# Returns an aggregate summary of all log groups in the Region grouped
|
|
4480
|
+
# by specified data source characteristics. Supports optional filtering
|
|
4481
|
+
# by log group class, name patterns, and data sources. If you perform
|
|
4482
|
+
# this action in a monitoring account, you can also return aggregated
|
|
4483
|
+
# summaries of log groups from source accounts that are linked to the
|
|
4484
|
+
# monitoring account. For more information about using cross-account
|
|
4485
|
+
# observability to set up monitoring accounts and source accounts, see
|
|
4486
|
+
# [CloudWatch cross-account observability][1].
|
|
4487
|
+
#
|
|
4488
|
+
# The operation aggregates log groups by data source name and type and
|
|
4489
|
+
# optionally format, providing counts of log groups that share these
|
|
4490
|
+
# characteristics. The operation paginates results. By default, it
|
|
4491
|
+
# returns up to 50 results and includes a token to retrieve more
|
|
4492
|
+
# results.
|
|
4493
|
+
#
|
|
4494
|
+
#
|
|
4495
|
+
#
|
|
4496
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
|
|
4497
|
+
#
|
|
4498
|
+
# @option params [Array<String>] :account_identifiers
|
|
4499
|
+
# When `includeLinkedAccounts` is set to `true`, use this parameter to
|
|
4500
|
+
# specify the list of accounts to search. You can specify as many as 20
|
|
4501
|
+
# account IDs in the array.
|
|
4502
|
+
#
|
|
4503
|
+
# @option params [Boolean] :include_linked_accounts
|
|
4504
|
+
# If you are using a monitoring account, set this to `true` to have the
|
|
4505
|
+
# operation return log groups in the accounts listed in
|
|
4506
|
+
# `accountIdentifiers`.
|
|
4507
|
+
#
|
|
4508
|
+
# If this parameter is set to `true` and `accountIdentifiers` contains a
|
|
4509
|
+
# null value, the operation returns all log groups in the monitoring
|
|
4510
|
+
# account and all log groups in all source accounts that are linked to
|
|
4511
|
+
# the monitoring account.
|
|
4512
|
+
#
|
|
4513
|
+
# The default for this parameter is `false`.
|
|
4514
|
+
#
|
|
4515
|
+
# @option params [String] :log_group_class
|
|
4516
|
+
# Filters the results by log group class to include only log groups of
|
|
4517
|
+
# the specified class.
|
|
4518
|
+
#
|
|
4519
|
+
# @option params [String] :log_group_name_pattern
|
|
4520
|
+
# Use this parameter to limit the returned log groups to only those with
|
|
4521
|
+
# names that match the pattern that you specify. This parameter is a
|
|
4522
|
+
# regular expression that can match prefixes and substrings, and
|
|
4523
|
+
# supports wildcard matching and matching multiple patterns, as in the
|
|
4524
|
+
# following examples.
|
|
4525
|
+
#
|
|
4526
|
+
# * Use `^` to match log group names by prefix.
|
|
4527
|
+
#
|
|
4528
|
+
# * For a substring match, specify the string to match. All matches are
|
|
4529
|
+
# case sensitive
|
|
4530
|
+
#
|
|
4531
|
+
# * To match multiple patterns, separate them with a `|` as in the
|
|
4532
|
+
# example `^/aws/lambda|discovery`
|
|
4533
|
+
#
|
|
4534
|
+
# You can specify as many as five different regular expression patterns
|
|
4535
|
+
# in this field, each of which must be between 3 and 24 characters. You
|
|
4536
|
+
# can include the `^` symbol as many as five times, and include the `|`
|
|
4537
|
+
# symbol as many as four times.
|
|
4538
|
+
#
|
|
4539
|
+
# @option params [Array<Types::DataSourceFilter>] :data_sources
|
|
4540
|
+
# Filters the results by data source characteristics to include only log
|
|
4541
|
+
# groups associated with the specified data sources.
|
|
4542
|
+
#
|
|
4543
|
+
# @option params [required, String] :group_by
|
|
4544
|
+
# Specifies how to group the log groups in the summary.
|
|
4545
|
+
#
|
|
4546
|
+
# @option params [String] :next_token
|
|
4547
|
+
# The token for the next set of items to return. The token expires after
|
|
4548
|
+
# 24 hours.
|
|
4549
|
+
#
|
|
4550
|
+
# @option params [Integer] :limit
|
|
4551
|
+
# The maximum number of aggregated summaries to return. If you omit this
|
|
4552
|
+
# parameter, the default is up to 50 aggregated summaries.
|
|
4553
|
+
#
|
|
4554
|
+
# @return [Types::ListAggregateLogGroupSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4555
|
+
#
|
|
4556
|
+
# * {Types::ListAggregateLogGroupSummariesResponse#aggregate_log_group_summaries #aggregate_log_group_summaries} => Array<Types::AggregateLogGroupSummary>
|
|
4557
|
+
# * {Types::ListAggregateLogGroupSummariesResponse#next_token #next_token} => String
|
|
4558
|
+
#
|
|
4559
|
+
# @example Request syntax with placeholder values
|
|
4560
|
+
#
|
|
4561
|
+
# resp = client.list_aggregate_log_group_summaries({
|
|
4562
|
+
# account_identifiers: ["AccountId"],
|
|
4563
|
+
# include_linked_accounts: false,
|
|
4564
|
+
# log_group_class: "STANDARD", # accepts STANDARD, INFREQUENT_ACCESS, DELIVERY
|
|
4565
|
+
# log_group_name_pattern: "LogGroupNameRegexPattern",
|
|
4566
|
+
# data_sources: [
|
|
4567
|
+
# {
|
|
4568
|
+
# name: "DataSourceName", # required
|
|
4569
|
+
# type: "DataSourceType",
|
|
4570
|
+
# },
|
|
4571
|
+
# ],
|
|
4572
|
+
# group_by: "DATA_SOURCE_NAME_TYPE_AND_FORMAT", # required, accepts DATA_SOURCE_NAME_TYPE_AND_FORMAT, DATA_SOURCE_NAME_AND_TYPE
|
|
4573
|
+
# next_token: "NextToken",
|
|
4574
|
+
# limit: 1,
|
|
4575
|
+
# })
|
|
4576
|
+
#
|
|
4577
|
+
# @example Response structure
|
|
4578
|
+
#
|
|
4579
|
+
# resp.aggregate_log_group_summaries #=> Array
|
|
4580
|
+
# resp.aggregate_log_group_summaries[0].log_group_count #=> Integer
|
|
4581
|
+
# resp.aggregate_log_group_summaries[0].grouping_identifiers #=> Array
|
|
4582
|
+
# resp.aggregate_log_group_summaries[0].grouping_identifiers[0].key #=> String
|
|
4583
|
+
# resp.aggregate_log_group_summaries[0].grouping_identifiers[0].value #=> String
|
|
4584
|
+
# resp.next_token #=> String
|
|
4585
|
+
#
|
|
4586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListAggregateLogGroupSummaries AWS API Documentation
|
|
4587
|
+
#
|
|
4588
|
+
# @overload list_aggregate_log_group_summaries(params = {})
|
|
4589
|
+
# @param [Hash] params ({})
|
|
4590
|
+
def list_aggregate_log_group_summaries(params = {}, options = {})
|
|
4591
|
+
req = build_request(:list_aggregate_log_group_summaries, params)
|
|
4592
|
+
req.send_request(options)
|
|
4593
|
+
end
|
|
4594
|
+
|
|
4347
4595
|
# Returns a list of anomalies that log anomaly detectors have found. For
|
|
4348
4596
|
# details about the structure format of each anomaly object that is
|
|
4349
4597
|
# returned, see the example in this section.
|
|
@@ -4529,9 +4777,12 @@ module Aws::CloudWatchLogs
|
|
|
4529
4777
|
# observability to set up monitoring accounts and source accounts, see [
|
|
4530
4778
|
# CloudWatch cross-account observability][1].
|
|
4531
4779
|
#
|
|
4532
|
-
# You can optionally filter the list by log group class
|
|
4780
|
+
# You can optionally filter the list by log group class, by using
|
|
4533
4781
|
# regular expressions in your request to match strings in the log group
|
|
4534
|
-
# names
|
|
4782
|
+
# names, by using the fieldIndexes parameter to filter log groups based
|
|
4783
|
+
# on which field indexes are configured, by using the dataSources
|
|
4784
|
+
# parameter to filter log groups by data source types, and by using the
|
|
4785
|
+
# fieldIndexNames parameter to filter by specific field index names.
|
|
4535
4786
|
#
|
|
4536
4787
|
# This operation is paginated. By default, your first use of this
|
|
4537
4788
|
# operation returns 50 results, and includes a token to use in a
|
|
@@ -4591,6 +4842,19 @@ module Aws::CloudWatchLogs
|
|
|
4591
4842
|
# The maximum number of log groups to return. If you omit this
|
|
4592
4843
|
# parameter, the default is up to 50 log groups.
|
|
4593
4844
|
#
|
|
4845
|
+
# @option params [Array<Types::DataSourceFilter>] :data_sources
|
|
4846
|
+
# An array of data source filters to filter log groups by their
|
|
4847
|
+
# associated data sources. You can filter by data source name, type, or
|
|
4848
|
+
# both. Multiple filters within the same dimension are combined with OR
|
|
4849
|
+
# logic, while filters across different dimensions are combined with AND
|
|
4850
|
+
# logic.
|
|
4851
|
+
#
|
|
4852
|
+
# @option params [Array<String>] :field_index_names
|
|
4853
|
+
# An array of field index names to filter log groups that have specific
|
|
4854
|
+
# field indexes. Only log groups containing all specified field indexes
|
|
4855
|
+
# are returned. You can specify 1 to 20 field index names, each with 1
|
|
4856
|
+
# to 512 characters.
|
|
4857
|
+
#
|
|
4594
4858
|
# @return [Types::ListLogGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4595
4859
|
#
|
|
4596
4860
|
# * {Types::ListLogGroupsResponse#log_groups #log_groups} => Array<Types::LogGroupSummary>
|
|
@@ -4605,6 +4869,13 @@ module Aws::CloudWatchLogs
|
|
|
4605
4869
|
# account_identifiers: ["AccountId"],
|
|
4606
4870
|
# next_token: "NextToken",
|
|
4607
4871
|
# limit: 1,
|
|
4872
|
+
# data_sources: [
|
|
4873
|
+
# {
|
|
4874
|
+
# name: "DataSourceName", # required
|
|
4875
|
+
# type: "DataSourceType",
|
|
4876
|
+
# },
|
|
4877
|
+
# ],
|
|
4878
|
+
# field_index_names: ["FieldIndexName"],
|
|
4608
4879
|
# })
|
|
4609
4880
|
#
|
|
4610
4881
|
# @example Response structure
|
|
@@ -4681,19 +4952,20 @@ module Aws::CloudWatchLogs
|
|
|
4681
4952
|
req.send_request(options)
|
|
4682
4953
|
end
|
|
4683
4954
|
|
|
4684
|
-
# Lists all scheduled queries in
|
|
4685
|
-
#
|
|
4955
|
+
# Lists all scheduled queries in your account and region. You can filter
|
|
4956
|
+
# results by state to show only enabled or disabled queries.
|
|
4686
4957
|
#
|
|
4687
4958
|
# @option params [Integer] :max_results
|
|
4688
|
-
# The maximum number of scheduled queries to return
|
|
4959
|
+
# The maximum number of scheduled queries to return. Valid range is 1 to
|
|
4960
|
+
# 1000.
|
|
4689
4961
|
#
|
|
4690
4962
|
# @option params [String] :next_token
|
|
4691
4963
|
# The token for the next set of items to return. The token expires after
|
|
4692
4964
|
# 24 hours.
|
|
4693
4965
|
#
|
|
4694
4966
|
# @option params [String] :state
|
|
4695
|
-
# Filter
|
|
4696
|
-
# DISABLED
|
|
4967
|
+
# Filter scheduled queries by state. Valid values are `ENABLED` and
|
|
4968
|
+
# `DISABLED`. If not specified, all scheduled queries are returned.
|
|
4697
4969
|
#
|
|
4698
4970
|
# @return [Types::ListScheduledQueriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4699
4971
|
#
|
|
@@ -4735,6 +5007,57 @@ module Aws::CloudWatchLogs
|
|
|
4735
5007
|
req.send_request(options)
|
|
4736
5008
|
end
|
|
4737
5009
|
|
|
5010
|
+
# Returns a list of data source associations for a specified S3 Table
|
|
5011
|
+
# Integration, showing which data sources are currently associated for
|
|
5012
|
+
# query access.
|
|
5013
|
+
#
|
|
5014
|
+
# @option params [required, String] :integration_arn
|
|
5015
|
+
# The Amazon Resource Name (ARN) of the S3 Table Integration to list
|
|
5016
|
+
# associations for.
|
|
5017
|
+
#
|
|
5018
|
+
# @option params [Integer] :max_results
|
|
5019
|
+
# The maximum number of associations to return in a single call. Valid
|
|
5020
|
+
# range is 1 to 100.
|
|
5021
|
+
#
|
|
5022
|
+
# @option params [String] :next_token
|
|
5023
|
+
# The token for the next set of items to return. The token expires after
|
|
5024
|
+
# 24 hours.
|
|
5025
|
+
#
|
|
5026
|
+
# @return [Types::ListSourcesForS3TableIntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5027
|
+
#
|
|
5028
|
+
# * {Types::ListSourcesForS3TableIntegrationResponse#sources #sources} => Array<Types::S3TableIntegrationSource>
|
|
5029
|
+
# * {Types::ListSourcesForS3TableIntegrationResponse#next_token #next_token} => String
|
|
5030
|
+
#
|
|
5031
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5032
|
+
#
|
|
5033
|
+
# @example Request syntax with placeholder values
|
|
5034
|
+
#
|
|
5035
|
+
# resp = client.list_sources_for_s3_table_integration({
|
|
5036
|
+
# integration_arn: "Arn", # required
|
|
5037
|
+
# max_results: 1,
|
|
5038
|
+
# next_token: "NextToken",
|
|
5039
|
+
# })
|
|
5040
|
+
#
|
|
5041
|
+
# @example Response structure
|
|
5042
|
+
#
|
|
5043
|
+
# resp.sources #=> Array
|
|
5044
|
+
# resp.sources[0].identifier #=> String
|
|
5045
|
+
# resp.sources[0].data_source.name #=> String
|
|
5046
|
+
# resp.sources[0].data_source.type #=> String
|
|
5047
|
+
# resp.sources[0].status #=> String, one of "ACTIVE", "UNHEALTHY", "FAILED", "DATA_SOURCE_DELETE_IN_PROGRESS"
|
|
5048
|
+
# resp.sources[0].status_reason #=> String
|
|
5049
|
+
# resp.sources[0].created_time_stamp #=> Integer
|
|
5050
|
+
# resp.next_token #=> String
|
|
5051
|
+
#
|
|
5052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListSourcesForS3TableIntegration AWS API Documentation
|
|
5053
|
+
#
|
|
5054
|
+
# @overload list_sources_for_s3_table_integration(params = {})
|
|
5055
|
+
# @param [Hash] params ({})
|
|
5056
|
+
def list_sources_for_s3_table_integration(params = {}, options = {})
|
|
5057
|
+
req = build_request(:list_sources_for_s3_table_integration, params)
|
|
5058
|
+
req.send_request(options)
|
|
5059
|
+
end
|
|
5060
|
+
|
|
4738
5061
|
# Displays the tags associated with a CloudWatch Logs resource.
|
|
4739
5062
|
# Currently, log groups and destinations support tagging.
|
|
4740
5063
|
#
|
|
@@ -4819,6 +5142,12 @@ module Aws::CloudWatchLogs
|
|
|
4819
5142
|
# policy that applies to all log groups or a subset of log groups in the
|
|
4820
5143
|
# account.
|
|
4821
5144
|
#
|
|
5145
|
+
# For field index policies, you can configure indexed fields as *facets*
|
|
5146
|
+
# to enable interactive exploration of your logs. Facets provide value
|
|
5147
|
+
# distributions and counts for indexed fields in the CloudWatch Logs
|
|
5148
|
+
# Insights console without requiring query execution. For more
|
|
5149
|
+
# information, see [Use facets to group and explore logs][1].
|
|
5150
|
+
#
|
|
4822
5151
|
# To use this operation, you must be signed on with the correct
|
|
4823
5152
|
# permissions depending on the type of policy that you are creating.
|
|
4824
5153
|
#
|
|
@@ -4836,6 +5165,9 @@ module Aws::CloudWatchLogs
|
|
|
4836
5165
|
# * To create a field index policy, you must have the
|
|
4837
5166
|
# `logs:PutIndexPolicy` and `logs:PutAccountPolicy` permissions.
|
|
4838
5167
|
#
|
|
5168
|
+
# * To configure facets for field index policies, you must have the
|
|
5169
|
+
# `logs:PutIndexPolicy` and `logs:PutAccountPolicy` permissions.
|
|
5170
|
+
#
|
|
4839
5171
|
# * To create a metric extraction policy, you must have the
|
|
4840
5172
|
# `logs:PutMetricExtractionPolicy` and `logs:PutAccountPolicy`
|
|
4841
5173
|
# permissions.
|
|
@@ -4860,21 +5192,21 @@ module Aws::CloudWatchLogs
|
|
|
4860
5192
|
#
|
|
4861
5193
|
# By default, when a user views a log event that includes masked data,
|
|
4862
5194
|
# the sensitive data is replaced by asterisks. A user who has the
|
|
4863
|
-
# `logs:Unmask` permission can use a [GetLogEvents][
|
|
4864
|
-
# [FilterLogEvents][
|
|
5195
|
+
# `logs:Unmask` permission can use a [GetLogEvents][2] or
|
|
5196
|
+
# [FilterLogEvents][3] operation with the `unmask` parameter set to
|
|
4865
5197
|
# `true` to view the unmasked log events. Users with the `logs:Unmask`
|
|
4866
5198
|
# can also view unmasked data in the CloudWatch Logs console by running
|
|
4867
5199
|
# a CloudWatch Logs Insights query with the `unmask` query command.
|
|
4868
5200
|
#
|
|
4869
5201
|
# For more information, including a list of types of data that can be
|
|
4870
|
-
# audited and masked, see [Protect sensitive log data with masking][
|
|
5202
|
+
# audited and masked, see [Protect sensitive log data with masking][4].
|
|
4871
5203
|
#
|
|
4872
5204
|
# To use the `PutAccountPolicy` operation for a data protection policy,
|
|
4873
5205
|
# you must be signed on with the `logs:PutDataProtectionPolicy` and
|
|
4874
5206
|
# `logs:PutAccountPolicy` permissions.
|
|
4875
5207
|
#
|
|
4876
5208
|
# The `PutAccountPolicy` operation applies to all log groups in the
|
|
4877
|
-
# account. You can use [PutDataProtectionPolicy][
|
|
5209
|
+
# account. You can use [PutDataProtectionPolicy][5] to create a data
|
|
4878
5210
|
# protection policy that applies to just one log group. If a log group
|
|
4879
5211
|
# has its own data protection policy and the account also has an
|
|
4880
5212
|
# account-level data protection policy, then the two policies are
|
|
@@ -4902,7 +5234,7 @@ module Aws::CloudWatchLogs
|
|
|
4902
5234
|
# for same-account delivery.
|
|
4903
5235
|
#
|
|
4904
5236
|
# * A logical destination in a different account created with
|
|
4905
|
-
# [PutDestination][
|
|
5237
|
+
# [PutDestination][6], for cross-account delivery. Kinesis Data
|
|
4906
5238
|
# Streams and Firehose are supported as logical destinations.
|
|
4907
5239
|
#
|
|
4908
5240
|
# Each account can have one account-level subscription filter policy per
|
|
@@ -4931,7 +5263,7 @@ module Aws::CloudWatchLogs
|
|
|
4931
5263
|
# processor applies one type of transformation to the log events
|
|
4932
5264
|
# ingested into this log group. For more information about the available
|
|
4933
5265
|
# processors to use in a transformer, see [ Processors that you can
|
|
4934
|
-
# use][
|
|
5266
|
+
# use][7].
|
|
4935
5267
|
#
|
|
4936
5268
|
# Having log events in standardized format enables visibility across
|
|
4937
5269
|
# your applications for your log analysis, reporting, and alarming
|
|
@@ -4973,7 +5305,7 @@ module Aws::CloudWatchLogs
|
|
|
4973
5305
|
# towards your field index quota.
|
|
4974
5306
|
#
|
|
4975
5307
|
# You can also set up a transformer at the log-group level. For more
|
|
4976
|
-
# information, see [PutTransformer][
|
|
5308
|
+
# information, see [PutTransformer][8]. If there is both a log-group
|
|
4977
5309
|
# level transformer created with `PutTransformer` and an account-level
|
|
4978
5310
|
# transformer that could apply to the same log group, the log group uses
|
|
4979
5311
|
# only the log-group level transformer. It ignores the account-level
|
|
@@ -4990,10 +5322,10 @@ module Aws::CloudWatchLogs
|
|
|
4990
5322
|
# that match only a small fraction of the total log events. Common
|
|
4991
5323
|
# examples of indexes include request ID, session ID, user IDs, or
|
|
4992
5324
|
# instance IDs. For more information, see [Create field indexes to
|
|
4993
|
-
# improve query performance and reduce costs][
|
|
5325
|
+
# improve query performance and reduce costs][9]
|
|
4994
5326
|
#
|
|
4995
5327
|
# To find the fields that are in your log group events, use the
|
|
4996
|
-
# [GetLogGroupFields][
|
|
5328
|
+
# [GetLogGroupFields][10] operation.
|
|
4997
5329
|
#
|
|
4998
5330
|
# For example, suppose you have created a field index for `requestId`.
|
|
4999
5331
|
# Then, any CloudWatch Logs Insights query on that log group that
|
|
@@ -5006,24 +5338,27 @@ module Aws::CloudWatchLogs
|
|
|
5006
5338
|
# match a log event containing `requestId`.
|
|
5007
5339
|
#
|
|
5008
5340
|
# You can have one account-level field index policy that applies to all
|
|
5009
|
-
# log groups in the account. Or you can create as many as
|
|
5010
|
-
# account-level field index policies
|
|
5011
|
-
#
|
|
5012
|
-
#
|
|
5013
|
-
#
|
|
5014
|
-
#
|
|
5015
|
-
#
|
|
5016
|
-
#
|
|
5341
|
+
# log groups in the account. Or you can create as many as 40
|
|
5342
|
+
# account-level field index policies (20 for log group prefix selection,
|
|
5343
|
+
# 20 for data source selection) that are each scoped to a subset of log
|
|
5344
|
+
# groups or data sources with the `selectionCriteria` parameter. Field
|
|
5345
|
+
# index policies can now be created for specific data source name and
|
|
5346
|
+
# type combinations using DataSourceName and DataSourceType selection
|
|
5347
|
+
# criteria. If you have multiple account-level index policies with
|
|
5348
|
+
# selection criteria, no two of them can use the same or overlapping log
|
|
5349
|
+
# group name prefixes. For example, if you have one policy filtered to
|
|
5350
|
+
# log groups that start with `my-log`, you can't have another field
|
|
5351
|
+
# index policy filtered to `my-logpprod` or `my-logging`.
|
|
5017
5352
|
#
|
|
5018
5353
|
# If you create an account-level field index policy in a monitoring
|
|
5019
5354
|
# account in cross-account observability, the policy is applied only to
|
|
5020
5355
|
# the monitoring account and not to any source accounts.
|
|
5021
5356
|
#
|
|
5022
5357
|
# If you want to create a field index policy for a single log group, you
|
|
5023
|
-
# can use [PutIndexPolicy][
|
|
5358
|
+
# can use [PutIndexPolicy][11] instead of `PutAccountPolicy`. If you do
|
|
5024
5359
|
# so, that log group will use only that log-group level policy, and will
|
|
5025
5360
|
# ignore the account-level policy that you create with
|
|
5026
|
-
# [PutAccountPolicy][
|
|
5361
|
+
# [PutAccountPolicy][12].
|
|
5027
5362
|
#
|
|
5028
5363
|
# **Metric extraction policy**
|
|
5029
5364
|
#
|
|
@@ -5089,17 +5424,18 @@ module Aws::CloudWatchLogs
|
|
|
5089
5424
|
#
|
|
5090
5425
|
#
|
|
5091
5426
|
#
|
|
5092
|
-
# [1]: https://docs.aws.amazon.com/
|
|
5093
|
-
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/
|
|
5094
|
-
# [3]: https://docs.aws.amazon.com/
|
|
5095
|
-
# [4]: https://docs.aws.amazon.com/
|
|
5096
|
-
# [5]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/
|
|
5097
|
-
# [6]: https://docs.aws.amazon.com/
|
|
5098
|
-
# [7]: https://docs.aws.amazon.com/
|
|
5099
|
-
# [8]: https://docs.aws.amazon.com/
|
|
5100
|
-
# [9]: https://docs.aws.amazon.com/
|
|
5101
|
-
# [10]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/
|
|
5102
|
-
# [11]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/
|
|
5427
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Facets.html
|
|
5428
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html
|
|
5429
|
+
# [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html
|
|
5430
|
+
# [4]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html
|
|
5431
|
+
# [5]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html
|
|
5432
|
+
# [6]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html
|
|
5433
|
+
# [7]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors
|
|
5434
|
+
# [8]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html
|
|
5435
|
+
# [9]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html
|
|
5436
|
+
# [10]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html
|
|
5437
|
+
# [11]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html
|
|
5438
|
+
# [12]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html
|
|
5103
5439
|
#
|
|
5104
5440
|
# @option params [required, String] :policy_name
|
|
5105
5441
|
# A name for the policy. This must be unique within the account.
|
|
@@ -5886,8 +6222,16 @@ module Aws::CloudWatchLogs
|
|
|
5886
6222
|
# userID, and instance IDs. For more information, see [Create field
|
|
5887
6223
|
# indexes to improve query performance and reduce costs][2].
|
|
5888
6224
|
#
|
|
6225
|
+
# You can configure indexed fields as *facets* to enable interactive
|
|
6226
|
+
# exploration and filtering of your logs in the CloudWatch Logs Insights
|
|
6227
|
+
# console. Facets allow you to view value distributions and counts for
|
|
6228
|
+
# indexed fields without running queries. When you create a field index,
|
|
6229
|
+
# you can optionally set it as a facet to enable this interactive
|
|
6230
|
+
# analysis capability. For more information, see [Use facets to group
|
|
6231
|
+
# and explore logs][3].
|
|
6232
|
+
#
|
|
5889
6233
|
# To find the fields that are in your log group events, use the
|
|
5890
|
-
# [GetLogGroupFields][
|
|
6234
|
+
# [GetLogGroupFields][4] operation.
|
|
5891
6235
|
#
|
|
5892
6236
|
# For example, suppose you have created a field index for `requestId`.
|
|
5893
6237
|
# Then, any CloudWatch Logs Insights query on that log group that
|
|
@@ -5925,17 +6269,20 @@ module Aws::CloudWatchLogs
|
|
|
5925
6269
|
#
|
|
5926
6270
|
# Log group-level field index policies created with `PutIndexPolicy`
|
|
5927
6271
|
# override account-level field index policies created with
|
|
5928
|
-
# [PutAccountPolicy][
|
|
5929
|
-
# index policy for a log group, that
|
|
5930
|
-
#
|
|
5931
|
-
#
|
|
6272
|
+
# [PutAccountPolicy][5] that apply to log groups. If you use
|
|
6273
|
+
# `PutIndexPolicy` to create a field index policy for a log group, that
|
|
6274
|
+
# log group uses only that policy for log group-level indexing,
|
|
6275
|
+
# including any facet configurations. The log group ignores any
|
|
6276
|
+
# account-wide field index policy that applies to log groups, but data
|
|
6277
|
+
# source-based account policies may still apply.
|
|
5932
6278
|
#
|
|
5933
6279
|
#
|
|
5934
6280
|
#
|
|
5935
6281
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html
|
|
5936
6282
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html
|
|
5937
|
-
# [3]: https://docs.aws.amazon.com/
|
|
5938
|
-
# [4]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/
|
|
6283
|
+
# [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Facets.html
|
|
6284
|
+
# [4]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html
|
|
6285
|
+
# [5]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html
|
|
5939
6286
|
#
|
|
5940
6287
|
# @option params [required, String] :log_group_identifier
|
|
5941
6288
|
# Specify either the log group name or log group ARN to apply this field
|
|
@@ -7247,9 +7594,10 @@ module Aws::CloudWatchLogs
|
|
|
7247
7594
|
req.send_request(options)
|
|
7248
7595
|
end
|
|
7249
7596
|
|
|
7250
|
-
# Starts a query of one or more log groups
|
|
7251
|
-
# Insights. You specify the log groups
|
|
7252
|
-
# query string to use.
|
|
7597
|
+
# Starts a query of one or more log groups or data sources using
|
|
7598
|
+
# CloudWatch Logs Insights. You specify the log groups or data sources
|
|
7599
|
+
# and time range to query and the query string to use. You can query up
|
|
7600
|
+
# to 10 data sources in a single query.
|
|
7253
7601
|
#
|
|
7254
7602
|
# For more information, see [CloudWatch Logs Insights Query Syntax][1].
|
|
7255
7603
|
#
|
|
@@ -7257,6 +7605,12 @@ module Aws::CloudWatchLogs
|
|
|
7257
7605
|
# by CloudWatch Logs. You can use [GetQueryResults][2] to retrieve the
|
|
7258
7606
|
# results of a query, using the `queryId` that `StartQuery` returns.
|
|
7259
7607
|
#
|
|
7608
|
+
# Interactive queries started with `StartQuery` share concurrency limits
|
|
7609
|
+
# with automated scheduled query executions. Both types of queries count
|
|
7610
|
+
# toward the same regional concurrent query quota, so high scheduled
|
|
7611
|
+
# query activity may affect the availability of concurrent slots for
|
|
7612
|
+
# interactive queries.
|
|
7613
|
+
#
|
|
7260
7614
|
# <note markdown="1"> To specify the log groups to query, a `StartQuery` operation must
|
|
7261
7615
|
# include one of the following:
|
|
7262
7616
|
#
|
|
@@ -7265,7 +7619,8 @@ module Aws::CloudWatchLogs
|
|
|
7265
7619
|
#
|
|
7266
7620
|
# * Or the `queryString` must include a `SOURCE` command to select log
|
|
7267
7621
|
# groups for the query. The `SOURCE` command can select log groups
|
|
7268
|
-
# based on log group name prefix, account ID, and log class
|
|
7622
|
+
# based on log group name prefix, account ID, and log class, or select
|
|
7623
|
+
# data sources using dataSource syntax in LogsQL, PPL, and SQL.
|
|
7269
7624
|
#
|
|
7270
7625
|
# For more information about the `SOURCE` command, see [SOURCE][3].
|
|
7271
7626
|
#
|
|
@@ -7406,6 +7761,11 @@ module Aws::CloudWatchLogs
|
|
|
7406
7761
|
# query has already ended, the operation returns an error indicating
|
|
7407
7762
|
# that the specified query is not running.
|
|
7408
7763
|
#
|
|
7764
|
+
# This operation can be used to cancel both interactive queries and
|
|
7765
|
+
# individual scheduled query executions. When used with scheduled
|
|
7766
|
+
# queries, `StopQuery` cancels only the specific execution identified by
|
|
7767
|
+
# the query ID, not the scheduled query configuration itself.
|
|
7768
|
+
#
|
|
7409
7769
|
# @option params [required, String] :query_id
|
|
7410
7770
|
# The ID number of the query to stop. To find this ID number, use
|
|
7411
7771
|
# `DescribeQueries`.
|
|
@@ -8022,51 +8382,51 @@ module Aws::CloudWatchLogs
|
|
|
8022
8382
|
req.send_request(options)
|
|
8023
8383
|
end
|
|
8024
8384
|
|
|
8025
|
-
# Updates
|
|
8026
|
-
# operation
|
|
8027
|
-
#
|
|
8385
|
+
# Updates an existing scheduled query with new configuration. This
|
|
8386
|
+
# operation uses PUT semantics, allowing modification of query
|
|
8387
|
+
# parameters, schedule, and destinations.
|
|
8028
8388
|
#
|
|
8029
8389
|
# @option params [required, String] :identifier
|
|
8030
|
-
# The
|
|
8390
|
+
# The ARN or name of the scheduled query to update.
|
|
8031
8391
|
#
|
|
8032
8392
|
# @option params [String] :description
|
|
8033
|
-
#
|
|
8393
|
+
# An updated description for the scheduled query.
|
|
8034
8394
|
#
|
|
8035
8395
|
# @option params [required, String] :query_language
|
|
8036
|
-
#
|
|
8396
|
+
# The updated query language for the scheduled query.
|
|
8037
8397
|
#
|
|
8038
8398
|
# @option params [required, String] :query_string
|
|
8039
|
-
#
|
|
8399
|
+
# The updated query string to execute.
|
|
8040
8400
|
#
|
|
8041
8401
|
# @option params [Array<String>] :log_group_identifiers
|
|
8042
|
-
#
|
|
8402
|
+
# The updated array of log group names or ARNs to query.
|
|
8043
8403
|
#
|
|
8044
8404
|
# @option params [required, String] :schedule_expression
|
|
8045
|
-
#
|
|
8405
|
+
# The updated cron expression that defines when the scheduled query
|
|
8406
|
+
# runs.
|
|
8046
8407
|
#
|
|
8047
8408
|
# @option params [String] :timezone
|
|
8048
|
-
#
|
|
8409
|
+
# The updated timezone for evaluating the schedule expression.
|
|
8049
8410
|
#
|
|
8050
8411
|
# @option params [Integer] :start_time_offset
|
|
8051
|
-
#
|
|
8052
|
-
#
|
|
8412
|
+
# The updated time offset in seconds that defines the lookback period
|
|
8413
|
+
# for the query.
|
|
8053
8414
|
#
|
|
8054
8415
|
# @option params [Types::DestinationConfiguration] :destination_configuration
|
|
8055
|
-
#
|
|
8056
|
-
# delivered.
|
|
8416
|
+
# The updated configuration for where to deliver query results.
|
|
8057
8417
|
#
|
|
8058
8418
|
# @option params [Integer] :schedule_start_time
|
|
8059
|
-
#
|
|
8419
|
+
# The updated start time for the scheduled query in Unix epoch format.
|
|
8060
8420
|
#
|
|
8061
8421
|
# @option params [Integer] :schedule_end_time
|
|
8062
|
-
#
|
|
8422
|
+
# The updated end time for the scheduled query in Unix epoch format.
|
|
8063
8423
|
#
|
|
8064
8424
|
# @option params [required, String] :execution_role_arn
|
|
8065
|
-
#
|
|
8066
|
-
#
|
|
8425
|
+
# The updated ARN of the IAM role that grants permissions to execute the
|
|
8426
|
+
# query and deliver results.
|
|
8067
8427
|
#
|
|
8068
8428
|
# @option params [String] :state
|
|
8069
|
-
#
|
|
8429
|
+
# The updated state of the scheduled query.
|
|
8070
8430
|
#
|
|
8071
8431
|
# @return [Types::UpdateScheduledQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8072
8432
|
#
|
|
@@ -8162,7 +8522,7 @@ module Aws::CloudWatchLogs
|
|
|
8162
8522
|
tracer: tracer
|
|
8163
8523
|
)
|
|
8164
8524
|
context[:gem_name] = 'aws-sdk-cloudwatchlogs'
|
|
8165
|
-
context[:gem_version] = '1.
|
|
8525
|
+
context[:gem_version] = '1.134.0'
|
|
8166
8526
|
Seahorse::Client::Request.new(handlers, context)
|
|
8167
8527
|
end
|
|
8168
8528
|
|