@aws-sdk/client-cloudwatch-logs 3.696.0 → 3.698.0

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

@@ -0,0 +1,89 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
+import { DeleteIndexPolicyRequest, DeleteIndexPolicyResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteIndexPolicyCommand}.
+ */
+export interface DeleteIndexPolicyCommandInput extends DeleteIndexPolicyRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteIndexPolicyCommand}.
+ */
+export interface DeleteIndexPolicyCommandOutput extends DeleteIndexPolicyResponse, __MetadataBearer {
+}
+declare const DeleteIndexPolicyCommand_base: {
+    new (input: DeleteIndexPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIndexPolicyCommandInput, DeleteIndexPolicyCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteIndexPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIndexPolicyCommandInput, DeleteIndexPolicyCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before
+ *     you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries.</p>
+ *          <p>You can't use this operation to delete an account-level index policy. Instead, use
+ *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteAccountPolicy.html">DeletAccountPolicy</a>.</p>
+ *          <p>If you delete a log-group level field index policy and there is an account-level field index policy, in a few minutes the log group begins using that account-wide policy to index new
+ *       incoming log events. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchLogsClient, DeleteIndexPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
+ * // const { CloudWatchLogsClient, DeleteIndexPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
+ * const client = new CloudWatchLogsClient(config);
+ * const input = { // DeleteIndexPolicyRequest
+ *   logGroupIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteIndexPolicyCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteIndexPolicyCommandInput - {@link DeleteIndexPolicyCommandInput}
+ * @returns {@link DeleteIndexPolicyCommandOutput}
+ * @see {@link DeleteIndexPolicyCommandInput} for command's `input` shape.
+ * @see {@link DeleteIndexPolicyCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>A parameter is specified incorrectly.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>You have reached the maximum number of resources that can be created.</p>
+ *
+ * @throws {@link OperationAbortedException} (client fault)
+ *  <p>Multiple concurrent requests to update the same resource were in conflict.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link CloudWatchLogsServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
+ *
+ * @public
+ */
+export declare class DeleteIndexPolicyCommand extends DeleteIndexPolicyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteIndexPolicyRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteIndexPolicyCommandInput;
+            output: DeleteIndexPolicyCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,89 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
+import { DeleteTransformerRequest } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteTransformerCommand}.
+ */
+export interface DeleteTransformerCommandInput extends DeleteTransformerRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteTransformerCommand}.
+ */
+export interface DeleteTransformerCommandOutput extends __MetadataBearer {
+}
+declare const DeleteTransformerCommand_base: {
+    new (input: DeleteTransformerCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteTransformerCommandInput, DeleteTransformerCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteTransformerCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteTransformerCommandInput, DeleteTransformerCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes the log transformer for the specified log group. As soon as you do this,
+ *       the transformation of incoming log events according to that transformer stops. If this account has an
+ *       account-level transformer that applies to this log group, the log group begins
+ *      using that account-level transformer when this log-group level transformer is deleted.</p>
+ *          <p>After you delete a transformer, be sure to edit any metric filters or subscription filters that relied
+ *      on the transformed versions of the log events.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchLogsClient, DeleteTransformerCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
+ * // const { CloudWatchLogsClient, DeleteTransformerCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
+ * const client = new CloudWatchLogsClient(config);
+ * const input = { // DeleteTransformerRequest
+ *   logGroupIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteTransformerCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteTransformerCommandInput - {@link DeleteTransformerCommandInput}
+ * @returns {@link DeleteTransformerCommandOutput}
+ * @see {@link DeleteTransformerCommandInput} for command's `input` shape.
+ * @see {@link DeleteTransformerCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
+ *
+ * @throws {@link InvalidOperationException} (client fault)
+ *  <p>The operation is not valid on the specified resource.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>A parameter is specified incorrectly.</p>
+ *
+ * @throws {@link OperationAbortedException} (client fault)
+ *  <p>Multiple concurrent requests to update the same resource were in conflict.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link CloudWatchLogsServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
+ *
+ * @public
+ */
+export declare class DeleteTransformerCommand extends DeleteTransformerCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteTransformerRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteTransformerCommandInput;
+            output: DeleteTransformerCommandOutput;
+        };
+    };
+}

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

@@ -35,11 +35,12 @@ declare const DescribeAccountPoliciesCommand_base: {
  * // const { CloudWatchLogsClient, DescribeAccountPoliciesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
  * const client = new CloudWatchLogsClient(config);
  * const input = { // DescribeAccountPoliciesRequest
- *   policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY", // required
+ *   policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY" || "FIELD_INDEX_POLICY" || "TRANSFORMER_POLICY", // required
  *   policyName: "STRING_VALUE",
  *   accountIdentifiers: [ // AccountIds
  *     "STRING_VALUE",
  *   ],
+ *   nextToken: "STRING_VALUE",
  * };
  * const command = new DescribeAccountPoliciesCommand(input);
  * const response = await client.send(command);
@@ -49,12 +50,13 @@ declare const DescribeAccountPoliciesCommand_base: {
  * //       policyName: "STRING_VALUE",
  * //       policyDocument: "STRING_VALUE",
  * //       lastUpdatedTime: Number("long"),
- * //       policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY",
+ * //       policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY" || "FIELD_INDEX_POLICY" || "TRANSFORMER_POLICY",
  * //       scope: "ALL",
  * //       selectionCriteria: "STRING_VALUE",
  * //       accountId: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   nextToken: "STRING_VALUE",
  * // };
  *
  * ```

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

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
+import { DescribeFieldIndexesRequest, DescribeFieldIndexesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeFieldIndexesCommand}.
+ */
+export interface DescribeFieldIndexesCommandInput extends DescribeFieldIndexesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeFieldIndexesCommand}.
+ */
+export interface DescribeFieldIndexesCommandOutput extends DescribeFieldIndexesResponse, __MetadataBearer {
+}
+declare const DescribeFieldIndexesCommand_base: {
+    new (input: DescribeFieldIndexesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeFieldIndexesCommandInput, DescribeFieldIndexesCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DescribeFieldIndexesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeFieldIndexesCommandInput, DescribeFieldIndexesCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of field indexes listed in the field index policies of
+ *     one or more log groups. 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
+ * import { CloudWatchLogsClient, DescribeFieldIndexesCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
+ * // const { CloudWatchLogsClient, DescribeFieldIndexesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
+ * const client = new CloudWatchLogsClient(config);
+ * const input = { // DescribeFieldIndexesRequest
+ *   logGroupIdentifiers: [ // DescribeFieldIndexesLogGroupIdentifiers // required
+ *     "STRING_VALUE",
+ *   ],
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new DescribeFieldIndexesCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeFieldIndexesResponse
+ * //   fieldIndexes: [ // FieldIndexes
+ * //     { // FieldIndex
+ * //       logGroupIdentifier: "STRING_VALUE",
+ * //       fieldIndexName: "STRING_VALUE",
+ * //       lastScanTime: Number("long"),
+ * //       firstEventTime: Number("long"),
+ * //       lastEventTime: Number("long"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeFieldIndexesCommandInput - {@link DescribeFieldIndexesCommandInput}
+ * @returns {@link DescribeFieldIndexesCommandOutput}
+ * @see {@link DescribeFieldIndexesCommandInput} for command's `input` shape.
+ * @see {@link DescribeFieldIndexesCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>A parameter is specified incorrectly.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>You have reached the maximum number of resources that can be created.</p>
+ *
+ * @throws {@link OperationAbortedException} (client fault)
+ *  <p>Multiple concurrent requests to update the same resource were in conflict.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link CloudWatchLogsServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
+ *
+ * @public
+ */
+export declare class DescribeFieldIndexesCommand extends DescribeFieldIndexesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeFieldIndexesRequest;
+            output: DescribeFieldIndexesResponse;
+        };
+        sdk: {
+            input: DescribeFieldIndexesCommandInput;
+            output: DescribeFieldIndexesCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
+import { DescribeIndexPoliciesRequest, DescribeIndexPoliciesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeIndexPoliciesCommand}.
+ */
+export interface DescribeIndexPoliciesCommandInput extends DescribeIndexPoliciesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeIndexPoliciesCommand}.
+ */
+export interface DescribeIndexPoliciesCommandOutput extends DescribeIndexPoliciesResponse, __MetadataBearer {
+}
+declare const DescribeIndexPoliciesCommand_base: {
+    new (input: DescribeIndexPoliciesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeIndexPoliciesCommandInput, DescribeIndexPoliciesCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DescribeIndexPoliciesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeIndexPoliciesCommandInput, DescribeIndexPoliciesCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns the field index policies of
+ *       one or more log groups. 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>If a specified log group has a log-group level index policy, that policy is returned by this operation.</p>
+ *          <p>If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it,
+ *       that account-wide policy is returned by this operation.</p>
+ *          <p>To find information about only account-level policies, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeAccountPolicies.html">DescribeAccountPolicies</a> instead.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchLogsClient, DescribeIndexPoliciesCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
+ * // const { CloudWatchLogsClient, DescribeIndexPoliciesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
+ * const client = new CloudWatchLogsClient(config);
+ * const input = { // DescribeIndexPoliciesRequest
+ *   logGroupIdentifiers: [ // DescribeIndexPoliciesLogGroupIdentifiers // required
+ *     "STRING_VALUE",
+ *   ],
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new DescribeIndexPoliciesCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeIndexPoliciesResponse
+ * //   indexPolicies: [ // IndexPolicies
+ * //     { // IndexPolicy
+ * //       logGroupIdentifier: "STRING_VALUE",
+ * //       lastUpdateTime: Number("long"),
+ * //       policyDocument: "STRING_VALUE",
+ * //       policyName: "STRING_VALUE",
+ * //       source: "ACCOUNT" || "LOG_GROUP",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeIndexPoliciesCommandInput - {@link DescribeIndexPoliciesCommandInput}
+ * @returns {@link DescribeIndexPoliciesCommandOutput}
+ * @see {@link DescribeIndexPoliciesCommandInput} for command's `input` shape.
+ * @see {@link DescribeIndexPoliciesCommandOutput} for command's `response` shape.
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>A parameter is specified incorrectly.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>You have reached the maximum number of resources that can be created.</p>
+ *
+ * @throws {@link OperationAbortedException} (client fault)
+ *  <p>Multiple concurrent requests to update the same resource were in conflict.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link CloudWatchLogsServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
+ *
+ * @public
+ */
+export declare class DescribeIndexPoliciesCommand extends DescribeIndexPoliciesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeIndexPoliciesRequest;
+            output: DescribeIndexPoliciesResponse;
+        };
+        sdk: {
+            input: DescribeIndexPoliciesCommandInput;
+            output: DescribeIndexPoliciesCommandOutput;
+        };
+    };
+}

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

@@ -65,6 +65,7 @@ declare const DescribeMetricFiltersCommand_base: {
  * //       ],
  * //       creationTime: Number("long"),
  * //       logGroupName: "STRING_VALUE",
+ * //       applyOnTransformedLogs: true || false,
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

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

@@ -52,6 +52,7 @@ declare const DescribeSubscriptionFiltersCommand_base: {
  * //       destinationArn: "STRING_VALUE",
  * //       roleArn: "STRING_VALUE",
  * //       distribution: "Random" || "ByLogStream",
+ * //       applyOnTransformedLogs: true || false,
  * //       creationTime: Number("long"),
  * //     },
  * //   ],

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

@@ -64,7 +64,10 @@ declare const GetQueryResultsCommand_base: {
  * //   statistics: { // QueryStatistics
  * //     recordsMatched: Number("double"),
  * //     recordsScanned: Number("double"),
+ * //     estimatedRecordsSkipped: Number("double"),
  * //     bytesScanned: Number("double"),
+ * //     estimatedBytesSkipped: Number("double"),
+ * //     logGroupsScanned: Number("double"),
  * //   },
  * //   status: "Scheduled" || "Running" || "Complete" || "Failed" || "Cancelled" || "Timeout" || "Unknown",
  * //   encryptionKey: "STRING_VALUE",