aws-sdk-cloudwatchlogs 1.27.0 → 1.32.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 64fb9c81431d167fa3b9f0498034bd63d2fd9eaf
4
- data.tar.gz: c59571b7f2187a9690bb52180f28c4780ddb79cb
2
+ SHA256:
3
+ metadata.gz: a69133aa6b95c8ead3ba62c50ce6e1312d4bde6ecda5fb522556ee195ab8889a
4
+ data.tar.gz: 3b65f1b92de5c530986675656ac0bb946098eaba493d799034eae1c352999750
5
5
  SHA512:
6
- metadata.gz: f074a234d6e0487bbd7824083a624ab975c6181058953a87f7364a9d7246f83289bc6be653e9c49b63fa87aa7cac5c1f432f82fd2c38387187a842c89df2e804
7
- data.tar.gz: 3f5f5329e7c9e1bdab619e5420ae07bd8f8299d3fb162940a0c2a98eca932ab2771322317d5422ca5d547ebc1b11bb22373bc656d034079f0939fc3d125f3b8f
6
+ metadata.gz: 22425da18fcebeae7851749fad346456a6aaf9c0d158e4597d87ab7555938a6ca39f441797274364cb0b32964566bc0367c048f4cf03bd77103c827aa51c917f
7
+ data.tar.gz: fe9b76ebdca1e07071839266499b464f432015c54793fb4b728b622f5286bce86bda2605b50374ecea80db7c73d66327a1102c83bd91c3ca82df6ca68bc4ed5e
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-cloudwatchlogs/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # cloud_watch_logs = Aws::CloudWatchLogs::Client.new
28
+ # resp = cloud_watch_logs.associate_kms_key(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon CloudWatch Logs all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon CloudWatch Logs are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::CloudWatchLogs::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon CloudWatch Logs API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-cloudwatchlogs/customizations'
42
45
  # @service
43
46
  module Aws::CloudWatchLogs
44
47
 
45
- GEM_VERSION = '1.27.0'
48
+ GEM_VERSION = '1.32.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:cloudwatchlogs)
31
32
 
32
33
  module Aws::CloudWatchLogs
34
+ # An API client for CloudWatchLogs. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::CloudWatchLogs::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::CloudWatchLogs
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::CloudWatchLogs
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::CloudWatchLogs
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::CloudWatchLogs
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::CloudWatchLogs
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::CloudWatchLogs
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::CloudWatchLogs
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @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.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::CloudWatchLogs
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @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.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::CloudWatchLogs
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # 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}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::CloudWatchLogs
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -275,6 +331,12 @@ module Aws::CloudWatchLogs
275
331
  # This enables Amazon CloudWatch Logs to decrypt this data whenever it
276
332
  # is requested.
277
333
  #
334
+ # <note markdown="1"> **Important:** CloudWatch Logs supports only symmetric CMKs. Do not
335
+ # use an associate an asymmetric CMK with your log group. For more
336
+ # information, see [Using Symmetric and Asymmetric Keys][1].
337
+ #
338
+ # </note>
339
+ #
278
340
  # Note that it can take up to 5 minutes for this operation to take
279
341
  # effect.
280
342
  #
@@ -282,17 +344,23 @@ module Aws::CloudWatchLogs
282
344
  # not exist or the CMK is disabled, you will receive an
283
345
  # `InvalidParameterException` error.
284
346
  #
347
+ #
348
+ #
349
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
350
+ #
285
351
  # @option params [required, String] :log_group_name
286
352
  # The name of the log group.
287
353
  #
288
354
  # @option params [required, String] :kms_key_id
289
355
  # The Amazon Resource Name (ARN) of the CMK to use when encrypting log
290
- # data. For more information, see [Amazon Resource Names - AWS Key
291
- # Management Service (AWS KMS)][1].
356
+ # data. This must be a symmetric CMK. For more information, see [Amazon
357
+ # Resource Names - AWS Key Management Service (AWS KMS)][1] and [Using
358
+ # Symmetric and Asymmetric Keys][2].
292
359
  #
293
360
  #
294
361
  #
295
362
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
363
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
296
364
  #
297
365
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
298
366
  #
@@ -342,9 +410,9 @@ module Aws::CloudWatchLogs
342
410
  # This is an asynchronous call. If all the required information is
343
411
  # provided, this operation initiates an export task and responds with
344
412
  # the ID of the task. After the task has started, you can use
345
- # DescribeExportTasks to get the status of the export task. Each account
346
- # can only have one active (`RUNNING` or `PENDING`) export task at a
347
- # time. To cancel an export task, use CancelExportTask.
413
+ # [DescribeExportTasks][1] to get the status of the export task. Each
414
+ # account can only have one active (`RUNNING` or `PENDING`) export task
415
+ # at a time. To cancel an export task, use [CancelExportTask][2].
348
416
  #
349
417
  # You can export logs from multiple log groups or multiple time ranges
350
418
  # to the same S3 bucket. To separate out log data for each export task,
@@ -354,6 +422,11 @@ module Aws::CloudWatchLogs
354
422
  # Exporting to S3 buckets that are encrypted with AES-256 is supported.
355
423
  # Exporting to S3 buckets encrypted with SSE-KMS is not supported.
356
424
  #
425
+ #
426
+ #
427
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html
428
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html
429
+ #
357
430
  # @option params [String] :task_name
358
431
  # The name of the export task.
359
432
  #
@@ -435,6 +508,16 @@ module Aws::CloudWatchLogs
435
508
  # not exist or the CMK is disabled, you will receive an
436
509
  # `InvalidParameterException` error.
437
510
  #
511
+ # <note markdown="1"> **Important:** CloudWatch Logs supports only symmetric CMKs. Do not
512
+ # associate an asymmetric CMK with your log group. For more information,
513
+ # see [Using Symmetric and Asymmetric Keys][1].
514
+ #
515
+ # </note>
516
+ #
517
+ #
518
+ #
519
+ # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
520
+ #
438
521
  # @option params [required, String] :log_group_name
439
522
  # The name of the log group.
440
523
  #
@@ -474,7 +557,8 @@ module Aws::CloudWatchLogs
474
557
  # Creates a log stream for the specified log group.
475
558
  #
476
559
  # There is no limit on the number of log streams that you can create for
477
- # a log group.
560
+ # a log group. There is a limit of 50 TPS on `CreateLogStream`
561
+ # operations, after which transactions are throttled.
478
562
  #
479
563
  # You must use the following guidelines when naming a log stream:
480
564
  #
@@ -608,6 +692,31 @@ module Aws::CloudWatchLogs
608
692
  req.send_request(options)
609
693
  end
610
694
 
695
+ # @option params [required, String] :query_definition_id
696
+ #
697
+ # @return [Types::DeleteQueryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
698
+ #
699
+ # * {Types::DeleteQueryDefinitionResponse#success #success} => Boolean
700
+ #
701
+ # @example Request syntax with placeholder values
702
+ #
703
+ # resp = client.delete_query_definition({
704
+ # query_definition_id: "QueryId", # required
705
+ # })
706
+ #
707
+ # @example Response structure
708
+ #
709
+ # resp.success #=> Boolean
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteQueryDefinition AWS API Documentation
712
+ #
713
+ # @overload delete_query_definition(params = {})
714
+ # @param [Hash] params ({})
715
+ def delete_query_definition(params = {}, options = {})
716
+ req = build_request(:delete_query_definition, params)
717
+ req.send_request(options)
718
+ end
719
+
611
720
  # Deletes a resource policy from this account. This revokes the access
612
721
  # of the identities in that policy to put log events to this account.
613
722
  #
@@ -702,6 +811,8 @@ module Aws::CloudWatchLogs
702
811
  # * {Types::DescribeDestinationsResponse#destinations #destinations} => Array&lt;Types::Destination&gt;
703
812
  # * {Types::DescribeDestinationsResponse#next_token #next_token} => String
704
813
  #
814
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
815
+ #
705
816
  # @example Request syntax with placeholder values
706
817
  #
707
818
  # resp = client.describe_destinations({
@@ -808,6 +919,8 @@ module Aws::CloudWatchLogs
808
919
  # * {Types::DescribeLogGroupsResponse#log_groups #log_groups} => Array&lt;Types::LogGroup&gt;
809
920
  # * {Types::DescribeLogGroupsResponse#next_token #next_token} => String
810
921
  #
922
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
923
+ #
811
924
  # @example Request syntax with placeholder values
812
925
  #
813
926
  # resp = client.describe_log_groups({
@@ -885,6 +998,8 @@ module Aws::CloudWatchLogs
885
998
  # * {Types::DescribeLogStreamsResponse#log_streams #log_streams} => Array&lt;Types::LogStream&gt;
886
999
  # * {Types::DescribeLogStreamsResponse#next_token #next_token} => String
887
1000
  #
1001
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1002
+ #
888
1003
  # @example Request syntax with placeholder values
889
1004
  #
890
1005
  # resp = client.describe_log_streams({
@@ -951,6 +1066,8 @@ module Aws::CloudWatchLogs
951
1066
  # * {Types::DescribeMetricFiltersResponse#metric_filters #metric_filters} => Array&lt;Types::MetricFilter&gt;
952
1067
  # * {Types::DescribeMetricFiltersResponse#next_token #next_token} => String
953
1068
  #
1069
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1070
+ #
954
1071
  # @example Request syntax with placeholder values
955
1072
  #
956
1073
  # resp = client.describe_metric_filters({
@@ -1038,6 +1155,47 @@ module Aws::CloudWatchLogs
1038
1155
  req.send_request(options)
1039
1156
  end
1040
1157
 
1158
+ # @option params [String] :query_definition_name_prefix
1159
+ #
1160
+ # @option params [Integer] :max_results
1161
+ #
1162
+ # @option params [String] :next_token
1163
+ # The token for the next set of items to return. The token expires after
1164
+ # 24 hours.
1165
+ #
1166
+ # @return [Types::DescribeQueryDefinitionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1167
+ #
1168
+ # * {Types::DescribeQueryDefinitionsResponse#query_definitions #query_definitions} => Array&lt;Types::QueryDefinition&gt;
1169
+ # * {Types::DescribeQueryDefinitionsResponse#next_token #next_token} => String
1170
+ #
1171
+ # @example Request syntax with placeholder values
1172
+ #
1173
+ # resp = client.describe_query_definitions({
1174
+ # query_definition_name_prefix: "QueryDefinitionName",
1175
+ # max_results: 1,
1176
+ # next_token: "NextToken",
1177
+ # })
1178
+ #
1179
+ # @example Response structure
1180
+ #
1181
+ # resp.query_definitions #=> Array
1182
+ # resp.query_definitions[0].query_definition_id #=> String
1183
+ # resp.query_definitions[0].name #=> String
1184
+ # resp.query_definitions[0].query_string #=> String
1185
+ # resp.query_definitions[0].last_modified #=> Integer
1186
+ # resp.query_definitions[0].log_group_names #=> Array
1187
+ # resp.query_definitions[0].log_group_names[0] #=> String
1188
+ # resp.next_token #=> String
1189
+ #
1190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueryDefinitions AWS API Documentation
1191
+ #
1192
+ # @overload describe_query_definitions(params = {})
1193
+ # @param [Hash] params ({})
1194
+ def describe_query_definitions(params = {}, options = {})
1195
+ req = build_request(:describe_query_definitions, params)
1196
+ req.send_request(options)
1197
+ end
1198
+
1041
1199
  # Lists the resource policies in this account.
1042
1200
  #
1043
1201
  # @option params [String] :next_token
@@ -1101,6 +1259,8 @@ module Aws::CloudWatchLogs
1101
1259
  # * {Types::DescribeSubscriptionFiltersResponse#subscription_filters #subscription_filters} => Array&lt;Types::SubscriptionFilter&gt;
1102
1260
  # * {Types::DescribeSubscriptionFiltersResponse#next_token #next_token} => String
1103
1261
  #
1262
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1263
+ #
1104
1264
  # @example Request syntax with placeholder values
1105
1265
  #
1106
1266
  # resp = client.describe_subscription_filters({
@@ -1237,6 +1397,8 @@ module Aws::CloudWatchLogs
1237
1397
  # * {Types::FilterLogEventsResponse#searched_log_streams #searched_log_streams} => Array&lt;Types::SearchedLogStream&gt;
1238
1398
  # * {Types::FilterLogEventsResponse#next_token #next_token} => String
1239
1399
  #
1400
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1401
+ #
1240
1402
  # @example Request syntax with placeholder values
1241
1403
  #
1242
1404
  # resp = client.filter_log_events({
@@ -1323,6 +1485,8 @@ module Aws::CloudWatchLogs
1323
1485
  # * {Types::GetLogEventsResponse#next_forward_token #next_forward_token} => String
1324
1486
  # * {Types::GetLogEventsResponse#next_backward_token #next_backward_token} => String
1325
1487
  #
1488
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1489
+ #
1326
1490
  # @example Request syntax with placeholder values
1327
1491
  #
1328
1492
  # resp = client.get_log_events({
@@ -1360,11 +1524,16 @@ module Aws::CloudWatchLogs
1360
1524
  #
1361
1525
  # In the results, fields that start with @ are fields generated by
1362
1526
  # CloudWatch Logs. For example, `@timestamp` is the timestamp of each
1363
- # log event.
1527
+ # log event. For more information about the fields that are generated by
1528
+ # CloudWatch logs, see [Supported Logs and Discovered Fields][1].
1364
1529
  #
1365
1530
  # The response results are sorted by the frequency percentage, starting
1366
1531
  # with the highest percentage.
1367
1532
  #
1533
+ #
1534
+ #
1535
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html
1536
+ #
1368
1537
  # @option params [required, String] :log_group_name
1369
1538
  # The name of the log group to search.
1370
1539
  #
@@ -1445,16 +1614,22 @@ module Aws::CloudWatchLogs
1445
1614
  #
1446
1615
  # Only the fields requested in the query are returned, along with a
1447
1616
  # `@ptr` field which is the identifier for the log record. You can use
1448
- # the value of `@ptr` in a operation to get the full log record.
1617
+ # the value of `@ptr` in a [GetLogRecord][1] operation to get the full
1618
+ # log record.
1449
1619
  #
1450
1620
  # `GetQueryResults` does not start a query execution. To run a query,
1451
- # use .
1621
+ # use [StartQuery][2].
1452
1622
  #
1453
1623
  # If the value of the `Status` field in the output is `Running`, this
1454
1624
  # operation returns only partial results. If you see a value of
1455
1625
  # `Scheduled` or `Running` for the status, you can retry the operation
1456
1626
  # later to see the final results.
1457
1627
  #
1628
+ #
1629
+ #
1630
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html
1631
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
1632
+ #
1458
1633
  # @option params [required, String] :query_id
1459
1634
  # The ID number of the query.
1460
1635
  #
@@ -1524,15 +1699,21 @@ module Aws::CloudWatchLogs
1524
1699
  #
1525
1700
  # A destination encapsulates a physical resource (such as an Amazon
1526
1701
  # Kinesis stream) and enables you to subscribe to a real-time stream of
1527
- # log events for a different account, ingested using PutLogEvents.
1702
+ # log events for a different account, ingested using [PutLogEvents][1].
1528
1703
  #
1529
1704
  # Through an access policy, a destination controls what is written to
1530
1705
  # it. By default, `PutDestination` does not set any access policy with
1531
1706
  # the destination, which means a cross-account user cannot call
1532
- # PutSubscriptionFilter against this destination. To enable this, the
1533
- # destination owner must call PutDestinationPolicy after
1707
+ # [PutSubscriptionFilter][2] against this destination. To enable this,
1708
+ # the destination owner must call [PutDestinationPolicy][3] after
1534
1709
  # `PutDestination`.
1535
1710
  #
1711
+ #
1712
+ #
1713
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
1714
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html
1715
+ # [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html
1716
+ #
1536
1717
  # @option params [required, String] :destination_name
1537
1718
  # A name for the destination.
1538
1719
  #
@@ -1612,10 +1793,11 @@ module Aws::CloudWatchLogs
1612
1793
  #
1613
1794
  # You must include the sequence token obtained from the response of the
1614
1795
  # previous call. An upload in a newly created log stream does not
1615
- # require a sequence token. You can also get the sequence token using
1616
- # DescribeLogStreams. If you call `PutLogEvents` twice within a narrow
1617
- # time period using the same value for `sequenceToken`, both calls may
1618
- # be successful, or one may be rejected.
1796
+ # require a sequence token. You can also get the sequence token in the
1797
+ # `expectedSequenceToken` field from `InvalidSequenceTokenException`. If
1798
+ # you call `PutLogEvents` twice within a narrow time period using the
1799
+ # same value for `sequenceToken`, both calls may be successful, or one
1800
+ # may be rejected.
1619
1801
  #
1620
1802
  # The batch of events must satisfy the following constraints:
1621
1803
  #
@@ -1636,11 +1818,14 @@ module Aws::CloudWatchLogs
1636
1818
  # timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For
1637
1819
  # example, 2017-09-15T13:45:30.)
1638
1820
  #
1639
- # * The maximum number of log events in a batch is 10,000.
1640
- #
1641
1821
  # * A batch of log events in a single request cannot span more than 24
1642
1822
  # hours. Otherwise, the operation fails.
1643
1823
  #
1824
+ # * The maximum number of log events in a batch is 10,000.
1825
+ #
1826
+ # * There is a quota of 5 requests per second per log stream. Additional
1827
+ # requests are throttled. This quota can't be changed.
1828
+ #
1644
1829
  # If a call to PutLogEvents returns "UnrecognizedClientException" the
1645
1830
  # most likely cause is an invalid AWS access key ID or secret key.
1646
1831
  #
@@ -1657,9 +1842,13 @@ module Aws::CloudWatchLogs
1657
1842
  # The sequence token obtained from the response of the previous
1658
1843
  # `PutLogEvents` call. An upload in a newly created log stream does not
1659
1844
  # require a sequence token. You can also get the sequence token using
1660
- # DescribeLogStreams. If you call `PutLogEvents` twice within a narrow
1661
- # time period using the same value for `sequenceToken`, both calls may
1662
- # be successful, or one may be rejected.
1845
+ # [DescribeLogStreams][1]. If you call `PutLogEvents` twice within a
1846
+ # narrow time period using the same value for `sequenceToken`, both
1847
+ # calls may be successful, or one may be rejected.
1848
+ #
1849
+ #
1850
+ #
1851
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogStreams.html
1663
1852
  #
1664
1853
  # @return [Types::PutLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1665
1854
  #
@@ -1698,11 +1887,16 @@ module Aws::CloudWatchLogs
1698
1887
 
1699
1888
  # Creates or updates a metric filter and associates it with the
1700
1889
  # specified log group. Metric filters allow you to configure rules to
1701
- # extract metric data from log events ingested through PutLogEvents.
1890
+ # extract metric data from log events ingested through
1891
+ # [PutLogEvents][1].
1702
1892
  #
1703
1893
  # The maximum number of metric filters that can be associated with a log
1704
1894
  # group is 100.
1705
1895
  #
1896
+ #
1897
+ #
1898
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
1899
+ #
1706
1900
  # @option params [required, String] :log_group_name
1707
1901
  # The name of the log group.
1708
1902
  #
@@ -1743,6 +1937,40 @@ module Aws::CloudWatchLogs
1743
1937
  req.send_request(options)
1744
1938
  end
1745
1939
 
1940
+ # @option params [required, String] :name
1941
+ #
1942
+ # @option params [String] :query_definition_id
1943
+ #
1944
+ # @option params [Array<String>] :log_group_names
1945
+ #
1946
+ # @option params [required, String] :query_string
1947
+ #
1948
+ # @return [Types::PutQueryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1949
+ #
1950
+ # * {Types::PutQueryDefinitionResponse#query_definition_id #query_definition_id} => String
1951
+ #
1952
+ # @example Request syntax with placeholder values
1953
+ #
1954
+ # resp = client.put_query_definition({
1955
+ # name: "QueryDefinitionName", # required
1956
+ # query_definition_id: "QueryId",
1957
+ # log_group_names: ["LogGroupName"],
1958
+ # query_string: "QueryDefinitionString", # required
1959
+ # })
1960
+ #
1961
+ # @example Response structure
1962
+ #
1963
+ # resp.query_definition_id #=> String
1964
+ #
1965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinition AWS API Documentation
1966
+ #
1967
+ # @overload put_query_definition(params = {})
1968
+ # @param [Hash] params ({})
1969
+ def put_query_definition(params = {}, options = {})
1970
+ req = build_request(:put_query_definition, params)
1971
+ req.send_request(options)
1972
+ end
1973
+
1746
1974
  # Creates or updates a resource policy allowing other AWS services to
1747
1975
  # put log events to this account, such as Amazon Route 53. An account
1748
1976
  # can have up to 10 resource policies per region.
@@ -1823,9 +2051,9 @@ module Aws::CloudWatchLogs
1823
2051
 
1824
2052
  # Creates or updates a subscription filter and associates it with the
1825
2053
  # specified log group. Subscription filters allow you to subscribe to a
1826
- # real-time stream of log events ingested through PutLogEvents and have
1827
- # them delivered to a specific destination. Currently, the supported
1828
- # destinations are:
2054
+ # real-time stream of log events ingested through [PutLogEvents][1] and
2055
+ # have them delivered to a specific destination. Currently, the
2056
+ # supported destinations are:
1829
2057
  #
1830
2058
  # * An Amazon Kinesis stream belonging to the same account as the
1831
2059
  # subscription filter, for same-account delivery.
@@ -1844,6 +2072,10 @@ module Aws::CloudWatchLogs
1844
2072
  # name in `filterName`. Otherwise, the call fails because you cannot
1845
2073
  # associate a second filter with a log group.
1846
2074
  #
2075
+ #
2076
+ #
2077
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
2078
+ #
1847
2079
  # @option params [required, String] :log_group_name
1848
2080
  # The name of the log group.
1849
2081
  #
@@ -1852,7 +2084,11 @@ module Aws::CloudWatchLogs
1852
2084
  # filter, you must specify the correct name in `filterName`. Otherwise,
1853
2085
  # the call fails because you cannot associate a second filter with a log
1854
2086
  # group. To find the name of the filter currently associated with a log
1855
- # group, use DescribeSubscriptionFilters.
2087
+ # group, use [DescribeSubscriptionFilters][1].
2088
+ #
2089
+ #
2090
+ #
2091
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html
1856
2092
  #
1857
2093
  # @option params [required, String] :filter_pattern
1858
2094
  # A filter pattern for subscribing to a filtered stream of log events.
@@ -2018,15 +2254,17 @@ module Aws::CloudWatchLogs
2018
2254
 
2019
2255
  # Adds or updates the specified tags for the specified log group.
2020
2256
  #
2021
- # To list the tags for a log group, use ListTagsLogGroup. To remove
2022
- # tags, use UntagLogGroup.
2257
+ # To list the tags for a log group, use [ListTagsLogGroup][1]. To remove
2258
+ # tags, use [UntagLogGroup][2].
2023
2259
  #
2024
2260
  # For more information about tags, see [Tag Log Groups in Amazon
2025
- # CloudWatch Logs][1] in the *Amazon CloudWatch Logs User Guide*.
2261
+ # CloudWatch Logs][3] in the *Amazon CloudWatch Logs User Guide*.
2026
2262
  #
2027
2263
  #
2028
2264
  #
2029
- # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html
2265
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html
2266
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagLogGroup.html
2267
+ # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging
2030
2268
  #
2031
2269
  # @option params [required, String] :log_group_name
2032
2270
  # The name of the log group.
@@ -2097,8 +2335,13 @@ module Aws::CloudWatchLogs
2097
2335
 
2098
2336
  # Removes the specified tags from the specified log group.
2099
2337
  #
2100
- # To list the tags for a log group, use ListTagsLogGroup. To add tags,
2101
- # use UntagLogGroup.
2338
+ # To list the tags for a log group, use [ListTagsLogGroup][1]. To add
2339
+ # tags, use [TagLogGroup][2].
2340
+ #
2341
+ #
2342
+ #
2343
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html
2344
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagLogGroup.html
2102
2345
  #
2103
2346
  # @option params [required, String] :log_group_name
2104
2347
  # The name of the log group.
@@ -2137,7 +2380,7 @@ module Aws::CloudWatchLogs
2137
2380
  params: params,
2138
2381
  config: config)
2139
2382
  context[:gem_name] = 'aws-sdk-cloudwatchlogs'
2140
- context[:gem_version] = '1.27.0'
2383
+ context[:gem_version] = '1.32.1'
2141
2384
  Seahorse::Client::Request.new(handlers, context)
2142
2385
  end
2143
2386