aws-sdk-cloudwatchlogs 1.28.0 → 1.33.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 7fa8d2e2efe92e0c4b08cf38a792f7fe323cca87
4
- data.tar.gz: 9b5dae6088c7d4062e49a6e4483022905ebda9aa
2
+ SHA256:
3
+ metadata.gz: ffb11f3cd2a519f1d87e4253abb57b2ec4d68ba14f923115f995aa396cf07606
4
+ data.tar.gz: 2fadfb05b4e41bf44fa6c65018cc05b632568eab20dabc315e6f4d9628dd0a85
5
5
  SHA512:
6
- metadata.gz: 50b0d9704fc02ac2606820bf839d5580080889c2adde8ecf3b8eb6268b802b77195478967cb2d5e591faf74b3ce8f8e8e987eeeb994347e05ee9ad0af5b6beb9
7
- data.tar.gz: c01665dc1179a9b020ef2ee4a64ec9a8f7e4e338c6ecd20cbae3ac90bcdfc369a59845fbc6b48c9f9a5e86f03a20da54a10c0f57be7d26e6154a8366a9b3970d
6
+ metadata.gz: 5a361d36746e2aa11f06ee64babb0e9c717bb5f4b34fd7ff8ec483da0c0e093ca6a44b8e0b38d51aaf242a5a3a5d6711a216b077f2d95962c3710e9b9dc0406f
7
+ data.tar.gz: d24cefcc2431f67925ec3b97a4dec84d8d21162e3b3bfacd332083ee483f8c4baa56eced8e34621b7b04daee9d53456b93dd0240f2a555c93993e6010985a701
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,17 +26,20 @@ require_relative 'aws-sdk-cloudwatchlogs/customizations'
24
26
  # methods each accept a hash of request parameters and return a response
25
27
  # structure.
26
28
  #
29
+ # cloud_watch_logs = Aws::CloudWatchLogs::Client.new
30
+ # resp = cloud_watch_logs.associate_kms_key(params)
31
+ #
27
32
  # See {Client} for more information.
28
33
  #
29
34
  # # Errors
30
35
  #
31
- # Errors returned from Amazon CloudWatch Logs all
32
- # extend {Errors::ServiceError}.
36
+ # Errors returned from Amazon CloudWatch Logs are defined in the
37
+ # {Errors} module and all extend {Errors::ServiceError}.
33
38
  #
34
39
  # begin
35
40
  # # do stuff
36
41
  # rescue Aws::CloudWatchLogs::Errors::ServiceError
37
- # # rescues all service API errors
42
+ # # rescues all Amazon CloudWatch Logs API errors
38
43
  # end
39
44
  #
40
45
  # See {Errors} for more information.
@@ -42,6 +47,6 @@ require_relative 'aws-sdk-cloudwatchlogs/customizations'
42
47
  # @service
43
48
  module Aws::CloudWatchLogs
44
49
 
45
- GEM_VERSION = '1.28.0'
50
+ GEM_VERSION = '1.33.0'
46
51
 
47
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,12 +26,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
32
 
30
33
  Aws::Plugins::GlobalConfiguration.add_identifier(:cloudwatchlogs)
31
34
 
32
35
  module Aws::CloudWatchLogs
36
+ # An API client for CloudWatchLogs. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::CloudWatchLogs::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
33
48
  class Client < Seahorse::Client::Base
34
49
 
35
50
  include Aws::ClientStubs
@@ -57,6 +72,7 @@ module Aws::CloudWatchLogs
57
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
60
76
  add_plugin(Aws::Plugins::SignatureV4)
61
77
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
78
 
@@ -93,7 +109,7 @@ module Aws::CloudWatchLogs
93
109
  # @option options [required, String] :region
94
110
  # The AWS region to connect to. The configured `:region` is
95
111
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
97
113
  #
98
114
  # * `Aws.config[:region]`
99
115
  # * `ENV['AWS_REGION']`
@@ -108,6 +124,12 @@ module Aws::CloudWatchLogs
108
124
  # When set to `true`, a thread polling for endpoints will be running in
109
125
  # the background every 60 secs (default). Defaults to `false`.
110
126
  #
127
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
128
+ # Used only in `adaptive` retry mode. When true, the request will sleep
129
+ # until there is sufficent client side capacity to retry the request.
130
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
131
+ # not retry instead of sleeping.
132
+ #
111
133
  # @option options [Boolean] :client_side_monitoring (false)
112
134
  # When `true`, client-side metrics will be collected for all API requests from
113
135
  # this client.
@@ -132,6 +154,10 @@ module Aws::CloudWatchLogs
132
154
  # When `true`, an attempt is made to coerce request parameters into
133
155
  # the required types.
134
156
  #
157
+ # @option options [Boolean] :correct_clock_skew (true)
158
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
+ # a clock skew correction and retry requests with skewed client clocks.
160
+ #
135
161
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
162
  # Set to true to disable SDK automatically adding host prefix
137
163
  # to default service endpoint when available.
@@ -139,7 +165,7 @@ module Aws::CloudWatchLogs
139
165
  # @option options [String] :endpoint
140
166
  # The client endpoint is normally constructed from the `:region`
141
167
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
169
  #
144
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +180,7 @@ module Aws::CloudWatchLogs
154
180
  # requests fetching endpoints information. Defaults to 60 sec.
155
181
  #
156
182
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
184
  #
159
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
186
  # The log formatter.
@@ -166,15 +192,29 @@ module Aws::CloudWatchLogs
166
192
  # The Logger instance to send log messages to. If this option
167
193
  # is not set, logging will be disabled.
168
194
  #
195
+ # @option options [Integer] :max_attempts (3)
196
+ # An integer representing the maximum number attempts that will be made for
197
+ # a single request, including the initial attempt. For example,
198
+ # setting this value to 5 will result in a request being retried up to
199
+ # 4 times. Used in `standard` and `adaptive` retry modes.
200
+ #
169
201
  # @option options [String] :profile ("default")
170
202
  # Used when loading credentials from the shared credentials file
171
203
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
204
  #
205
+ # @option options [Proc] :retry_backoff
206
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
+ # This option is only used in the `legacy` retry mode.
208
+ #
173
209
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
210
+ # The base delay in seconds used by the default backoff function. This option
211
+ # is only used in the `legacy` retry mode.
175
212
  #
176
213
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
214
+ # A delay randomiser function used by the default backoff function.
215
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
216
+ # otherwise a Proc that takes and returns a number. This option is only used
217
+ # in the `legacy` retry mode.
178
218
  #
179
219
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
220
  #
@@ -182,11 +222,30 @@ module Aws::CloudWatchLogs
182
222
  # The maximum number of times to retry failed requests. Only
183
223
  # ~ 500 level server errors and certain ~ 400 level client errors
184
224
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
225
+ # checksum errors, networking errors, timeout errors, auth errors,
226
+ # endpoint discovery, and errors from expired credentials.
227
+ # This option is only used in the `legacy` retry mode.
187
228
  #
188
229
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
230
+ # The maximum number of seconds to delay between retries (0 for no limit)
231
+ # used by the default backoff function. This option is only used in the
232
+ # `legacy` retry mode.
233
+ #
234
+ # @option options [String] :retry_mode ("legacy")
235
+ # Specifies which retry algorithm to use. Values are:
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
190
249
  #
191
250
  # @option options [String] :secret_access_key
192
251
  #
@@ -219,16 +278,15 @@ module Aws::CloudWatchLogs
219
278
  # requests through. Formatted like 'http://proxy.com:123'.
220
279
  #
221
280
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
281
+ # seconds to wait when opening a HTTP session before raising a
223
282
  # `Timeout::Error`.
224
283
  #
225
284
  # @option options [Integer] :http_read_timeout (60) The default
226
285
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
286
+ # safely be set per-request on the session.
229
287
  #
230
288
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
289
+ # seconds a connection is allowed to sit idle before it is
232
290
  # considered stale. Stale connections are closed and removed
233
291
  # from the pool before making a request.
234
292
  #
@@ -237,7 +295,7 @@ module Aws::CloudWatchLogs
237
295
  # request body. This option has no effect unless the request has
238
296
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
297
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
298
+ # request on the session.
241
299
  #
242
300
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
301
  # HTTP debug output will be sent to the `:logger`.
@@ -354,9 +412,9 @@ module Aws::CloudWatchLogs
354
412
  # This is an asynchronous call. If all the required information is
355
413
  # provided, this operation initiates an export task and responds with
356
414
  # the ID of the task. After the task has started, you can use
357
- # DescribeExportTasks to get the status of the export task. Each account
358
- # can only have one active (`RUNNING` or `PENDING`) export task at a
359
- # time. To cancel an export task, use CancelExportTask.
415
+ # [DescribeExportTasks][1] to get the status of the export task. Each
416
+ # account can only have one active (`RUNNING` or `PENDING`) export task
417
+ # at a time. To cancel an export task, use [CancelExportTask][2].
360
418
  #
361
419
  # You can export logs from multiple log groups or multiple time ranges
362
420
  # to the same S3 bucket. To separate out log data for each export task,
@@ -366,6 +424,11 @@ module Aws::CloudWatchLogs
366
424
  # Exporting to S3 buckets that are encrypted with AES-256 is supported.
367
425
  # Exporting to S3 buckets encrypted with SSE-KMS is not supported.
368
426
  #
427
+ #
428
+ #
429
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html
430
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html
431
+ #
369
432
  # @option params [String] :task_name
370
433
  # The name of the export task.
371
434
  #
@@ -631,6 +694,31 @@ module Aws::CloudWatchLogs
631
694
  req.send_request(options)
632
695
  end
633
696
 
697
+ # @option params [required, String] :query_definition_id
698
+ #
699
+ # @return [Types::DeleteQueryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
700
+ #
701
+ # * {Types::DeleteQueryDefinitionResponse#success #success} => Boolean
702
+ #
703
+ # @example Request syntax with placeholder values
704
+ #
705
+ # resp = client.delete_query_definition({
706
+ # query_definition_id: "QueryId", # required
707
+ # })
708
+ #
709
+ # @example Response structure
710
+ #
711
+ # resp.success #=> Boolean
712
+ #
713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteQueryDefinition AWS API Documentation
714
+ #
715
+ # @overload delete_query_definition(params = {})
716
+ # @param [Hash] params ({})
717
+ def delete_query_definition(params = {}, options = {})
718
+ req = build_request(:delete_query_definition, params)
719
+ req.send_request(options)
720
+ end
721
+
634
722
  # Deletes a resource policy from this account. This revokes the access
635
723
  # of the identities in that policy to put log events to this account.
636
724
  #
@@ -725,6 +813,8 @@ module Aws::CloudWatchLogs
725
813
  # * {Types::DescribeDestinationsResponse#destinations #destinations} => Array&lt;Types::Destination&gt;
726
814
  # * {Types::DescribeDestinationsResponse#next_token #next_token} => String
727
815
  #
816
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
817
+ #
728
818
  # @example Request syntax with placeholder values
729
819
  #
730
820
  # resp = client.describe_destinations({
@@ -831,6 +921,8 @@ module Aws::CloudWatchLogs
831
921
  # * {Types::DescribeLogGroupsResponse#log_groups #log_groups} => Array&lt;Types::LogGroup&gt;
832
922
  # * {Types::DescribeLogGroupsResponse#next_token #next_token} => String
833
923
  #
924
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
925
+ #
834
926
  # @example Request syntax with placeholder values
835
927
  #
836
928
  # resp = client.describe_log_groups({
@@ -908,6 +1000,8 @@ module Aws::CloudWatchLogs
908
1000
  # * {Types::DescribeLogStreamsResponse#log_streams #log_streams} => Array&lt;Types::LogStream&gt;
909
1001
  # * {Types::DescribeLogStreamsResponse#next_token #next_token} => String
910
1002
  #
1003
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1004
+ #
911
1005
  # @example Request syntax with placeholder values
912
1006
  #
913
1007
  # resp = client.describe_log_streams({
@@ -974,6 +1068,8 @@ module Aws::CloudWatchLogs
974
1068
  # * {Types::DescribeMetricFiltersResponse#metric_filters #metric_filters} => Array&lt;Types::MetricFilter&gt;
975
1069
  # * {Types::DescribeMetricFiltersResponse#next_token #next_token} => String
976
1070
  #
1071
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1072
+ #
977
1073
  # @example Request syntax with placeholder values
978
1074
  #
979
1075
  # resp = client.describe_metric_filters({
@@ -1061,6 +1157,47 @@ module Aws::CloudWatchLogs
1061
1157
  req.send_request(options)
1062
1158
  end
1063
1159
 
1160
+ # @option params [String] :query_definition_name_prefix
1161
+ #
1162
+ # @option params [Integer] :max_results
1163
+ #
1164
+ # @option params [String] :next_token
1165
+ # The token for the next set of items to return. The token expires after
1166
+ # 24 hours.
1167
+ #
1168
+ # @return [Types::DescribeQueryDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1169
+ #
1170
+ # * {Types::DescribeQueryDefinitionsResponse#query_definitions #query_definitions} => Array&lt;Types::QueryDefinition&gt;
1171
+ # * {Types::DescribeQueryDefinitionsResponse#next_token #next_token} => String
1172
+ #
1173
+ # @example Request syntax with placeholder values
1174
+ #
1175
+ # resp = client.describe_query_definitions({
1176
+ # query_definition_name_prefix: "QueryDefinitionName",
1177
+ # max_results: 1,
1178
+ # next_token: "NextToken",
1179
+ # })
1180
+ #
1181
+ # @example Response structure
1182
+ #
1183
+ # resp.query_definitions #=> Array
1184
+ # resp.query_definitions[0].query_definition_id #=> String
1185
+ # resp.query_definitions[0].name #=> String
1186
+ # resp.query_definitions[0].query_string #=> String
1187
+ # resp.query_definitions[0].last_modified #=> Integer
1188
+ # resp.query_definitions[0].log_group_names #=> Array
1189
+ # resp.query_definitions[0].log_group_names[0] #=> String
1190
+ # resp.next_token #=> String
1191
+ #
1192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueryDefinitions AWS API Documentation
1193
+ #
1194
+ # @overload describe_query_definitions(params = {})
1195
+ # @param [Hash] params ({})
1196
+ def describe_query_definitions(params = {}, options = {})
1197
+ req = build_request(:describe_query_definitions, params)
1198
+ req.send_request(options)
1199
+ end
1200
+
1064
1201
  # Lists the resource policies in this account.
1065
1202
  #
1066
1203
  # @option params [String] :next_token
@@ -1124,6 +1261,8 @@ module Aws::CloudWatchLogs
1124
1261
  # * {Types::DescribeSubscriptionFiltersResponse#subscription_filters #subscription_filters} => Array&lt;Types::SubscriptionFilter&gt;
1125
1262
  # * {Types::DescribeSubscriptionFiltersResponse#next_token #next_token} => String
1126
1263
  #
1264
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1265
+ #
1127
1266
  # @example Request syntax with placeholder values
1128
1267
  #
1129
1268
  # resp = client.describe_subscription_filters({
@@ -1260,6 +1399,8 @@ module Aws::CloudWatchLogs
1260
1399
  # * {Types::FilterLogEventsResponse#searched_log_streams #searched_log_streams} => Array&lt;Types::SearchedLogStream&gt;
1261
1400
  # * {Types::FilterLogEventsResponse#next_token #next_token} => String
1262
1401
  #
1402
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1403
+ #
1263
1404
  # @example Request syntax with placeholder values
1264
1405
  #
1265
1406
  # resp = client.filter_log_events({
@@ -1346,6 +1487,8 @@ module Aws::CloudWatchLogs
1346
1487
  # * {Types::GetLogEventsResponse#next_forward_token #next_forward_token} => String
1347
1488
  # * {Types::GetLogEventsResponse#next_backward_token #next_backward_token} => String
1348
1489
  #
1490
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1491
+ #
1349
1492
  # @example Request syntax with placeholder values
1350
1493
  #
1351
1494
  # resp = client.get_log_events({
@@ -1383,11 +1526,16 @@ module Aws::CloudWatchLogs
1383
1526
  #
1384
1527
  # In the results, fields that start with @ are fields generated by
1385
1528
  # CloudWatch Logs. For example, `@timestamp` is the timestamp of each
1386
- # log event.
1529
+ # log event. For more information about the fields that are generated by
1530
+ # CloudWatch logs, see [Supported Logs and Discovered Fields][1].
1387
1531
  #
1388
1532
  # The response results are sorted by the frequency percentage, starting
1389
1533
  # with the highest percentage.
1390
1534
  #
1535
+ #
1536
+ #
1537
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html
1538
+ #
1391
1539
  # @option params [required, String] :log_group_name
1392
1540
  # The name of the log group to search.
1393
1541
  #
@@ -1468,16 +1616,22 @@ module Aws::CloudWatchLogs
1468
1616
  #
1469
1617
  # Only the fields requested in the query are returned, along with a
1470
1618
  # `@ptr` field which is the identifier for the log record. You can use
1471
- # the value of `@ptr` in a operation to get the full log record.
1619
+ # the value of `@ptr` in a [GetLogRecord][1] operation to get the full
1620
+ # log record.
1472
1621
  #
1473
1622
  # `GetQueryResults` does not start a query execution. To run a query,
1474
- # use .
1623
+ # use [StartQuery][2].
1475
1624
  #
1476
1625
  # If the value of the `Status` field in the output is `Running`, this
1477
1626
  # operation returns only partial results. If you see a value of
1478
1627
  # `Scheduled` or `Running` for the status, you can retry the operation
1479
1628
  # later to see the final results.
1480
1629
  #
1630
+ #
1631
+ #
1632
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html
1633
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
1634
+ #
1481
1635
  # @option params [required, String] :query_id
1482
1636
  # The ID number of the query.
1483
1637
  #
@@ -1547,15 +1701,21 @@ module Aws::CloudWatchLogs
1547
1701
  #
1548
1702
  # A destination encapsulates a physical resource (such as an Amazon
1549
1703
  # Kinesis stream) and enables you to subscribe to a real-time stream of
1550
- # log events for a different account, ingested using PutLogEvents.
1704
+ # log events for a different account, ingested using [PutLogEvents][1].
1551
1705
  #
1552
1706
  # Through an access policy, a destination controls what is written to
1553
1707
  # it. By default, `PutDestination` does not set any access policy with
1554
1708
  # the destination, which means a cross-account user cannot call
1555
- # PutSubscriptionFilter against this destination. To enable this, the
1556
- # destination owner must call PutDestinationPolicy after
1709
+ # [PutSubscriptionFilter][2] against this destination. To enable this,
1710
+ # the destination owner must call [PutDestinationPolicy][3] after
1557
1711
  # `PutDestination`.
1558
1712
  #
1713
+ #
1714
+ #
1715
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
1716
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html
1717
+ # [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html
1718
+ #
1559
1719
  # @option params [required, String] :destination_name
1560
1720
  # A name for the destination.
1561
1721
  #
@@ -1684,9 +1844,13 @@ module Aws::CloudWatchLogs
1684
1844
  # The sequence token obtained from the response of the previous
1685
1845
  # `PutLogEvents` call. An upload in a newly created log stream does not
1686
1846
  # require a sequence token. You can also get the sequence token using
1687
- # DescribeLogStreams. If you call `PutLogEvents` twice within a narrow
1688
- # time period using the same value for `sequenceToken`, both calls may
1689
- # be successful, or one may be rejected.
1847
+ # [DescribeLogStreams][1]. If you call `PutLogEvents` twice within a
1848
+ # narrow time period using the same value for `sequenceToken`, both
1849
+ # calls may be successful, or one may be rejected.
1850
+ #
1851
+ #
1852
+ #
1853
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogStreams.html
1690
1854
  #
1691
1855
  # @return [Types::PutLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1692
1856
  #
@@ -1725,11 +1889,16 @@ module Aws::CloudWatchLogs
1725
1889
 
1726
1890
  # Creates or updates a metric filter and associates it with the
1727
1891
  # specified log group. Metric filters allow you to configure rules to
1728
- # extract metric data from log events ingested through PutLogEvents.
1892
+ # extract metric data from log events ingested through
1893
+ # [PutLogEvents][1].
1729
1894
  #
1730
1895
  # The maximum number of metric filters that can be associated with a log
1731
1896
  # group is 100.
1732
1897
  #
1898
+ #
1899
+ #
1900
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
1901
+ #
1733
1902
  # @option params [required, String] :log_group_name
1734
1903
  # The name of the log group.
1735
1904
  #
@@ -1770,6 +1939,40 @@ module Aws::CloudWatchLogs
1770
1939
  req.send_request(options)
1771
1940
  end
1772
1941
 
1942
+ # @option params [required, String] :name
1943
+ #
1944
+ # @option params [String] :query_definition_id
1945
+ #
1946
+ # @option params [Array<String>] :log_group_names
1947
+ #
1948
+ # @option params [required, String] :query_string
1949
+ #
1950
+ # @return [Types::PutQueryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1951
+ #
1952
+ # * {Types::PutQueryDefinitionResponse#query_definition_id #query_definition_id} => String
1953
+ #
1954
+ # @example Request syntax with placeholder values
1955
+ #
1956
+ # resp = client.put_query_definition({
1957
+ # name: "QueryDefinitionName", # required
1958
+ # query_definition_id: "QueryId",
1959
+ # log_group_names: ["LogGroupName"],
1960
+ # query_string: "QueryDefinitionString", # required
1961
+ # })
1962
+ #
1963
+ # @example Response structure
1964
+ #
1965
+ # resp.query_definition_id #=> String
1966
+ #
1967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinition AWS API Documentation
1968
+ #
1969
+ # @overload put_query_definition(params = {})
1970
+ # @param [Hash] params ({})
1971
+ def put_query_definition(params = {}, options = {})
1972
+ req = build_request(:put_query_definition, params)
1973
+ req.send_request(options)
1974
+ end
1975
+
1773
1976
  # Creates or updates a resource policy allowing other AWS services to
1774
1977
  # put log events to this account, such as Amazon Route 53. An account
1775
1978
  # can have up to 10 resource policies per region.
@@ -1850,9 +2053,9 @@ module Aws::CloudWatchLogs
1850
2053
 
1851
2054
  # Creates or updates a subscription filter and associates it with the
1852
2055
  # specified log group. Subscription filters allow you to subscribe to a
1853
- # real-time stream of log events ingested through PutLogEvents and have
1854
- # them delivered to a specific destination. Currently, the supported
1855
- # destinations are:
2056
+ # real-time stream of log events ingested through [PutLogEvents][1] and
2057
+ # have them delivered to a specific destination. Currently, the
2058
+ # supported destinations are:
1856
2059
  #
1857
2060
  # * An Amazon Kinesis stream belonging to the same account as the
1858
2061
  # subscription filter, for same-account delivery.
@@ -1871,6 +2074,10 @@ module Aws::CloudWatchLogs
1871
2074
  # name in `filterName`. Otherwise, the call fails because you cannot
1872
2075
  # associate a second filter with a log group.
1873
2076
  #
2077
+ #
2078
+ #
2079
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
2080
+ #
1874
2081
  # @option params [required, String] :log_group_name
1875
2082
  # The name of the log group.
1876
2083
  #
@@ -1879,7 +2086,11 @@ module Aws::CloudWatchLogs
1879
2086
  # filter, you must specify the correct name in `filterName`. Otherwise,
1880
2087
  # the call fails because you cannot associate a second filter with a log
1881
2088
  # group. To find the name of the filter currently associated with a log
1882
- # group, use DescribeSubscriptionFilters.
2089
+ # group, use [DescribeSubscriptionFilters][1].
2090
+ #
2091
+ #
2092
+ #
2093
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html
1883
2094
  #
1884
2095
  # @option params [required, String] :filter_pattern
1885
2096
  # A filter pattern for subscribing to a filtered stream of log events.
@@ -2045,15 +2256,17 @@ module Aws::CloudWatchLogs
2045
2256
 
2046
2257
  # Adds or updates the specified tags for the specified log group.
2047
2258
  #
2048
- # To list the tags for a log group, use ListTagsLogGroup. To remove
2049
- # tags, use UntagLogGroup.
2259
+ # To list the tags for a log group, use [ListTagsLogGroup][1]. To remove
2260
+ # tags, use [UntagLogGroup][2].
2050
2261
  #
2051
2262
  # For more information about tags, see [Tag Log Groups in Amazon
2052
- # CloudWatch Logs][1] in the *Amazon CloudWatch Logs User Guide*.
2263
+ # CloudWatch Logs][3] in the *Amazon CloudWatch Logs User Guide*.
2053
2264
  #
2054
2265
  #
2055
2266
  #
2056
- # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html
2267
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html
2268
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagLogGroup.html
2269
+ # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging
2057
2270
  #
2058
2271
  # @option params [required, String] :log_group_name
2059
2272
  # The name of the log group.
@@ -2124,8 +2337,13 @@ module Aws::CloudWatchLogs
2124
2337
 
2125
2338
  # Removes the specified tags from the specified log group.
2126
2339
  #
2127
- # To list the tags for a log group, use ListTagsLogGroup. To add tags,
2128
- # use UntagLogGroup.
2340
+ # To list the tags for a log group, use [ListTagsLogGroup][1]. To add
2341
+ # tags, use [TagLogGroup][2].
2342
+ #
2343
+ #
2344
+ #
2345
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html
2346
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagLogGroup.html
2129
2347
  #
2130
2348
  # @option params [required, String] :log_group_name
2131
2349
  # The name of the log group.
@@ -2164,7 +2382,7 @@ module Aws::CloudWatchLogs
2164
2382
  params: params,
2165
2383
  config: config)
2166
2384
  context[:gem_name] = 'aws-sdk-cloudwatchlogs'
2167
- context[:gem_version] = '1.28.0'
2385
+ context[:gem_version] = '1.33.0'
2168
2386
  Seahorse::Client::Request.new(handlers, context)
2169
2387
  end
2170
2388