@aws-sdk/client-cloudwatch-logs 3.1104.0 → 3.1105.0

package/dist-cjs/index.js

@@ -70,7 +70,7 @@ const commonParams = {
     UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
 };
 
-var version = "3.1103.0";
+var version = "3.1104.0";
 var packageInfo = {
 	version: version};
 
@@ -1078,6 +1078,8 @@ const _hE = "httpError";
 const _i = "identifier";
 const _iA = "integrationArn";
 const _iB = "importBatches";
+const _iC = "indexCategories";
+const _iCn = "indexCategory";
 const _iD = "integrationDetails";
 const _iDA = "importDestinationArn";
 const _iDs = "isDynamic";
@@ -1877,8 +1879,8 @@ var DescribeExportTasksResponse$ = [3, n0, _DETRe,
 ];
 var DescribeFieldIndexesRequest$ = [3, n0, _DFIR,
     0,
-    [_lGI, _nT],
-    [64 | 0, 0], 1
+    [_lGI, _iC, _nT],
+    [64 | 0, 64 | 0, 0], 1
 ];
 var DescribeFieldIndexesResponse$ = [3, n0, _DFIRe,
     0,
@@ -2042,8 +2044,8 @@ var ExportTaskStatus$ = [3, n0, _ETS,
 ];
 var FieldIndex$ = [3, n0, _FI,
     0,
-    [_lGIo, _fIN, _lST, _fET, _lET, _ty],
-    [0, 0, 1, 1, 1, 0]
+    [_lGIo, _fIN, _lST, _fET, _lET, _ty, _iCn],
+    [0, 0, 1, 1, 1, 0, 0]
 ];
 var FieldsData$ = [3, n0, _FD,
     0,
@@ -4387,6 +4389,12 @@ const ExportTaskStatusCode = {
     PENDING_CANCEL: "PENDING_CANCEL",
     RUNNING: "RUNNING",
 };
+const IndexCategory = {
+    AUTO: "AUTO",
+    CUSTOM: "CUSTOM",
+    DEFAULT: "DEFAULT",
+    INACTIVE: "INACTIVE",
+};
 const IndexType = {
     FACET: "FACET",
     FIELD_INDEX: "FIELD_INDEX",
@@ -4868,6 +4876,7 @@ exports.ImportBatch$ = ImportBatch$;
 exports.ImportFilter$ = ImportFilter$;
 exports.ImportStatistics$ = ImportStatistics$;
 exports.ImportStatus = ImportStatus;
+exports.IndexCategory = IndexCategory;
 exports.IndexPolicy$ = IndexPolicy$;
 exports.IndexSource = IndexSource;
 exports.IndexType = IndexType;

package/dist-es/models/enums.js

@@ -96,6 +96,12 @@ export const ExportTaskStatusCode = {
     PENDING_CANCEL: "PENDING_CANCEL",
     RUNNING: "RUNNING",
 };
+export const IndexCategory = {
+    AUTO: "AUTO",
+    CUSTOM: "CUSTOM",
+    DEFAULT: "DEFAULT",
+    INACTIVE: "INACTIVE",
+};
 export const IndexType = {
     FACET: "FACET",
     FIELD_INDEX: "FIELD_INDEX",

package/dist-es/schemas/schemas_0.js

@@ -670,6 +670,8 @@ const _hE = "httpError";
 const _i = "identifier";
 const _iA = "integrationArn";
 const _iB = "importBatches";
+const _iC = "indexCategories";
+const _iCn = "indexCategory";
 const _iD = "integrationDetails";
 const _iDA = "importDestinationArn";
 const _iDs = "isDynamic";
@@ -1472,8 +1474,8 @@ export var DescribeExportTasksResponse$ = [3, n0, _DETRe,
 ];
 export var DescribeFieldIndexesRequest$ = [3, n0, _DFIR,
     0,
-    [_lGI, _nT],
-    [64 | 0, 0], 1
+    [_lGI, _iC, _nT],
+    [64 | 0, 64 | 0, 0], 1
 ];
 export var DescribeFieldIndexesResponse$ = [3, n0, _DFIRe,
     0,
@@ -1637,8 +1639,8 @@ export var ExportTaskStatus$ = [3, n0, _ETS,
 ];
 export var FieldIndex$ = [3, n0, _FI,
     0,
-    [_lGIo, _fIN, _lST, _fET, _lET, _ty],
-    [0, 0, 1, 1, 1, 0]
+    [_lGIo, _fIN, _lST, _fET, _lET, _ty, _iCn],
+    [0, 0, 1, 1, 1, 0, 0]
 ];
 export var FieldsData$ = [3, n0, _FD,
     0,
@@ -2725,6 +2727,7 @@ var ImportList = [1, n0, _IL,
     0, () => Import$
 ];
 var ImportStatusList = 64 | 0;
+var IndexCategories = 64 | 0;
 var IndexPolicies = [1, n0, _IPn,
     0, () => IndexPolicy$
 ];

package/dist-types/commands/DescribeFieldIndexesCommand.d.ts

@@ -24,8 +24,10 @@ declare const DescribeFieldIndexesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of custom and default field indexes which are discovered in log data. For
- *       more information about field index policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a>.</p>
+ * <p>Returns a list of field indexes discovered in log data. By default, the response includes
+ *       the <code>DEFAULT</code>, <code>CUSTOM</code>, and <code>INACTIVE</code> index categories. To
+ *       return indexes from other categories, use the <code>indexCategories</code> parameter.</p>
+ *          <p>For more information about field index policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -38,6 +40,9 @@ declare const DescribeFieldIndexesCommand_base: {
  *   logGroupIdentifiers: [ // DescribeFieldIndexesLogGroupIdentifiers // required
  *     "STRING_VALUE",
  *   ],
+ *   indexCategories: [ // IndexCategories
+ *     "DEFAULT" || "CUSTOM" || "AUTO" || "INACTIVE",
+ *   ],
  *   nextToken: "STRING_VALUE",
  * };
  * const command = new DescribeFieldIndexesCommand(input);
@@ -51,6 +56,7 @@ declare const DescribeFieldIndexesCommand_base: {
  * //       firstEventTime: Number("long"),
  * //       lastEventTime: Number("long"),
  * //       type: "FACET" || "FIELD_INDEX",
+ * //       indexCategory: "DEFAULT" || "CUSTOM" || "AUTO" || "INACTIVE",
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

package/dist-types/models/enums.d.ts

@@ -232,6 +232,20 @@ export declare const ExportTaskStatusCode: {
  * @public
  */
 export type ExportTaskStatusCode = (typeof ExportTaskStatusCode)[keyof typeof ExportTaskStatusCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const IndexCategory: {
+    readonly AUTO: "AUTO";
+    readonly CUSTOM: "CUSTOM";
+    readonly DEFAULT: "DEFAULT";
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type IndexCategory = (typeof IndexCategory)[keyof typeof IndexCategory];
 /**
  * @public
  * @enum

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { ActionStatus, AnomalyDetectorStatus, DataProtectionStatus, DeliveryDestinationType, DeliverySourceConfigurationSchemaValueType, DeliverySourceStatus, DeliverySourceStatusReason, Distribution, EntityRejectionErrorType, EvaluationFrequency, EventSource, ExecutionStatus, ExportTaskStatusCode, FlattenedElement, ImportStatus, IndexSource, IndexType, InheritedProperty, IntegrationStatus, IntegrationType, ListAggregateLogGroupSummariesGroupBy, LogGroupClass, OCSFVersion, OpenSearchResourceStatusType, OrderBy, OutputFormat, PolicyScope, PolicyType, QueryLanguage, QueryStatus, S3TableIntegrationSourceStatus, ScheduledQueryDestinationType, ScheduledQueryState, ScheduleType, Scope, StandardUnit, State, StorageTier, SuppressionState, SyslogSourceType, Type } from "./enums";
+import type { ActionStatus, AnomalyDetectorStatus, DataProtectionStatus, DeliveryDestinationType, DeliverySourceConfigurationSchemaValueType, DeliverySourceStatus, DeliverySourceStatusReason, Distribution, EntityRejectionErrorType, EvaluationFrequency, EventSource, ExecutionStatus, ExportTaskStatusCode, FlattenedElement, ImportStatus, IndexCategory, IndexSource, IndexType, InheritedProperty, IntegrationStatus, IntegrationType, ListAggregateLogGroupSummariesGroupBy, LogGroupClass, OCSFVersion, OpenSearchResourceStatusType, OrderBy, OutputFormat, PolicyScope, PolicyType, QueryLanguage, QueryStatus, S3TableIntegrationSourceStatus, ScheduledQueryDestinationType, ScheduledQueryState, ScheduleType, Scope, StandardUnit, State, StorageTier, SuppressionState, SyslogSourceType, Type } from "./enums";
 import type { InternalStreamingException, SessionStreamingException, SessionTimeoutException } from "./errors";
 /**
  * <p>A structure that contains information about one CloudWatch Logs account policy.</p>
@@ -1156,8 +1156,9 @@ export interface CreateLookupTableRequest {
      */
     tableBody?: string | undefined;
     /**
-     * <p>The ID of a completed CloudWatch Logs query whose results populate
-     *       the lookup table.</p>
+     * <p>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.</p>
      *          <p>You must specify either <code>tableBody</code> or <code>queryId</code>, but not
      *       both.</p>
      * @public
@@ -2383,6 +2384,42 @@ export interface DescribeFieldIndexesRequest {
      * @public
      */
     logGroupIdentifiers: string[] | undefined;
+    /**
+     * <p>The index categories to return. The following values are supported:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>DEFAULT</code>: Fields that CloudWatch Logs indexes by default. Examples
+     *           include <code>@logStream</code> and <code>@data_format</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>CUSTOM</code>: 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.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>AUTO</code>: 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.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INACTIVE</code>: 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.</p>
+     *             </li>
+     *          </ul>
+     *          <p>If you omit this parameter, the response includes the <code>DEFAULT</code>,
+     *         <code>CUSTOM</code>, and <code>INACTIVE</code> categories.</p>
+     *          <p>For more information about automatically indexed fields and using the <code>AUTO</code>
+     *       category, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Automatic.html">Automatically indexed fields</a>.</p>
+     * @public
+     */
+    indexCategories?: IndexCategory[] | undefined;
     /**
      * <p>The token for the next set of items to return. The token expires after 24
      *       hours.</p>
@@ -2432,6 +2469,39 @@ export interface FieldIndex {
      * @public
      */
     type?: IndexType | undefined;
+    /**
+     * <p>The category of the field index:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>DEFAULT</code>: Fields that CloudWatch Logs indexes by default. Examples
+     *           include <code>@logStream</code> and <code>@data_format</code>.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>CUSTOM</code>: 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.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>AUTO</code>: 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.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INACTIVE</code>: 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.</p>
+     *             </li>
+     *          </ul>
+     *          <p>For more information about automatically indexed fields, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing-Automatic.html">Automatically indexed fields</a>.</p>
+     * @public
+     */
+    indexCategory?: IndexCategory | undefined;
 }
 /**
  * @public
@@ -3925,6 +3995,10 @@ export interface FilterLogEventsRequest {
      * <p>The start of the time range, expressed as the number of milliseconds after <code>Jan 1,
      *         1970 00:00:00 UTC</code>. Events with a timestamp before this time are not
      *       returned.</p>
+     *          <note>
+     *             <p>Set <code>startTime</code> explicitly to reduce the chances of empty pages in the
+     *         response.</p>
+     *          </note>
      * @public
      */
     startTime?: number | undefined;
@@ -4609,6 +4683,10 @@ export interface GetLogEventsRequest {
      * <p>The start of the time range, expressed as the number of milliseconds after <code>Jan 1,
      *         1970 00:00:00 UTC</code>. 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.</p>
+     *          <note>
+     *             <p>Set <code>startTime</code> explicitly to reduce the chances of empty pages in the
+     *         response.</p>
+     *          </note>
      * @public
      */
     startTime?: number | undefined;
@@ -7276,6 +7354,10 @@ export interface PutDeliverySourceRequest {
      * <p>Defines the type of log that the source is sending.</p>
      *          <ul>
      *             <li>
+     *                <p>For Application Load Balancer, the valid values are <code>ALB_ACCESS_LOGS</code>,
+     *             <code>ALB_CONNECTION_LOGS</code>, and <code>ALB_HEALTH_CHECK_LOGS</code>.</p>
+     *             </li>
+     *             <li>
      *                <p>For Amazon Bedrock Agents, the valid values are <code>APPLICATION_LOGS</code> and
      *             <code>EVENT_LOGS</code>.</p>
      *             </li>

package/dist-types/models/models_1.d.ts

@@ -281,8 +281,9 @@ export interface UpdateLookupTableRequest {
      */
     tableBody?: string | undefined;
     /**
-     * <p>The ID of a completed CloudWatch Logs query whose results replace
-     *       the lookup table content.</p>
+     * <p>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.</p>
      *          <p>You must specify either <code>tableBody</code> or <code>queryId</code>, but not
      *       both.</p>
      * @public

package/dist-types/ts3.4/models/enums.d.ts

@@ -117,6 +117,13 @@ export declare const ExportTaskStatusCode: {
   readonly RUNNING: "RUNNING";
 };
 export type ExportTaskStatusCode = (typeof ExportTaskStatusCode)[keyof typeof ExportTaskStatusCode];
+export declare const IndexCategory: {
+  readonly AUTO: "AUTO";
+  readonly CUSTOM: "CUSTOM";
+  readonly DEFAULT: "DEFAULT";
+  readonly INACTIVE: "INACTIVE";
+};
+export type IndexCategory = (typeof IndexCategory)[keyof typeof IndexCategory];
 export declare const IndexType: {
   readonly FACET: "FACET";
   readonly FIELD_INDEX: "FIELD_INDEX";

package/dist-types/ts3.4/models/models_0.d.ts

@@ -14,6 +14,7 @@ import {
   ExportTaskStatusCode,
   FlattenedElement,
   ImportStatus,
+  IndexCategory,
   IndexSource,
   IndexType,
   InheritedProperty,
@@ -531,6 +532,7 @@ export interface DescribeExportTasksResponse {
 }
 export interface DescribeFieldIndexesRequest {
   logGroupIdentifiers: string[] | undefined;
+  indexCategories?: IndexCategory[] | undefined;
   nextToken?: string | undefined;
 }
 export interface FieldIndex {
@@ -540,6 +542,7 @@ export interface FieldIndex {
   firstEventTime?: number | undefined;
   lastEventTime?: number | undefined;
   type?: IndexType | undefined;
+  indexCategory?: IndexCategory | undefined;
 }
 export interface DescribeFieldIndexesResponse {
   fieldIndexes?: FieldIndex[] | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/client-cloudwatch-logs",
-  "version": "3.1104.0",
+  "version": "3.1105.0",
   "description": "AWS SDK for JavaScript Cloudwatch Logs Client for Node.js, Browser and React Native",
   "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-cloudwatch-logs",
   "license": "Apache-2.0",