aws-sdk-cloudwatchlogs 1.32.1 → 1.38.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
2
  SHA256:
3
- metadata.gz: a69133aa6b95c8ead3ba62c50ce6e1312d4bde6ecda5fb522556ee195ab8889a
4
- data.tar.gz: 3b65f1b92de5c530986675656ac0bb946098eaba493d799034eae1c352999750
3
+ metadata.gz: 6e06f884ae9f11c031be6f4d3887730189c98434fd175d73c1613cbf2b2e6846
4
+ data.tar.gz: 5924cbf59c1283a7c740a8a68f92c38fa57989dd6a5653ca14fdc7ef76d23887
5
5
  SHA512:
6
- metadata.gz: 22425da18fcebeae7851749fad346456a6aaf9c0d158e4597d87ab7555938a6ca39f441797274364cb0b32964566bc0367c048f4cf03bd77103c827aa51c917f
7
- data.tar.gz: fe9b76ebdca1e07071839266499b464f432015c54793fb4b728b622f5286bce86bda2605b50374ecea80db7c73d66327a1102c83bd91c3ca82df6ca68bc4ed5e
6
+ metadata.gz: 632e7a8a10f3be89cd484abeb384d29f43a16f01817fa8369fb32de563f74b673dcd46061a50ab735814b1d12ba0b88e92ff1fa5434cf4ac59fd001c4e8382e5
7
+ data.tar.gz: 8f846c1cb88f9aedb97b157e98b0f8d4c4bc61bd76cff731696ecd364b151de47befe2face0dcbf5ebff66d2c5e790995eb3b6b4811c51116c50d49a1700e1d6
@@ -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:
@@ -5,6 +7,7 @@
5
7
  #
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
10
+
8
11
  require 'aws-sdk-core'
9
12
  require 'aws-sigv4'
10
13
 
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-cloudwatchlogs/customizations'
42
45
  #
43
46
  # See {Errors} for more information.
44
47
  #
45
- # @service
48
+ # @!group service
46
49
  module Aws::CloudWatchLogs
47
50
 
48
- GEM_VERSION = '1.32.1'
51
+ GEM_VERSION = '1.38.0'
49
52
 
50
53
  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:
@@ -83,13 +85,28 @@ module Aws::CloudWatchLogs
83
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
84
86
  # credentials.
85
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
86
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
87
103
  # from an EC2 IMDS on an EC2 instance.
88
104
  #
89
- # * `Aws::SharedCredentials` - Used for loading credentials from a
90
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
91
107
  #
92
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
93
110
  #
94
111
  # When `:credentials` are not configured directly, the following
95
112
  # locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::CloudWatchLogs
99
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
100
117
  # * `~/.aws/credentials`
101
118
  # * `~/.aws/config`
102
- # * EC2 IMDS instance profile - When used by default, the timeouts are
103
- # very aggressive. Construct and pass an instance of
104
- # `Aws::InstanceProfileCredentails` to enable retries and extended
105
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
106
123
  #
107
124
  # @option options [required, String] :region
108
125
  # The AWS region to connect to. The configured `:region` is
@@ -331,17 +348,14 @@ module Aws::CloudWatchLogs
331
348
  # This enables Amazon CloudWatch Logs to decrypt this data whenever it
332
349
  # is requested.
333
350
  #
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].
351
+ # CloudWatch Logs supports only symmetric CMKs. Do not use an associate
352
+ # an asymmetric CMK with your log group. For more information, see
353
+ # [Using Symmetric and Asymmetric Keys][1].
337
354
  #
338
- # </note>
339
- #
340
- # Note that it can take up to 5 minutes for this operation to take
341
- # effect.
355
+ # It can take up to 5 minutes for this operation to take effect.
342
356
  #
343
357
  # If you attempt to associate a CMK with a log group but the CMK does
344
- # not exist or the CMK is disabled, you will receive an
358
+ # not exist or the CMK is disabled, you receive an
345
359
  # `InvalidParameterException` error.
346
360
  #
347
361
  #
@@ -405,7 +419,10 @@ module Aws::CloudWatchLogs
405
419
  end
406
420
 
407
421
  # Creates an export task, which allows you to efficiently export data
408
- # from a log group to an Amazon S3 bucket.
422
+ # from a log group to an Amazon S3 bucket. When you perform a
423
+ # `CreateExportTask` operation, you must use credentials that have
424
+ # permission to write to the S3 bucket that you specify as the
425
+ # destination.
409
426
  #
410
427
  # This is an asynchronous call. If all the required information is
411
428
  # provided, this operation initiates an export task and responds with
@@ -484,9 +501,8 @@ module Aws::CloudWatchLogs
484
501
  req.send_request(options)
485
502
  end
486
503
 
487
- # Creates a log group with the specified name.
488
- #
489
- # You can create up to 20,000 log groups per account.
504
+ # Creates a log group with the specified name. You can create up to
505
+ # 20,000 log groups per account.
490
506
  #
491
507
  # You must use the following guidelines when naming a log group:
492
508
  #
@@ -498,6 +514,10 @@ module Aws::CloudWatchLogs
498
514
  # '\_' (underscore), '-' (hyphen), '/' (forward slash), '.'
499
515
  # (period), and '#' (number sign)
500
516
  #
517
+ # When you create a log group, by default the log events in the log
518
+ # group never expire. To set a retention policy so that events expire
519
+ # and are deleted after a specified time, use [PutRetentionPolicy][1].
520
+ #
501
521
  # If you associate a AWS Key Management Service (AWS KMS) customer
502
522
  # master key (CMK) with the log group, ingested data is encrypted using
503
523
  # the CMK. This association is stored as long as the data encrypted with
@@ -505,18 +525,17 @@ module Aws::CloudWatchLogs
505
525
  # CloudWatch Logs to decrypt this data whenever it is requested.
506
526
  #
507
527
  # If you attempt to associate a CMK with the log group but the CMK does
508
- # not exist or the CMK is disabled, you will receive an
528
+ # not exist or the CMK is disabled, you receive an
509
529
  # `InvalidParameterException` error.
510
530
  #
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>
531
+ # CloudWatch Logs supports only symmetric CMKs. Do not associate an
532
+ # asymmetric CMK with your log group. For more information, see [Using
533
+ # Symmetric and Asymmetric Keys][2].
516
534
  #
517
535
  #
518
536
  #
519
- # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
537
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html
538
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
520
539
  #
521
540
  # @option params [required, String] :log_group_name
522
541
  # The name of the log group.
@@ -554,7 +573,9 @@ module Aws::CloudWatchLogs
554
573
  req.send_request(options)
555
574
  end
556
575
 
557
- # Creates a log stream for the specified log group.
576
+ # Creates a log stream for the specified log group. A log stream is a
577
+ # sequence of log events that originate from a single source, such as an
578
+ # application instance or a resource that is being monitored.
558
579
  #
559
580
  # There is no limit on the number of log streams that you can create for
560
581
  # a log group. There is a limit of 50 TPS on `CreateLogStream`
@@ -692,7 +713,24 @@ module Aws::CloudWatchLogs
692
713
  req.send_request(options)
693
714
  end
694
715
 
716
+ # Deletes a saved CloudWatch Logs Insights query definition. A query
717
+ # definition contains details about a saved CloudWatch Logs Insights
718
+ # query.
719
+ #
720
+ # Each `DeleteQueryDefinition` operation can delete one query
721
+ # definition.
722
+ #
723
+ # You must have the `logs:DeleteQueryDefinition` permission to be able
724
+ # to perform this operation.
725
+ #
695
726
  # @option params [required, String] :query_definition_id
727
+ # The ID of the query definition that you want to delete. You can use
728
+ # [DescribeQueryDefinitions][1] to retrieve the IDs of your saved query
729
+ # definitions.
730
+ #
731
+ #
732
+ #
733
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html
696
734
  #
697
735
  # @return [Types::DeleteQueryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
698
736
  #
@@ -963,7 +1001,7 @@ module Aws::CloudWatchLogs
963
1001
  # @option params [String] :log_stream_name_prefix
964
1002
  # The prefix to match.
965
1003
  #
966
- # If `orderBy` is `LastEventTime`,you cannot specify this parameter.
1004
+ # If `orderBy` is `LastEventTime`, you cannot specify this parameter.
967
1005
  #
968
1006
  # @option params [String] :order_by
969
1007
  # If the value is `LogStreamName`, the results are ordered by log stream
@@ -973,12 +1011,12 @@ module Aws::CloudWatchLogs
973
1011
  # If you order the results by event time, you cannot specify the
974
1012
  # `logStreamNamePrefix` parameter.
975
1013
  #
976
- # lastEventTimestamp represents the time of the most recent log event in
977
- # the log stream in CloudWatch Logs. This number is expressed as the
1014
+ # `lastEventTimeStamp` represents the time of the most recent log event
1015
+ # in the log stream in CloudWatch Logs. This number is expressed as the
978
1016
  # number of milliseconds after Jan 1, 1970 00:00:00 UTC.
979
- # lastEventTimeStamp updates on an eventual consistency basis. It
980
- # typically updates in less than an hour from ingestion, but may take
981
- # longer in some rare situations.
1017
+ # `lastEventTimeStamp` updates on an eventual consistency basis. It
1018
+ # typically updates in less than an hour from ingestion, but in rare
1019
+ # situations might take longer.
982
1020
  #
983
1021
  # @option params [Boolean] :descending
984
1022
  # If the value is true, results are returned in descending order. If the
@@ -1033,7 +1071,7 @@ module Aws::CloudWatchLogs
1033
1071
  req.send_request(options)
1034
1072
  end
1035
1073
 
1036
- # Lists the specified metric filters. You can list all the metric
1074
+ # Lists the specified metric filters. You can list all of the metric
1037
1075
  # filters or filter the results by log name, prefix, metric name, or
1038
1076
  # metric namespace. The results are ASCII-sorted by filter name.
1039
1077
  #
@@ -1041,7 +1079,8 @@ module Aws::CloudWatchLogs
1041
1079
  # The name of the log group.
1042
1080
  #
1043
1081
  # @option params [String] :filter_name_prefix
1044
- # The prefix to match.
1082
+ # The prefix to match. CloudWatch Logs uses the value you set here only
1083
+ # if you also include the `logGroupName` parameter in your request.
1045
1084
  #
1046
1085
  # @option params [String] :next_token
1047
1086
  # The token for the next set of items to return. (You received this
@@ -1104,7 +1143,7 @@ module Aws::CloudWatchLogs
1104
1143
 
1105
1144
  # Returns a list of CloudWatch Logs Insights queries that are scheduled,
1106
1145
  # executing, or have been executed recently in this account. You can
1107
- # request all queries, or limit it to queries of a specific log group or
1146
+ # request all queries or limit it to queries of a specific log group or
1108
1147
  # queries with a certain status.
1109
1148
  #
1110
1149
  # @option params [String] :log_group_name
@@ -1155,9 +1194,20 @@ module Aws::CloudWatchLogs
1155
1194
  req.send_request(options)
1156
1195
  end
1157
1196
 
1197
+ # This operation returns a paginated list of your saved CloudWatch Logs
1198
+ # Insights query definitions.
1199
+ #
1200
+ # You can use the `queryDefinitionNamePrefix` parameter to limit the
1201
+ # results to only the query definitions that have names that start with
1202
+ # a certain string.
1203
+ #
1158
1204
  # @option params [String] :query_definition_name_prefix
1205
+ # Use this parameter to filter your results to only the query
1206
+ # definitions that have names that start with the prefix you specify.
1159
1207
  #
1160
1208
  # @option params [Integer] :max_results
1209
+ # Limits the number of returned query definitions to the specified
1210
+ # number.
1161
1211
  #
1162
1212
  # @option params [String] :next_token
1163
1213
  # The token for the next set of items to return. The token expires after
@@ -1328,10 +1378,16 @@ module Aws::CloudWatchLogs
1328
1378
  # and the name of the log stream.
1329
1379
  #
1330
1380
  # By default, this operation returns as many log events as can fit in 1
1331
- # MB (up to 10,000 log events), or all the events found within the time
1381
+ # MB (up to 10,000 log events) or all the events found within the time
1332
1382
  # range that you specify. If the results include a token, then there are
1333
1383
  # more log events available, and you can get additional results by
1334
- # specifying the token in a subsequent call.
1384
+ # specifying the token in a subsequent call. This operation can return
1385
+ # empty results while there are more log events available through the
1386
+ # token.
1387
+ #
1388
+ # The returned log events are sorted by event timestamp, the timestamp
1389
+ # when the event was ingested by CloudWatch Logs, and the ID of the
1390
+ # `PutLogEvents` request.
1335
1391
  #
1336
1392
  # @option params [required, String] :log_group_name
1337
1393
  # The name of the log group to search.
@@ -1357,6 +1413,9 @@ module Aws::CloudWatchLogs
1357
1413
  # after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this
1358
1414
  # time are not returned.
1359
1415
  #
1416
+ # If you omit `startTime` and `endTime` the most recent log events are
1417
+ # retrieved, to up 1 MB or 10,000 log events.
1418
+ #
1360
1419
  # @option params [Integer] :end_time
1361
1420
  # The end of the time range, expressed as the number of milliseconds
1362
1421
  # after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than
@@ -1386,10 +1445,10 @@ module Aws::CloudWatchLogs
1386
1445
  # the matched log events in the first log stream are searched first,
1387
1446
  # then those in the next log stream, and so on. The default is false.
1388
1447
  #
1389
- # **IMPORTANT:** Starting on June 17, 2019, this parameter will be
1390
- # ignored and the value will be assumed to be true. The response from
1391
- # this operation will always interleave events from multiple log streams
1392
- # within a log group.
1448
+ # **Important:** Starting on June 17, 2019, this parameter is ignored
1449
+ # and the value is assumed to be true. The response from this operation
1450
+ # always interleaves events from multiple log streams within a log
1451
+ # group.
1393
1452
  #
1394
1453
  # @return [Types::FilterLogEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1395
1454
  #
@@ -1435,12 +1494,14 @@ module Aws::CloudWatchLogs
1435
1494
  req.send_request(options)
1436
1495
  end
1437
1496
 
1438
- # Lists log events from the specified log stream. You can list all the
1439
- # log events or filter using a time range.
1497
+ # Lists log events from the specified log stream. You can list all of
1498
+ # the log events or filter using a time range.
1440
1499
  #
1441
1500
  # By default, this operation returns as many log events as can fit in a
1442
1501
  # response size of 1MB (up to 10,000 log events). You can get additional
1443
- # log events by specifying one of the tokens in a subsequent call.
1502
+ # log events by specifying one of the tokens in a subsequent call. This
1503
+ # operation can return empty results while there are more log events
1504
+ # available through the token.
1444
1505
  #
1445
1506
  # @option params [required, String] :log_group_name
1446
1507
  # The name of the log group.
@@ -1571,13 +1632,12 @@ module Aws::CloudWatchLogs
1571
1632
  req.send_request(options)
1572
1633
  end
1573
1634
 
1574
- # Retrieves all the fields and values of a single log event. All fields
1575
- # are retrieved, even if the original query that produced the
1635
+ # Retrieves all of the fields and values of a single log event. All
1636
+ # fields are retrieved, even if the original query that produced the
1576
1637
  # `logRecordPointer` retrieved only a subset of fields. Fields are
1577
1638
  # returned as field name/field value pairs.
1578
1639
  #
1579
- # Additionally, the entire unparsed log event is returned within
1580
- # `@message`.
1640
+ # The full unparsed log event is returned within `@message`.
1581
1641
  #
1582
1642
  # @option params [required, String] :log_record_pointer
1583
1643
  # The pointer corresponding to the log event record you want to
@@ -1613,7 +1673,7 @@ module Aws::CloudWatchLogs
1613
1673
  # Returns the results from the specified query.
1614
1674
  #
1615
1675
  # Only the fields requested in the query are returned, along with a
1616
- # `@ptr` field which is the identifier for the log record. You can use
1676
+ # `@ptr` field, which is the identifier for the log record. You can use
1617
1677
  # the value of `@ptr` in a [GetLogRecord][1] operation to get the full
1618
1678
  # log record.
1619
1679
  #
@@ -1708,6 +1768,9 @@ module Aws::CloudWatchLogs
1708
1768
  # the destination owner must call [PutDestinationPolicy][3] after
1709
1769
  # `PutDestination`.
1710
1770
  #
1771
+ # To perform a `PutDestination` operation, you must also have the
1772
+ # `iam:PassRole` permission.
1773
+ #
1711
1774
  #
1712
1775
  #
1713
1776
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
@@ -1723,7 +1786,7 @@ module Aws::CloudWatchLogs
1723
1786
  #
1724
1787
  # @option params [required, String] :role_arn
1725
1788
  # The ARN of an IAM role that grants CloudWatch Logs permissions to call
1726
- # the Amazon Kinesis PutRecord operation on the destination stream.
1789
+ # the Amazon Kinesis `PutRecord` operation on the destination stream.
1727
1790
  #
1728
1791
  # @return [Types::PutDestinationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1729
1792
  #
@@ -1769,7 +1832,8 @@ module Aws::CloudWatchLogs
1769
1832
  #
1770
1833
  # @option params [required, String] :access_policy
1771
1834
  # An IAM policy document that authorizes cross-account users to deliver
1772
- # their log events to the associated destination.
1835
+ # their log events to the associated destination. This can be up to 5120
1836
+ # bytes.
1773
1837
  #
1774
1838
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1775
1839
  #
@@ -1796,14 +1860,14 @@ module Aws::CloudWatchLogs
1796
1860
  # require a sequence token. You can also get the sequence token in the
1797
1861
  # `expectedSequenceToken` field from `InvalidSequenceTokenException`. If
1798
1862
  # 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.
1863
+ # same value for `sequenceToken`, both calls might be successful or one
1864
+ # might be rejected.
1801
1865
  #
1802
1866
  # The batch of events must satisfy the following constraints:
1803
1867
  #
1804
- # * The maximum batch size is 1,048,576 bytes, and this size is
1805
- # calculated as the sum of all event messages in UTF-8, plus 26 bytes
1806
- # for each log event.
1868
+ # * The maximum batch size is 1,048,576 bytes. This size is calculated
1869
+ # as the sum of all event messages in UTF-8, plus 26 bytes for each
1870
+ # log event.
1807
1871
  #
1808
1872
  # * None of the log events in the batch can be more than 2 hours in the
1809
1873
  # future.
@@ -1811,12 +1875,12 @@ module Aws::CloudWatchLogs
1811
1875
  # * None of the log events in the batch can be older than 14 days or
1812
1876
  # older than the retention period of the log group.
1813
1877
  #
1814
- # * The log events in the batch must be in chronological ordered by
1815
- # their timestamp. The timestamp is the time the event occurred,
1816
- # expressed as the number of milliseconds after Jan 1, 1970 00:00:00
1817
- # UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the
1818
- # timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For
1819
- # example, 2017-09-15T13:45:30.)
1878
+ # * The log events in the batch must be in chronological order by their
1879
+ # timestamp. The timestamp is the time the event occurred, expressed
1880
+ # as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In
1881
+ # AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is
1882
+ # specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,
1883
+ # 2017-09-15T13:45:30.)
1820
1884
  #
1821
1885
  # * A batch of log events in a single request cannot span more than 24
1822
1886
  # hours. Otherwise, the operation fails.
@@ -1826,8 +1890,8 @@ module Aws::CloudWatchLogs
1826
1890
  # * There is a quota of 5 requests per second per log stream. Additional
1827
1891
  # requests are throttled. This quota can't be changed.
1828
1892
  #
1829
- # If a call to PutLogEvents returns "UnrecognizedClientException" the
1830
- # most likely cause is an invalid AWS access key ID or secret key.
1893
+ # If a call to `PutLogEvents` returns "UnrecognizedClientException"
1894
+ # the most likely cause is an invalid AWS access key ID or secret key.
1831
1895
  #
1832
1896
  # @option params [required, String] :log_group_name
1833
1897
  # The name of the log group.
@@ -1844,7 +1908,7 @@ module Aws::CloudWatchLogs
1844
1908
  # require a sequence token. You can also get the sequence token using
1845
1909
  # [DescribeLogStreams][1]. If you call `PutLogEvents` twice within a
1846
1910
  # narrow time period using the same value for `sequenceToken`, both
1847
- # calls may be successful, or one may be rejected.
1911
+ # calls might be successful or one might be rejected.
1848
1912
  #
1849
1913
  #
1850
1914
  #
@@ -1937,13 +2001,65 @@ module Aws::CloudWatchLogs
1937
2001
  req.send_request(options)
1938
2002
  end
1939
2003
 
2004
+ # Creates or updates a query definition for CloudWatch Logs Insights.
2005
+ # For more information, see [Analyzing Log Data with CloudWatch Logs
2006
+ # Insights][1].
2007
+ #
2008
+ # To update a query definition, specify its `queryDefinitionId` in your
2009
+ # request. The values of `name`, `queryString`, and `logGroupNames` are
2010
+ # changed to the values that you specify in your update operation. No
2011
+ # current values are retained from the current query definition. For
2012
+ # example, if you update a current query definition that includes log
2013
+ # groups, and you don't specify the `logGroupNames` parameter in your
2014
+ # update operation, the query definition changes to contain no log
2015
+ # groups.
2016
+ #
2017
+ # You must have the `logs:PutQueryDefinition` permission to be able to
2018
+ # perform this operation.
2019
+ #
2020
+ #
2021
+ #
2022
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html
2023
+ #
1940
2024
  # @option params [required, String] :name
2025
+ # A name for the query definition. If you are saving a lot of query
2026
+ # definitions, we recommend that you name them so that you can easily
2027
+ # find the ones you want by using the first part of the name as a filter
2028
+ # in the `queryDefinitionNamePrefix` parameter of
2029
+ # [DescribeQueryDefinitions][1].
2030
+ #
2031
+ #
2032
+ #
2033
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html
1941
2034
  #
1942
2035
  # @option params [String] :query_definition_id
2036
+ # If you are updating a query definition, use this parameter to specify
2037
+ # the ID of the query definition that you want to update. You can use
2038
+ # [DescribeQueryDefinitions][1] to retrieve the IDs of your saved query
2039
+ # definitions.
2040
+ #
2041
+ # If you are creating a query definition, do not specify this parameter.
2042
+ # CloudWatch generates a unique ID for the new query definition and
2043
+ # include it in the response to this operation.
2044
+ #
2045
+ #
2046
+ #
2047
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html
1943
2048
  #
1944
2049
  # @option params [Array<String>] :log_group_names
2050
+ # Use this parameter to include specific log groups as part of your
2051
+ # query definition.
2052
+ #
2053
+ # If you are updating a query definition and you omit this parameter,
2054
+ # then the updated definition will contain no log groups.
1945
2055
  #
1946
2056
  # @option params [required, String] :query_string
2057
+ # The query string to use for this definition. For more information, see
2058
+ # [CloudWatch Logs Insights Query Syntax][1].
2059
+ #
2060
+ #
2061
+ #
2062
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
1947
2063
  #
1948
2064
  # @return [Types::PutQueryDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1949
2065
  #
@@ -1973,7 +2089,7 @@ module Aws::CloudWatchLogs
1973
2089
 
1974
2090
  # Creates or updates a resource policy allowing other AWS services to
1975
2091
  # put log events to this account, such as Amazon Route 53. An account
1976
- # can have up to 10 resource policies per region.
2092
+ # can have up to 10 resource policies per AWS Region.
1977
2093
  #
1978
2094
  # @option params [String] :policy_name
1979
2095
  # Name of the new policy. This parameter is required.
@@ -1985,7 +2101,7 @@ module Aws::CloudWatchLogs
1985
2101
  #
1986
2102
  # The following example creates a resource policy enabling the Route 53
1987
2103
  # service to put DNS query logs in to the specified log group. Replace
1988
- # "logArn" with the ARN of your CloudWatch Logs resource, such as a
2104
+ # `"logArn"` with the ARN of your CloudWatch Logs resource, such as a
1989
2105
  # log group or log stream.
1990
2106
  #
1991
2107
  # `\{ "Version": "2012-10-17", "Statement": [ \{ "Sid":
@@ -2031,6 +2147,9 @@ module Aws::CloudWatchLogs
2031
2147
  # group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180,
2032
2148
  # 365, 400, 545, 731, 1827, and 3653.
2033
2149
  #
2150
+ # If you omit `retentionInDays` in a `PutRetentionPolicy` operation, the
2151
+ # events in the log group are always retained and never expire.
2152
+ #
2034
2153
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2035
2154
  #
2036
2155
  # @example Request syntax with placeholder values
@@ -2052,8 +2171,11 @@ module Aws::CloudWatchLogs
2052
2171
  # Creates or updates a subscription filter and associates it with the
2053
2172
  # specified log group. Subscription filters allow you to subscribe to a
2054
2173
  # 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:
2174
+ # have them delivered to a specific destination. When log events are
2175
+ # sent to the receiving service, they are Base64 encoded and compressed
2176
+ # with the gzip format.
2177
+ #
2178
+ # The following destinations are supported for subscription filters:
2057
2179
  #
2058
2180
  # * An Amazon Kinesis stream belonging to the same account as the
2059
2181
  # subscription filter, for same-account delivery.
@@ -2072,6 +2194,9 @@ module Aws::CloudWatchLogs
2072
2194
  # name in `filterName`. Otherwise, the call fails because you cannot
2073
2195
  # associate a second filter with a log group.
2074
2196
  #
2197
+ # To perform a `PutSubscriptionFilter` operation, you must also have the
2198
+ # `iam:PassRole` permission.
2199
+ #
2075
2200
  #
2076
2201
  #
2077
2202
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
@@ -2116,7 +2241,7 @@ module Aws::CloudWatchLogs
2116
2241
  # cross-account delivery.
2117
2242
  #
2118
2243
  # @option params [String] :distribution
2119
- # The method used to distribute log data to the destination. By default
2244
+ # The method used to distribute log data to the destination. By default,
2120
2245
  # log data is grouped by log stream, but the grouping can be set to
2121
2246
  # random for a more even distribution. This property is only applicable
2122
2247
  # when the destination is an Amazon Kinesis stream.
@@ -2144,13 +2269,13 @@ module Aws::CloudWatchLogs
2144
2269
  end
2145
2270
 
2146
2271
  # Schedules a query of a log group using CloudWatch Logs Insights. You
2147
- # specify the log group and time range to query, and the query string to
2272
+ # specify the log group and time range to query and the query string to
2148
2273
  # use.
2149
2274
  #
2150
2275
  # For more information, see [CloudWatch Logs Insights Query Syntax][1].
2151
2276
  #
2152
2277
  # Queries time out after 15 minutes of execution. If your queries are
2153
- # timing out, reduce the time range being searched, or partition your
2278
+ # timing out, reduce the time range being searched or partition your
2154
2279
  # query into a number of queries.
2155
2280
  #
2156
2281
  #
@@ -2226,8 +2351,8 @@ module Aws::CloudWatchLogs
2226
2351
  # that the specified query is not running.
2227
2352
  #
2228
2353
  # @option params [required, String] :query_id
2229
- # The ID number of the query to stop. If necessary, you can use
2230
- # `DescribeQueries` to find this ID number.
2354
+ # The ID number of the query to stop. To find this ID number, use
2355
+ # `DescribeQueries`.
2231
2356
  #
2232
2357
  # @return [Types::StopQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2233
2358
  #
@@ -2298,7 +2423,7 @@ module Aws::CloudWatchLogs
2298
2423
  #
2299
2424
  # @option params [required, String] :filter_pattern
2300
2425
  # A symbolic description of how CloudWatch Logs should interpret the
2301
- # data in each log event. For example, a log event may contain
2426
+ # data in each log event. For example, a log event can contain
2302
2427
  # timestamps, IP addresses, strings, and so on. You use the filter
2303
2428
  # pattern to specify what to look for in the log event message.
2304
2429
  #
@@ -2380,7 +2505,7 @@ module Aws::CloudWatchLogs
2380
2505
  params: params,
2381
2506
  config: config)
2382
2507
  context[:gem_name] = 'aws-sdk-cloudwatchlogs'
2383
- context[:gem_version] = '1.32.1'
2508
+ context[:gem_version] = '1.38.0'
2384
2509
  Seahorse::Client::Request.new(handlers, context)
2385
2510
  end
2386
2511