aws-sdk-cloudwatchlogs 1.103.0 → 1.104.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatchlogs/client.rb +280 -4
- data/lib/aws-sdk-cloudwatchlogs/client_api.rb +200 -0
- data/lib/aws-sdk-cloudwatchlogs/types.rb +790 -4
- data/lib/aws-sdk-cloudwatchlogs.rb +1 -1
- data/sig/client.rbs +62 -1
- data/sig/types.rbs +161 -0
- metadata +2 -2
@@ -1146,6 +1146,35 @@ module Aws::CloudWatchLogs
|
|
1146
1146
|
#
|
1147
1147
|
class DeleteIndexPolicyResponse < Aws::EmptyStructure; end
|
1148
1148
|
|
1149
|
+
# @!attribute [rw] integration_name
|
1150
|
+
# The name of the integration to delete. To find the name of your
|
1151
|
+
# integration, use [ListIntegrations][1].
|
1152
|
+
#
|
1153
|
+
#
|
1154
|
+
#
|
1155
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] force
|
1159
|
+
# Specify `true` to force the deletion of the integration even if
|
1160
|
+
# vended logs dashboards currently exist.
|
1161
|
+
#
|
1162
|
+
# The default is `false`.
|
1163
|
+
# @return [Boolean]
|
1164
|
+
#
|
1165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteIntegrationRequest AWS API Documentation
|
1166
|
+
#
|
1167
|
+
class DeleteIntegrationRequest < Struct.new(
|
1168
|
+
:integration_name,
|
1169
|
+
:force)
|
1170
|
+
SENSITIVE = []
|
1171
|
+
include Aws::Structure
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DeleteIntegrationResponse AWS API Documentation
|
1175
|
+
#
|
1176
|
+
class DeleteIntegrationResponse < Aws::EmptyStructure; end
|
1177
|
+
|
1149
1178
|
# This processor deletes entries from a log event. These entries are
|
1150
1179
|
# key-value pairs.
|
1151
1180
|
#
|
@@ -2249,13 +2278,19 @@ module Aws::CloudWatchLogs
|
|
2249
2278
|
# after 24 hours.
|
2250
2279
|
# @return [String]
|
2251
2280
|
#
|
2281
|
+
# @!attribute [rw] query_language
|
2282
|
+
# Limits the returned queries to only the queries that use the
|
2283
|
+
# specified query language.
|
2284
|
+
# @return [String]
|
2285
|
+
#
|
2252
2286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueriesRequest AWS API Documentation
|
2253
2287
|
#
|
2254
2288
|
class DescribeQueriesRequest < Struct.new(
|
2255
2289
|
:log_group_name,
|
2256
2290
|
:status,
|
2257
2291
|
:max_results,
|
2258
|
-
:next_token
|
2292
|
+
:next_token,
|
2293
|
+
:query_language)
|
2259
2294
|
SENSITIVE = []
|
2260
2295
|
include Aws::Structure
|
2261
2296
|
end
|
@@ -2278,6 +2313,16 @@ module Aws::CloudWatchLogs
|
|
2278
2313
|
include Aws::Structure
|
2279
2314
|
end
|
2280
2315
|
|
2316
|
+
# @!attribute [rw] query_language
|
2317
|
+
# The query language used for this query. For more information about
|
2318
|
+
# the query languages that CloudWatch Logs supports, see [Supported
|
2319
|
+
# query languages][1].
|
2320
|
+
#
|
2321
|
+
#
|
2322
|
+
#
|
2323
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html
|
2324
|
+
# @return [String]
|
2325
|
+
#
|
2281
2326
|
# @!attribute [rw] query_definition_name_prefix
|
2282
2327
|
# Use this parameter to filter your results to only the query
|
2283
2328
|
# definitions that have names that start with the prefix you specify.
|
@@ -2296,6 +2341,7 @@ module Aws::CloudWatchLogs
|
|
2296
2341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeQueryDefinitionsRequest AWS API Documentation
|
2297
2342
|
#
|
2298
2343
|
class DescribeQueryDefinitionsRequest < Struct.new(
|
2344
|
+
:query_language,
|
2299
2345
|
:query_definition_name_prefix,
|
2300
2346
|
:max_results,
|
2301
2347
|
:next_token)
|
@@ -2977,6 +3023,54 @@ module Aws::CloudWatchLogs
|
|
2977
3023
|
include Aws::Structure
|
2978
3024
|
end
|
2979
3025
|
|
3026
|
+
# @!attribute [rw] integration_name
|
3027
|
+
# The name of the integration that you want to find information about.
|
3028
|
+
# To find the name of your integration, use [ListIntegrations][1]
|
3029
|
+
#
|
3030
|
+
#
|
3031
|
+
#
|
3032
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html
|
3033
|
+
# @return [String]
|
3034
|
+
#
|
3035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetIntegrationRequest AWS API Documentation
|
3036
|
+
#
|
3037
|
+
class GetIntegrationRequest < Struct.new(
|
3038
|
+
:integration_name)
|
3039
|
+
SENSITIVE = []
|
3040
|
+
include Aws::Structure
|
3041
|
+
end
|
3042
|
+
|
3043
|
+
# @!attribute [rw] integration_name
|
3044
|
+
# The name of the integration.
|
3045
|
+
# @return [String]
|
3046
|
+
#
|
3047
|
+
# @!attribute [rw] integration_type
|
3048
|
+
# The type of integration. Integrations with OpenSearch Service have
|
3049
|
+
# the type `OPENSEARCH`.
|
3050
|
+
# @return [String]
|
3051
|
+
#
|
3052
|
+
# @!attribute [rw] integration_status
|
3053
|
+
# The current status of this integration.
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] integration_details
|
3057
|
+
# A structure that contains information about the integration
|
3058
|
+
# configuration. For an integration with OpenSearch Service, this
|
3059
|
+
# includes information about OpenSearch Service resources such as the
|
3060
|
+
# collection, the workspace, and policies.
|
3061
|
+
# @return [Types::IntegrationDetails]
|
3062
|
+
#
|
3063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetIntegrationResponse AWS API Documentation
|
3064
|
+
#
|
3065
|
+
class GetIntegrationResponse < Struct.new(
|
3066
|
+
:integration_name,
|
3067
|
+
:integration_type,
|
3068
|
+
:integration_status,
|
3069
|
+
:integration_details)
|
3070
|
+
SENSITIVE = []
|
3071
|
+
include Aws::Structure
|
3072
|
+
end
|
3073
|
+
|
2980
3074
|
# @!attribute [rw] anomaly_detector_arn
|
2981
3075
|
# The ARN of the anomaly detector to retrieve information about. You
|
2982
3076
|
# can find the ARNs of log anomaly detectors in your account by using
|
@@ -3276,6 +3370,16 @@ module Aws::CloudWatchLogs
|
|
3276
3370
|
include Aws::Structure
|
3277
3371
|
end
|
3278
3372
|
|
3373
|
+
# @!attribute [rw] query_language
|
3374
|
+
# The query language used for this query. For more information about
|
3375
|
+
# the query languages that CloudWatch Logs supports, see [Supported
|
3376
|
+
# query languages][1].
|
3377
|
+
#
|
3378
|
+
#
|
3379
|
+
#
|
3380
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html
|
3381
|
+
# @return [String]
|
3382
|
+
#
|
3279
3383
|
# @!attribute [rw] results
|
3280
3384
|
# The log events that matched the query criteria during the most
|
3281
3385
|
# recent time it ran.
|
@@ -3316,6 +3420,7 @@ module Aws::CloudWatchLogs
|
|
3316
3420
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/GetQueryResultsResponse AWS API Documentation
|
3317
3421
|
#
|
3318
3422
|
class GetQueryResultsResponse < Struct.new(
|
3423
|
+
:query_language,
|
3319
3424
|
:results,
|
3320
3425
|
:statistics,
|
3321
3426
|
:status,
|
@@ -3463,6 +3568,68 @@ module Aws::CloudWatchLogs
|
|
3463
3568
|
include Aws::Structure
|
3464
3569
|
end
|
3465
3570
|
|
3571
|
+
# This structure contains information about the integration
|
3572
|
+
# configuration. For an integration with OpenSearch Service, this
|
3573
|
+
# includes information about OpenSearch Service resources such as the
|
3574
|
+
# collection, the workspace, and policies.
|
3575
|
+
#
|
3576
|
+
# This structure is returned by a [GetIntegration][1] operation.
|
3577
|
+
#
|
3578
|
+
#
|
3579
|
+
#
|
3580
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetIntegration.html
|
3581
|
+
#
|
3582
|
+
# @note IntegrationDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IntegrationDetails corresponding to the set member.
|
3583
|
+
#
|
3584
|
+
# @!attribute [rw] open_search_integration_details
|
3585
|
+
# This structure contains complete information about one integration
|
3586
|
+
# between CloudWatch Logs and OpenSearch Service.
|
3587
|
+
# @return [Types::OpenSearchIntegrationDetails]
|
3588
|
+
#
|
3589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/IntegrationDetails AWS API Documentation
|
3590
|
+
#
|
3591
|
+
class IntegrationDetails < Struct.new(
|
3592
|
+
:open_search_integration_details,
|
3593
|
+
:unknown)
|
3594
|
+
SENSITIVE = []
|
3595
|
+
include Aws::Structure
|
3596
|
+
include Aws::Structure::Union
|
3597
|
+
|
3598
|
+
class OpenSearchIntegrationDetails < IntegrationDetails; end
|
3599
|
+
class Unknown < IntegrationDetails; end
|
3600
|
+
end
|
3601
|
+
|
3602
|
+
# This structure contains information about one CloudWatch Logs
|
3603
|
+
# integration. This structure is returned by a [ListIntegrations][1]
|
3604
|
+
# operation.
|
3605
|
+
#
|
3606
|
+
#
|
3607
|
+
#
|
3608
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListIntegrations.html
|
3609
|
+
#
|
3610
|
+
# @!attribute [rw] integration_name
|
3611
|
+
# The name of this integration.
|
3612
|
+
# @return [String]
|
3613
|
+
#
|
3614
|
+
# @!attribute [rw] integration_type
|
3615
|
+
# The type of integration. Integrations with OpenSearch Service have
|
3616
|
+
# the type `OPENSEARCH`.
|
3617
|
+
# @return [String]
|
3618
|
+
#
|
3619
|
+
# @!attribute [rw] integration_status
|
3620
|
+
# The current status of this integration.
|
3621
|
+
# @return [String]
|
3622
|
+
#
|
3623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/IntegrationSummary AWS API Documentation
|
3624
|
+
#
|
3625
|
+
class IntegrationSummary < Struct.new(
|
3626
|
+
:integration_name,
|
3627
|
+
:integration_type,
|
3628
|
+
:integration_status)
|
3629
|
+
SENSITIVE = []
|
3630
|
+
include Aws::Structure
|
3631
|
+
end
|
3632
|
+
|
3466
3633
|
# The operation is not valid on the specified resource.
|
3467
3634
|
#
|
3468
3635
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/InvalidOperationException AWS API Documentation
|
@@ -3551,6 +3718,44 @@ module Aws::CloudWatchLogs
|
|
3551
3718
|
include Aws::Structure
|
3552
3719
|
end
|
3553
3720
|
|
3721
|
+
# @!attribute [rw] integration_name_prefix
|
3722
|
+
# To limit the results to integrations that start with a certain name
|
3723
|
+
# prefix, specify that name prefix here.
|
3724
|
+
# @return [String]
|
3725
|
+
#
|
3726
|
+
# @!attribute [rw] integration_type
|
3727
|
+
# To limit the results to integrations of a certain type, specify that
|
3728
|
+
# type here.
|
3729
|
+
# @return [String]
|
3730
|
+
#
|
3731
|
+
# @!attribute [rw] integration_status
|
3732
|
+
# To limit the results to integrations with a certain status, specify
|
3733
|
+
# that status here.
|
3734
|
+
# @return [String]
|
3735
|
+
#
|
3736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListIntegrationsRequest AWS API Documentation
|
3737
|
+
#
|
3738
|
+
class ListIntegrationsRequest < Struct.new(
|
3739
|
+
:integration_name_prefix,
|
3740
|
+
:integration_type,
|
3741
|
+
:integration_status)
|
3742
|
+
SENSITIVE = []
|
3743
|
+
include Aws::Structure
|
3744
|
+
end
|
3745
|
+
|
3746
|
+
# @!attribute [rw] integration_summaries
|
3747
|
+
# An array, where each object in the array contains information about
|
3748
|
+
# one CloudWatch Logs integration in this account.
|
3749
|
+
# @return [Array<Types::IntegrationSummary>]
|
3750
|
+
#
|
3751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListIntegrationsResponse AWS API Documentation
|
3752
|
+
#
|
3753
|
+
class ListIntegrationsResponse < Struct.new(
|
3754
|
+
:integration_summaries)
|
3755
|
+
SENSITIVE = []
|
3756
|
+
include Aws::Structure
|
3757
|
+
end
|
3758
|
+
|
3554
3759
|
# @!attribute [rw] filter_log_group_arn
|
3555
3760
|
# Use this to optionally filter the results to only include anomaly
|
3556
3761
|
# detectors that are associated with the specified log group.
|
@@ -4390,6 +4595,453 @@ module Aws::CloudWatchLogs
|
|
4390
4595
|
include Aws::Structure
|
4391
4596
|
end
|
4392
4597
|
|
4598
|
+
# This structure contains information about the OpenSearch Service
|
4599
|
+
# application used for this integration. An OpenSearch Service
|
4600
|
+
# application is the web application created by the integration with
|
4601
|
+
# CloudWatch Logs. It hosts the vended logs dashboards.
|
4602
|
+
#
|
4603
|
+
# @!attribute [rw] application_endpoint
|
4604
|
+
# The endpoint of the application.
|
4605
|
+
# @return [String]
|
4606
|
+
#
|
4607
|
+
# @!attribute [rw] application_arn
|
4608
|
+
# The Amazon Resource Name (ARN) of the application.
|
4609
|
+
# @return [String]
|
4610
|
+
#
|
4611
|
+
# @!attribute [rw] application_id
|
4612
|
+
# The ID of the application.
|
4613
|
+
# @return [String]
|
4614
|
+
#
|
4615
|
+
# @!attribute [rw] status
|
4616
|
+
# This structure contains information about the status of this
|
4617
|
+
# OpenSearch Service resource.
|
4618
|
+
# @return [Types::OpenSearchResourceStatus]
|
4619
|
+
#
|
4620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchApplication AWS API Documentation
|
4621
|
+
#
|
4622
|
+
class OpenSearchApplication < Struct.new(
|
4623
|
+
:application_endpoint,
|
4624
|
+
:application_arn,
|
4625
|
+
:application_id,
|
4626
|
+
:status)
|
4627
|
+
SENSITIVE = []
|
4628
|
+
include Aws::Structure
|
4629
|
+
end
|
4630
|
+
|
4631
|
+
# This structure contains information about the OpenSearch Service
|
4632
|
+
# collection used for this integration. An OpenSearch Service collection
|
4633
|
+
# is a logical grouping of one or more indexes that represent an
|
4634
|
+
# analytics workload. For more information, see [Creating and managing
|
4635
|
+
# OpenSearch Service Serverless collections][1].
|
4636
|
+
#
|
4637
|
+
#
|
4638
|
+
#
|
4639
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-collections.html
|
4640
|
+
#
|
4641
|
+
# @!attribute [rw] collection_endpoint
|
4642
|
+
# The endpoint of the collection.
|
4643
|
+
# @return [String]
|
4644
|
+
#
|
4645
|
+
# @!attribute [rw] collection_arn
|
4646
|
+
# The ARN of the collection.
|
4647
|
+
# @return [String]
|
4648
|
+
#
|
4649
|
+
# @!attribute [rw] status
|
4650
|
+
# This structure contains information about the status of this
|
4651
|
+
# OpenSearch Service resource.
|
4652
|
+
# @return [Types::OpenSearchResourceStatus]
|
4653
|
+
#
|
4654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchCollection AWS API Documentation
|
4655
|
+
#
|
4656
|
+
class OpenSearchCollection < Struct.new(
|
4657
|
+
:collection_endpoint,
|
4658
|
+
:collection_arn,
|
4659
|
+
:status)
|
4660
|
+
SENSITIVE = []
|
4661
|
+
include Aws::Structure
|
4662
|
+
end
|
4663
|
+
|
4664
|
+
# This structure contains information about the OpenSearch Service data
|
4665
|
+
# access policy used for this integration. The access policy defines the
|
4666
|
+
# access controls for the collection. This data access policy was
|
4667
|
+
# automatically created as part of the integration setup. For more
|
4668
|
+
# information about OpenSearch Service data access policies, see [Data
|
4669
|
+
# access control for Amazon OpenSearch Serverless][1] in the OpenSearch
|
4670
|
+
# Service Developer Guide.
|
4671
|
+
#
|
4672
|
+
#
|
4673
|
+
#
|
4674
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html
|
4675
|
+
#
|
4676
|
+
# @!attribute [rw] policy_name
|
4677
|
+
# The name of the data access policy.
|
4678
|
+
# @return [String]
|
4679
|
+
#
|
4680
|
+
# @!attribute [rw] status
|
4681
|
+
# This structure contains information about the status of this
|
4682
|
+
# OpenSearch Service resource.
|
4683
|
+
# @return [Types::OpenSearchResourceStatus]
|
4684
|
+
#
|
4685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchDataAccessPolicy AWS API Documentation
|
4686
|
+
#
|
4687
|
+
class OpenSearchDataAccessPolicy < Struct.new(
|
4688
|
+
:policy_name,
|
4689
|
+
:status)
|
4690
|
+
SENSITIVE = []
|
4691
|
+
include Aws::Structure
|
4692
|
+
end
|
4693
|
+
|
4694
|
+
# This structure contains information about the OpenSearch Service data
|
4695
|
+
# source used for this integration. This data source was created as part
|
4696
|
+
# of the integration setup. An OpenSearch Service data source defines
|
4697
|
+
# the source and destination for OpenSearch Service queries. It includes
|
4698
|
+
# the role required to execute queries and write to collections.
|
4699
|
+
#
|
4700
|
+
# For more information about OpenSearch Service data sources , see
|
4701
|
+
# [Creating OpenSearch Service data source integrations with Amazon
|
4702
|
+
# S3.][1]
|
4703
|
+
#
|
4704
|
+
#
|
4705
|
+
#
|
4706
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html
|
4707
|
+
#
|
4708
|
+
# @!attribute [rw] data_source_name
|
4709
|
+
# The name of the OpenSearch Service data source.
|
4710
|
+
# @return [String]
|
4711
|
+
#
|
4712
|
+
# @!attribute [rw] status
|
4713
|
+
# This structure contains information about the status of this
|
4714
|
+
# OpenSearch Service resource.
|
4715
|
+
# @return [Types::OpenSearchResourceStatus]
|
4716
|
+
#
|
4717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchDataSource AWS API Documentation
|
4718
|
+
#
|
4719
|
+
class OpenSearchDataSource < Struct.new(
|
4720
|
+
:data_source_name,
|
4721
|
+
:status)
|
4722
|
+
SENSITIVE = []
|
4723
|
+
include Aws::Structure
|
4724
|
+
end
|
4725
|
+
|
4726
|
+
# This structure contains information about the OpenSearch Service
|
4727
|
+
# encryption policy used for this integration. The encryption policy was
|
4728
|
+
# created automatically when you created the integration. For more
|
4729
|
+
# information, see [Encryption policies][1] in the OpenSearch Service
|
4730
|
+
# Developer Guide.
|
4731
|
+
#
|
4732
|
+
#
|
4733
|
+
#
|
4734
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html#serverless-encryption-policies
|
4735
|
+
#
|
4736
|
+
# @!attribute [rw] policy_name
|
4737
|
+
# The name of the encryption policy.
|
4738
|
+
# @return [String]
|
4739
|
+
#
|
4740
|
+
# @!attribute [rw] status
|
4741
|
+
# This structure contains information about the status of this
|
4742
|
+
# OpenSearch Service resource.
|
4743
|
+
# @return [Types::OpenSearchResourceStatus]
|
4744
|
+
#
|
4745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchEncryptionPolicy AWS API Documentation
|
4746
|
+
#
|
4747
|
+
class OpenSearchEncryptionPolicy < Struct.new(
|
4748
|
+
:policy_name,
|
4749
|
+
:status)
|
4750
|
+
SENSITIVE = []
|
4751
|
+
include Aws::Structure
|
4752
|
+
end
|
4753
|
+
|
4754
|
+
# This structure contains complete information about one CloudWatch Logs
|
4755
|
+
# integration. This structure is returned by a [GetIntegration][1]
|
4756
|
+
# operation.
|
4757
|
+
#
|
4758
|
+
#
|
4759
|
+
#
|
4760
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetIntegration.html
|
4761
|
+
#
|
4762
|
+
# @!attribute [rw] data_source
|
4763
|
+
# This structure contains information about the OpenSearch Service
|
4764
|
+
# data source used for this integration. This data source was created
|
4765
|
+
# as part of the integration setup. An OpenSearch Service data source
|
4766
|
+
# defines the source and destination for OpenSearch Service queries.
|
4767
|
+
# It includes the role required to execute queries and write to
|
4768
|
+
# collections.
|
4769
|
+
#
|
4770
|
+
# For more information about OpenSearch Service data sources , see
|
4771
|
+
# [Creating OpenSearch Service data source integrations with Amazon
|
4772
|
+
# S3.][1]
|
4773
|
+
#
|
4774
|
+
#
|
4775
|
+
#
|
4776
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html
|
4777
|
+
# @return [Types::OpenSearchDataSource]
|
4778
|
+
#
|
4779
|
+
# @!attribute [rw] application
|
4780
|
+
# This structure contains information about the OpenSearch Service
|
4781
|
+
# application used for this integration. An OpenSearch Service
|
4782
|
+
# application is the web application that was created by the
|
4783
|
+
# integration with CloudWatch Logs. It hosts the vended logs
|
4784
|
+
# dashboards.
|
4785
|
+
# @return [Types::OpenSearchApplication]
|
4786
|
+
#
|
4787
|
+
# @!attribute [rw] collection
|
4788
|
+
# This structure contains information about the OpenSearch Service
|
4789
|
+
# collection used for this integration. This collection was created as
|
4790
|
+
# part of the integration setup. An OpenSearch Service collection is a
|
4791
|
+
# logical grouping of one or more indexes that represent an analytics
|
4792
|
+
# workload. For more information, see [Creating and managing
|
4793
|
+
# OpenSearch Service Serverless collections][1].
|
4794
|
+
#
|
4795
|
+
#
|
4796
|
+
#
|
4797
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-collections.html
|
4798
|
+
# @return [Types::OpenSearchCollection]
|
4799
|
+
#
|
4800
|
+
# @!attribute [rw] workspace
|
4801
|
+
# This structure contains information about the OpenSearch Service
|
4802
|
+
# workspace used for this integration. An OpenSearch Service workspace
|
4803
|
+
# is the collection of dashboards along with other OpenSearch Service
|
4804
|
+
# tools. This workspace was created automatically as part of the
|
4805
|
+
# integration setup. For more information, see [Centralized OpenSearch
|
4806
|
+
# user interface (Dashboards) with OpenSearch Service][1].
|
4807
|
+
#
|
4808
|
+
#
|
4809
|
+
#
|
4810
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html
|
4811
|
+
# @return [Types::OpenSearchWorkspace]
|
4812
|
+
#
|
4813
|
+
# @!attribute [rw] encryption_policy
|
4814
|
+
# This structure contains information about the OpenSearch Service
|
4815
|
+
# encryption policy used for this integration. The encryption policy
|
4816
|
+
# was created automatically when you created the integration. For more
|
4817
|
+
# information, see [Encryption policies][1] in the OpenSearch Service
|
4818
|
+
# Developer Guide.
|
4819
|
+
#
|
4820
|
+
#
|
4821
|
+
#
|
4822
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html#serverless-encryption-policies
|
4823
|
+
# @return [Types::OpenSearchEncryptionPolicy]
|
4824
|
+
#
|
4825
|
+
# @!attribute [rw] network_policy
|
4826
|
+
# This structure contains information about the OpenSearch Service
|
4827
|
+
# network policy used for this integration. The network policy assigns
|
4828
|
+
# network access settings to collections. For more information, see
|
4829
|
+
# [Network policies][1] in the OpenSearch Service Developer Guide.
|
4830
|
+
#
|
4831
|
+
#
|
4832
|
+
#
|
4833
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html#serverless-network-policies
|
4834
|
+
# @return [Types::OpenSearchNetworkPolicy]
|
4835
|
+
#
|
4836
|
+
# @!attribute [rw] access_policy
|
4837
|
+
# This structure contains information about the OpenSearch Service
|
4838
|
+
# data access policy used for this integration. The access policy
|
4839
|
+
# defines the access controls for the collection. This data access
|
4840
|
+
# policy was automatically created as part of the integration setup.
|
4841
|
+
# For more information about OpenSearch Service data access policies,
|
4842
|
+
# see [Data access control for Amazon OpenSearch Serverless][1] in the
|
4843
|
+
# OpenSearch Service Developer Guide.
|
4844
|
+
#
|
4845
|
+
#
|
4846
|
+
#
|
4847
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html
|
4848
|
+
# @return [Types::OpenSearchDataAccessPolicy]
|
4849
|
+
#
|
4850
|
+
# @!attribute [rw] lifecycle_policy
|
4851
|
+
# This structure contains information about the OpenSearch Service
|
4852
|
+
# data lifecycle policy used for this integration. The lifecycle
|
4853
|
+
# policy determines the lifespan of the data in the collection. It was
|
4854
|
+
# automatically created as part of the integration setup.
|
4855
|
+
#
|
4856
|
+
# For more information, see [Using data lifecycle policies with
|
4857
|
+
# OpenSearch Service Serverless][1] in the OpenSearch Service
|
4858
|
+
# Developer Guide.
|
4859
|
+
#
|
4860
|
+
#
|
4861
|
+
#
|
4862
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html
|
4863
|
+
# @return [Types::OpenSearchLifecyclePolicy]
|
4864
|
+
#
|
4865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchIntegrationDetails AWS API Documentation
|
4866
|
+
#
|
4867
|
+
class OpenSearchIntegrationDetails < Struct.new(
|
4868
|
+
:data_source,
|
4869
|
+
:application,
|
4870
|
+
:collection,
|
4871
|
+
:workspace,
|
4872
|
+
:encryption_policy,
|
4873
|
+
:network_policy,
|
4874
|
+
:access_policy,
|
4875
|
+
:lifecycle_policy)
|
4876
|
+
SENSITIVE = []
|
4877
|
+
include Aws::Structure
|
4878
|
+
end
|
4879
|
+
|
4880
|
+
# This structure contains information about the OpenSearch Service data
|
4881
|
+
# lifecycle policy used for this integration. The lifecycle policy
|
4882
|
+
# determines the lifespan of the data in the collection. It was
|
4883
|
+
# automatically created as part of the integration setup.
|
4884
|
+
#
|
4885
|
+
# For more information, see [Using data lifecycle policies with
|
4886
|
+
# OpenSearch Service Serverless][1] in the OpenSearch Service Developer
|
4887
|
+
# Guide.
|
4888
|
+
#
|
4889
|
+
#
|
4890
|
+
#
|
4891
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html
|
4892
|
+
#
|
4893
|
+
# @!attribute [rw] policy_name
|
4894
|
+
# The name of the lifecycle policy.
|
4895
|
+
# @return [String]
|
4896
|
+
#
|
4897
|
+
# @!attribute [rw] status
|
4898
|
+
# This structure contains information about the status of this
|
4899
|
+
# OpenSearch Service resource.
|
4900
|
+
# @return [Types::OpenSearchResourceStatus]
|
4901
|
+
#
|
4902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchLifecyclePolicy AWS API Documentation
|
4903
|
+
#
|
4904
|
+
class OpenSearchLifecyclePolicy < Struct.new(
|
4905
|
+
:policy_name,
|
4906
|
+
:status)
|
4907
|
+
SENSITIVE = []
|
4908
|
+
include Aws::Structure
|
4909
|
+
end
|
4910
|
+
|
4911
|
+
# This structure contains information about the OpenSearch Service
|
4912
|
+
# network policy used for this integration. The network policy assigns
|
4913
|
+
# network access settings to collections. For more information, see
|
4914
|
+
# [Network policies][1] in the OpenSearch Service Developer Guide.
|
4915
|
+
#
|
4916
|
+
#
|
4917
|
+
#
|
4918
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html#serverless-network-policies
|
4919
|
+
#
|
4920
|
+
# @!attribute [rw] policy_name
|
4921
|
+
# The name of the network policy.
|
4922
|
+
# @return [String]
|
4923
|
+
#
|
4924
|
+
# @!attribute [rw] status
|
4925
|
+
# This structure contains information about the status of this
|
4926
|
+
# OpenSearch Service resource.
|
4927
|
+
# @return [Types::OpenSearchResourceStatus]
|
4928
|
+
#
|
4929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchNetworkPolicy AWS API Documentation
|
4930
|
+
#
|
4931
|
+
class OpenSearchNetworkPolicy < Struct.new(
|
4932
|
+
:policy_name,
|
4933
|
+
:status)
|
4934
|
+
SENSITIVE = []
|
4935
|
+
include Aws::Structure
|
4936
|
+
end
|
4937
|
+
|
4938
|
+
# This structure contains configuration details about an integration
|
4939
|
+
# between CloudWatch Logs and OpenSearch Service.
|
4940
|
+
#
|
4941
|
+
# @!attribute [rw] kms_key_arn
|
4942
|
+
# To have the vended dashboard data encrypted with KMS instead of the
|
4943
|
+
# CloudWatch Logs default encryption method, specify the ARN of the
|
4944
|
+
# KMS key that you want to use.
|
4945
|
+
# @return [String]
|
4946
|
+
#
|
4947
|
+
# @!attribute [rw] data_source_role_arn
|
4948
|
+
# Specify the ARN of an IAM role that CloudWatch Logs will use to
|
4949
|
+
# create the integration. This role must have the permissions
|
4950
|
+
# necessary to access the OpenSearch Service collection to be able to
|
4951
|
+
# create the dashboards. For more information about the permissions
|
4952
|
+
# needed, see [Create an IAM role to access the OpenSearch Service
|
4953
|
+
# collection][1] in the CloudWatch Logs User Guide.
|
4954
|
+
#
|
4955
|
+
#
|
4956
|
+
#
|
4957
|
+
# [1]: https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole
|
4958
|
+
# @return [String]
|
4959
|
+
#
|
4960
|
+
# @!attribute [rw] dashboard_viewer_principals
|
4961
|
+
# Specify the ARNs of IAM roles and IAM users who you want to grant
|
4962
|
+
# permission to for viewing the dashboards.
|
4963
|
+
#
|
4964
|
+
# In addition to specifying these users here, you must also grant them
|
4965
|
+
# the **CloudWatchOpenSearchDashboardsAccess** IAM policy. For more
|
4966
|
+
# information, see
|
4967
|
+
# @return [Array<String>]
|
4968
|
+
#
|
4969
|
+
# @!attribute [rw] application_arn
|
4970
|
+
# If you want to use an existing OpenSearch Service application for
|
4971
|
+
# your integration with OpenSearch Service, specify it here. If you
|
4972
|
+
# omit this, a new application will be created.
|
4973
|
+
# @return [String]
|
4974
|
+
#
|
4975
|
+
# @!attribute [rw] retention_days
|
4976
|
+
# Specify how many days that you want the data derived by OpenSearch
|
4977
|
+
# Service to be retained in the index that the dashboard refers to.
|
4978
|
+
# This also sets the maximum time period that you can choose when
|
4979
|
+
# viewing data in the dashboard. Choosing a longer time frame will
|
4980
|
+
# incur additional costs.
|
4981
|
+
# @return [Integer]
|
4982
|
+
#
|
4983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchResourceConfig AWS API Documentation
|
4984
|
+
#
|
4985
|
+
class OpenSearchResourceConfig < Struct.new(
|
4986
|
+
:kms_key_arn,
|
4987
|
+
:data_source_role_arn,
|
4988
|
+
:dashboard_viewer_principals,
|
4989
|
+
:application_arn,
|
4990
|
+
:retention_days)
|
4991
|
+
SENSITIVE = []
|
4992
|
+
include Aws::Structure
|
4993
|
+
end
|
4994
|
+
|
4995
|
+
# This structure contains information about the status of an OpenSearch
|
4996
|
+
# Service resource.
|
4997
|
+
#
|
4998
|
+
# @!attribute [rw] status
|
4999
|
+
# The current status of this resource.
|
5000
|
+
# @return [String]
|
5001
|
+
#
|
5002
|
+
# @!attribute [rw] status_message
|
5003
|
+
# A message with additional information about the status of this
|
5004
|
+
# resource.
|
5005
|
+
# @return [String]
|
5006
|
+
#
|
5007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchResourceStatus AWS API Documentation
|
5008
|
+
#
|
5009
|
+
class OpenSearchResourceStatus < Struct.new(
|
5010
|
+
:status,
|
5011
|
+
:status_message)
|
5012
|
+
SENSITIVE = []
|
5013
|
+
include Aws::Structure
|
5014
|
+
end
|
5015
|
+
|
5016
|
+
# This structure contains information about the OpenSearch Service
|
5017
|
+
# workspace used for this integration. An OpenSearch Service workspace
|
5018
|
+
# is the collection of dashboards along with other OpenSearch Service
|
5019
|
+
# tools. This workspace was created automatically as part of the
|
5020
|
+
# integration setup. For more information, see [Centralized OpenSearch
|
5021
|
+
# user interface (Dashboards) with OpenSearch Service][1].
|
5022
|
+
#
|
5023
|
+
#
|
5024
|
+
#
|
5025
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html
|
5026
|
+
#
|
5027
|
+
# @!attribute [rw] workspace_id
|
5028
|
+
# The ID of this workspace.
|
5029
|
+
# @return [String]
|
5030
|
+
#
|
5031
|
+
# @!attribute [rw] status
|
5032
|
+
# This structure contains information about the status of an
|
5033
|
+
# OpenSearch Service resource.
|
5034
|
+
# @return [Types::OpenSearchResourceStatus]
|
5035
|
+
#
|
5036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/OpenSearchWorkspace AWS API Documentation
|
5037
|
+
#
|
5038
|
+
class OpenSearchWorkspace < Struct.new(
|
5039
|
+
:workspace_id,
|
5040
|
+
:status)
|
5041
|
+
SENSITIVE = []
|
5042
|
+
include Aws::Structure
|
5043
|
+
end
|
5044
|
+
|
4393
5045
|
# Multiple concurrent requests to update the same resource were in
|
4394
5046
|
# conflict.
|
4395
5047
|
#
|
@@ -5506,6 +6158,50 @@ module Aws::CloudWatchLogs
|
|
5506
6158
|
include Aws::Structure
|
5507
6159
|
end
|
5508
6160
|
|
6161
|
+
# @!attribute [rw] integration_name
|
6162
|
+
# A name for the integration.
|
6163
|
+
# @return [String]
|
6164
|
+
#
|
6165
|
+
# @!attribute [rw] resource_config
|
6166
|
+
# A structure that contains configuration information for the
|
6167
|
+
# integration that you are creating.
|
6168
|
+
# @return [Types::ResourceConfig]
|
6169
|
+
#
|
6170
|
+
# @!attribute [rw] integration_type
|
6171
|
+
# The type of integration. Currently, the only supported type is
|
6172
|
+
# `OPENSEARCH`.
|
6173
|
+
# @return [String]
|
6174
|
+
#
|
6175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutIntegrationRequest AWS API Documentation
|
6176
|
+
#
|
6177
|
+
class PutIntegrationRequest < Struct.new(
|
6178
|
+
:integration_name,
|
6179
|
+
:resource_config,
|
6180
|
+
:integration_type)
|
6181
|
+
SENSITIVE = []
|
6182
|
+
include Aws::Structure
|
6183
|
+
end
|
6184
|
+
|
6185
|
+
# @!attribute [rw] integration_name
|
6186
|
+
# The name of the integration that you just created.
|
6187
|
+
# @return [String]
|
6188
|
+
#
|
6189
|
+
# @!attribute [rw] integration_status
|
6190
|
+
# The status of the integration that you just created.
|
6191
|
+
#
|
6192
|
+
# After you create an integration, it takes a few minutes to complete.
|
6193
|
+
# During this time, you'll see the status as `PROVISIONING`.
|
6194
|
+
# @return [String]
|
6195
|
+
#
|
6196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutIntegrationResponse AWS API Documentation
|
6197
|
+
#
|
6198
|
+
class PutIntegrationResponse < Struct.new(
|
6199
|
+
:integration_name,
|
6200
|
+
:integration_status)
|
6201
|
+
SENSITIVE = []
|
6202
|
+
include Aws::Structure
|
6203
|
+
end
|
6204
|
+
|
5509
6205
|
# @!attribute [rw] log_group_name
|
5510
6206
|
# The name of the log group.
|
5511
6207
|
# @return [String]
|
@@ -5625,6 +6321,17 @@ module Aws::CloudWatchLogs
|
|
5625
6321
|
include Aws::Structure
|
5626
6322
|
end
|
5627
6323
|
|
6324
|
+
# @!attribute [rw] query_language
|
6325
|
+
# Specify the query language to use for this query. The options are
|
6326
|
+
# Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more
|
6327
|
+
# information about the query languages that CloudWatch Logs supports,
|
6328
|
+
# see [Supported query languages][1].
|
6329
|
+
#
|
6330
|
+
#
|
6331
|
+
#
|
6332
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html
|
6333
|
+
# @return [String]
|
6334
|
+
#
|
5628
6335
|
# @!attribute [rw] name
|
5629
6336
|
# A name for the query definition. If you are saving numerous query
|
5630
6337
|
# definitions, we recommend that you name them. This way, you can find
|
@@ -5654,9 +6361,12 @@ module Aws::CloudWatchLogs
|
|
5654
6361
|
#
|
5655
6362
|
# @!attribute [rw] log_group_names
|
5656
6363
|
# Use this parameter to include specific log groups as part of your
|
5657
|
-
# query definition.
|
6364
|
+
# query definition. If your query uses the OpenSearch Service query
|
6365
|
+
# language, you specify the log group names inside the `querystring`
|
6366
|
+
# instead of here.
|
5658
6367
|
#
|
5659
|
-
# If you are updating
|
6368
|
+
# If you are updating an existing query definition for the Logs
|
6369
|
+
# Insights QL or OpenSearch Service PPL and you omit this parameter,
|
5660
6370
|
# then the updated definition will contain no log groups.
|
5661
6371
|
# @return [Array<String>]
|
5662
6372
|
#
|
@@ -5680,6 +6390,7 @@ module Aws::CloudWatchLogs
|
|
5680
6390
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/PutQueryDefinitionRequest AWS API Documentation
|
5681
6391
|
#
|
5682
6392
|
class PutQueryDefinitionRequest < Struct.new(
|
6393
|
+
:query_language,
|
5683
6394
|
:name,
|
5684
6395
|
:query_definition_id,
|
5685
6396
|
:log_group_names,
|
@@ -5936,6 +6647,16 @@ module Aws::CloudWatchLogs
|
|
5936
6647
|
# This structure contains details about a saved CloudWatch Logs Insights
|
5937
6648
|
# query definition.
|
5938
6649
|
#
|
6650
|
+
# @!attribute [rw] query_language
|
6651
|
+
# The query language used for this query. For more information about
|
6652
|
+
# the query languages that CloudWatch Logs supports, see [Supported
|
6653
|
+
# query languages][1].
|
6654
|
+
#
|
6655
|
+
#
|
6656
|
+
#
|
6657
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html
|
6658
|
+
# @return [String]
|
6659
|
+
#
|
5939
6660
|
# @!attribute [rw] query_definition_id
|
5940
6661
|
# The unique ID of the query definition.
|
5941
6662
|
# @return [String]
|
@@ -5965,6 +6686,7 @@ module Aws::CloudWatchLogs
|
|
5965
6686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryDefinition AWS API Documentation
|
5966
6687
|
#
|
5967
6688
|
class QueryDefinition < Struct.new(
|
6689
|
+
:query_language,
|
5968
6690
|
:query_definition_id,
|
5969
6691
|
:name,
|
5970
6692
|
:query_string,
|
@@ -5977,6 +6699,16 @@ module Aws::CloudWatchLogs
|
|
5977
6699
|
# Information about one CloudWatch Logs Insights query that matches the
|
5978
6700
|
# request in a `DescribeQueries` operation.
|
5979
6701
|
#
|
6702
|
+
# @!attribute [rw] query_language
|
6703
|
+
# The query language used for this query. For more information about
|
6704
|
+
# the query languages that CloudWatch Logs supports, see [Supported
|
6705
|
+
# query languages][1].
|
6706
|
+
#
|
6707
|
+
#
|
6708
|
+
#
|
6709
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html
|
6710
|
+
# @return [String]
|
6711
|
+
#
|
5980
6712
|
# @!attribute [rw] query_id
|
5981
6713
|
# The unique ID number of this query.
|
5982
6714
|
# @return [String]
|
@@ -6001,6 +6733,7 @@ module Aws::CloudWatchLogs
|
|
6001
6733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/QueryInfo AWS API Documentation
|
6002
6734
|
#
|
6003
6735
|
class QueryInfo < Struct.new(
|
6736
|
+
:query_language,
|
6004
6737
|
:query_id,
|
6005
6738
|
:query_string,
|
6006
6739
|
:status,
|
@@ -6212,6 +6945,29 @@ module Aws::CloudWatchLogs
|
|
6212
6945
|
#
|
6213
6946
|
class ResourceAlreadyExistsException < Aws::EmptyStructure; end
|
6214
6947
|
|
6948
|
+
# This structure contains configuration details about an integration
|
6949
|
+
# between CloudWatch Logs and another entity.
|
6950
|
+
#
|
6951
|
+
# @note ResourceConfig is a union - when making an API calls you must set exactly one of the members.
|
6952
|
+
#
|
6953
|
+
# @!attribute [rw] open_search_resource_config
|
6954
|
+
# This structure contains configuration details about an integration
|
6955
|
+
# between CloudWatch Logs and OpenSearch Service.
|
6956
|
+
# @return [Types::OpenSearchResourceConfig]
|
6957
|
+
#
|
6958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResourceConfig AWS API Documentation
|
6959
|
+
#
|
6960
|
+
class ResourceConfig < Struct.new(
|
6961
|
+
:open_search_resource_config,
|
6962
|
+
:unknown)
|
6963
|
+
SENSITIVE = []
|
6964
|
+
include Aws::Structure
|
6965
|
+
include Aws::Structure::Union
|
6966
|
+
|
6967
|
+
class OpenSearchResourceConfig < ResourceConfig; end
|
6968
|
+
class Unknown < ResourceConfig; end
|
6969
|
+
end
|
6970
|
+
|
6215
6971
|
# The specified resource does not exist.
|
6216
6972
|
#
|
6217
6973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ResourceNotFoundException AWS API Documentation
|
@@ -6484,13 +7240,40 @@ module Aws::CloudWatchLogs
|
|
6484
7240
|
include Aws::Structure
|
6485
7241
|
end
|
6486
7242
|
|
7243
|
+
# @!attribute [rw] query_language
|
7244
|
+
# Specify the query language to use for this query. The options are
|
7245
|
+
# Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more
|
7246
|
+
# information about the query languages that CloudWatch Logs supports,
|
7247
|
+
# see [Supported query languages][1].
|
7248
|
+
#
|
7249
|
+
#
|
7250
|
+
#
|
7251
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html
|
7252
|
+
# @return [String]
|
7253
|
+
#
|
6487
7254
|
# @!attribute [rw] log_group_name
|
6488
7255
|
# The log group on which to perform the query.
|
7256
|
+
#
|
7257
|
+
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
7258
|
+
# parameters: `logGroupName`, `logGroupNames`, or
|
7259
|
+
# `logGroupIdentifiers`. The exception is queries using the OpenSearch
|
7260
|
+
# Service SQL query language, where you specify the log group names
|
7261
|
+
# inside the `querystring` instead of here.
|
7262
|
+
#
|
7263
|
+
# </note>
|
6489
7264
|
# @return [String]
|
6490
7265
|
#
|
6491
7266
|
# @!attribute [rw] log_group_names
|
6492
7267
|
# The list of log groups to be queried. You can include up to 50 log
|
6493
7268
|
# groups.
|
7269
|
+
#
|
7270
|
+
# <note markdown="1"> A `StartQuery` operation must include exactly one of the following
|
7271
|
+
# parameters: `logGroupName`, `logGroupNames`, or
|
7272
|
+
# `logGroupIdentifiers`. The exception is queries using the OpenSearch
|
7273
|
+
# Service SQL query language, where you specify the log group names
|
7274
|
+
# inside the `querystring` instead of here.
|
7275
|
+
#
|
7276
|
+
# </note>
|
6494
7277
|
# @return [Array<String>]
|
6495
7278
|
#
|
6496
7279
|
# @!attribute [rw] log_group_identifiers
|
@@ -6508,7 +7291,9 @@ module Aws::CloudWatchLogs
|
|
6508
7291
|
#
|
6509
7292
|
# A `StartQuery` operation must include exactly one of the following
|
6510
7293
|
# parameters: `logGroupName`, `logGroupNames`, or
|
6511
|
-
# `logGroupIdentifiers`.
|
7294
|
+
# `logGroupIdentifiers`. The exception is queries using the OpenSearch
|
7295
|
+
# Service SQL query language, where you specify the log group names
|
7296
|
+
# inside the `querystring` instead of here.
|
6512
7297
|
# @return [Array<String>]
|
6513
7298
|
#
|
6514
7299
|
# @!attribute [rw] start_time
|
@@ -6542,6 +7327,7 @@ module Aws::CloudWatchLogs
|
|
6542
7327
|
# @see http://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/StartQueryRequest AWS API Documentation
|
6543
7328
|
#
|
6544
7329
|
class StartQueryRequest < Struct.new(
|
7330
|
+
:query_language,
|
6545
7331
|
:log_group_name,
|
6546
7332
|
:log_group_names,
|
6547
7333
|
:log_group_identifiers,
|