@aws-sdk/client-cloudwatch-logs 3.699.0 → 3.709.0

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

@@ -0,0 +1,86 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
+import { ListIntegrationsRequest, ListIntegrationsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListIntegrationsCommand}.
+ */
+export interface ListIntegrationsCommandInput extends ListIntegrationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListIntegrationsCommand}.
+ */
+export interface ListIntegrationsCommandOutput extends ListIntegrationsResponse, __MetadataBearer {
+}
+declare const ListIntegrationsCommand_base: {
+    new (input: ListIntegrationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListIntegrationsCommandInput, ListIntegrationsCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListIntegrationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListIntegrationsCommandInput, ListIntegrationsCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one
+ *       integration can be created in an account, and this integration must be with OpenSearch Service.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchLogsClient, ListIntegrationsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
+ * // const { CloudWatchLogsClient, ListIntegrationsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
+ * const client = new CloudWatchLogsClient(config);
+ * const input = { // ListIntegrationsRequest
+ *   integrationNamePrefix: "STRING_VALUE",
+ *   integrationType: "OPENSEARCH",
+ *   integrationStatus: "PROVISIONING" || "ACTIVE" || "FAILED",
+ * };
+ * const command = new ListIntegrationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListIntegrationsResponse
+ * //   integrationSummaries: [ // IntegrationSummaries
+ * //     { // IntegrationSummary
+ * //       integrationName: "STRING_VALUE",
+ * //       integrationType: "OPENSEARCH",
+ * //       integrationStatus: "PROVISIONING" || "ACTIVE" || "FAILED",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListIntegrationsCommandInput - {@link ListIntegrationsCommandInput}
+ * @returns {@link ListIntegrationsCommandOutput}
+ * @see {@link ListIntegrationsCommandInput} for command's `input` shape.
+ * @see {@link ListIntegrationsCommandOutput} 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 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 ListIntegrationsCommand extends ListIntegrationsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListIntegrationsRequest;
+            output: ListIntegrationsResponse;
+        };
+        sdk: {
+            input: ListIntegrationsCommandInput;
+            output: ListIntegrationsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
+import { PutIntegrationRequest, PutIntegrationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutIntegrationCommand}.
+ */
+export interface PutIntegrationCommandInput extends PutIntegrationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutIntegrationCommand}.
+ */
+export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __MetadataBearer {
+}
+declare const PutIntegrationCommand_base: {
+    new (input: PutIntegrationCommandInput): import("@smithy/smithy-client").CommandImpl<PutIntegrationCommandInput, PutIntegrationCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PutIntegrationCommandInput): import("@smithy/smithy-client").CommandImpl<PutIntegrationCommandInput, PutIntegrationCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with
+ *        OpenSearch Service are supported, and currently you can have only one integration in your account.</p>
+ *          <p>Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered
+ *        by OpenSearch Service analytics. For more information, see
+ *        <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-OpenSearch-Dashboards.html">Vended log dashboards powered by Amazon OpenSearch Service</a>.</p>
+ *          <p>You can use this operation only to create a new integration. You can't modify an existing integration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudWatchLogsClient, PutIntegrationCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
+ * // const { CloudWatchLogsClient, PutIntegrationCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
+ * const client = new CloudWatchLogsClient(config);
+ * const input = { // PutIntegrationRequest
+ *   integrationName: "STRING_VALUE", // required
+ *   resourceConfig: { // ResourceConfig Union: only one key present
+ *     openSearchResourceConfig: { // OpenSearchResourceConfig
+ *       kmsKeyArn: "STRING_VALUE",
+ *       dataSourceRoleArn: "STRING_VALUE", // required
+ *       dashboardViewerPrincipals: [ // DashboardViewerPrincipals // required
+ *         "STRING_VALUE",
+ *       ],
+ *       applicationArn: "STRING_VALUE",
+ *       retentionDays: Number("int"), // required
+ *     },
+ *   },
+ *   integrationType: "OPENSEARCH", // required
+ * };
+ * const command = new PutIntegrationCommand(input);
+ * const response = await client.send(command);
+ * // { // PutIntegrationResponse
+ * //   integrationName: "STRING_VALUE",
+ * //   integrationStatus: "PROVISIONING" || "ACTIVE" || "FAILED",
+ * // };
+ *
+ * ```
+ *
+ * @param PutIntegrationCommandInput - {@link PutIntegrationCommandInput}
+ * @returns {@link PutIntegrationCommandOutput}
+ * @see {@link PutIntegrationCommandInput} for command's `input` shape.
+ * @see {@link PutIntegrationCommandOutput} 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 ServiceUnavailableException} (server fault)
+ *  <p>The service cannot complete the request.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>One of the parameters for the request is not valid.</p>
+ *
+ * @throws {@link CloudWatchLogsServiceException}
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
+ *
+ * @public
+ */
+export declare class PutIntegrationCommand extends PutIntegrationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutIntegrationRequest;
+            output: PutIntegrationResponse;
+        };
+        sdk: {
+            input: PutIntegrationCommandInput;
+            output: PutIntegrationCommandOutput;
+        };
+    };
+}

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

@@ -45,6 +45,7 @@ declare const PutQueryDefinitionCommand_base: {
  * // const { CloudWatchLogsClient, PutQueryDefinitionCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
  * const client = new CloudWatchLogsClient(config);
  * const input = { // PutQueryDefinitionRequest
+ *   queryLanguage: "CWLI" || "SQL" || "PPL",
  *   name: "STRING_VALUE", // required
  *   queryDefinitionId: "STRING_VALUE",
  *   logGroupNames: [ // LogGroupNames

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

@@ -73,6 +73,7 @@ declare const StartQueryCommand_base: {
  * // const { CloudWatchLogsClient, StartQueryCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
  * const client = new CloudWatchLogsClient(config);
  * const input = { // StartQueryRequest
+ *   queryLanguage: "CWLI" || "SQL" || "PPL",
  *   logGroupName: "STRING_VALUE",
  *   logGroupNames: [ // LogGroupNames
  *     "STRING_VALUE",

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

@@ -13,6 +13,7 @@ export * from "./DeleteDeliveryDestinationPolicyCommand";
 export * from "./DeleteDeliverySourceCommand";
 export * from "./DeleteDestinationCommand";
 export * from "./DeleteIndexPolicyCommand";
+export * from "./DeleteIntegrationCommand";
 export * from "./DeleteLogAnomalyDetectorCommand";
 export * from "./DeleteLogGroupCommand";
 export * from "./DeleteLogStreamCommand";
@@ -45,6 +46,7 @@ export * from "./GetDeliveryCommand";
 export * from "./GetDeliveryDestinationCommand";
 export * from "./GetDeliveryDestinationPolicyCommand";
 export * from "./GetDeliverySourceCommand";
+export * from "./GetIntegrationCommand";
 export * from "./GetLogAnomalyDetectorCommand";
 export * from "./GetLogEventsCommand";
 export * from "./GetLogGroupFieldsCommand";
@@ -52,6 +54,7 @@ export * from "./GetLogRecordCommand";
 export * from "./GetQueryResultsCommand";
 export * from "./GetTransformerCommand";
 export * from "./ListAnomaliesCommand";
+export * from "./ListIntegrationsCommand";
 export * from "./ListLogAnomalyDetectorsCommand";
 export * from "./ListLogGroupsForQueryCommand";
 export * from "./ListTagsForResourceCommand";
@@ -64,6 +67,7 @@ export * from "./PutDeliverySourceCommand";
 export * from "./PutDestinationCommand";
 export * from "./PutDestinationPolicyCommand";
 export * from "./PutIndexPolicyCommand";
+export * from "./PutIntegrationCommand";
 export * from "./PutLogEventsCommand";
 export * from "./PutMetricFilterCommand";
 export * from "./PutQueryDefinitionCommand";