aws-sdk-cloudwatchlogs 1.67.0 → 1.68.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchlogs/client.rb +175 -37
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +7 -2
- data/lib/aws-sdk-cloudwatchlogs/types.rb +92 -13
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bdb3c2322cb472fec5d163bad38d694a65955dba0abde68f73c78ae8efa7c3c6
|
4
|
+
data.tar.gz: bb7f82ba4af6c0400663a5897e105dc0ad4198a593199f928a8ee76043802275
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f3363af80f9cd6aa3592880824074a23e9f007d7c470f2d3fe8afd48e3cd4be169f1752088b78ffaa5b6a1f9e63c951af00816c48867e5affd11250a27dfb797
|
7
|
+
data.tar.gz: ce51613f3d9a6a19dd63e92355e42887e1e29568c128508cc7d93ca2acc6d088af56b02f913b52d791e06a138779cf56f18f5ee5f78ea539a0551563968f7658
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.68.0
|
@@ -394,19 +394,56 @@ module Aws::CloudWatchLogs
|
|
394
394
|
|
395
395
|
# @!group API Operations
|
396
396
|
|
397
|
-
# Associates the specified KMS key with
|
397
|
+
# Associates the specified KMS key with either one log group in the
|
398
|
+
# account, or with all stored CloudWatch Logs query insights results in
|
399
|
+
# the account.
|
400
|
+
#
|
401
|
+
# When you use `AssociateKmsKey`, you specify either the `logGroupName`
|
402
|
+
# parameter or the `resourceIdentifier` parameter. You can't specify
|
403
|
+
# both of those parameters in the same operation.
|
404
|
+
#
|
405
|
+
# * Specify the `logGroupName` parameter to cause all log events stored
|
406
|
+
# in the log group to be encrypted with that key. Only the log events
|
407
|
+
# ingested after the key is associated are encrypted with that key.
|
408
|
+
#
|
409
|
+
# Associating a KMS key with a log group overrides any existing
|
410
|
+
# associations between the log group and a KMS key. After a KMS key is
|
411
|
+
# associated with a log group, all newly ingested data for the log
|
412
|
+
# group is encrypted using the KMS key. This association is stored as
|
413
|
+
# long as the data encrypted with the KMS key is still within
|
414
|
+
# CloudWatch Logs. This enables CloudWatch Logs to decrypt this data
|
415
|
+
# whenever it is requested.
|
416
|
+
#
|
417
|
+
# Associating a key with a log group does not cause the results of
|
418
|
+
# queries of that log group to be encrypted with that key. To have
|
419
|
+
# query results encrypted with a KMS key, you must use an
|
420
|
+
# `AssociateKmsKey` operation with the `resourceIdentifier` parameter
|
421
|
+
# that specifies a `query-result` resource.
|
422
|
+
#
|
423
|
+
# * Specify the `resourceIdentifier` parameter with a `query-result`
|
424
|
+
# resource, to use that key to encrypt the stored results of all
|
425
|
+
# future [StartQuery][1] operations in the account. The response from
|
426
|
+
# a [GetQueryResults][2] operation will still return the query results
|
427
|
+
# in plain text.
|
428
|
+
#
|
429
|
+
# Even if you have not associated a key with your query results, the
|
430
|
+
# query results are encrypted when stored, using the default
|
431
|
+
# CloudWatch Logs method.
|
432
|
+
#
|
433
|
+
# If you run a query from a monitoring account that queries logs in a
|
434
|
+
# source account, the query results key from the monitoring account,
|
435
|
+
# if any, is used.
|
436
|
+
#
|
437
|
+
# If you delete the key that is used to encrypt log events or log group
|
438
|
+
# query results, then all the associated stored log events or query
|
439
|
+
# results that were encrypted with that key will be unencryptable and
|
440
|
+
# unusable.
|
441
|
+
#
|
442
|
+
# <note markdown="1"> CloudWatch Logs supports only symmetric KMS keys. Do not use an
|
443
|
+
# associate an asymmetric KMS key with your log group or query results.
|
444
|
+
# For more information, see [Using Symmetric and Asymmetric Keys][3].
|
398
445
|
#
|
399
|
-
#
|
400
|
-
# associations between the log group and a KMS key. After a KMS key is
|
401
|
-
# associated with a log group, all newly ingested data for the log group
|
402
|
-
# is encrypted using the KMS key. This association is stored as long as
|
403
|
-
# the data encrypted with the KMS keyis still within CloudWatch Logs.
|
404
|
-
# This enables CloudWatch Logs to decrypt this data whenever it is
|
405
|
-
# requested.
|
406
|
-
#
|
407
|
-
# CloudWatch Logs supports only symmetric KMS keys. Do not use an
|
408
|
-
# associate an asymmetric KMS key with your log group. For more
|
409
|
-
# information, see [Using Symmetric and Asymmetric Keys][1].
|
446
|
+
# </note>
|
410
447
|
#
|
411
448
|
# It can take up to 5 minutes for this operation to take effect.
|
412
449
|
#
|
@@ -416,11 +453,17 @@ module Aws::CloudWatchLogs
|
|
416
453
|
#
|
417
454
|
#
|
418
455
|
#
|
419
|
-
# [1]: https://docs.aws.amazon.com/
|
456
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
|
457
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html
|
458
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
420
459
|
#
|
421
|
-
# @option params [
|
460
|
+
# @option params [String] :log_group_name
|
422
461
|
# The name of the log group.
|
423
462
|
#
|
463
|
+
# In your `AssociateKmsKey` operation, you must specify either the
|
464
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
465
|
+
# can't specify both.
|
466
|
+
#
|
424
467
|
# @option params [required, String] :kms_key_id
|
425
468
|
# The Amazon Resource Name (ARN) of the KMS key to use when encrypting
|
426
469
|
# log data. This must be a symmetric KMS key. For more information, see
|
@@ -432,13 +475,40 @@ module Aws::CloudWatchLogs
|
|
432
475
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms
|
433
476
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
434
477
|
#
|
478
|
+
# @option params [String] :resource_identifier
|
479
|
+
# Specifies the target for this operation. You must specify one of the
|
480
|
+
# following:
|
481
|
+
#
|
482
|
+
# * Specify the following ARN to have future [GetQueryResults][1]
|
483
|
+
# operations in this account encrypt the results with the specified
|
484
|
+
# KMS key. Replace *REGION* and *ACCOUNT\_ID* with your Region and
|
485
|
+
# account ID.
|
486
|
+
#
|
487
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`
|
488
|
+
#
|
489
|
+
# * Specify the ARN of a log group to have CloudWatch Logs use the KMS
|
490
|
+
# key to encrypt log events that are ingested and stored by that log
|
491
|
+
# group. The log group ARN must be in the following format. Replace
|
492
|
+
# *REGION* and *ACCOUNT\_ID* with your Region and account ID.
|
493
|
+
#
|
494
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `
|
495
|
+
#
|
496
|
+
# In your `AssociateKmsKey` operation, you must specify either the
|
497
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
498
|
+
# can't specify both.
|
499
|
+
#
|
500
|
+
#
|
501
|
+
#
|
502
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html
|
503
|
+
#
|
435
504
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
436
505
|
#
|
437
506
|
# @example Request syntax with placeholder values
|
438
507
|
#
|
439
508
|
# resp = client.associate_kms_key({
|
440
|
-
# log_group_name: "LogGroupName",
|
509
|
+
# log_group_name: "LogGroupName",
|
441
510
|
# kms_key_id: "KmsKeyId", # required
|
511
|
+
# resource_identifier: "ResourceIdentifier",
|
442
512
|
# })
|
443
513
|
#
|
444
514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKey AWS API Documentation
|
@@ -1625,25 +1695,76 @@ module Aws::CloudWatchLogs
|
|
1625
1695
|
req.send_request(options)
|
1626
1696
|
end
|
1627
1697
|
|
1628
|
-
# Disassociates the
|
1698
|
+
# Disassociates the specified KMS key from the specified log group or
|
1699
|
+
# from all CloudWatch Logs Insights query results in the account.
|
1700
|
+
#
|
1701
|
+
# When you use `DisassociateKmsKey`, you specify either the
|
1702
|
+
# `logGroupName` parameter or the `resourceIdentifier` parameter. You
|
1703
|
+
# can't specify both of those parameters in the same operation.
|
1704
|
+
#
|
1705
|
+
# * Specify the `logGroupName` parameter to stop using the KMS key to
|
1706
|
+
# encrypt future log events ingested and stored in the log group.
|
1707
|
+
# Instead, they will be encrypted with the default CloudWatch Logs
|
1708
|
+
# method. The log events that were ingested while the key was
|
1709
|
+
# associated with the log group are still encrypted with that key.
|
1710
|
+
# Therefore, CloudWatch Logs will need permissions for the key
|
1711
|
+
# whenever that data is accessed.
|
1712
|
+
#
|
1713
|
+
# * Specify the `resourceIdentifier` parameter with the `query-result`
|
1714
|
+
# resource to stop using the KMS key to encrypt the results of all
|
1715
|
+
# future [StartQuery][1] operations in the account. They will instead
|
1716
|
+
# be encrypted with the default CloudWatch Logs method. The results
|
1717
|
+
# from queries that ran while the key was associated with the account
|
1718
|
+
# are still encrypted with that key. Therefore, CloudWatch Logs will
|
1719
|
+
# need permissions for the key whenever that data is accessed.
|
1720
|
+
#
|
1721
|
+
# It can take up to 5 minutes for this operation to take effect.
|
1629
1722
|
#
|
1630
|
-
# After the KMS key is disassociated from the log group, CloudWatch Logs
|
1631
|
-
# stops encrypting newly ingested data for the log group. All previously
|
1632
|
-
# ingested data remains encrypted, and CloudWatch Logs requires
|
1633
|
-
# permissions for the KMS key whenever the encrypted data is requested.
|
1634
1723
|
#
|
1635
|
-
# Note that it can take up to 5 minutes for this operation to take
|
1636
|
-
# effect.
|
1637
1724
|
#
|
1638
|
-
#
|
1725
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
|
1726
|
+
#
|
1727
|
+
# @option params [String] :log_group_name
|
1639
1728
|
# The name of the log group.
|
1640
1729
|
#
|
1730
|
+
# In your `DisassociateKmsKey` operation, you must specify either the
|
1731
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
1732
|
+
# can't specify both.
|
1733
|
+
#
|
1734
|
+
# @option params [String] :resource_identifier
|
1735
|
+
# Specifies the target for this operation. You must specify one of the
|
1736
|
+
# following:
|
1737
|
+
#
|
1738
|
+
# * Specify the ARN of a log group to stop having CloudWatch Logs use
|
1739
|
+
# the KMS key to encrypt log events that are ingested and stored by
|
1740
|
+
# that log group. After you run this operation, CloudWatch Logs
|
1741
|
+
# encrypts ingested log events with the default CloudWatch Logs
|
1742
|
+
# method. The log group ARN must be in the following format. Replace
|
1743
|
+
# *REGION* and *ACCOUNT\_ID* with your Region and account ID.
|
1744
|
+
#
|
1745
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `
|
1746
|
+
#
|
1747
|
+
# * Specify the following ARN to stop using this key to encrypt the
|
1748
|
+
# results of future [StartQuery][1] operations in this account.
|
1749
|
+
# Replace *REGION* and *ACCOUNT\_ID* with your Region and account ID.
|
1750
|
+
#
|
1751
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`
|
1752
|
+
#
|
1753
|
+
# In your `DisssociateKmsKey` operation, you must specify either the
|
1754
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
1755
|
+
# can't specify both.
|
1756
|
+
#
|
1757
|
+
#
|
1758
|
+
#
|
1759
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
|
1760
|
+
#
|
1641
1761
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1642
1762
|
#
|
1643
1763
|
# @example Request syntax with placeholder values
|
1644
1764
|
#
|
1645
1765
|
# resp = client.disassociate_kms_key({
|
1646
|
-
# log_group_name: "LogGroupName",
|
1766
|
+
# log_group_name: "LogGroupName",
|
1767
|
+
# resource_identifier: "ResourceIdentifier",
|
1647
1768
|
# })
|
1648
1769
|
#
|
1649
1770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKey AWS API Documentation
|
@@ -2001,8 +2122,9 @@ module Aws::CloudWatchLogs
|
|
2001
2122
|
#
|
2002
2123
|
# @option params [Integer] :time
|
2003
2124
|
# The time to set as the center of the query. If you specify `time`, the
|
2004
|
-
#
|
2005
|
-
#
|
2125
|
+
# 8 minutes before and 8 minutes after this time are searched. If you
|
2126
|
+
# omit `time`, the most recent 15 minutes up to the current time are
|
2127
|
+
# searched.
|
2006
2128
|
#
|
2007
2129
|
# The `time` value is specified as epoch time, which is the number of
|
2008
2130
|
# seconds since `January 1, 1970, 00:00:00 UTC`.
|
@@ -2124,6 +2246,7 @@ module Aws::CloudWatchLogs
|
|
2124
2246
|
# * {Types::GetQueryResultsResponse#results #results} => Array<Array<Types::ResultField>>
|
2125
2247
|
# * {Types::GetQueryResultsResponse#statistics #statistics} => Types::QueryStatistics
|
2126
2248
|
# * {Types::GetQueryResultsResponse#status #status} => String
|
2249
|
+
# * {Types::GetQueryResultsResponse#encryption_key #encryption_key} => String
|
2127
2250
|
#
|
2128
2251
|
# @example Request syntax with placeholder values
|
2129
2252
|
#
|
@@ -2141,6 +2264,7 @@ module Aws::CloudWatchLogs
|
|
2141
2264
|
# resp.statistics.records_scanned #=> Float
|
2142
2265
|
# resp.statistics.bytes_scanned #=> Float
|
2143
2266
|
# resp.status #=> String, one of "Scheduled", "Running", "Complete", "Failed", "Cancelled", "Timeout", "Unknown"
|
2267
|
+
# resp.encryption_key #=> String
|
2144
2268
|
#
|
2145
2269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResults AWS API Documentation
|
2146
2270
|
#
|
@@ -2329,10 +2453,9 @@ module Aws::CloudWatchLogs
|
|
2329
2453
|
# `DATA_PROTECTION_POLICY`.
|
2330
2454
|
#
|
2331
2455
|
# @option params [String] :scope
|
2332
|
-
# Currently the only valid value for this parameter is `
|
2456
|
+
# Currently the only valid value for this parameter is `ALL`, which
|
2333
2457
|
# specifies that the data protection policy applies to all log groups in
|
2334
|
-
# the account. If you omit this parameter, the default of `
|
2335
|
-
# used.
|
2458
|
+
# the account. If you omit this parameter, the default of `ALL` is used.
|
2336
2459
|
#
|
2337
2460
|
# @return [Types::PutAccountPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2338
2461
|
#
|
@@ -2994,8 +3117,10 @@ module Aws::CloudWatchLogs
|
|
2994
3117
|
# * An Amazon Kinesis data stream belonging to the same account as the
|
2995
3118
|
# subscription filter, for same-account delivery.
|
2996
3119
|
#
|
2997
|
-
# * A logical destination
|
2998
|
-
# cross-account delivery.
|
3120
|
+
# * A logical destination created with [PutDestination][2] that belongs
|
3121
|
+
# to a different account, for cross-account delivery. We currently
|
3122
|
+
# support Kinesis Data Streams and Kinesis Data Firehose as logical
|
3123
|
+
# destinations.
|
2999
3124
|
#
|
3000
3125
|
# * An Amazon Kinesis Data Firehose delivery stream that belongs to the
|
3001
3126
|
# same account as the subscription filter, for same-account delivery.
|
@@ -3014,6 +3139,7 @@ module Aws::CloudWatchLogs
|
|
3014
3139
|
#
|
3015
3140
|
#
|
3016
3141
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html
|
3142
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html
|
3017
3143
|
#
|
3018
3144
|
# @option params [required, String] :log_group_name
|
3019
3145
|
# The name of the log group.
|
@@ -3096,6 +3222,16 @@ module Aws::CloudWatchLogs
|
|
3096
3222
|
#
|
3097
3223
|
# For more information, see [CloudWatch Logs Insights Query Syntax][1].
|
3098
3224
|
#
|
3225
|
+
# After you run a query using `StartQuery`, the query results are stored
|
3226
|
+
# by CloudWatch Logs. You can use [GetQueryResults][2] to retrieve the
|
3227
|
+
# results of a query, using the `queryId` that `StartQuery` returns.
|
3228
|
+
#
|
3229
|
+
# If you have associated a KMS key with the query results in this
|
3230
|
+
# account, then [StartQuery][3] uses that key to encrypt the results
|
3231
|
+
# when it stores them. If no key is associated with query results, the
|
3232
|
+
# query results are encrypted with the default CloudWatch Logs
|
3233
|
+
# encryption method.
|
3234
|
+
#
|
3099
3235
|
# Queries time out after 60 minutes of runtime. If your queries are
|
3100
3236
|
# timing out, reduce the time range being searched or partition your
|
3101
3237
|
# query into a number of queries.
|
@@ -3103,7 +3239,7 @@ module Aws::CloudWatchLogs
|
|
3103
3239
|
# If you are using CloudWatch cross-account observability, you can use
|
3104
3240
|
# this operation in a monitoring account to start a query in a linked
|
3105
3241
|
# source account. For more information, see [CloudWatch cross-account
|
3106
|
-
# observability][
|
3242
|
+
# observability][4]. For a cross-account `StartQuery` operation, the
|
3107
3243
|
# query definition must be defined in the monitoring account.
|
3108
3244
|
#
|
3109
3245
|
# You can have up to 30 concurrent CloudWatch Logs insights queries,
|
@@ -3112,13 +3248,15 @@ module Aws::CloudWatchLogs
|
|
3112
3248
|
#
|
3113
3249
|
#
|
3114
3250
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html
|
3115
|
-
# [2]: https://docs.aws.amazon.com/
|
3251
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html
|
3252
|
+
# [3]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
|
3253
|
+
# [4]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html
|
3116
3254
|
#
|
3117
3255
|
# @option params [String] :log_group_name
|
3118
3256
|
# The log group on which to perform the query.
|
3119
3257
|
#
|
3120
3258
|
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
3121
|
-
# parameters: `logGroupName`, `logGroupNames
|
3259
|
+
# parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.
|
3122
3260
|
#
|
3123
3261
|
# </note>
|
3124
3262
|
#
|
@@ -3127,7 +3265,7 @@ module Aws::CloudWatchLogs
|
|
3127
3265
|
# groups.
|
3128
3266
|
#
|
3129
3267
|
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
3130
|
-
# parameters: `logGroupName`, `logGroupNames
|
3268
|
+
# parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.
|
3131
3269
|
#
|
3132
3270
|
# </note>
|
3133
3271
|
#
|
@@ -3142,7 +3280,7 @@ module Aws::CloudWatchLogs
|
|
3142
3280
|
# If you specify an ARN, the ARN can't end with an asterisk (*).
|
3143
3281
|
#
|
3144
3282
|
# A `StartQuery` operation must include exactly one of the following
|
3145
|
-
# parameters: `logGroupName`, `logGroupNames
|
3283
|
+
# parameters: `logGroupName`, `logGroupNames`, or `logGroupIdentifiers`.
|
3146
3284
|
#
|
3147
3285
|
# @option params [required, Integer] :start_time
|
3148
3286
|
# The beginning of the time range to query. The range is inclusive, so
|
@@ -3472,7 +3610,7 @@ module Aws::CloudWatchLogs
|
|
3472
3610
|
params: params,
|
3473
3611
|
config: config)
|
3474
3612
|
context[:gem_name] = 'aws-sdk-cloudwatchlogs'
|
3475
|
-
context[:gem_version] = '1.
|
3613
|
+
context[:gem_version] = '1.68.0'
|
3476
3614
|
Seahorse::Client::Request.new(handlers, context)
|
3477
3615
|
end
|
3478
3616
|
|
@@ -75,6 +75,7 @@ module Aws::CloudWatchLogs
|
|
75
75
|
DimensionsValue = Shapes::StringShape.new(name: 'DimensionsValue')
|
76
76
|
DisassociateKmsKeyRequest = Shapes::StructureShape.new(name: 'DisassociateKmsKeyRequest')
|
77
77
|
Distribution = Shapes::StringShape.new(name: 'Distribution')
|
78
|
+
EncryptionKey = Shapes::StringShape.new(name: 'EncryptionKey')
|
78
79
|
EventId = Shapes::StringShape.new(name: 'EventId')
|
79
80
|
EventMessage = Shapes::StringShape.new(name: 'EventMessage')
|
80
81
|
EventNumber = Shapes::IntegerShape.new(name: 'EventNumber')
|
@@ -194,6 +195,7 @@ module Aws::CloudWatchLogs
|
|
194
195
|
QueryString = Shapes::StringShape.new(name: 'QueryString')
|
195
196
|
RejectedLogEventsInfo = Shapes::StructureShape.new(name: 'RejectedLogEventsInfo')
|
196
197
|
ResourceAlreadyExistsException = Shapes::StructureShape.new(name: 'ResourceAlreadyExistsException')
|
198
|
+
ResourceIdentifier = Shapes::StringShape.new(name: 'ResourceIdentifier')
|
197
199
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
198
200
|
ResourcePolicies = Shapes::ListShape.new(name: 'ResourcePolicies')
|
199
201
|
ResourcePolicy = Shapes::StructureShape.new(name: 'ResourcePolicy')
|
@@ -248,8 +250,9 @@ module Aws::CloudWatchLogs
|
|
248
250
|
AccountPolicy.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "accountId"))
|
249
251
|
AccountPolicy.struct_class = Types::AccountPolicy
|
250
252
|
|
251
|
-
AssociateKmsKeyRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName,
|
253
|
+
AssociateKmsKeyRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, location_name: "logGroupName"))
|
252
254
|
AssociateKmsKeyRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, required: true, location_name: "kmsKeyId"))
|
255
|
+
AssociateKmsKeyRequest.add_member(:resource_identifier, Shapes::ShapeRef.new(shape: ResourceIdentifier, location_name: "resourceIdentifier"))
|
253
256
|
AssociateKmsKeyRequest.struct_class = Types::AssociateKmsKeyRequest
|
254
257
|
|
255
258
|
CancelExportTaskRequest.add_member(:task_id, Shapes::ShapeRef.new(shape: ExportTaskId, required: true, location_name: "taskId"))
|
@@ -430,7 +433,8 @@ module Aws::CloudWatchLogs
|
|
430
433
|
Dimensions.key = Shapes::ShapeRef.new(shape: DimensionsKey)
|
431
434
|
Dimensions.value = Shapes::ShapeRef.new(shape: DimensionsValue)
|
432
435
|
|
433
|
-
DisassociateKmsKeyRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName,
|
436
|
+
DisassociateKmsKeyRequest.add_member(:log_group_name, Shapes::ShapeRef.new(shape: LogGroupName, location_name: "logGroupName"))
|
437
|
+
DisassociateKmsKeyRequest.add_member(:resource_identifier, Shapes::ShapeRef.new(shape: ResourceIdentifier, location_name: "resourceIdentifier"))
|
434
438
|
DisassociateKmsKeyRequest.struct_class = Types::DisassociateKmsKeyRequest
|
435
439
|
|
436
440
|
ExportTask.add_member(:task_id, Shapes::ShapeRef.new(shape: ExportTaskId, location_name: "taskId"))
|
@@ -529,6 +533,7 @@ module Aws::CloudWatchLogs
|
|
529
533
|
GetQueryResultsResponse.add_member(:results, Shapes::ShapeRef.new(shape: QueryResults, location_name: "results"))
|
530
534
|
GetQueryResultsResponse.add_member(:statistics, Shapes::ShapeRef.new(shape: QueryStatistics, location_name: "statistics"))
|
531
535
|
GetQueryResultsResponse.add_member(:status, Shapes::ShapeRef.new(shape: QueryStatus, location_name: "status"))
|
536
|
+
GetQueryResultsResponse.add_member(:encryption_key, Shapes::ShapeRef.new(shape: EncryptionKey, location_name: "encryptionKey"))
|
532
537
|
GetQueryResultsResponse.struct_class = Types::GetQueryResultsResponse
|
533
538
|
|
534
539
|
InheritedProperties.member = Shapes::ShapeRef.new(shape: InheritedProperty)
|
@@ -55,6 +55,10 @@ module Aws::CloudWatchLogs
|
|
55
55
|
|
56
56
|
# @!attribute [rw] log_group_name
|
57
57
|
# The name of the log group.
|
58
|
+
#
|
59
|
+
# In your `AssociateKmsKey` operation, you must specify either the
|
60
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
61
|
+
# can't specify both.
|
58
62
|
# @return [String]
|
59
63
|
#
|
60
64
|
# @!attribute [rw] kms_key_id
|
@@ -69,11 +73,39 @@ module Aws::CloudWatchLogs
|
|
69
73
|
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
|
70
74
|
# @return [String]
|
71
75
|
#
|
76
|
+
# @!attribute [rw] resource_identifier
|
77
|
+
# Specifies the target for this operation. You must specify one of the
|
78
|
+
# following:
|
79
|
+
#
|
80
|
+
# * Specify the following ARN to have future [GetQueryResults][1]
|
81
|
+
# operations in this account encrypt the results with the specified
|
82
|
+
# KMS key. Replace *REGION* and *ACCOUNT\_ID* with your Region and
|
83
|
+
# account ID.
|
84
|
+
#
|
85
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`
|
86
|
+
#
|
87
|
+
# * Specify the ARN of a log group to have CloudWatch Logs use the KMS
|
88
|
+
# key to encrypt log events that are ingested and stored by that log
|
89
|
+
# group. The log group ARN must be in the following format. Replace
|
90
|
+
# *REGION* and *ACCOUNT\_ID* with your Region and account ID.
|
91
|
+
#
|
92
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `
|
93
|
+
#
|
94
|
+
# In your `AssociateKmsKey` operation, you must specify either the
|
95
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
96
|
+
# can't specify both.
|
97
|
+
#
|
98
|
+
#
|
99
|
+
#
|
100
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html
|
101
|
+
# @return [String]
|
102
|
+
#
|
72
103
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/AssociateKmsKeyRequest AWS API Documentation
|
73
104
|
#
|
74
105
|
class AssociateKmsKeyRequest < Struct.new(
|
75
106
|
:log_group_name,
|
76
|
-
:kms_key_id
|
107
|
+
:kms_key_id,
|
108
|
+
:resource_identifier)
|
77
109
|
SENSITIVE = []
|
78
110
|
include Aws::Structure
|
79
111
|
end
|
@@ -990,12 +1022,46 @@ module Aws::CloudWatchLogs
|
|
990
1022
|
|
991
1023
|
# @!attribute [rw] log_group_name
|
992
1024
|
# The name of the log group.
|
1025
|
+
#
|
1026
|
+
# In your `DisassociateKmsKey` operation, you must specify either the
|
1027
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
1028
|
+
# can't specify both.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] resource_identifier
|
1032
|
+
# Specifies the target for this operation. You must specify one of the
|
1033
|
+
# following:
|
1034
|
+
#
|
1035
|
+
# * Specify the ARN of a log group to stop having CloudWatch Logs use
|
1036
|
+
# the KMS key to encrypt log events that are ingested and stored by
|
1037
|
+
# that log group. After you run this operation, CloudWatch Logs
|
1038
|
+
# encrypts ingested log events with the default CloudWatch Logs
|
1039
|
+
# method. The log group ARN must be in the following format. Replace
|
1040
|
+
# *REGION* and *ACCOUNT\_ID* with your Region and account ID.
|
1041
|
+
#
|
1042
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `
|
1043
|
+
#
|
1044
|
+
# * Specify the following ARN to stop using this key to encrypt the
|
1045
|
+
# results of future [StartQuery][1] operations in this account.
|
1046
|
+
# Replace *REGION* and *ACCOUNT\_ID* with your Region and account
|
1047
|
+
# ID.
|
1048
|
+
#
|
1049
|
+
# `arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`
|
1050
|
+
#
|
1051
|
+
# In your `DisssociateKmsKey` operation, you must specify either the
|
1052
|
+
# `resourceIdentifier` parameter or the `logGroup` parameter, but you
|
1053
|
+
# can't specify both.
|
1054
|
+
#
|
1055
|
+
#
|
1056
|
+
#
|
1057
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
|
993
1058
|
# @return [String]
|
994
1059
|
#
|
995
1060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DisassociateKmsKeyRequest AWS API Documentation
|
996
1061
|
#
|
997
1062
|
class DisassociateKmsKeyRequest < Struct.new(
|
998
|
-
:log_group_name
|
1063
|
+
:log_group_name,
|
1064
|
+
:resource_identifier)
|
999
1065
|
SENSITIVE = []
|
1000
1066
|
include Aws::Structure
|
1001
1067
|
end
|
@@ -1426,8 +1492,9 @@ module Aws::CloudWatchLogs
|
|
1426
1492
|
#
|
1427
1493
|
# @!attribute [rw] time
|
1428
1494
|
# The time to set as the center of the query. If you specify `time`,
|
1429
|
-
# the
|
1430
|
-
#
|
1495
|
+
# the 8 minutes before and 8 minutes after this time are searched. If
|
1496
|
+
# you omit `time`, the most recent 15 minutes up to the current time
|
1497
|
+
# are searched.
|
1431
1498
|
#
|
1432
1499
|
# The `time` value is specified as epoch time, which is the number of
|
1433
1500
|
# seconds since `January 1, 1970, 00:00:00 UTC`.
|
@@ -1529,8 +1596,8 @@ module Aws::CloudWatchLogs
|
|
1529
1596
|
# @!attribute [rw] statistics
|
1530
1597
|
# Includes the number of log events scanned by the query, the number
|
1531
1598
|
# of log events that matched the query criteria, and the total number
|
1532
|
-
# of bytes in the log events
|
1533
|
-
#
|
1599
|
+
# of bytes in the scanned log events. These values reflect the full
|
1600
|
+
# raw results of the query.
|
1534
1601
|
# @return [Types::QueryStatistics]
|
1535
1602
|
#
|
1536
1603
|
# @!attribute [rw] status
|
@@ -1543,12 +1610,24 @@ module Aws::CloudWatchLogs
|
|
1543
1610
|
# your query into a number of queries.
|
1544
1611
|
# @return [String]
|
1545
1612
|
#
|
1613
|
+
# @!attribute [rw] encryption_key
|
1614
|
+
# If you associated an KMS key with the CloudWatch Logs Insights query
|
1615
|
+
# results in this account, this field displays the ARN of the key
|
1616
|
+
# that's used to encrypt the query results when [StartQuery][1]
|
1617
|
+
# stores them.
|
1618
|
+
#
|
1619
|
+
#
|
1620
|
+
#
|
1621
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html
|
1622
|
+
# @return [String]
|
1623
|
+
#
|
1546
1624
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResultsResponse AWS API Documentation
|
1547
1625
|
#
|
1548
1626
|
class GetQueryResultsResponse < Struct.new(
|
1549
1627
|
:results,
|
1550
1628
|
:statistics,
|
1551
|
-
:status
|
1629
|
+
:status,
|
1630
|
+
:encryption_key)
|
1552
1631
|
SENSITIVE = []
|
1553
1632
|
include Aws::Structure
|
1554
1633
|
end
|
@@ -2084,10 +2163,10 @@ module Aws::CloudWatchLogs
|
|
2084
2163
|
# @return [String]
|
2085
2164
|
#
|
2086
2165
|
# @!attribute [rw] scope
|
2087
|
-
# Currently the only valid value for this parameter is `
|
2166
|
+
# Currently the only valid value for this parameter is `ALL`, which
|
2088
2167
|
# specifies that the data protection policy applies to all log groups
|
2089
|
-
# in the account. If you omit this parameter, the default of `
|
2090
|
-
#
|
2168
|
+
# in the account. If you omit this parameter, the default of `ALL` is
|
2169
|
+
# used.
|
2091
2170
|
# @return [String]
|
2092
2171
|
#
|
2093
2172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutAccountPolicyRequest AWS API Documentation
|
@@ -2855,7 +2934,7 @@ module Aws::CloudWatchLogs
|
|
2855
2934
|
# The log group on which to perform the query.
|
2856
2935
|
#
|
2857
2936
|
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
2858
|
-
# parameters: `logGroupName`, `logGroupNames
|
2937
|
+
# parameters: `logGroupName`, `logGroupNames`, or
|
2859
2938
|
# `logGroupIdentifiers`.
|
2860
2939
|
#
|
2861
2940
|
# </note>
|
@@ -2866,7 +2945,7 @@ module Aws::CloudWatchLogs
|
|
2866
2945
|
# groups.
|
2867
2946
|
#
|
2868
2947
|
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
2869
|
-
# parameters: `logGroupName`, `logGroupNames
|
2948
|
+
# parameters: `logGroupName`, `logGroupNames`, or
|
2870
2949
|
# `logGroupIdentifiers`.
|
2871
2950
|
#
|
2872
2951
|
# </note>
|
@@ -2884,7 +2963,7 @@ module Aws::CloudWatchLogs
|
|
2884
2963
|
# If you specify an ARN, the ARN can't end with an asterisk (*).
|
2885
2964
|
#
|
2886
2965
|
# A `StartQuery` operation must include exactly one of the following
|
2887
|
-
# parameters: `logGroupName`, `logGroupNames
|
2966
|
+
# parameters: `logGroupName`, `logGroupNames`, or
|
2888
2967
|
# `logGroupIdentifiers`.
|
2889
2968
|
# @return [Array<String>]
|
2890
2969
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudwatchlogs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.68.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-07-
|
11
|
+
date: 2023-07-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|