aws-sdk-cloudwatchlogs 1.160.0 → 1.161.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b200667491ac782dd20cdf52122ec35b1615203f6494bab416ab0d829e1334
-  data.tar.gz: a0ae4310581fe59d8e58ec6f650aba483b97b6ffc4eeb3c73809920361946953
+  metadata.gz: b118398e5d33e503c30e524c9c9927dba433b6f4fbb4697795509d3eaadd7a72
+  data.tar.gz: 36d9a27673094a461fd06a45da01f0afb6dda78b9cad014f17f8b29eae61d1b2
 SHA512:
-  metadata.gz: f207dee45eee8b4e6506bcc4946f5291d68156f5c95b1c611ad4d15e8b3c7f1be57970f9f8ae2d1a077cdf4c84e10ff87bac2cd37863465f4f7f0816fb0c4c62
-  data.tar.gz: a8beb6d42f772807929b0e2b2b86e47d23414023cfde492224a14c82fdc5b454520034d9b1fd97457611f240c56cb247b1efb3e03e6f92da25566fb75ba9d99a
+  metadata.gz: 1602fe95620c8185927a4ab82f49a5a24c1327163b8d2c96c0202238e2953f77305615508bfb2ec37210697c765fe77236d9b2e61ed7e1f646c710cd2c0a29ea
+  data.tar.gz: c4d4577f0819389f4eea7c78e78b41418ff5ca547a0d191b9be913d367ab4c49a75dae724d104d9ce0702c5154bb21708ea5063382226b1120c8dd00a46862ee

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.161.0 (2026-08-06)
+------------------
+
+* Feature - This release adds index category support to the CloudWatch Logs DescribeFieldIndexes API. Customers can filter and identify DEFAULT, CUSTOM, AUTO, and INACTIVE field indexes.
+
 1.160.0 (2026-07-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.160.0
+1.161.0

data/lib/aws-sdk-cloudwatchlogs/client.rb

@@ -1371,8 +1371,9 @@ module Aws::CloudWatchLogs
     #   You must specify either `tableBody` or `queryId`, but not both.
     #
     # @option params [String] :query_id
-    #   The ID of a completed CloudWatch Logs query whose results populate the
-    #   lookup table.
+    #   The ID of a completed or cancelled CloudWatch Logs query whose results
+    #   populate the lookup table. A cancelled query populates the table with
+    #   the partial results that were available when the query was stopped.
     #
     #   You must specify either `tableBody` or `queryId`, but not both.
     #
@@ -2663,9 +2664,13 @@ module Aws::CloudWatchLogs
       req.send_request(options)
     end
 
-    # Returns a list of custom and default field indexes which are
-    # discovered in log data. For more information about field index
-    # policies, see [PutIndexPolicy][1].
+    # Returns a list of field indexes discovered in log data. By default,
+    # the response includes the `DEFAULT`, `CUSTOM`, and `INACTIVE` index
+    # categories. To return indexes from other categories, use the
+    # `indexCategories` parameter.
+    #
+    # For more information about field index policies, see
+    # [PutIndexPolicy][1].
     #
     #
     #
@@ -2675,6 +2680,38 @@ module Aws::CloudWatchLogs
     #   An array containing the names or ARNs of the log groups that you want
     #   to retrieve field indexes for.
     #
+    # @option params [Array<String>] :index_categories
+    #   The index categories to return. The following values are supported:
+    #
+    #   * `DEFAULT`: Fields that CloudWatch Logs indexes by default. Examples
+    #     include `@logStream` and `@data_format`.
+    #
+    #   * `CUSTOM`: Fields that you added manually to the field index policy.
+    #     CloudWatch Logs always indexes these fields. These fields count
+    #     toward the quota of 20 fields for each log group.
+    #
+    #   * `AUTO`: Fields that CloudWatch Logs indexes automatically based on
+    #     your query patterns and usage. These fields do not count toward the
+    #     field index quota. CloudWatch Logs might update these fields based
+    #     on changes in your query patterns. To keep a field indexed
+    #     permanently, add it to an account-level or log-group level field
+    #     index policy.
+    #
+    #   * `INACTIVE`: Fields that CloudWatch Logs indexed before but does not
+    #     index now. This happens if you remove a field from the field index
+    #     policy or if CloudWatch Logs automatically selects a different field
+    #     based on your queries.
+    #
+    #   If you omit this parameter, the response includes the `DEFAULT`,
+    #   `CUSTOM`, and `INACTIVE` categories.
+    #
+    #   For more information about automatically indexed fields and using the
+    #   `AUTO` category, see [Automatically indexed fields][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Automatic.html
+    #
     # @option params [String] :next_token
     #   The token for the next set of items to return. The token expires after
     #   24 hours.
@@ -2688,6 +2725,7 @@ module Aws::CloudWatchLogs
     #
     #   resp = client.describe_field_indexes({
     #     log_group_identifiers: ["LogGroupIdentifier"], # required
+    #     index_categories: ["DEFAULT"], # accepts DEFAULT, CUSTOM, AUTO, INACTIVE
     #     next_token: "NextToken",
     #   })
     #
@@ -2700,6 +2738,7 @@ module Aws::CloudWatchLogs
     #   resp.field_indexes[0].first_event_time #=> Integer
     #   resp.field_indexes[0].last_event_time #=> Integer
     #   resp.field_indexes[0].type #=> String, one of "FACET", "FIELD_INDEX"
+    #   resp.field_indexes[0].index_category #=> String, one of "DEFAULT", "CUSTOM", "AUTO", "INACTIVE"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeFieldIndexes AWS API Documentation
@@ -3737,6 +3776,11 @@ module Aws::CloudWatchLogs
     #   after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp before this
     #   time are not returned.
     #
+    #   <note markdown="1"> Set `startTime` explicitly to reduce the chances of empty pages in the
+    #   response.
+    #
+    #    </note>
+    #
     # @option params [Integer] :end_time
     #   The end of the time range, expressed as the number of milliseconds
     #   after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp later than
@@ -4236,6 +4280,11 @@ module Aws::CloudWatchLogs
     #   this time or later than this time are included. Events with a
     #   timestamp earlier than this time are not included.
     #
+    #   <note markdown="1"> Set `startTime` explicitly to reduce the chances of empty pages in the
+    #   response.
+    #
+    #    </note>
+    #
     # @option params [Integer] :end_time
     #   The end of the time range, expressed as the number of milliseconds
     #   after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp equal to or
@@ -6841,6 +6890,10 @@ module Aws::CloudWatchLogs
     # @option params [required, String] :log_type
     #   Defines the type of log that the source is sending.
     #
+    #   * For Application Load Balancer, the valid values are
+    #     `ALB_ACCESS_LOGS`, `ALB_CONNECTION_LOGS`, and
+    #     `ALB_HEALTH_CHECK_LOGS`.
+    #
     #   * For Amazon Bedrock Agents, the valid values are `APPLICATION_LOGS`
     #     and `EVENT_LOGS`.
     #
@@ -9410,8 +9463,10 @@ module Aws::CloudWatchLogs
     #   You must specify either `tableBody` or `queryId`, but not both.
     #
     # @option params [String] :query_id
-    #   The ID of a completed CloudWatch Logs query whose results replace the
-    #   lookup table content.
+    #   The ID of a completed or cancelled CloudWatch Logs query whose results
+    #   replace the lookup table content. A cancelled query replaces the
+    #   content with the partial results that were available when the query
+    #   was stopped.
     #
     #   You must specify either `tableBody` or `queryId`, but not both.
     #
@@ -9618,7 +9673,7 @@ module Aws::CloudWatchLogs
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-cloudwatchlogs'
-      context[:gem_version] = '1.160.0'
+      context[:gem_version] = '1.161.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudwatchlogs/client_api.rb

@@ -323,6 +323,8 @@ module Aws::CloudWatchLogs
     ImportStatus = Shapes::StringShape.new(name: 'ImportStatus')
     ImportStatusList = Shapes::ListShape.new(name: 'ImportStatusList')
     IncludeLinkedAccounts = Shapes::BooleanShape.new(name: 'IncludeLinkedAccounts')
+    IndexCategories = Shapes::ListShape.new(name: 'IndexCategories')
+    IndexCategory = Shapes::StringShape.new(name: 'IndexCategory')
     IndexPolicies = Shapes::ListShape.new(name: 'IndexPolicies')
     IndexPolicy = Shapes::StructureShape.new(name: 'IndexPolicy')
     IndexSource = Shapes::StringShape.new(name: 'IndexSource')
@@ -1171,6 +1173,7 @@ module Aws::CloudWatchLogs
     DescribeFieldIndexesLogGroupIdentifiers.member = Shapes::ShapeRef.new(shape: LogGroupIdentifier)
 
     DescribeFieldIndexesRequest.add_member(:log_group_identifiers, Shapes::ShapeRef.new(shape: DescribeFieldIndexesLogGroupIdentifiers, required: true, location_name: "logGroupIdentifiers"))
+    DescribeFieldIndexesRequest.add_member(:index_categories, Shapes::ShapeRef.new(shape: IndexCategories, location_name: "indexCategories"))
     DescribeFieldIndexesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     DescribeFieldIndexesRequest.struct_class = Types::DescribeFieldIndexesRequest
 
@@ -1376,6 +1379,7 @@ module Aws::CloudWatchLogs
     FieldIndex.add_member(:first_event_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "firstEventTime"))
     FieldIndex.add_member(:last_event_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastEventTime"))
     FieldIndex.add_member(:type, Shapes::ShapeRef.new(shape: IndexType, location_name: "type"))
+    FieldIndex.add_member(:index_category, Shapes::ShapeRef.new(shape: IndexCategory, location_name: "indexCategory"))
     FieldIndex.struct_class = Types::FieldIndex
 
     FieldIndexNames.member = Shapes::ShapeRef.new(shape: FieldIndexName)
@@ -1638,6 +1642,8 @@ module Aws::CloudWatchLogs
 
     ImportStatusList.member = Shapes::ShapeRef.new(shape: ImportStatus)
 
+    IndexCategories.member = Shapes::ShapeRef.new(shape: IndexCategory)
+
     IndexPolicies.member = Shapes::ShapeRef.new(shape: IndexPolicy)
 
     IndexPolicy.add_member(:log_group_identifier, Shapes::ShapeRef.new(shape: LogGroupIdentifier, location_name: "logGroupIdentifier"))

data/lib/aws-sdk-cloudwatchlogs/types.rb

@@ -1164,8 +1164,10 @@ module Aws::CloudWatchLogs
     #   @return [String]
     #
     # @!attribute [rw] query_id
-    #   The ID of a completed CloudWatch Logs query whose results populate
-    #   the lookup table.
+    #   The ID of a completed or cancelled CloudWatch Logs query whose
+    #   results populate the lookup table. A cancelled query populates the
+    #   table with the partial results that were available when the query
+    #   was stopped.
     #
     #   You must specify either `tableBody` or `queryId`, but not both.
     #   @return [String]
@@ -2488,6 +2490,39 @@ module Aws::CloudWatchLogs
     #   want to retrieve field indexes for.
     #   @return [Array<String>]
     #
+    # @!attribute [rw] index_categories
+    #   The index categories to return. The following values are supported:
+    #
+    #   * `DEFAULT`: Fields that CloudWatch Logs indexes by default.
+    #     Examples include `@logStream` and `@data_format`.
+    #
+    #   * `CUSTOM`: Fields that you added manually to the field index
+    #     policy. CloudWatch Logs always indexes these fields. These fields
+    #     count toward the quota of 20 fields for each log group.
+    #
+    #   * `AUTO`: Fields that CloudWatch Logs indexes automatically based on
+    #     your query patterns and usage. These fields do not count toward
+    #     the field index quota. CloudWatch Logs might update these fields
+    #     based on changes in your query patterns. To keep a field indexed
+    #     permanently, add it to an account-level or log-group level field
+    #     index policy.
+    #
+    #   * `INACTIVE`: Fields that CloudWatch Logs indexed before but does
+    #     not index now. This happens if you remove a field from the field
+    #     index policy or if CloudWatch Logs automatically selects a
+    #     different field based on your queries.
+    #
+    #   If you omit this parameter, the response includes the `DEFAULT`,
+    #   `CUSTOM`, and `INACTIVE` categories.
+    #
+    #   For more information about automatically indexed fields and using
+    #   the `AUTO` category, see [Automatically indexed fields][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Automatic.html
+    #   @return [Array<String>]
+    #
     # @!attribute [rw] next_token
     #   The token for the next set of items to return. The token expires
     #   after 24 hours.
@@ -2497,6 +2532,7 @@ module Aws::CloudWatchLogs
     #
     class DescribeFieldIndexesRequest < Struct.new(
       :log_group_identifiers,
+      :index_categories,
       :next_token)
       SENSITIVE = []
       include Aws::Structure
@@ -3508,6 +3544,36 @@ module Aws::CloudWatchLogs
     #   field is indexed and can be queried.
     #   @return [String]
     #
+    # @!attribute [rw] index_category
+    #   The category of the field index:
+    #
+    #   * `DEFAULT`: Fields that CloudWatch Logs indexes by default.
+    #     Examples include `@logStream` and `@data_format`.
+    #
+    #   * `CUSTOM`: Fields that you added manually to the field index
+    #     policy. CloudWatch Logs always indexes these fields. These fields
+    #     count toward the quota of 20 fields for each log group.
+    #
+    #   * `AUTO`: Fields that CloudWatch Logs indexes automatically based on
+    #     your query patterns and usage. These fields do not count toward
+    #     the field index quota. CloudWatch Logs might update these fields
+    #     based on changes in your query patterns. To keep a field indexed
+    #     permanently, add it to an account-level or log-group level field
+    #     index policy.
+    #
+    #   * `INACTIVE`: Fields that CloudWatch Logs indexed before but does
+    #     not index now. This happens if you remove a field from the field
+    #     index policy or if CloudWatch Logs automatically selects a
+    #     different field based on your queries.
+    #
+    #   For more information about automatically indexed fields, see
+    #   [Automatically indexed fields][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Automatic.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FieldIndex AWS API Documentation
     #
     class FieldIndex < Struct.new(
@@ -3516,7 +3582,8 @@ module Aws::CloudWatchLogs
       :last_scan_time,
       :first_event_time,
       :last_event_time,
-      :type)
+      :type,
+      :index_category)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3581,6 +3648,11 @@ module Aws::CloudWatchLogs
     #   The start of the time range, expressed as the number of milliseconds
     #   after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp before
     #   this time are not returned.
+    #
+    #   <note markdown="1"> Set `startTime` explicitly to reduce the chances of empty pages in
+    #   the response.
+    #
+    #    </note>
     #   @return [Integer]
     #
     # @!attribute [rw] end_time
@@ -4031,6 +4103,11 @@ module Aws::CloudWatchLogs
     #   after `Jan 1, 1970 00:00:00 UTC`. Events with a timestamp equal to
     #   this time or later than this time are included. Events with a
     #   timestamp earlier than this time are not included.
+    #
+    #   <note markdown="1"> Set `startTime` explicitly to reduce the chances of empty pages in
+    #   the response.
+    #
+    #    </note>
     #   @return [Integer]
     #
     # @!attribute [rw] end_time
@@ -8044,6 +8121,10 @@ module Aws::CloudWatchLogs
     # @!attribute [rw] log_type
     #   Defines the type of log that the source is sending.
     #
+    #   * For Application Load Balancer, the valid values are
+    #     `ALB_ACCESS_LOGS`, `ALB_CONNECTION_LOGS`, and
+    #     `ALB_HEALTH_CHECK_LOGS`.
+    #
     #   * For Amazon Bedrock Agents, the valid values are `APPLICATION_LOGS`
     #     and `EVENT_LOGS`.
     #
@@ -10662,8 +10743,10 @@ module Aws::CloudWatchLogs
     #   @return [String]
     #
     # @!attribute [rw] query_id
-    #   The ID of a completed CloudWatch Logs query whose results replace
-    #   the lookup table content.
+    #   The ID of a completed or cancelled CloudWatch Logs query whose
+    #   results replace the lookup table content. A cancelled query replaces
+    #   the content with the partial results that were available when the
+    #   query was stopped.
     #
     #   You must specify either `tableBody` or `queryId`, but not both.
     #   @return [String]

data/lib/aws-sdk-cloudwatchlogs.rb

@@ -55,7 +55,7 @@ module Aws::CloudWatchLogs
   autoload :Endpoints, 'aws-sdk-cloudwatchlogs/endpoints'
   autoload :EventStreams, 'aws-sdk-cloudwatchlogs/event_streams'
 
-  GEM_VERSION = '1.160.0'
+  GEM_VERSION = '1.161.0'
 
 end
 

data/sig/client.rbs

@@ -497,6 +497,7 @@ module Aws
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatchLogs/Client.html#describe_field_indexes-instance_method
       def describe_field_indexes: (
                                     log_group_identifiers: Array[::String],
+                                    ?index_categories: Array[("DEFAULT" | "CUSTOM" | "AUTO" | "INACTIVE")],
                                     ?next_token: ::String
                                   ) -> _DescribeFieldIndexesResponseSuccess
                                 | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeFieldIndexesResponseSuccess

data/sig/types.rbs

@@ -584,6 +584,7 @@ module Aws::CloudWatchLogs
 
     class DescribeFieldIndexesRequest
       attr_accessor log_group_identifiers: ::Array[::String]
+      attr_accessor index_categories: ::Array[("DEFAULT" | "CUSTOM" | "AUTO" | "INACTIVE")]
       attr_accessor next_token: ::String
       SENSITIVE: []
     end
@@ -828,6 +829,7 @@ module Aws::CloudWatchLogs
       attr_accessor first_event_time: ::Integer
       attr_accessor last_event_time: ::Integer
       attr_accessor type: ("FACET" | "FIELD_INDEX")
+      attr_accessor index_category: ("DEFAULT" | "CUSTOM" | "AUTO" | "INACTIVE")
       SENSITIVE: []
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatchlogs
 version: !ruby/object:Gem::Version
-  version: 1.160.0
+  version: 1.161.0
 platform: ruby
 authors:
 - Amazon Web Services