aws-sdk-cloudwatchlogs 1.134.0 → 1.135.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 +419 -63
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +151 -0
- data/lib/aws-sdk-cloudwatchlogs/types.rb +370 -13
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- data/sig/client.rbs +62 -0
- data/sig/types.rbs +90 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cd22fa8a24761a0f711c39eb85d0e3d0c34afed49ff2b643f962cb0550fe6711
|
|
4
|
+
data.tar.gz: 2bebb7e8746e3e50354371c8f8d07d75d6011540070438a5bacd3e31e51d1f0a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a7dbf0475304be793127a9bb3eab516239b9424d7271770259af9862e3da8051228725c2838504328343d1aef121e9787845a82f6c84a2021674e7f827757cf5
|
|
7
|
+
data.tar.gz: a9ed4c830467dd10429a4a3b9a28ba1efca2040f46fe2048b34d55b04d563074f0d3f63eab32679dd4a22123ef584459a21b7674ce3ddc4255afc868aff29360
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.135.0 (2025-12-15)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release allows you to import your historical CloudTrail Lake data into CloudWatch with a few steps, enabling you to easily consolidate operational, security, and compliance data in one place.
|
|
8
|
+
|
|
4
9
|
1.134.0 (2025-12-02)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.135.0
|
|
@@ -685,6 +685,43 @@ module Aws::CloudWatchLogs
|
|
|
685
685
|
req.send_request(options)
|
|
686
686
|
end
|
|
687
687
|
|
|
688
|
+
# Cancels an active import task and stops importing data from the
|
|
689
|
+
# CloudTrail Lake Event Data Store.
|
|
690
|
+
#
|
|
691
|
+
# @option params [required, String] :import_id
|
|
692
|
+
# The ID of the import task to cancel.
|
|
693
|
+
#
|
|
694
|
+
# @return [Types::CancelImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
695
|
+
#
|
|
696
|
+
# * {Types::CancelImportTaskResponse#import_id #import_id} => String
|
|
697
|
+
# * {Types::CancelImportTaskResponse#import_statistics #import_statistics} => Types::ImportStatistics
|
|
698
|
+
# * {Types::CancelImportTaskResponse#import_status #import_status} => String
|
|
699
|
+
# * {Types::CancelImportTaskResponse#creation_time #creation_time} => Integer
|
|
700
|
+
# * {Types::CancelImportTaskResponse#last_updated_time #last_updated_time} => Integer
|
|
701
|
+
#
|
|
702
|
+
# @example Request syntax with placeholder values
|
|
703
|
+
#
|
|
704
|
+
# resp = client.cancel_import_task({
|
|
705
|
+
# import_id: "ImportId", # required
|
|
706
|
+
# })
|
|
707
|
+
#
|
|
708
|
+
# @example Response structure
|
|
709
|
+
#
|
|
710
|
+
# resp.import_id #=> String
|
|
711
|
+
# resp.import_statistics.bytes_imported #=> Integer
|
|
712
|
+
# resp.import_status #=> String, one of "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
|
713
|
+
# resp.creation_time #=> Integer
|
|
714
|
+
# resp.last_updated_time #=> Integer
|
|
715
|
+
#
|
|
716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CancelImportTask AWS API Documentation
|
|
717
|
+
#
|
|
718
|
+
# @overload cancel_import_task(params = {})
|
|
719
|
+
# @param [Hash] params ({})
|
|
720
|
+
def cancel_import_task(params = {}, options = {})
|
|
721
|
+
req = build_request(:cancel_import_task, params)
|
|
722
|
+
req.send_request(options)
|
|
723
|
+
end
|
|
724
|
+
|
|
688
725
|
# Creates a *delivery*. A delivery is a connection between a logical
|
|
689
726
|
# *delivery source* and a logical *delivery destination* that you have
|
|
690
727
|
# already created.
|
|
@@ -913,6 +950,111 @@ module Aws::CloudWatchLogs
|
|
|
913
950
|
req.send_request(options)
|
|
914
951
|
end
|
|
915
952
|
|
|
953
|
+
# Starts an import from a data source to CloudWatch Log and creates a
|
|
954
|
+
# managed log group as the destination for the imported data. Currently,
|
|
955
|
+
# [CloudTrail Event Data Store][1] is the only supported data source.
|
|
956
|
+
#
|
|
957
|
+
# The import task must satisfy the following constraints:
|
|
958
|
+
#
|
|
959
|
+
# * The specified source must be in an ACTIVE state.
|
|
960
|
+
#
|
|
961
|
+
# * The API caller must have permissions to access the data in the
|
|
962
|
+
# provided source and to perform iam:PassRole on the provided import
|
|
963
|
+
# role which has the same permissions, as described below.
|
|
964
|
+
#
|
|
965
|
+
# * The provided IAM role must trust the "cloudtrail.amazonaws.com"
|
|
966
|
+
# principal and have the following permissions:
|
|
967
|
+
#
|
|
968
|
+
# * cloudtrail:GetEventDataStoreData
|
|
969
|
+
#
|
|
970
|
+
# * logs:CreateLogGroup
|
|
971
|
+
#
|
|
972
|
+
# * logs:CreateLogStream
|
|
973
|
+
#
|
|
974
|
+
# * logs:PutResourcePolicy
|
|
975
|
+
#
|
|
976
|
+
# * (If source has an associated AWS KMS Key) kms:Decrypt
|
|
977
|
+
#
|
|
978
|
+
# * (If source has an associated AWS KMS Key) kms:GenerateDataKey
|
|
979
|
+
# Example IAM policy for provided import role:
|
|
980
|
+
#
|
|
981
|
+
# `[ { "Effect": "Allow", "Action": "iam:PassRole", "Resource":
|
|
982
|
+
# "arn:aws:iam::123456789012:role/apiCallerCredentials", "Condition":
|
|
983
|
+
# { "StringLike": { "iam:AssociatedResourceARN":
|
|
984
|
+
# "arn:aws:logs:us-east-1:123456789012:log-group:aws/cloudtrail/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb:*"
|
|
985
|
+
# } } }, { "Effect": "Allow", "Action": [
|
|
986
|
+
# "cloudtrail:GetEventDataStoreData" ], "Resource": [
|
|
987
|
+
# "arn:aws:cloudtrail:us-east-1:123456789012:eventdatastore/f1d45bff-d0e3-4868-b5d9-2eb678aa32fb"
|
|
988
|
+
# ] }, { "Effect": "Allow", "Action": [ "logs:CreateImportTask",
|
|
989
|
+
# "logs:CreateLogGroup", "logs:CreateLogStream",
|
|
990
|
+
# "logs:PutResourcePolicy" ], "Resource": [
|
|
991
|
+
# "arn:aws:logs:us-east-1:123456789012:log-group:/aws/cloudtrail/*" ]
|
|
992
|
+
# }, { "Effect": "Allow", "Action": [ "kms:Decrypt",
|
|
993
|
+
# "kms:GenerateDataKey" ], "Resource": [
|
|
994
|
+
# "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
|
|
995
|
+
# ] } ]`
|
|
996
|
+
#
|
|
997
|
+
# * If the import source has a customer managed key, the
|
|
998
|
+
# "cloudtrail.amazonaws.com" principal needs permissions to perform
|
|
999
|
+
# kms:Decrypt and kms:GenerateDataKey.
|
|
1000
|
+
#
|
|
1001
|
+
# * There can be no more than 3 active imports per account at a given
|
|
1002
|
+
# time.
|
|
1003
|
+
#
|
|
1004
|
+
# * The startEventTime must be less than or equal to endEventTime.
|
|
1005
|
+
#
|
|
1006
|
+
# * The data being imported must be within the specified source's
|
|
1007
|
+
# retention period.
|
|
1008
|
+
#
|
|
1009
|
+
#
|
|
1010
|
+
#
|
|
1011
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html
|
|
1012
|
+
#
|
|
1013
|
+
# @option params [required, String] :import_source_arn
|
|
1014
|
+
# The ARN of the source to import from.
|
|
1015
|
+
#
|
|
1016
|
+
# @option params [required, String] :import_role_arn
|
|
1017
|
+
# The ARN of the IAM role that grants CloudWatch Logs permission to
|
|
1018
|
+
# import from the CloudTrail Lake Event Data Store.
|
|
1019
|
+
#
|
|
1020
|
+
# @option params [Types::ImportFilter] :import_filter
|
|
1021
|
+
# Optional filters to constrain the import by CloudTrail event time.
|
|
1022
|
+
# Times are specified in Unix timestamp milliseconds. The range of data
|
|
1023
|
+
# being imported must be within the specified source's retention
|
|
1024
|
+
# period.
|
|
1025
|
+
#
|
|
1026
|
+
# @return [Types::CreateImportTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1027
|
+
#
|
|
1028
|
+
# * {Types::CreateImportTaskResponse#import_id #import_id} => String
|
|
1029
|
+
# * {Types::CreateImportTaskResponse#import_destination_arn #import_destination_arn} => String
|
|
1030
|
+
# * {Types::CreateImportTaskResponse#creation_time #creation_time} => Integer
|
|
1031
|
+
#
|
|
1032
|
+
# @example Request syntax with placeholder values
|
|
1033
|
+
#
|
|
1034
|
+
# resp = client.create_import_task({
|
|
1035
|
+
# import_source_arn: "Arn", # required
|
|
1036
|
+
# import_role_arn: "RoleArn", # required
|
|
1037
|
+
# import_filter: {
|
|
1038
|
+
# start_event_time: 1,
|
|
1039
|
+
# end_event_time: 1,
|
|
1040
|
+
# },
|
|
1041
|
+
# })
|
|
1042
|
+
#
|
|
1043
|
+
# @example Response structure
|
|
1044
|
+
#
|
|
1045
|
+
# resp.import_id #=> String
|
|
1046
|
+
# resp.import_destination_arn #=> String
|
|
1047
|
+
# resp.creation_time #=> Integer
|
|
1048
|
+
#
|
|
1049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/CreateImportTask AWS API Documentation
|
|
1050
|
+
#
|
|
1051
|
+
# @overload create_import_task(params = {})
|
|
1052
|
+
# @param [Hash] params ({})
|
|
1053
|
+
def create_import_task(params = {}, options = {})
|
|
1054
|
+
req = build_request(:create_import_task, params)
|
|
1055
|
+
req.send_request(options)
|
|
1056
|
+
end
|
|
1057
|
+
|
|
916
1058
|
# Creates an *anomaly detector* that regularly scans one or more log
|
|
917
1059
|
# groups and look for patterns and anomalies in the logs.
|
|
918
1060
|
#
|
|
@@ -1567,7 +1709,7 @@ module Aws::CloudWatchLogs
|
|
|
1567
1709
|
# retained for up to 30 days.
|
|
1568
1710
|
#
|
|
1569
1711
|
# You can't use this operation to delete an account-level index policy.
|
|
1570
|
-
# Instead, use [
|
|
1712
|
+
# Instead, use [DeleteAccountPolicy][1].
|
|
1571
1713
|
#
|
|
1572
1714
|
# If you delete a log-group level field index policy and there is an
|
|
1573
1715
|
# account-level field index policy, in a few minutes the log group
|
|
@@ -2409,6 +2551,119 @@ module Aws::CloudWatchLogs
|
|
|
2409
2551
|
req.send_request(options)
|
|
2410
2552
|
end
|
|
2411
2553
|
|
|
2554
|
+
# Gets detailed information about the individual batches within an
|
|
2555
|
+
# import task, including their status and any error messages. For
|
|
2556
|
+
# CloudTrail Event Data Store sources, a batch refers to a subset of
|
|
2557
|
+
# stored events grouped by their eventTime.
|
|
2558
|
+
#
|
|
2559
|
+
# @option params [required, String] :import_id
|
|
2560
|
+
# The ID of the import task to get batch information for.
|
|
2561
|
+
#
|
|
2562
|
+
# @option params [Array<String>] :batch_import_status
|
|
2563
|
+
# Optional filter to list import batches by their status. Accepts
|
|
2564
|
+
# multiple status values: IN\_PROGRESS, CANCELLED, COMPLETED and FAILED.
|
|
2565
|
+
#
|
|
2566
|
+
# @option params [Integer] :limit
|
|
2567
|
+
# The maximum number of import batches to return in the response.
|
|
2568
|
+
# Default: 10
|
|
2569
|
+
#
|
|
2570
|
+
# @option params [String] :next_token
|
|
2571
|
+
# The pagination token for the next set of results.
|
|
2572
|
+
#
|
|
2573
|
+
# @return [Types::DescribeImportTaskBatchesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2574
|
+
#
|
|
2575
|
+
# * {Types::DescribeImportTaskBatchesResponse#import_source_arn #import_source_arn} => String
|
|
2576
|
+
# * {Types::DescribeImportTaskBatchesResponse#import_id #import_id} => String
|
|
2577
|
+
# * {Types::DescribeImportTaskBatchesResponse#import_batches #import_batches} => Array<Types::ImportBatch>
|
|
2578
|
+
# * {Types::DescribeImportTaskBatchesResponse#next_token #next_token} => String
|
|
2579
|
+
#
|
|
2580
|
+
# @example Request syntax with placeholder values
|
|
2581
|
+
#
|
|
2582
|
+
# resp = client.describe_import_task_batches({
|
|
2583
|
+
# import_id: "ImportId", # required
|
|
2584
|
+
# batch_import_status: ["IN_PROGRESS"], # accepts IN_PROGRESS, CANCELLED, COMPLETED, FAILED
|
|
2585
|
+
# limit: 1,
|
|
2586
|
+
# next_token: "NextToken",
|
|
2587
|
+
# })
|
|
2588
|
+
#
|
|
2589
|
+
# @example Response structure
|
|
2590
|
+
#
|
|
2591
|
+
# resp.import_source_arn #=> String
|
|
2592
|
+
# resp.import_id #=> String
|
|
2593
|
+
# resp.import_batches #=> Array
|
|
2594
|
+
# resp.import_batches[0].batch_id #=> String
|
|
2595
|
+
# resp.import_batches[0].status #=> String, one of "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
|
2596
|
+
# resp.import_batches[0].error_message #=> String
|
|
2597
|
+
# resp.next_token #=> String
|
|
2598
|
+
#
|
|
2599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeImportTaskBatches AWS API Documentation
|
|
2600
|
+
#
|
|
2601
|
+
# @overload describe_import_task_batches(params = {})
|
|
2602
|
+
# @param [Hash] params ({})
|
|
2603
|
+
def describe_import_task_batches(params = {}, options = {})
|
|
2604
|
+
req = build_request(:describe_import_task_batches, params)
|
|
2605
|
+
req.send_request(options)
|
|
2606
|
+
end
|
|
2607
|
+
|
|
2608
|
+
# Lists and describes import tasks, with optional filtering by import
|
|
2609
|
+
# status and source ARN.
|
|
2610
|
+
#
|
|
2611
|
+
# @option params [String] :import_id
|
|
2612
|
+
# Optional filter to describe a specific import task by its ID.
|
|
2613
|
+
#
|
|
2614
|
+
# @option params [String] :import_status
|
|
2615
|
+
# Optional filter to list imports by their status. Valid values are
|
|
2616
|
+
# IN\_PROGRESS, CANCELLED, COMPLETED and FAILED.
|
|
2617
|
+
#
|
|
2618
|
+
# @option params [String] :import_source_arn
|
|
2619
|
+
# Optional filter to list imports from a specific source
|
|
2620
|
+
#
|
|
2621
|
+
# @option params [Integer] :limit
|
|
2622
|
+
# The maximum number of import tasks to return in the response. Default:
|
|
2623
|
+
# 50
|
|
2624
|
+
#
|
|
2625
|
+
# @option params [String] :next_token
|
|
2626
|
+
# The pagination token for the next set of results.
|
|
2627
|
+
#
|
|
2628
|
+
# @return [Types::DescribeImportTasksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2629
|
+
#
|
|
2630
|
+
# * {Types::DescribeImportTasksResponse#imports #imports} => Array<Types::Import>
|
|
2631
|
+
# * {Types::DescribeImportTasksResponse#next_token #next_token} => String
|
|
2632
|
+
#
|
|
2633
|
+
# @example Request syntax with placeholder values
|
|
2634
|
+
#
|
|
2635
|
+
# resp = client.describe_import_tasks({
|
|
2636
|
+
# import_id: "ImportId",
|
|
2637
|
+
# import_status: "IN_PROGRESS", # accepts IN_PROGRESS, CANCELLED, COMPLETED, FAILED
|
|
2638
|
+
# import_source_arn: "Arn",
|
|
2639
|
+
# limit: 1,
|
|
2640
|
+
# next_token: "NextToken",
|
|
2641
|
+
# })
|
|
2642
|
+
#
|
|
2643
|
+
# @example Response structure
|
|
2644
|
+
#
|
|
2645
|
+
# resp.imports #=> Array
|
|
2646
|
+
# resp.imports[0].import_id #=> String
|
|
2647
|
+
# resp.imports[0].import_source_arn #=> String
|
|
2648
|
+
# resp.imports[0].import_status #=> String, one of "IN_PROGRESS", "CANCELLED", "COMPLETED", "FAILED"
|
|
2649
|
+
# resp.imports[0].import_destination_arn #=> String
|
|
2650
|
+
# resp.imports[0].import_statistics.bytes_imported #=> Integer
|
|
2651
|
+
# resp.imports[0].import_filter.start_event_time #=> Integer
|
|
2652
|
+
# resp.imports[0].import_filter.end_event_time #=> Integer
|
|
2653
|
+
# resp.imports[0].creation_time #=> Integer
|
|
2654
|
+
# resp.imports[0].last_updated_time #=> Integer
|
|
2655
|
+
# resp.imports[0].error_message #=> String
|
|
2656
|
+
# resp.next_token #=> String
|
|
2657
|
+
#
|
|
2658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeImportTasks AWS API Documentation
|
|
2659
|
+
#
|
|
2660
|
+
# @overload describe_import_tasks(params = {})
|
|
2661
|
+
# @param [Hash] params ({})
|
|
2662
|
+
def describe_import_tasks(params = {}, options = {})
|
|
2663
|
+
req = build_request(:describe_import_tasks, params)
|
|
2664
|
+
req.send_request(options)
|
|
2665
|
+
end
|
|
2666
|
+
|
|
2412
2667
|
# Returns the field index policies of the specified log group. For more
|
|
2413
2668
|
# information about field index policies, see [PutIndexPolicy][1].
|
|
2414
2669
|
#
|
|
@@ -4556,6 +4811,8 @@ module Aws::CloudWatchLogs
|
|
|
4556
4811
|
# * {Types::ListAggregateLogGroupSummariesResponse#aggregate_log_group_summaries #aggregate_log_group_summaries} => Array<Types::AggregateLogGroupSummary>
|
|
4557
4812
|
# * {Types::ListAggregateLogGroupSummariesResponse#next_token #next_token} => String
|
|
4558
4813
|
#
|
|
4814
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
4815
|
+
#
|
|
4559
4816
|
# @example Request syntax with placeholder values
|
|
4560
4817
|
#
|
|
4561
4818
|
# resp = client.list_aggregate_log_group_summaries({
|
|
@@ -5139,8 +5396,8 @@ module Aws::CloudWatchLogs
|
|
|
5139
5396
|
|
|
5140
5397
|
# Creates an account-level data protection policy, subscription filter
|
|
5141
5398
|
# policy, field index policy, transformer policy, or metric extraction
|
|
5142
|
-
# policy that applies to all log groups
|
|
5143
|
-
# account.
|
|
5399
|
+
# policy that applies to all log groups, a subset of log groups, or a
|
|
5400
|
+
# data source name and type combination in the account.
|
|
5144
5401
|
#
|
|
5145
5402
|
# For field index policies, you can configure indexed fields as *facets*
|
|
5146
5403
|
# to enable interactive exploration of your logs. Facets provide value
|
|
@@ -5283,27 +5540,9 @@ module Aws::CloudWatchLogs
|
|
|
5283
5540
|
# multiple account-level transformer policies with selection criteria,
|
|
5284
5541
|
# no two of them can use the same or overlapping log group name
|
|
5285
5542
|
# prefixes. For example, if you have one policy filtered to log groups
|
|
5286
|
-
# that start with `my-log`, you can't have another
|
|
5543
|
+
# that start with `my-log`, you can't have another transformer policy
|
|
5287
5544
|
# filtered to `my-logpprod` or `my-logging`.
|
|
5288
5545
|
#
|
|
5289
|
-
# CloudWatch Logs provides default field indexes for all log groups in
|
|
5290
|
-
# the Standard log class. Default field indexes are automatically
|
|
5291
|
-
# available for the following fields:
|
|
5292
|
-
#
|
|
5293
|
-
# * `@logStream`
|
|
5294
|
-
#
|
|
5295
|
-
# * `@aws.region`
|
|
5296
|
-
#
|
|
5297
|
-
# * `@aws.account`
|
|
5298
|
-
#
|
|
5299
|
-
# * `@source.log`
|
|
5300
|
-
#
|
|
5301
|
-
# * `traceId`
|
|
5302
|
-
#
|
|
5303
|
-
# Default field indexes are in addition to any custom field indexes you
|
|
5304
|
-
# define within your policy. Default field indexes are not counted
|
|
5305
|
-
# towards your field index quota.
|
|
5306
|
-
#
|
|
5307
5546
|
# You can also set up a transformer at the log-group level. For more
|
|
5308
5547
|
# information, see [PutTransformer][8]. If there is both a log-group
|
|
5309
5548
|
# level transformer created with `PutTransformer` and an account-level
|
|
@@ -5314,18 +5553,20 @@ module Aws::CloudWatchLogs
|
|
|
5314
5553
|
# **Field index policy**
|
|
5315
5554
|
#
|
|
5316
5555
|
# You can use field index policies to create indexes on fields found in
|
|
5317
|
-
# log events
|
|
5318
|
-
#
|
|
5319
|
-
#
|
|
5320
|
-
#
|
|
5321
|
-
#
|
|
5322
|
-
#
|
|
5323
|
-
#
|
|
5324
|
-
#
|
|
5325
|
-
# improve query performance
|
|
5556
|
+
# log events for a log group or data source name and type combination.
|
|
5557
|
+
# Creating field indexes can help lower the scan volume for CloudWatch
|
|
5558
|
+
# Logs Insights queries that reference those fields, because these
|
|
5559
|
+
# queries attempt to skip the processing of log events that are known to
|
|
5560
|
+
# not match the indexed field. Good fields to index are fields that you
|
|
5561
|
+
# often need to query for and fields or values that match only a small
|
|
5562
|
+
# fraction of the total log events. Common examples of indexes include
|
|
5563
|
+
# request ID, session ID, user IDs, or instance IDs. For more
|
|
5564
|
+
# information, see [Create field indexes to improve query performance
|
|
5565
|
+
# and reduce costs][9]
|
|
5326
5566
|
#
|
|
5327
5567
|
# To find the fields that are in your log group events, use the
|
|
5328
|
-
# [GetLogGroupFields][10] operation.
|
|
5568
|
+
# [GetLogGroupFields][10] operation. To find the fields for a data
|
|
5569
|
+
# source use the [GetLogFields][11] operation.
|
|
5329
5570
|
#
|
|
5330
5571
|
# For example, suppose you have created a field index for `requestId`.
|
|
5331
5572
|
# Then, any CloudWatch Logs Insights query on that log group that
|
|
@@ -5338,27 +5579,113 @@ module Aws::CloudWatchLogs
|
|
|
5338
5579
|
# match a log event containing `requestId`.
|
|
5339
5580
|
#
|
|
5340
5581
|
# You can have one account-level field index policy that applies to all
|
|
5341
|
-
# log groups in the account. Or you can create as many as
|
|
5342
|
-
# account-level field index policies
|
|
5343
|
-
#
|
|
5344
|
-
#
|
|
5345
|
-
#
|
|
5346
|
-
#
|
|
5347
|
-
#
|
|
5348
|
-
#
|
|
5349
|
-
#
|
|
5350
|
-
#
|
|
5351
|
-
#
|
|
5582
|
+
# log groups in the account. Or you can create as many as 20
|
|
5583
|
+
# account-level field index policies that are each scoped to a subset of
|
|
5584
|
+
# log groups using `LogGroupNamePrefix` with the `selectionCriteria`
|
|
5585
|
+
# parameter. You can have another 20 account-level field index policies
|
|
5586
|
+
# using `DataSourceName` and `DataSourceType` for the
|
|
5587
|
+
# `selectionCriteria` parameter. If you have multiple account-level
|
|
5588
|
+
# index policies with `LogGroupNamePrefix` selection criteria, no two of
|
|
5589
|
+
# them can use the same or overlapping log group name prefixes. For
|
|
5590
|
+
# example, if you have one policy filtered to log groups that start with
|
|
5591
|
+
# *my-log*, you can't have another field index policy filtered to
|
|
5592
|
+
# *my-logpprod* or *my-logging*. Similarly, if you have multiple
|
|
5593
|
+
# account-level index policies with `DataSourceName` and
|
|
5594
|
+
# `DataSourceType` selection criteria, no two of them can use the same
|
|
5595
|
+
# data source name and type combination. For example, if you have one
|
|
5596
|
+
# policy filtered to the data source name `amazon_vpc` and data source
|
|
5597
|
+
# type `flow` you cannot create another policy with this combination.
|
|
5352
5598
|
#
|
|
5353
5599
|
# If you create an account-level field index policy in a monitoring
|
|
5354
5600
|
# account in cross-account observability, the policy is applied only to
|
|
5355
5601
|
# the monitoring account and not to any source accounts.
|
|
5356
5602
|
#
|
|
5603
|
+
# CloudWatch Logs provides default field indexes for all log groups in
|
|
5604
|
+
# the Standard log class. Default field indexes are automatically
|
|
5605
|
+
# available for the following fields:
|
|
5606
|
+
#
|
|
5607
|
+
# * `@logStream`
|
|
5608
|
+
#
|
|
5609
|
+
# * `@aws.region`
|
|
5610
|
+
#
|
|
5611
|
+
# * `@aws.account`
|
|
5612
|
+
#
|
|
5613
|
+
# * `@source.log`
|
|
5614
|
+
#
|
|
5615
|
+
# * `@data_source_name`
|
|
5616
|
+
#
|
|
5617
|
+
# * `@data_source_type`
|
|
5618
|
+
#
|
|
5619
|
+
# * `@data_format`
|
|
5620
|
+
#
|
|
5621
|
+
# * `traceId`
|
|
5622
|
+
#
|
|
5623
|
+
# * `severityText`
|
|
5624
|
+
#
|
|
5625
|
+
# * `attributes.session.id`
|
|
5626
|
+
#
|
|
5627
|
+
# CloudWatch Logs provides default field indexes for certain data source
|
|
5628
|
+
# name and type combinations as well. Default field indexes are
|
|
5629
|
+
# automatically available for the following data source name and type
|
|
5630
|
+
# combinations as identified in the following list:
|
|
5631
|
+
#
|
|
5632
|
+
# `amazon_vpc.flow`
|
|
5633
|
+
#
|
|
5634
|
+
# * `action`
|
|
5635
|
+
#
|
|
5636
|
+
# * `logStatus`
|
|
5637
|
+
#
|
|
5638
|
+
# * `region`
|
|
5639
|
+
#
|
|
5640
|
+
# * `flowDirection`
|
|
5641
|
+
#
|
|
5642
|
+
# * `type`
|
|
5643
|
+
#
|
|
5644
|
+
# `amazon_route53.resolver_query`
|
|
5645
|
+
#
|
|
5646
|
+
# * `transport`
|
|
5647
|
+
#
|
|
5648
|
+
# * `rcode`
|
|
5649
|
+
#
|
|
5650
|
+
# `aws_waf.access`
|
|
5651
|
+
#
|
|
5652
|
+
# * `action`
|
|
5653
|
+
#
|
|
5654
|
+
# * `httpRequest.country`
|
|
5655
|
+
#
|
|
5656
|
+
# `aws_cloudtrail.data`, `aws_cloudtrail.management`
|
|
5657
|
+
#
|
|
5658
|
+
# * `eventSource`
|
|
5659
|
+
#
|
|
5660
|
+
# * `eventName`
|
|
5661
|
+
#
|
|
5662
|
+
# * `awsRegion`
|
|
5663
|
+
#
|
|
5664
|
+
# * `userAgent`
|
|
5665
|
+
#
|
|
5666
|
+
# * `errorCode`
|
|
5667
|
+
#
|
|
5668
|
+
# * `eventType`
|
|
5669
|
+
#
|
|
5670
|
+
# * `managementEvent`
|
|
5671
|
+
#
|
|
5672
|
+
# * `readOnly`
|
|
5673
|
+
#
|
|
5674
|
+
# * `eventCategory`
|
|
5675
|
+
#
|
|
5676
|
+
# * `requestId`
|
|
5677
|
+
#
|
|
5678
|
+
# Default field indexes are in addition to any custom field indexes you
|
|
5679
|
+
# define within your policy. Default field indexes are not counted
|
|
5680
|
+
# towards your [field index quota][12].
|
|
5681
|
+
#
|
|
5357
5682
|
# If you want to create a field index policy for a single log group, you
|
|
5358
|
-
# can use [PutIndexPolicy][
|
|
5359
|
-
# so, that log group will use
|
|
5360
|
-
#
|
|
5361
|
-
#
|
|
5683
|
+
# can use [PutIndexPolicy][13] instead of `PutAccountPolicy`. If you do
|
|
5684
|
+
# so, that log group will use that log-group level policy and any
|
|
5685
|
+
# account-level policies that match at the data source level; any
|
|
5686
|
+
# account-level policy that matches at the log group level (for example,
|
|
5687
|
+
# no selection criteria or log group name prefix selection criteria)
|
|
5688
|
+
# will be ignored.
|
|
5362
5689
|
#
|
|
5363
5690
|
# **Metric extraction policy**
|
|
5364
5691
|
#
|
|
@@ -5434,11 +5761,13 @@ module Aws::CloudWatchLogs
|
|
|
5434
5761
|
# [8]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html
|
|
5435
5762
|
# [9]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html
|
|
5436
5763
|
# [10]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html
|
|
5437
|
-
# [11]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/
|
|
5438
|
-
# [12]: https://docs.aws.amazon.com/
|
|
5764
|
+
# [11]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogFields.html
|
|
5765
|
+
# [12]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Syntax
|
|
5766
|
+
# [13]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html
|
|
5439
5767
|
#
|
|
5440
5768
|
# @option params [required, String] :policy_name
|
|
5441
|
-
# A name for the policy. This must be unique within the account
|
|
5769
|
+
# A name for the policy. This must be unique within the account and
|
|
5770
|
+
# cannot start with `aws/`.
|
|
5442
5771
|
#
|
|
5443
5772
|
# @option params [required, String] :policy_document
|
|
5444
5773
|
# Specify the policy, in JSON.
|
|
@@ -5530,15 +5859,21 @@ module Aws::CloudWatchLogs
|
|
|
5530
5859
|
#
|
|
5531
5860
|
# * **Fields** The array of field indexes to create.
|
|
5532
5861
|
#
|
|
5533
|
-
#
|
|
5862
|
+
# * **FieldsV2** The object of field indexes to create along with it's
|
|
5863
|
+
# type.
|
|
5534
5864
|
#
|
|
5535
5865
|
# It must contain at least one field index.
|
|
5536
5866
|
#
|
|
5537
5867
|
# The following is an example of an index policy document that creates
|
|
5538
|
-
#
|
|
5868
|
+
# indexes with different types.
|
|
5869
|
+
#
|
|
5870
|
+
# `"policyDocument": "{ "Fields": [ "TransactionId" ], "FieldsV2":
|
|
5871
|
+
# {"RequestId": {"type": "FIELD_INDEX"}, "APIName": {"type":
|
|
5872
|
+
# "FACET"}, "StatusCode": {"type": "FACET"}}}"`
|
|
5539
5873
|
#
|
|
5540
|
-
# `
|
|
5541
|
-
#
|
|
5874
|
+
# You can use `FieldsV2` to specify the type for each field. Supported
|
|
5875
|
+
# types are `FIELD_INDEX` and `FACET`. Field names within `Fields` and
|
|
5876
|
+
# `FieldsV2` must be mutually exclusive.
|
|
5542
5877
|
#
|
|
5543
5878
|
#
|
|
5544
5879
|
#
|
|
@@ -5556,17 +5891,27 @@ module Aws::CloudWatchLogs
|
|
|
5556
5891
|
#
|
|
5557
5892
|
# @option params [String] :selection_criteria
|
|
5558
5893
|
# Use this parameter to apply the new policy to a subset of log groups
|
|
5559
|
-
# in the account.
|
|
5894
|
+
# in the account or a data source name and type combination.
|
|
5560
5895
|
#
|
|
5561
5896
|
# Specifying `selectionCriteria` is valid only when you specify
|
|
5562
5897
|
# `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY` or
|
|
5563
5898
|
# `TRANSFORMER_POLICY`for `policyType`.
|
|
5564
5899
|
#
|
|
5565
|
-
# If `policyType` is `SUBSCRIPTION_FILTER_POLICY`, the only supported
|
|
5566
|
-
#
|
|
5900
|
+
# * If `policyType` is `SUBSCRIPTION_FILTER_POLICY`, the only supported
|
|
5901
|
+
# `selectionCriteria` filter is `LogGroupName NOT IN []`
|
|
5902
|
+
#
|
|
5903
|
+
# * If `policyType` is `TRANSFORMER_POLICY`, the only supported
|
|
5904
|
+
# `selectionCriteria` filter is `LogGroupNamePrefix`
|
|
5567
5905
|
#
|
|
5568
|
-
# If `policyType` is `FIELD_INDEX_POLICY
|
|
5569
|
-
#
|
|
5906
|
+
# * If `policyType` is `FIELD_INDEX_POLICY`, the supported
|
|
5907
|
+
# `selectionCriteria` filters are:
|
|
5908
|
+
#
|
|
5909
|
+
# * `LogGroupNamePrefix`
|
|
5910
|
+
#
|
|
5911
|
+
# * `DataSourceName` AND `DataSourceType`
|
|
5912
|
+
# When you specify `selectionCriteria` for a field index policy you
|
|
5913
|
+
# can use either `LogGroupNamePrefix` by itself or `DataSourceName`
|
|
5914
|
+
# and `DataSourceType` together.
|
|
5570
5915
|
#
|
|
5571
5916
|
# The `selectionCriteria` string can be up to 25KB in length. The length
|
|
5572
5917
|
# is determined by using its UTF-8 bytes.
|
|
@@ -6010,11 +6355,17 @@ module Aws::CloudWatchLogs
|
|
|
6010
6355
|
#
|
|
6011
6356
|
# * For IAM Identity Center, the valid value is `ERROR_LOGS`.
|
|
6012
6357
|
#
|
|
6358
|
+
# * For Network Firewall Proxy, the valid values are `ALERT_LOGS`,
|
|
6359
|
+
# `ALLOW_LOGS`, and `DENY_LOGS`.
|
|
6360
|
+
#
|
|
6013
6361
|
# * For Network Load Balancer, the valid value is `NLB_ACCESS_LOGS`.
|
|
6014
6362
|
#
|
|
6015
6363
|
# * For PCS, the valid values are `PCS_SCHEDULER_LOGS` and
|
|
6016
6364
|
# `PCS_JOBCOMP_LOGS`.
|
|
6017
6365
|
#
|
|
6366
|
+
# * For Quick Suite, the valid values are `CHAT_LOGS` and
|
|
6367
|
+
# `FEEDBACK_LOGS`.
|
|
6368
|
+
#
|
|
6018
6369
|
# * For Amazon Web Services RTB Fabric, the valid values is
|
|
6019
6370
|
# `APPLICATION_LOGS`.
|
|
6020
6371
|
#
|
|
@@ -6292,10 +6643,15 @@ module Aws::CloudWatchLogs
|
|
|
6292
6643
|
#
|
|
6293
6644
|
# @option params [required, String] :policy_document
|
|
6294
6645
|
# The index policy document, in JSON format. The following is an example
|
|
6295
|
-
# of an index policy document that creates
|
|
6296
|
-
#
|
|
6646
|
+
# of an index policy document that creates indexes with different types.
|
|
6647
|
+
#
|
|
6648
|
+
# `"policyDocument": "{"Fields": [ "TransactionId" ], "FieldsV2":
|
|
6649
|
+
# {"RequestId": {"type": "FIELD_INDEX"}, "APIName": {"type": "FACET"},
|
|
6650
|
+
# "StatusCode": {"type": "FACET"}}}"`
|
|
6297
6651
|
#
|
|
6298
|
-
# `
|
|
6652
|
+
# You can use `FieldsV2` to specify the type for each field. Supported
|
|
6653
|
+
# types are `FIELD_INDEX` and `FACET`. Field names within `Fields` and
|
|
6654
|
+
# `FieldsV2` must be mutually exclusive.
|
|
6299
6655
|
#
|
|
6300
6656
|
# The policy document must include at least one field index. For more
|
|
6301
6657
|
# information about the fields that can be included and other
|
|
@@ -8522,7 +8878,7 @@ module Aws::CloudWatchLogs
|
|
|
8522
8878
|
tracer: tracer
|
|
8523
8879
|
)
|
|
8524
8880
|
context[:gem_name] = 'aws-sdk-cloudwatchlogs'
|
|
8525
|
-
context[:gem_version] = '1.
|
|
8881
|
+
context[:gem_version] = '1.135.0'
|
|
8526
8882
|
Seahorse::Client::Request.new(handlers, context)
|
|
8527
8883
|
end
|
|
8528
8884
|
|