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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/index.js +192 -0
  3. package/dist-es/CloudWatchLogs.js +8 -0
  4. package/dist-es/commands/DeleteIntegrationCommand.js +22 -0
  5. package/dist-es/commands/GetIntegrationCommand.js +22 -0
  6. package/dist-es/commands/ListIntegrationsCommand.js +22 -0
  7. package/dist-es/commands/PutIntegrationCommand.js +22 -0
  8. package/dist-es/commands/index.js +4 -0
  9. package/dist-es/models/models_0.js +34 -0
  10. package/dist-es/protocols/Aws_json1_1.js +78 -0
  11. package/dist-types/CloudWatchLogs.d.ts +29 -0
  12. package/dist-types/CloudWatchLogsClient.d.ts +6 -2
  13. package/dist-types/commands/DeleteIntegrationCommand.d.ts +86 -0
  14. package/dist-types/commands/DescribeQueriesCommand.d.ts +2 -0
  15. package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +2 -0
  16. package/dist-types/commands/GetIntegrationCommand.d.ts +136 -0
  17. package/dist-types/commands/GetQueryResultsCommand.d.ts +1 -0
  18. package/dist-types/commands/ListIntegrationsCommand.d.ts +86 -0
  19. package/dist-types/commands/PutIntegrationCommand.d.ts +101 -0
  20. package/dist-types/commands/PutQueryDefinitionCommand.d.ts +1 -0
  21. package/dist-types/commands/StartQueryCommand.d.ts +1 -0
  22. package/dist-types/commands/index.d.ts +4 -0
  23. package/dist-types/models/models_0.d.ts +606 -3
  24. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  25. package/dist-types/ts3.4/CloudWatchLogs.d.ts +69 -0
  26. package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +24 -0
  27. package/dist-types/ts3.4/commands/DeleteIntegrationCommand.d.ts +51 -0
  28. package/dist-types/ts3.4/commands/GetIntegrationCommand.d.ts +50 -0
  29. package/dist-types/ts3.4/commands/ListIntegrationsCommand.d.ts +50 -0
  30. package/dist-types/ts3.4/commands/PutIntegrationCommand.d.ts +50 -0
  31. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  32. package/dist-types/ts3.4/models/models_0.d.ts +160 -0
  33. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
  34. package/package.json +4 -4
@@ -1295,6 +1295,28 @@ export interface DeleteIndexPolicyRequest {
1295
1295
  */
1296
1296
  export interface DeleteIndexPolicyResponse {
1297
1297
  }
1298
+ /**
1299
+ * @public
1300
+ */
1301
+ export interface DeleteIntegrationRequest {
1302
+ /**
1303
+ * <p>The name of the integration to delete. To find the name of your integration, use
1304
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html">ListIntegrations</a>.</p>
1305
+ * @public
1306
+ */
1307
+ integrationName: string | undefined;
1308
+ /**
1309
+ * <p>Specify <code>true</code> to force the deletion of the integration even if vended logs dashboards currently exist.</p>
1310
+ * <p>The default is <code>false</code>.</p>
1311
+ * @public
1312
+ */
1313
+ force?: boolean | undefined;
1314
+ }
1315
+ /**
1316
+ * @public
1317
+ */
1318
+ export interface DeleteIntegrationResponse {
1319
+ }
1298
1320
  /**
1299
1321
  * <p>This processor deletes entries from a log event. These entries are key-value pairs. </p>
1300
1322
  * <p>For more information about this processor including examples, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-deleteKeys">
@@ -2678,6 +2700,19 @@ export interface DescribeMetricFiltersResponse {
2678
2700
  */
2679
2701
  nextToken?: string | undefined;
2680
2702
  }
2703
+ /**
2704
+ * @public
2705
+ * @enum
2706
+ */
2707
+ export declare const QueryLanguage: {
2708
+ readonly CWLI: "CWLI";
2709
+ readonly PPL: "PPL";
2710
+ readonly SQL: "SQL";
2711
+ };
2712
+ /**
2713
+ * @public
2714
+ */
2715
+ export type QueryLanguage = (typeof QueryLanguage)[keyof typeof QueryLanguage];
2681
2716
  /**
2682
2717
  * @public
2683
2718
  * @enum
@@ -2720,12 +2755,23 @@ export interface DescribeQueriesRequest {
2720
2755
  * @public
2721
2756
  */
2722
2757
  nextToken?: string | undefined;
2758
+ /**
2759
+ * <p>Limits the returned queries to only the queries that use the specified query language.</p>
2760
+ * @public
2761
+ */
2762
+ queryLanguage?: QueryLanguage | undefined;
2723
2763
  }
2724
2764
  /**
2725
2765
  * <p>Information about one CloudWatch Logs Insights query that matches the request in a <code>DescribeQueries</code> operation. </p>
2726
2766
  * @public
2727
2767
  */
2728
2768
  export interface QueryInfo {
2769
+ /**
2770
+ * <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
2771
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
2772
+ * @public
2773
+ */
2774
+ queryLanguage?: QueryLanguage | undefined;
2729
2775
  /**
2730
2776
  * <p>The unique ID number of this query.</p>
2731
2777
  * @public
@@ -2772,6 +2818,12 @@ export interface DescribeQueriesResponse {
2772
2818
  * @public
2773
2819
  */
2774
2820
  export interface DescribeQueryDefinitionsRequest {
2821
+ /**
2822
+ * <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
2823
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
2824
+ * @public
2825
+ */
2826
+ queryLanguage?: QueryLanguage | undefined;
2775
2827
  /**
2776
2828
  * <p>Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.</p>
2777
2829
  * @public
@@ -2793,6 +2845,12 @@ export interface DescribeQueryDefinitionsRequest {
2793
2845
  * @public
2794
2846
  */
2795
2847
  export interface QueryDefinition {
2848
+ /**
2849
+ * <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
2850
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
2851
+ * @public
2852
+ */
2853
+ queryLanguage?: QueryLanguage | undefined;
2796
2854
  /**
2797
2855
  * <p>The unique ID of the query definition.</p>
2798
2856
  * @public
@@ -3379,6 +3437,362 @@ export interface GetDeliverySourceResponse {
3379
3437
  */
3380
3438
  deliverySource?: DeliverySource | undefined;
3381
3439
  }
3440
+ /**
3441
+ * @public
3442
+ */
3443
+ export interface GetIntegrationRequest {
3444
+ /**
3445
+ * <p>The name of the integration that you want to find information about. To find the name of your integration, use
3446
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html">ListIntegrations</a>
3447
+ * </p>
3448
+ * @public
3449
+ */
3450
+ integrationName: string | undefined;
3451
+ }
3452
+ /**
3453
+ * @public
3454
+ * @enum
3455
+ */
3456
+ export declare const OpenSearchResourceStatusType: {
3457
+ readonly ACTIVE: "ACTIVE";
3458
+ readonly ERROR: "ERROR";
3459
+ readonly NOT_FOUND: "NOT_FOUND";
3460
+ };
3461
+ /**
3462
+ * @public
3463
+ */
3464
+ export type OpenSearchResourceStatusType = (typeof OpenSearchResourceStatusType)[keyof typeof OpenSearchResourceStatusType];
3465
+ /**
3466
+ * <p>This structure contains information about the status of an OpenSearch Service resource.</p>
3467
+ * @public
3468
+ */
3469
+ export interface OpenSearchResourceStatus {
3470
+ /**
3471
+ * <p>The current status of this resource.</p>
3472
+ * @public
3473
+ */
3474
+ status?: OpenSearchResourceStatusType | undefined;
3475
+ /**
3476
+ * <p>A message with additional information about the status of this resource.</p>
3477
+ * @public
3478
+ */
3479
+ statusMessage?: string | undefined;
3480
+ }
3481
+ /**
3482
+ * <p>This structure contains information about the OpenSearch Service data access policy used for this integration. The access
3483
+ * policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup.
3484
+ * For more information about OpenSearch Service data access policies, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a> in the OpenSearch Service Developer Guide.</p>
3485
+ * @public
3486
+ */
3487
+ export interface OpenSearchDataAccessPolicy {
3488
+ /**
3489
+ * <p>The name of the data access policy.</p>
3490
+ * @public
3491
+ */
3492
+ policyName?: string | undefined;
3493
+ /**
3494
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3495
+ * @public
3496
+ */
3497
+ status?: OpenSearchResourceStatus | undefined;
3498
+ }
3499
+ /**
3500
+ * <p>This structure contains information about the OpenSearch Service application used for this integration.
3501
+ * An OpenSearch Service application is the web application created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.</p>
3502
+ * @public
3503
+ */
3504
+ export interface OpenSearchApplication {
3505
+ /**
3506
+ * <p>The endpoint of the application.</p>
3507
+ * @public
3508
+ */
3509
+ applicationEndpoint?: string | undefined;
3510
+ /**
3511
+ * <p>The Amazon Resource Name (ARN) of the application.</p>
3512
+ * @public
3513
+ */
3514
+ applicationArn?: string | undefined;
3515
+ /**
3516
+ * <p>The ID of the application.</p>
3517
+ * @public
3518
+ */
3519
+ applicationId?: string | undefined;
3520
+ /**
3521
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3522
+ * @public
3523
+ */
3524
+ status?: OpenSearchResourceStatus | undefined;
3525
+ }
3526
+ /**
3527
+ * <p>This structure contains information about the OpenSearch Service collection used for this integration.
3528
+ * An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload.
3529
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-collections.html">Creating and managing OpenSearch Service Serverless collections</a>.</p>
3530
+ * @public
3531
+ */
3532
+ export interface OpenSearchCollection {
3533
+ /**
3534
+ * <p>The endpoint of the collection.</p>
3535
+ * @public
3536
+ */
3537
+ collectionEndpoint?: string | undefined;
3538
+ /**
3539
+ * <p>The ARN of the collection.</p>
3540
+ * @public
3541
+ */
3542
+ collectionArn?: string | undefined;
3543
+ /**
3544
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3545
+ * @public
3546
+ */
3547
+ status?: OpenSearchResourceStatus | undefined;
3548
+ }
3549
+ /**
3550
+ * <p>This structure contains information about the OpenSearch Service data source used for this integration. This data source was
3551
+ * created as part of the integration setup.
3552
+ * 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.</p>
3553
+ * <p>For more information about OpenSearch Service data sources , see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Creating OpenSearch Service data source integrations with Amazon S3.</a>
3554
+ * </p>
3555
+ * @public
3556
+ */
3557
+ export interface OpenSearchDataSource {
3558
+ /**
3559
+ * <p>The name of the OpenSearch Service data source.</p>
3560
+ * @public
3561
+ */
3562
+ dataSourceName?: string | undefined;
3563
+ /**
3564
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3565
+ * @public
3566
+ */
3567
+ status?: OpenSearchResourceStatus | undefined;
3568
+ }
3569
+ /**
3570
+ * <p>This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created
3571
+ * automatically when you created the integration. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html#serverless-encryption-policies">Encryption policies</a> in the OpenSearch Service Developer Guide.
3572
+ * </p>
3573
+ * @public
3574
+ */
3575
+ export interface OpenSearchEncryptionPolicy {
3576
+ /**
3577
+ * <p>The name of the encryption policy.</p>
3578
+ * @public
3579
+ */
3580
+ policyName?: string | undefined;
3581
+ /**
3582
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3583
+ * @public
3584
+ */
3585
+ status?: OpenSearchResourceStatus | undefined;
3586
+ }
3587
+ /**
3588
+ * <p>This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy
3589
+ * determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.</p>
3590
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html">Using data lifecycle policies with OpenSearch Service Serverless</a>
3591
+ * in the OpenSearch Service Developer Guide.</p>
3592
+ * @public
3593
+ */
3594
+ export interface OpenSearchLifecyclePolicy {
3595
+ /**
3596
+ * <p>The name of the lifecycle policy.</p>
3597
+ * @public
3598
+ */
3599
+ policyName?: string | undefined;
3600
+ /**
3601
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3602
+ * @public
3603
+ */
3604
+ status?: OpenSearchResourceStatus | undefined;
3605
+ }
3606
+ /**
3607
+ * <p>This structure contains information about the OpenSearch Service network policy used for this integration. The network
3608
+ * policy assigns network access settings to collections.
3609
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html#serverless-network-policies">Network policies</a> in the OpenSearch Service Developer Guide.</p>
3610
+ * @public
3611
+ */
3612
+ export interface OpenSearchNetworkPolicy {
3613
+ /**
3614
+ * <p>The name of the network policy.</p>
3615
+ * @public
3616
+ */
3617
+ policyName?: string | undefined;
3618
+ /**
3619
+ * <p>This structure contains information about the status of this OpenSearch Service resource.</p>
3620
+ * @public
3621
+ */
3622
+ status?: OpenSearchResourceStatus | undefined;
3623
+ }
3624
+ /**
3625
+ * <p>This structure contains information about the OpenSearch Service workspace used for this integration.
3626
+ * 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.
3627
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Centralized OpenSearch user interface (Dashboards) with
3628
+ * OpenSearch Service</a>.</p>
3629
+ * @public
3630
+ */
3631
+ export interface OpenSearchWorkspace {
3632
+ /**
3633
+ * <p>The ID of this workspace.</p>
3634
+ * @public
3635
+ */
3636
+ workspaceId?: string | undefined;
3637
+ /**
3638
+ * <p>This structure contains information about the status of an OpenSearch Service resource.</p>
3639
+ * @public
3640
+ */
3641
+ status?: OpenSearchResourceStatus | undefined;
3642
+ }
3643
+ /**
3644
+ * <p>This structure contains complete information about one CloudWatch Logs integration. This structure
3645
+ * is returned by a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetIntegration.html">GetIntegration</a> operation.</p>
3646
+ * @public
3647
+ */
3648
+ export interface OpenSearchIntegrationDetails {
3649
+ /**
3650
+ * <p>This structure contains information about the OpenSearch Service data source used for this integration. This data source was
3651
+ * created as part of the integration setup.
3652
+ * 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.</p>
3653
+ * <p>For more information about OpenSearch Service data sources , see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html">Creating OpenSearch Service data source integrations with Amazon S3.</a>
3654
+ * </p>
3655
+ * @public
3656
+ */
3657
+ dataSource?: OpenSearchDataSource | undefined;
3658
+ /**
3659
+ * <p>This structure contains information about the OpenSearch Service application used for this integration.
3660
+ * An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.</p>
3661
+ * @public
3662
+ */
3663
+ application?: OpenSearchApplication | undefined;
3664
+ /**
3665
+ * <p>This structure contains information about the OpenSearch Service collection used for this integration. This collection was
3666
+ * created as part of the integration setup.
3667
+ * An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload.
3668
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-collections.html">Creating and managing OpenSearch Service Serverless collections</a>.</p>
3669
+ * @public
3670
+ */
3671
+ collection?: OpenSearchCollection | undefined;
3672
+ /**
3673
+ * <p>This structure contains information about the OpenSearch Service workspace used for this integration.
3674
+ * 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.
3675
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Centralized OpenSearch user interface (Dashboards) with
3676
+ * OpenSearch Service</a>.</p>
3677
+ * @public
3678
+ */
3679
+ workspace?: OpenSearchWorkspace | undefined;
3680
+ /**
3681
+ * <p>This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created
3682
+ * automatically when you created the integration. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html#serverless-encryption-policies">Encryption policies</a> in the OpenSearch Service Developer Guide.
3683
+ * </p>
3684
+ * @public
3685
+ */
3686
+ encryptionPolicy?: OpenSearchEncryptionPolicy | undefined;
3687
+ /**
3688
+ * <p>This structure contains information about the OpenSearch Service network policy used for this integration. The network
3689
+ * policy assigns network access settings to collections.
3690
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html#serverless-network-policies">Network policies</a> in the OpenSearch Service Developer Guide.</p>
3691
+ * @public
3692
+ */
3693
+ networkPolicy?: OpenSearchNetworkPolicy | undefined;
3694
+ /**
3695
+ * <p>This structure contains information about the OpenSearch Service data access policy used for this integration. The access
3696
+ * policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup.
3697
+ * For more information about OpenSearch Service data access policies, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a> in the OpenSearch Service Developer Guide.</p>
3698
+ * @public
3699
+ */
3700
+ accessPolicy?: OpenSearchDataAccessPolicy | undefined;
3701
+ /**
3702
+ * <p>This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy
3703
+ * determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.</p>
3704
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html">Using data lifecycle policies with OpenSearch Service Serverless</a>
3705
+ * in the OpenSearch Service Developer Guide.</p>
3706
+ * @public
3707
+ */
3708
+ lifecyclePolicy?: OpenSearchLifecyclePolicy | undefined;
3709
+ }
3710
+ /**
3711
+ * <p>This structure contains information about the integration configuration. For an integration
3712
+ * with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace,
3713
+ * and policies.</p>
3714
+ * <p>This structure
3715
+ * is returned by a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetIntegration.html">GetIntegration</a> operation.</p>
3716
+ * @public
3717
+ */
3718
+ export type IntegrationDetails = IntegrationDetails.OpenSearchIntegrationDetailsMember | IntegrationDetails.$UnknownMember;
3719
+ /**
3720
+ * @public
3721
+ */
3722
+ export declare namespace IntegrationDetails {
3723
+ /**
3724
+ * <p>This structure contains complete information about one integration between CloudWatch Logs and
3725
+ * OpenSearch Service.</p>
3726
+ * @public
3727
+ */
3728
+ interface OpenSearchIntegrationDetailsMember {
3729
+ openSearchIntegrationDetails: OpenSearchIntegrationDetails;
3730
+ $unknown?: never;
3731
+ }
3732
+ /**
3733
+ * @public
3734
+ */
3735
+ interface $UnknownMember {
3736
+ openSearchIntegrationDetails?: never;
3737
+ $unknown: [string, any];
3738
+ }
3739
+ interface Visitor<T> {
3740
+ openSearchIntegrationDetails: (value: OpenSearchIntegrationDetails) => T;
3741
+ _: (name: string, value: any) => T;
3742
+ }
3743
+ const visit: <T>(value: IntegrationDetails, visitor: Visitor<T>) => T;
3744
+ }
3745
+ /**
3746
+ * @public
3747
+ * @enum
3748
+ */
3749
+ export declare const IntegrationStatus: {
3750
+ readonly ACTIVE: "ACTIVE";
3751
+ readonly FAILED: "FAILED";
3752
+ readonly PROVISIONING: "PROVISIONING";
3753
+ };
3754
+ /**
3755
+ * @public
3756
+ */
3757
+ export type IntegrationStatus = (typeof IntegrationStatus)[keyof typeof IntegrationStatus];
3758
+ /**
3759
+ * @public
3760
+ * @enum
3761
+ */
3762
+ export declare const IntegrationType: {
3763
+ readonly OPENSEARCH: "OPENSEARCH";
3764
+ };
3765
+ /**
3766
+ * @public
3767
+ */
3768
+ export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationType];
3769
+ /**
3770
+ * @public
3771
+ */
3772
+ export interface GetIntegrationResponse {
3773
+ /**
3774
+ * <p>The name of the integration.</p>
3775
+ * @public
3776
+ */
3777
+ integrationName?: string | undefined;
3778
+ /**
3779
+ * <p>The type of integration. Integrations with OpenSearch Service have the type <code>OPENSEARCH</code>.</p>
3780
+ * @public
3781
+ */
3782
+ integrationType?: IntegrationType | undefined;
3783
+ /**
3784
+ * <p>The current status of this integration.</p>
3785
+ * @public
3786
+ */
3787
+ integrationStatus?: IntegrationStatus | undefined;
3788
+ /**
3789
+ * <p>A structure that contains information about the integration configuration. For an integration
3790
+ * with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace,
3791
+ * and policies.</p>
3792
+ * @public
3793
+ */
3794
+ integrationDetails?: IntegrationDetails | undefined;
3795
+ }
3382
3796
  /**
3383
3797
  * @public
3384
3798
  */
@@ -3749,6 +4163,12 @@ export interface QueryStatistics {
3749
4163
  * @public
3750
4164
  */
3751
4165
  export interface GetQueryResultsResponse {
4166
+ /**
4167
+ * <p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports,
4168
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
4169
+ * @public
4170
+ */
4171
+ queryLanguage?: QueryLanguage | undefined;
3752
4172
  /**
3753
4173
  * <p>The log events that matched the query criteria during the most recent time it ran.</p>
3754
4174
  * <p>The <code>results</code> value is an array of arrays. Each log event is one object in the
@@ -4435,6 +4855,28 @@ export interface InputLogEvent {
4435
4855
  */
4436
4856
  message: string | undefined;
4437
4857
  }
4858
+ /**
4859
+ * <p>This structure contains information about one CloudWatch Logs integration. This structure
4860
+ * is returned by a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html">ListIntegrations</a> operation.</p>
4861
+ * @public
4862
+ */
4863
+ export interface IntegrationSummary {
4864
+ /**
4865
+ * <p>The name of this integration.</p>
4866
+ * @public
4867
+ */
4868
+ integrationName?: string | undefined;
4869
+ /**
4870
+ * <p>The type of integration. Integrations with OpenSearch Service have the type <code>OPENSEARCH</code>.</p>
4871
+ * @public
4872
+ */
4873
+ integrationType?: IntegrationType | undefined;
4874
+ /**
4875
+ * <p>The current status of this integration.</p>
4876
+ * @public
4877
+ */
4878
+ integrationStatus?: IntegrationStatus | undefined;
4879
+ }
4438
4880
  /**
4439
4881
  * <p>The sequence token is not valid. You can get the correct sequence token in
4440
4882
  * the <code>expectedSequenceToken</code> field in the <code>InvalidSequenceTokenException</code>
@@ -4512,6 +4954,36 @@ export interface ListAnomaliesResponse {
4512
4954
  */
4513
4955
  nextToken?: string | undefined;
4514
4956
  }
4957
+ /**
4958
+ * @public
4959
+ */
4960
+ export interface ListIntegrationsRequest {
4961
+ /**
4962
+ * <p>To limit the results to integrations that start with a certain name prefix, specify that name prefix here.</p>
4963
+ * @public
4964
+ */
4965
+ integrationNamePrefix?: string | undefined;
4966
+ /**
4967
+ * <p>To limit the results to integrations of a certain type, specify that type here.</p>
4968
+ * @public
4969
+ */
4970
+ integrationType?: IntegrationType | undefined;
4971
+ /**
4972
+ * <p>To limit the results to integrations with a certain status, specify that status here.</p>
4973
+ * @public
4974
+ */
4975
+ integrationStatus?: IntegrationStatus | undefined;
4976
+ }
4977
+ /**
4978
+ * @public
4979
+ */
4980
+ export interface ListIntegrationsResponse {
4981
+ /**
4982
+ * <p>An array, where each object in the array contains information about one CloudWatch Logs integration in this account. </p>
4983
+ * @public
4984
+ */
4985
+ integrationSummaries?: IntegrationSummary[] | undefined;
4986
+ }
4515
4987
  /**
4516
4988
  * @public
4517
4989
  */
@@ -5192,6 +5664,111 @@ export interface PutIndexPolicyResponse {
5192
5664
  */
5193
5665
  indexPolicy?: IndexPolicy | undefined;
5194
5666
  }
5667
+ /**
5668
+ * <p>This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.</p>
5669
+ * @public
5670
+ */
5671
+ export interface OpenSearchResourceConfig {
5672
+ /**
5673
+ * <p>To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default
5674
+ * encryption method, specify the ARN of the KMS key that you want to use.</p>
5675
+ * @public
5676
+ */
5677
+ kmsKeyArn?: string | undefined;
5678
+ /**
5679
+ * <p>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
5680
+ * collection to be able to create the dashboards. For more information about the permissions needed, see <a href="https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole">Create an IAM role to access the OpenSearch Service collection</a> in the CloudWatch Logs User Guide.</p>
5681
+ * @public
5682
+ */
5683
+ dataSourceRoleArn: string | undefined;
5684
+ /**
5685
+ * <p>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</p>
5686
+ * <important>
5687
+ * <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardsAccess</b>
5688
+ * IAM policy. For more information, see </p>
5689
+ * </important>
5690
+ * @public
5691
+ */
5692
+ dashboardViewerPrincipals: string[] | undefined;
5693
+ /**
5694
+ * <p>If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you
5695
+ * omit this, a new application will be created.</p>
5696
+ * @public
5697
+ */
5698
+ applicationArn?: string | undefined;
5699
+ /**
5700
+ * <p>Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to.
5701
+ * 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. </p>
5702
+ * @public
5703
+ */
5704
+ retentionDays: number | undefined;
5705
+ }
5706
+ /**
5707
+ * <p>This structure contains configuration details about an integration between CloudWatch Logs and another entity.</p>
5708
+ * @public
5709
+ */
5710
+ export type ResourceConfig = ResourceConfig.OpenSearchResourceConfigMember | ResourceConfig.$UnknownMember;
5711
+ /**
5712
+ * @public
5713
+ */
5714
+ export declare namespace ResourceConfig {
5715
+ /**
5716
+ * <p>This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.</p>
5717
+ * @public
5718
+ */
5719
+ interface OpenSearchResourceConfigMember {
5720
+ openSearchResourceConfig: OpenSearchResourceConfig;
5721
+ $unknown?: never;
5722
+ }
5723
+ /**
5724
+ * @public
5725
+ */
5726
+ interface $UnknownMember {
5727
+ openSearchResourceConfig?: never;
5728
+ $unknown: [string, any];
5729
+ }
5730
+ interface Visitor<T> {
5731
+ openSearchResourceConfig: (value: OpenSearchResourceConfig) => T;
5732
+ _: (name: string, value: any) => T;
5733
+ }
5734
+ const visit: <T>(value: ResourceConfig, visitor: Visitor<T>) => T;
5735
+ }
5736
+ /**
5737
+ * @public
5738
+ */
5739
+ export interface PutIntegrationRequest {
5740
+ /**
5741
+ * <p>A name for the integration.</p>
5742
+ * @public
5743
+ */
5744
+ integrationName: string | undefined;
5745
+ /**
5746
+ * <p>A structure that contains configuration information for the integration that you are creating.</p>
5747
+ * @public
5748
+ */
5749
+ resourceConfig: ResourceConfig | undefined;
5750
+ /**
5751
+ * <p>The type of integration. Currently, the only supported type is <code>OPENSEARCH</code>.</p>
5752
+ * @public
5753
+ */
5754
+ integrationType: IntegrationType | undefined;
5755
+ }
5756
+ /**
5757
+ * @public
5758
+ */
5759
+ export interface PutIntegrationResponse {
5760
+ /**
5761
+ * <p>The name of the integration that you just created.</p>
5762
+ * @public
5763
+ */
5764
+ integrationName?: string | undefined;
5765
+ /**
5766
+ * <p>The status of the integration that you just created.</p>
5767
+ * <p>After you create an integration, it takes a few minutes to complete. During this time, you'll see the status as <code>PROVISIONING</code>.</p>
5768
+ * @public
5769
+ */
5770
+ integrationStatus?: IntegrationStatus | undefined;
5771
+ }
5195
5772
  /**
5196
5773
  * @public
5197
5774
  */
@@ -5346,6 +5923,12 @@ export interface PutMetricFilterRequest {
5346
5923
  * @public
5347
5924
  */
5348
5925
  export interface PutQueryDefinitionRequest {
5926
+ /**
5927
+ * <p>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,
5928
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
5929
+ * @public
5930
+ */
5931
+ queryLanguage?: QueryLanguage | undefined;
5349
5932
  /**
5350
5933
  * <p>A name for the query definition. If you are saving numerous query definitions, we
5351
5934
  * recommend that you name them. This way, you can find the ones you want by using the first part
@@ -5364,8 +5947,9 @@ export interface PutQueryDefinitionRequest {
5364
5947
  */
5365
5948
  queryDefinitionId?: string | undefined;
5366
5949
  /**
5367
- * <p>Use this parameter to include specific log groups as part of your query definition.</p>
5368
- * <p>If you are updating a query definition and you omit this parameter, then the updated
5950
+ * <p>Use this parameter to include specific log groups as part of your query definition. If your query
5951
+ * uses the OpenSearch Service query language, you specify the log group names inside the <code>querystring</code> instead of here.</p>
5952
+ * <p>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
5369
5953
  * definition will contain no log groups.</p>
5370
5954
  * @public
5371
5955
  */
@@ -5775,13 +6359,31 @@ export declare class MalformedQueryException extends __BaseException {
5775
6359
  * @public
5776
6360
  */
5777
6361
  export interface StartQueryRequest {
6362
+ /**
6363
+ * <p>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,
6364
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>
6365
+ * @public
6366
+ */
6367
+ queryLanguage?: QueryLanguage | undefined;
5778
6368
  /**
5779
6369
  * <p>The log group on which to perform the query.</p>
6370
+ * <note>
6371
+ * <p>A <code>StartQuery</code> operation must include exactly one of the following
6372
+ * parameters: <code>logGroupName</code>, <code>logGroupNames</code>, or
6373
+ * <code>logGroupIdentifiers</code>. The exception is queries using the OpenSearch Service SQL query
6374
+ * language, where you specify the log group names inside the <code>querystring</code> instead of here.</p>
6375
+ * </note>
5780
6376
  * @public
5781
6377
  */
5782
6378
  logGroupName?: string | undefined;
5783
6379
  /**
5784
6380
  * <p>The list of log groups to be queried. You can include up to 50 log groups.</p>
6381
+ * <note>
6382
+ * <p>A <code>StartQuery</code> operation must include exactly one of the following
6383
+ * parameters: <code>logGroupName</code>, <code>logGroupNames</code>, or
6384
+ * <code>logGroupIdentifiers</code>. The exception is queries using the OpenSearch Service SQL query
6385
+ * language, where you specify the log group names inside the <code>querystring</code> instead of here.</p>
6386
+ * </note>
5785
6387
  * @public
5786
6388
  */
5787
6389
  logGroupNames?: string[] | undefined;
@@ -5793,7 +6395,8 @@ export interface StartQueryRequest {
5793
6395
  * <p>If you specify an ARN, use the format
5794
6396
  * arn:aws:logs:<i>region</i>:<i>account-id</i>:log-group:<i>log_group_name</i> Don't include an * at the end.</p>
5795
6397
  * <p>A <code>StartQuery</code> operation must include exactly one of the following parameters:
5796
- * <code>logGroupName</code>, <code>logGroupNames</code>, or <code>logGroupIdentifiers</code>. </p>
6398
+ * <code>logGroupName</code>, <code>logGroupNames</code>, or <code>logGroupIdentifiers</code>. The exception is queries using the OpenSearch Service SQL query
6399
+ * language, where you specify the log group names inside the <code>querystring</code> instead of here. </p>
5797
6400
  * @public
5798
6401
  */
5799
6402
  logGroupIdentifiers?: string[] | undefined;