Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards,
+ * you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by
+ * setting force to true,
+ * all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them
+ * will no longer be accessible.
A parameter is specified incorrectly.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link CloudWatchLogsServiceException} + *Base exception class for all service exceptions from CloudWatchLogs service.
+ * + * @public + */ +export class DeleteIntegrationCommand extends $Command + .classBuilder< + DeleteIntegrationCommandInput, + DeleteIntegrationCommandOutput, + CloudWatchLogsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchLogsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Logs_20140328", "DeleteIntegration", {}) + .n("CloudWatchLogsClient", "DeleteIntegrationCommand") + .f(void 0, void 0) + .ser(se_DeleteIntegrationCommand) + .de(de_DeleteIntegrationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteIntegrationRequest; + output: {}; + }; + sdk: { + input: DeleteIntegrationCommandInput; + output: DeleteIntegrationCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-logs/src/commands/DescribeQueriesCommand.ts b/clients/client-cloudwatch-logs/src/commands/DescribeQueriesCommand.ts index db7949f98549..5c83682a6d46 100644 --- a/clients/client-cloudwatch-logs/src/commands/DescribeQueriesCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/DescribeQueriesCommand.ts @@ -42,12 +42,14 @@ export interface DescribeQueriesCommandOutput extends DescribeQueriesResponse, _ * status: "Scheduled" || "Running" || "Complete" || "Failed" || "Cancelled" || "Timeout" || "Unknown", * maxResults: Number("int"), * nextToken: "STRING_VALUE", + * queryLanguage: "CWLI" || "SQL" || "PPL", * }; * const command = new DescribeQueriesCommand(input); * const response = await client.send(command); * // { // DescribeQueriesResponse * // queries: [ // QueryInfoList * // { // QueryInfo + * // queryLanguage: "CWLI" || "SQL" || "PPL", * // queryId: "STRING_VALUE", * // queryString: "STRING_VALUE", * // status: "Scheduled" || "Running" || "Complete" || "Failed" || "Cancelled" || "Timeout" || "Unknown", diff --git a/clients/client-cloudwatch-logs/src/commands/DescribeQueryDefinitionsCommand.ts b/clients/client-cloudwatch-logs/src/commands/DescribeQueryDefinitionsCommand.ts index f239bf414fdf..2a04a9ef4550 100644 --- a/clients/client-cloudwatch-logs/src/commands/DescribeQueryDefinitionsCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/DescribeQueryDefinitionsCommand.ts @@ -39,6 +39,7 @@ export interface DescribeQueryDefinitionsCommandOutput extends DescribeQueryDefi * // const { CloudWatchLogsClient, DescribeQueryDefinitionsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import * const client = new CloudWatchLogsClient(config); * const input = { // DescribeQueryDefinitionsRequest + * queryLanguage: "CWLI" || "SQL" || "PPL", * queryDefinitionNamePrefix: "STRING_VALUE", * maxResults: Number("int"), * nextToken: "STRING_VALUE", @@ -48,6 +49,7 @@ export interface DescribeQueryDefinitionsCommandOutput extends DescribeQueryDefi * // { // DescribeQueryDefinitionsResponse * // queryDefinitions: [ // QueryDefinitionList * // { // QueryDefinition + * // queryLanguage: "CWLI" || "SQL" || "PPL", * // queryDefinitionId: "STRING_VALUE", * // name: "STRING_VALUE", * // queryString: "STRING_VALUE", diff --git a/clients/client-cloudwatch-logs/src/commands/GetIntegrationCommand.ts b/clients/client-cloudwatch-logs/src/commands/GetIntegrationCommand.ts new file mode 100644 index 000000000000..319d391e6513 --- /dev/null +++ b/clients/client-cloudwatch-logs/src/commands/GetIntegrationCommand.ts @@ -0,0 +1,157 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetIntegrationRequest, GetIntegrationResponse } from "../models/models_0"; +import { de_GetIntegrationCommand, se_GetIntegrationCommand } from "../protocols/Aws_json1_1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetIntegrationCommand}. + */ +export interface GetIntegrationCommandInput extends GetIntegrationRequest {} +/** + * @public + * + * The output of {@link GetIntegrationCommand}. + */ +export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __MetadataBearer {} + +/** + *Returns information about one integration between CloudWatch Logs and OpenSearch Service.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, GetIntegrationCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, GetIntegrationCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const input = { // GetIntegrationRequest + * integrationName: "STRING_VALUE", // required + * }; + * const command = new GetIntegrationCommand(input); + * const response = await client.send(command); + * // { // GetIntegrationResponse + * // integrationName: "STRING_VALUE", + * // integrationType: "OPENSEARCH", + * // integrationStatus: "PROVISIONING" || "ACTIVE" || "FAILED", + * // integrationDetails: { // IntegrationDetails Union: only one key present + * // openSearchIntegrationDetails: { // OpenSearchIntegrationDetails + * // dataSource: { // OpenSearchDataSource + * // dataSourceName: "STRING_VALUE", + * // status: { // OpenSearchResourceStatus + * // status: "ACTIVE" || "NOT_FOUND" || "ERROR", + * // statusMessage: "STRING_VALUE", + * // }, + * // }, + * // application: { // OpenSearchApplication + * // applicationEndpoint: "STRING_VALUE", + * // applicationArn: "STRING_VALUE", + * // applicationId: "STRING_VALUE", + * // status: { + * // status: "ACTIVE" || "NOT_FOUND" || "ERROR", + * // statusMessage: "STRING_VALUE", + * // }, + * // }, + * // collection: { // OpenSearchCollection + * // collectionEndpoint: "STRING_VALUE", + * // collectionArn: "STRING_VALUE", + * // status: { + * // status: "ACTIVE" || "NOT_FOUND" || "ERROR", + * // statusMessage: "STRING_VALUE", + * // }, + * // }, + * // workspace: { // OpenSearchWorkspace + * // workspaceId: "STRING_VALUE", + * // status: { + * // status: "ACTIVE" || "NOT_FOUND" || "ERROR", + * // statusMessage: "STRING_VALUE", + * // }, + * // }, + * // encryptionPolicy: { // OpenSearchEncryptionPolicy + * // policyName: "STRING_VALUE", + * // status: { + * // status: "ACTIVE" || "NOT_FOUND" || "ERROR", + * // statusMessage: "STRING_VALUE", + * // }, + * // }, + * // networkPolicy: { // OpenSearchNetworkPolicy + * // policyName: "STRING_VALUE", + * // status: "A parameter is specified incorrectly.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link CloudWatchLogsServiceException} + *Base exception class for all service exceptions from CloudWatchLogs service.
+ * + * @public + */ +export class GetIntegrationCommand extends $Command + .classBuilder< + GetIntegrationCommandInput, + GetIntegrationCommandOutput, + CloudWatchLogsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchLogsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Logs_20140328", "GetIntegration", {}) + .n("CloudWatchLogsClient", "GetIntegrationCommand") + .f(void 0, void 0) + .ser(se_GetIntegrationCommand) + .de(de_GetIntegrationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetIntegrationRequest; + output: GetIntegrationResponse; + }; + sdk: { + input: GetIntegrationCommandInput; + output: GetIntegrationCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-logs/src/commands/GetQueryResultsCommand.ts b/clients/client-cloudwatch-logs/src/commands/GetQueryResultsCommand.ts index 7047ae6141db..44950a6198f8 100644 --- a/clients/client-cloudwatch-logs/src/commands/GetQueryResultsCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/GetQueryResultsCommand.ts @@ -54,6 +54,7 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsResponse, _ * const command = new GetQueryResultsCommand(input); * const response = await client.send(command); * // { // GetQueryResultsResponse + * // queryLanguage: "CWLI" || "SQL" || "PPL", * // results: [ // QueryResults * // [ // ResultRows * // { // ResultField diff --git a/clients/client-cloudwatch-logs/src/commands/ListIntegrationsCommand.ts b/clients/client-cloudwatch-logs/src/commands/ListIntegrationsCommand.ts new file mode 100644 index 000000000000..7f11a4070500 --- /dev/null +++ b/clients/client-cloudwatch-logs/src/commands/ListIntegrationsCommand.ts @@ -0,0 +1,107 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListIntegrationsRequest, ListIntegrationsResponse } from "../models/models_0"; +import { de_ListIntegrationsCommand, se_ListIntegrationsCommand } from "../protocols/Aws_json1_1"; + +/** + * @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 {} + +/** + *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.
+ * @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) + *A parameter is specified incorrectly.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link CloudWatchLogsServiceException} + *Base exception class for all service exceptions from CloudWatchLogs service.
+ * + * @public + */ +export class ListIntegrationsCommand extends $Command + .classBuilder< + ListIntegrationsCommandInput, + ListIntegrationsCommandOutput, + CloudWatchLogsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchLogsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Logs_20140328", "ListIntegrations", {}) + .n("CloudWatchLogsClient", "ListIntegrationsCommand") + .f(void 0, void 0) + .ser(se_ListIntegrationsCommand) + .de(de_ListIntegrationsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListIntegrationsRequest; + output: ListIntegrationsResponse; + }; + sdk: { + input: ListIntegrationsCommandInput; + output: ListIntegrationsCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-logs/src/commands/PutIntegrationCommand.ts b/clients/client-cloudwatch-logs/src/commands/PutIntegrationCommand.ts new file mode 100644 index 000000000000..104f857c530f --- /dev/null +++ b/clients/client-cloudwatch-logs/src/commands/PutIntegrationCommand.ts @@ -0,0 +1,122 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutIntegrationRequest, PutIntegrationResponse } from "../models/models_0"; +import { de_PutIntegrationCommand, se_PutIntegrationCommand } from "../protocols/Aws_json1_1"; + +/** + * @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 {} + +/** + *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.
+ *Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered + * by OpenSearch Service analytics. For more information, see + * Vended log dashboards powered by Amazon OpenSearch Service.
+ *You can use this operation only to create a new integration. You can't modify an existing integration.
+ * @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) + *A parameter is specified incorrectly.
+ * + * @throws {@link LimitExceededException} (client fault) + *You have reached the maximum number of resources that can be created.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *The service cannot complete the request.
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link CloudWatchLogsServiceException} + *Base exception class for all service exceptions from CloudWatchLogs service.
+ * + * @public + */ +export class PutIntegrationCommand extends $Command + .classBuilder< + PutIntegrationCommandInput, + PutIntegrationCommandOutput, + CloudWatchLogsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: CloudWatchLogsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Logs_20140328", "PutIntegration", {}) + .n("CloudWatchLogsClient", "PutIntegrationCommand") + .f(void 0, void 0) + .ser(se_PutIntegrationCommand) + .de(de_PutIntegrationCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutIntegrationRequest; + output: PutIntegrationResponse; + }; + sdk: { + input: PutIntegrationCommandInput; + output: PutIntegrationCommandOutput; + }; + }; +} diff --git a/clients/client-cloudwatch-logs/src/commands/PutQueryDefinitionCommand.ts b/clients/client-cloudwatch-logs/src/commands/PutQueryDefinitionCommand.ts index 70808d481a71..dd6afd56a9b4 100644 --- a/clients/client-cloudwatch-logs/src/commands/PutQueryDefinitionCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/PutQueryDefinitionCommand.ts @@ -46,6 +46,7 @@ export interface PutQueryDefinitionCommandOutput extends PutQueryDefinitionRespo * // 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 diff --git a/clients/client-cloudwatch-logs/src/commands/StartQueryCommand.ts b/clients/client-cloudwatch-logs/src/commands/StartQueryCommand.ts index d8e3855ed2e0..e98e044854c3 100644 --- a/clients/client-cloudwatch-logs/src/commands/StartQueryCommand.ts +++ b/clients/client-cloudwatch-logs/src/commands/StartQueryCommand.ts @@ -74,6 +74,7 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB * // 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", diff --git a/clients/client-cloudwatch-logs/src/commands/index.ts b/clients/client-cloudwatch-logs/src/commands/index.ts index 48d7e553b183..191489aaa311 100644 --- a/clients/client-cloudwatch-logs/src/commands/index.ts +++ b/clients/client-cloudwatch-logs/src/commands/index.ts @@ -14,6 +14,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"; @@ -46,6 +47,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"; @@ -53,6 +55,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"; @@ -65,6 +68,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"; diff --git a/clients/client-cloudwatch-logs/src/models/models_0.ts b/clients/client-cloudwatch-logs/src/models/models_0.ts index 6a7c11f2fbab..c75b772373f5 100644 --- a/clients/client-cloudwatch-logs/src/models/models_0.ts +++ b/clients/client-cloudwatch-logs/src/models/models_0.ts @@ -1551,6 +1551,30 @@ export interface DeleteIndexPolicyRequest { */ export interface DeleteIndexPolicyResponse {} +/** + * @public + */ +export interface DeleteIntegrationRequest { + /** + *The name of the integration to delete. To find the name of your integration, use + * ListIntegrations.
+ * @public + */ + integrationName: string | undefined; + + /** + *Specify true to force the deletion of the integration even if vended logs dashboards currently exist.
The default is false.
This processor deletes entries from a log event. These entries are key-value pairs.
*For more information about this processor including examples, see
@@ -3102,6 +3126,21 @@ export interface DescribeMetricFiltersResponse {
nextToken?: string | undefined;
}
+/**
+ * @public
+ * @enum
+ */
+export const QueryLanguage = {
+ CWLI: "CWLI",
+ PPL: "PPL",
+ SQL: "SQL",
+} as const;
+
+/**
+ * @public
+ */
+export type QueryLanguage = (typeof QueryLanguage)[keyof typeof QueryLanguage];
+
/**
* @public
* @enum
@@ -3149,6 +3188,12 @@ export interface DescribeQueriesRequest {
* @public
*/
nextToken?: string | undefined;
+
+ /**
+ * Limits the returned queries to only the queries that use the specified query language. The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
+ * see Supported query languages. The unique ID number of this query. The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
+ * see Supported query languages. Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify. The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
+ * see Supported query languages. The unique ID of the query definition. The name of the integration that you want to find information about. To find the name of your integration, use
+ * ListIntegrations
+ * This structure contains information about the status of an OpenSearch Service resource. The current status of this resource. A message with additional information about the status of this resource. This structure contains information about the OpenSearch Service data access policy used for this integration. The access
+ * policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup.
+ * For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide. The name of the data access policy. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service application used for this integration.
+ * An OpenSearch Service application is the web application created by the integration with CloudWatch Logs. It hosts the vended logs dashboards. The endpoint of the application. The Amazon Resource Name (ARN) of the application. The ID of the application. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service collection used for this integration.
+ * An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload.
+ * For more information, see Creating and managing OpenSearch Service Serverless collections. The endpoint of the collection. The ARN of the collection. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service data source used for this integration. This data source was
+ * created as part of the integration setup.
+ * An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections. For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.
+ * The name of the OpenSearch Service data source. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created
+ * automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.
+ * The name of the encryption policy. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy
+ * determines the lifespan of the data in the collection. It was automatically created as part of the integration setup. For more information, see Using data lifecycle policies with OpenSearch Service Serverless
+ * in the OpenSearch Service Developer Guide. The name of the lifecycle policy. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service network policy used for this integration. The network
+ * policy assigns network access settings to collections.
+ * For more information, see Network policies in the OpenSearch Service Developer Guide. The name of the network policy. This structure contains information about the status of this OpenSearch Service resource. This structure contains information about the OpenSearch Service workspace used for this integration.
+ * An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup.
+ * For more information, see Centralized OpenSearch user interface (Dashboards) with
+ * OpenSearch Service. The ID of this workspace. This structure contains information about the status of an OpenSearch Service resource. This structure contains complete information about one CloudWatch Logs integration. This structure
+ * is returned by a GetIntegration operation. This structure contains information about the OpenSearch Service data source used for this integration. This data source was
+ * created as part of the integration setup.
+ * An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections. For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.
+ * This structure contains information about the OpenSearch Service application used for this integration.
+ * An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards. This structure contains information about the OpenSearch Service collection used for this integration. This collection was
+ * created as part of the integration setup.
+ * An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload.
+ * For more information, see Creating and managing OpenSearch Service Serverless collections. This structure contains information about the OpenSearch Service workspace used for this integration.
+ * An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup.
+ * For more information, see Centralized OpenSearch user interface (Dashboards) with
+ * OpenSearch Service. This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created
+ * automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.
+ * This structure contains information about the OpenSearch Service network policy used for this integration. The network
+ * policy assigns network access settings to collections.
+ * For more information, see Network policies in the OpenSearch Service Developer Guide. This structure contains information about the OpenSearch Service data access policy used for this integration. The access
+ * policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup.
+ * For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide. This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy
+ * determines the lifespan of the data in the collection. It was automatically created as part of the integration setup. For more information, see Using data lifecycle policies with OpenSearch Service Serverless
+ * in the OpenSearch Service Developer Guide. This structure contains information about the integration configuration. For an integration
+ * with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace,
+ * and policies. This structure
+ * is returned by a GetIntegration operation. This structure contains complete information about one integration between CloudWatch Logs and
+ * OpenSearch Service. The name of the integration. The type of integration. Integrations with OpenSearch Service have the type The current status of this integration. A structure that contains information about the integration configuration. For an integration
+ * with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace,
+ * and policies. The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
+ * see Supported query languages. The log events that matched the query criteria during the most recent time it ran. The This structure contains information about one CloudWatch Logs integration. This structure
+ * is returned by a ListIntegrations operation. The name of this integration. The type of integration. Integrations with OpenSearch Service have the type The current status of this integration. The sequence token is not valid. You can get the correct sequence token in
* the To limit the results to integrations that start with a certain name prefix, specify that name prefix here. To limit the results to integrations of a certain type, specify that type here. To limit the results to integrations with a certain status, specify that status here. An array, where each object in the array contains information about one CloudWatch Logs integration in this account. This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service. To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default
+ * encryption method, specify the ARN of the KMS key that you want to use. Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service
+ * collection to be able to create the dashboards. For more information about the permissions needed, see Create an IAM role to access the OpenSearch Service collection in the CloudWatch Logs User Guide. Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards. In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardsAccess
+ * IAM policy. For more information, see If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you
+ * omit this, a new application will be created. Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to.
+ * This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs. This structure contains configuration details about an integration between CloudWatch Logs and another entity. This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service. A name for the integration. A structure that contains configuration information for the integration that you are creating. The type of integration. Currently, the only supported type is The name of the integration that you just created. The status of the integration that you just created. After you create an integration, it takes a few minutes to complete. During this time, you'll see the status as Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports,
+ * see Supported query languages. A name for the query definition. If you are saving numerous query definitions, we
* recommend that you name them. This way, you can find the ones you want by using the first part
@@ -6104,8 +6775,9 @@ export interface PutQueryDefinitionRequest {
queryDefinitionId?: string | undefined;
/**
- * Use this parameter to include specific log groups as part of your query definition. If you are updating a query definition and you omit this parameter, then the updated
+ * Use this parameter to include specific log groups as part of your query definition. If your query
+ * uses the OpenSearch Service query language, you specify the log group names inside the If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated
* definition will contain no log groups. Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports,
+ * see Supported query languages. The log group on which to perform the query. A The list of log groups to be queried. You can include up to 50 log groups. A If you specify an ARN, use the format
* arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end. A OPENSEARCH.results value is an array of arrays. Each log event is one object in the
@@ -5068,6 +5549,31 @@ export interface InputLogEvent {
message: string | undefined;
}
+/**
+ * OPENSEARCH.expectedSequenceToken field in the InvalidSequenceTokenException
@@ -5162,6 +5668,40 @@ export interface ListAnomaliesResponse {
nextToken?: string | undefined;
}
+/**
+ * @public
+ */
+export interface ListIntegrationsRequest {
+ /**
+ * OPENSEARCH.PROVISIONING.querystring instead of here.StartQuery operation must include exactly one of the following
+ * parameters: logGroupName, logGroupNames, or
+ * logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query
+ * language, where you specify the log group names inside the querystring instead of here.StartQuery operation must include exactly one of the following
+ * parameters: logGroupName, logGroupNames, or
+ * logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query
+ * language, where you specify the log group names inside the querystring instead of here.StartQuery operation must include exactly one of the following parameters:
- * logGroupName, logGroupNames, or logGroupIdentifiers. logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query
+ * language, where you specify the log group names inside the querystring instead of here.
Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, \n you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by \n setting force to true, \n all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them \n will no longer be accessible.
The name of the integration to delete. To find the name of your integration, use \n ListIntegrations.
", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.cloudwatchlogs#Force", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specify true to force the deletion of the integration even if vended logs dashboards currently exist.
The default is false.
Limits the returned queries to only the queries that use the specified query language.
" + } } }, "traits": { @@ -3488,6 +3564,12 @@ "com.amazonaws.cloudwatchlogs#DescribeQueryDefinitionsRequest": { "type": "structure", "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "The query language used for this query. For more information about the query languages that CloudWatch Logs supports, \n see Supported query languages.
" + } + }, "queryDefinitionNamePrefix": { "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", "traits": { @@ -4565,6 +4647,12 @@ } } }, + "com.amazonaws.cloudwatchlogs#Force": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.cloudwatchlogs#ForceUpdate": { "type": "boolean" }, @@ -4870,6 +4958,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#GetIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about one integration between CloudWatch Logs and OpenSearch Service.
" + } + }, + "com.amazonaws.cloudwatchlogs#GetIntegrationRequest": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "The name of the integration that you want to find information about. To find the name of your integration, use \n ListIntegrations\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetIntegrationResponse": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "The name of the integration.
" + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH.
The current status of this integration.
" + } + }, + "integrationDetails": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationDetails", + "traits": { + "smithy.api#documentation": "A structure that contains information about the integration configuration. For an integration \n with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace, \n and policies.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector": { "type": "operation", "input": { @@ -5276,6 +5434,12 @@ "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { "type": "structure", "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "The query language used for this query. For more information about the query languages that CloudWatch Logs supports, \n see Supported query languages.
" + } + }, "results": { "target": "com.amazonaws.cloudwatchlogs#QueryResults", "traits": { @@ -5558,6 +5722,114 @@ "smithy.api#default": 0 } }, + "com.amazonaws.cloudwatchlogs#IntegrationDetails": { + "type": "union", + "members": { + "openSearchIntegrationDetails": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchIntegrationDetails", + "traits": { + "smithy.api#documentation": "This structure contains complete information about one integration between CloudWatch Logs and\n OpenSearch Service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the integration configuration. For an integration \n with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace, \n and policies.
\nThis structure\n is returned by a GetIntegration operation.
" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationStatus": { + "type": "enum", + "members": { + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationSummary" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationSummary": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "The name of this integration.
" + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH.
The current status of this integration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about one CloudWatch Logs integration. This structure\n is returned by a ListIntegrations operation.
" + } + }, + "com.amazonaws.cloudwatchlogs#IntegrationType": { + "type": "enum", + "members": { + "OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSEARCH" + } + } + } + }, "com.amazonaws.cloudwatchlogs#Interleaved": { "type": "boolean" }, @@ -5741,6 +6013,66 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#ListIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#ListIntegrationsRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#ListIntegrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one\n integration can be created in an account, and this integration must be with OpenSearch Service.
" + } + }, + "com.amazonaws.cloudwatchlogs#ListIntegrationsRequest": { + "type": "structure", + "members": { + "integrationNamePrefix": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationNamePrefix", + "traits": { + "smithy.api#documentation": "To limit the results to integrations that start with a certain name prefix, specify that name prefix here.
" + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "To limit the results to integrations of a certain type, specify that type here.
" + } + }, + "integrationStatus": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatus", + "traits": { + "smithy.api#documentation": "To limit the results to integrations with a certain status, specify that status here.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#ListIntegrationsResponse": { + "type": "structure", + "members": { + "integrationSummaries": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationSummaries", + "traits": { + "smithy.api#documentation": "An array, where each object in the array contains information about one CloudWatch Logs integration in this account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors": { "type": "operation", "input": { @@ -6561,6 +6893,9 @@ { "target": "com.amazonaws.cloudwatchlogs#DeleteIndexPolicy" }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteIntegration" + }, { "target": "com.amazonaws.cloudwatchlogs#DeleteLogAnomalyDetector" }, @@ -6657,6 +6992,9 @@ { "target": "com.amazonaws.cloudwatchlogs#GetDeliverySource" }, + { + "target": "com.amazonaws.cloudwatchlogs#GetIntegration" + }, { "target": "com.amazonaws.cloudwatchlogs#GetLogAnomalyDetector" }, @@ -6678,6 +7016,9 @@ { "target": "com.amazonaws.cloudwatchlogs#ListAnomalies" }, + { + "target": "com.amazonaws.cloudwatchlogs#ListIntegrations" + }, { "target": "com.amazonaws.cloudwatchlogs#ListLogAnomalyDetectors" }, @@ -6714,6 +7055,9 @@ { "target": "com.amazonaws.cloudwatchlogs#PutIndexPolicy" }, + { + "target": "com.amazonaws.cloudwatchlogs#PutIntegration" + }, { "target": "com.amazonaws.cloudwatchlogs#PutLogEvents" }, @@ -8132,17 +8476,395 @@ } } }, - "com.amazonaws.cloudwatchlogs#OperationAbortedException": { + "com.amazonaws.cloudwatchlogs#OpenSearchApplication": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.cloudwatchlogs#Message" - } - }, - "traits": { - "smithy.api#documentation": "Multiple concurrent requests to update the same resource were in conflict.
", - "smithy.api#error": "client" - } + "applicationEndpoint": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchApplicationEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint of the application.
" + } + }, + "applicationArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application.
" + } + }, + "applicationId": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service application used for this integration.\n An OpenSearch Service application is the web application created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchApplicationEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^https://[\\.\\-_/#:A-Za-z0-9]+\\.com$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchCollection": { + "type": "structure", + "members": { + "collectionEndpoint": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchCollectionEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint of the collection.
" + } + }, + "collectionArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the collection.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service collection used for this integration.\n An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. \n For more information, see Creating and managing OpenSearch Service Serverless collections.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchCollectionEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^https://[\\.\\-_/#:A-Za-z0-9]+\\.com$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchDataAccessPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "The name of the data access policy.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service data access policy used for this integration. The access \n policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup.\n For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchDataSource": { + "type": "structure", + "members": { + "dataSourceName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchDataSourceName", + "traits": { + "smithy.api#documentation": "The name of the OpenSearch Service data source.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service data source used for this integration. This data source was \n created as part of the integration setup.\n An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.
\nFor more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.\n
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchDataSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchEncryptionPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "The name of the encryption policy.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created\n automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.\n
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchIntegrationDetails": { + "type": "structure", + "members": { + "dataSource": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchDataSource", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service data source used for this integration. This data source was \n created as part of the integration setup.\n An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.
\nFor more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.\n
" + } + }, + "application": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchApplication", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service application used for this integration.\n An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.
" + } + }, + "collection": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchCollection", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service collection used for this integration. This collection was \n created as part of the integration setup.\n An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. \n For more information, see Creating and managing OpenSearch Service Serverless collections.
" + } + }, + "workspace": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchWorkspace", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service workspace used for this integration.\n An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup.\n For more information, see Centralized OpenSearch user interface (Dashboards) with \n OpenSearch Service.
" + } + }, + "encryptionPolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchEncryptionPolicy", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created\n automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.\n
" + } + }, + "networkPolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchNetworkPolicy", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service network policy used for this integration. The network \n policy assigns network access settings to collections. \n For more information, see Network policies in the OpenSearch Service Developer Guide.
" + } + }, + "accessPolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchDataAccessPolicy", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service data access policy used for this integration. The access \n policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup.\n For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.
" + } + }, + "lifecyclePolicy": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchLifecyclePolicy", + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy\n determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.
\nFor more information, see Using data lifecycle policies with OpenSearch Service Serverless \n in the OpenSearch Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains complete information about one CloudWatch Logs integration. This structure\n is returned by a GetIntegration operation.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchLifecyclePolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "The name of the lifecycle policy.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy\n determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.
\nFor more information, see Using data lifecycle policies with OpenSearch Service Serverless \n in the OpenSearch Service Developer Guide.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchNetworkPolicy": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName", + "traits": { + "smithy.api#documentation": "The name of the network policy.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of this OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service network policy used for this integration. The network \n policy assigns network access settings to collections. \n For more information, see Network policies in the OpenSearch Service Developer Guide.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchResourceConfig": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default \n encryption method, specify the ARN of the KMS key that you want to use.
" + } + }, + "dataSourceRoleArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service\n collection to be able to create the dashboards. For more information about the permissions needed, see Create an IAM role to access the OpenSearch Service collection in the CloudWatch Logs User Guide.
", + "smithy.api#required": {} + } + }, + "dashboardViewerPrincipals": { + "target": "com.amazonaws.cloudwatchlogs#DashboardViewerPrincipals", + "traits": { + "smithy.api#documentation": "Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.
\nIn addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardsAccess \n IAM policy. For more information, see
\nIf you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you \n omit this, a new application will be created.
" + } + }, + "retentionDays": { + "target": "com.amazonaws.cloudwatchlogs#CollectionRetentionDays", + "traits": { + "smithy.api#documentation": "Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. \n This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatusType", + "traits": { + "smithy.api#documentation": "The current status of this resource.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatusMessage", + "traits": { + "smithy.api#documentation": "A message with additional information about the status of this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the status of an OpenSearch Service resource.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatusType": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_FOUND" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchWorkspace": { + "type": "structure", + "members": { + "workspaceId": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchWorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of this workspace.
" + } + }, + "status": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceStatus", + "traits": { + "smithy.api#documentation": "This structure contains information about the status of an OpenSearch Service resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains information about the OpenSearch Service workspace used for this integration.\n An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup.\n For more information, see Centralized OpenSearch user interface (Dashboards) with \n OpenSearch Service.
" + } + }, + "com.amazonaws.cloudwatchlogs#OpenSearchWorkspaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.cloudwatchlogs#OperationAbortedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "Multiple concurrent requests to update the same resource were in conflict.
", + "smithy.api#error": "client" + } }, "com.amazonaws.cloudwatchlogs#OrderBy": { "type": "enum", @@ -9254,6 +9976,81 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#PutIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutIntegrationRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutIntegrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with \n OpenSearch Service are supported, and currently you can have only one integration in your account.
\nIntegrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered \n by OpenSearch Service analytics. For more information, see \n Vended log dashboards powered by Amazon OpenSearch Service.
\nYou can use this operation only to create a new integration. You can't modify an existing integration.
" + } + }, + "com.amazonaws.cloudwatchlogs#PutIntegrationRequest": { + "type": "structure", + "members": { + "integrationName": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationName", + "traits": { + "smithy.api#documentation": "A name for the integration.
", + "smithy.api#required": {} + } + }, + "resourceConfig": { + "target": "com.amazonaws.cloudwatchlogs#ResourceConfig", + "traits": { + "smithy.api#documentation": "A structure that contains configuration information for the integration that you are creating.
", + "smithy.api#required": {} + } + }, + "integrationType": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationType", + "traits": { + "smithy.api#documentation": "The type of integration. Currently, the only supported type is OPENSEARCH.
The name of the integration that you just created.
" + } + }, + "integrationStatus": { + "target": "com.amazonaws.cloudwatchlogs#IntegrationStatus", + "traits": { + "smithy.api#documentation": "The status of the integration that you just created.
\nAfter you create an integration, it takes a few minutes to complete. During this time, you'll see the status as PROVISIONING.
Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, \n see Supported query languages.
" + } + }, "name": { "target": "com.amazonaws.cloudwatchlogs#QueryDefinitionName", "traits": { @@ -9473,7 +10276,7 @@ "logGroupNames": { "target": "com.amazonaws.cloudwatchlogs#LogGroupNames", "traits": { - "smithy.api#documentation": "Use this parameter to include specific log groups as part of your query definition.
\nIf you are updating a query definition and you omit this parameter, then the updated\n definition will contain no log groups.
" + "smithy.api#documentation": "Use this parameter to include specific log groups as part of your query definition. If your query\n uses the OpenSearch Service query language, you specify the log group names inside the querystring instead of here.
If you are updating an existing query definition for the Logs Insights QL or OpenSearch Service PPL and you omit this parameter, then the updated\n definition will contain no log groups.
" } }, "queryString": { @@ -9800,6 +10603,12 @@ "com.amazonaws.cloudwatchlogs#QueryDefinition": { "type": "structure", "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "The query language used for this query. For more information about the query languages that CloudWatch Logs supports, \n see Supported query languages.
" + } + }, "queryDefinitionId": { "target": "com.amazonaws.cloudwatchlogs#QueryId", "traits": { @@ -9871,6 +10680,12 @@ "com.amazonaws.cloudwatchlogs#QueryInfo": { "type": "structure", "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "The query language used for this query. For more information about the query languages that CloudWatch Logs supports, \n see Supported query languages.
" + } + }, "queryId": { "target": "com.amazonaws.cloudwatchlogs#QueryId", "traits": { @@ -9912,6 +10727,29 @@ "target": "com.amazonaws.cloudwatchlogs#QueryInfo" } }, + "com.amazonaws.cloudwatchlogs#QueryLanguage": { + "type": "enum", + "members": { + "CWLI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CWLI" + } + }, + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" + } + }, + "PPL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PPL" + } + } + } + }, "com.amazonaws.cloudwatchlogs#QueryListMaxResults": { "type": "integer", "traits": { @@ -10207,6 +11045,20 @@ "target": "com.amazonaws.cloudwatchlogs#Arn" } }, + "com.amazonaws.cloudwatchlogs#ResourceConfig": { + "type": "union", + "members": { + "openSearchResourceConfig": { + "target": "com.amazonaws.cloudwatchlogs#OpenSearchResourceConfig", + "traits": { + "smithy.api#documentation": "This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This structure contains configuration details about an integration between CloudWatch Logs and another entity.
" + } + }, "com.amazonaws.cloudwatchlogs#ResourceIdentifier": { "type": "string", "traits": { @@ -10844,22 +11696,28 @@ "com.amazonaws.cloudwatchlogs#StartQueryRequest": { "type": "structure", "members": { + "queryLanguage": { + "target": "com.amazonaws.cloudwatchlogs#QueryLanguage", + "traits": { + "smithy.api#documentation": "Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, \n see Supported query languages.
" + } + }, "logGroupName": { "target": "com.amazonaws.cloudwatchlogs#LogGroupName", "traits": { - "smithy.api#documentation": "The log group on which to perform the query.
" + "smithy.api#documentation": "The log group on which to perform the query.
\nA StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query\n language, where you specify the log group names inside the querystring instead of here.
The list of log groups to be queried. You can include up to 50 log groups.
" + "smithy.api#documentation": "The list of log groups to be queried. You can include up to 50 log groups.
\nA StartQuery operation must include exactly one of the following\n parameters: logGroupName, logGroupNames, or\n logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query\n language, where you specify the log group names inside the querystring instead of here.
The list of log groups to query. You can include up to 50 log groups.
\nYou can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.
\nIf you specify an ARN, use the format\n arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.
\nA StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers.
The list of log groups to query. You can include up to 50 log groups.
\nYou can specify them by the log group name or ARN. If a log group that you're querying is\n in a source account and you're using a monitoring account, you must specify the ARN of the log\n group here. The query definition must also be defined in the monitoring account.
\nIf you specify an ARN, use the format\n arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.
\nA StartQuery operation must include exactly one of the following parameters:\n logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query\n language, where you specify the log group names inside the querystring instead of here.