aws-sdk-opensearchservice 1.91.0 → 1.92.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ebd029245d7097b6b55e69dfbf9291795c9b3888ddb48ae5dafd0f8b3b9541a3
4
- data.tar.gz: 519cc02cb66b841eaae385c93b875cbdc5778ae37fc1e62d48790b7030b4958a
3
+ metadata.gz: 10953333eb97bb883856995d86ebb47c9eccff889cd0e2250f2cf396f2bd4f06
4
+ data.tar.gz: c99f57261495612fd245304c4eb37a2121e581c4183e25fb467be66f83d52182
5
5
  SHA512:
6
- metadata.gz: 932b5f5c9210fa9d07dcc52f3d7ce4b5f9ae2c58c9a69282b4f95e1e782452f1ba91a71a9609e9767bcf4bac59b7d99a73dd4de70e481f1c7498e793eed59de1
7
- data.tar.gz: 14446b8cd94497929b46ff45c7073fb54afb56cf93be7e0f259f9ec18bfd23cde79fe69bdb2a15a2715b3f07feeb9c10e1e3e1067c432430f8b3995c7c25909f
6
+ metadata.gz: 50f4768506606b5e6bd6aa900cb9e2e826a9b9caa32efccdd7c46a30ac07752a76310dadecb473de74e656fbabf9b3c6045d67250e9d0ee63b16940942b079fb
7
+ data.tar.gz: 620b0db05ab9569f5c4eaf4495b6d7457523b5b2531f39268c7a71d06b823366776bda05a600ae2d6805d1b7ec98dcf19b87fcea060e0d0feb1decd07372faa1
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.92.0 (2026-03-30)
5
+ ------------------
6
+
7
+ * Feature - Added Cluster Insights API's In OpenSearch Service SDK.
8
+
4
9
  1.91.0 (2026-03-20)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.91.0
1
+ 1.92.0
@@ -3203,6 +3203,53 @@ module Aws::OpenSearchService
3203
3203
  req.send_request(options)
3204
3204
  end
3205
3205
 
3206
+ # Describes the details of an existing insight for an Amazon OpenSearch
3207
+ # Service domain. Returns detailed fields associated with the specified
3208
+ # insight, such as text descriptions and metric data.
3209
+ #
3210
+ # @option params [required, Types::InsightEntity] :entity
3211
+ # The entity for which to retrieve insight details. Specifies the type
3212
+ # and value of the entity, such as a domain name or Amazon Web Services
3213
+ # account ID.
3214
+ #
3215
+ # @option params [required, String] :insight_id
3216
+ # The unique identifier of the insight to describe.
3217
+ #
3218
+ # @option params [Boolean] :show_html_content
3219
+ # Specifies whether to show response with HTML content in response or
3220
+ # not.
3221
+ #
3222
+ # @return [Types::DescribeInsightDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3223
+ #
3224
+ # * {Types::DescribeInsightDetailsResponse#fields #fields} => Array<Types::InsightField>
3225
+ #
3226
+ # @example Request syntax with placeholder values
3227
+ #
3228
+ # resp = client.describe_insight_details({
3229
+ # entity: { # required
3230
+ # type: "Account", # required, accepts Account, DomainName
3231
+ # value: "InsightEntityValue",
3232
+ # },
3233
+ # insight_id: "GUID", # required
3234
+ # show_html_content: false,
3235
+ # })
3236
+ #
3237
+ # @example Response structure
3238
+ #
3239
+ # resp.fields #=> Array
3240
+ # resp.fields[0].name #=> String
3241
+ # resp.fields[0].type #=> String, one of "text", "metric"
3242
+ # resp.fields[0].value #=> String
3243
+ #
3244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInsightDetails AWS API Documentation
3245
+ #
3246
+ # @overload describe_insight_details(params = {})
3247
+ # @param [Hash] params ({})
3248
+ def describe_insight_details(params = {}, options = {})
3249
+ req = build_request(:describe_insight_details, params)
3250
+ req.send_request(options)
3251
+ end
3252
+
3206
3253
  # Describes the instance count, storage, and master node limits for a
3207
3254
  # given OpenSearch or Elasticsearch version and instance type.
3208
3255
  #
@@ -4398,6 +4445,75 @@ module Aws::OpenSearchService
4398
4445
  req.send_request(options)
4399
4446
  end
4400
4447
 
4448
+ # Lists insights for an Amazon OpenSearch Service domain or Amazon Web
4449
+ # Services account. Returns a paginated list of insights based on the
4450
+ # specified entity, filters, time range, and sort order.
4451
+ #
4452
+ # @option params [required, Types::InsightEntity] :entity
4453
+ # The entity for which to list insights. Specifies the type and value of
4454
+ # the entity, such as a domain name or Amazon Web Services account ID.
4455
+ #
4456
+ # @option params [Types::InsightTimeRange] :time_range
4457
+ # The time range for filtering insights, specified as epoch millisecond
4458
+ # timestamps.
4459
+ #
4460
+ # @option params [String] :sort_order
4461
+ # The sort order for the results. Possible values are `ASC` (ascending)
4462
+ # and `DESC` (descending).
4463
+ #
4464
+ # @option params [Integer] :max_results
4465
+ # An optional parameter that specifies the maximum number of results to
4466
+ # return. You can use `NextToken` to get the next page of results. Valid
4467
+ # values are 1 to 500.
4468
+ #
4469
+ # @option params [String] :next_token
4470
+ # If your initial `ListInsights` operation returns a `NextToken`,
4471
+ # include the returned `NextToken` in subsequent `ListInsights`
4472
+ # operations to retrieve the next page of results.
4473
+ #
4474
+ # @return [Types::ListInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4475
+ #
4476
+ # * {Types::ListInsightsResponse#insights #insights} => Array<Types::Insight>
4477
+ # * {Types::ListInsightsResponse#next_token #next_token} => String
4478
+ #
4479
+ # @example Request syntax with placeholder values
4480
+ #
4481
+ # resp = client.list_insights({
4482
+ # entity: { # required
4483
+ # type: "Account", # required, accepts Account, DomainName
4484
+ # value: "InsightEntityValue",
4485
+ # },
4486
+ # time_range: {
4487
+ # from: 1, # required
4488
+ # to: 1, # required
4489
+ # },
4490
+ # sort_order: "ASC", # accepts ASC, DESC
4491
+ # max_results: 1,
4492
+ # next_token: "String",
4493
+ # })
4494
+ #
4495
+ # @example Response structure
4496
+ #
4497
+ # resp.insights #=> Array
4498
+ # resp.insights[0].insight_id #=> String
4499
+ # resp.insights[0].display_name #=> String
4500
+ # resp.insights[0].type #=> String, one of "EVENT", "RECOMMENDATION"
4501
+ # resp.insights[0].priority #=> String, one of "CRITICAL", "HIGH", "MEDIUM", "LOW"
4502
+ # resp.insights[0].status #=> String, one of "ACTIVE", "RESOLVED", "DISMISSED"
4503
+ # resp.insights[0].creation_time #=> Time
4504
+ # resp.insights[0].update_time #=> Time
4505
+ # resp.insights[0].is_experimental #=> Boolean
4506
+ # resp.next_token #=> String
4507
+ #
4508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInsights AWS API Documentation
4509
+ #
4510
+ # @overload list_insights(params = {})
4511
+ # @param [Hash] params ({})
4512
+ def list_insights(params = {}, options = {})
4513
+ req = build_request(:list_insights, params)
4514
+ req.send_request(options)
4515
+ end
4516
+
4401
4517
  # Lists all instance types and available features for a given OpenSearch
4402
4518
  # or Elasticsearch version.
4403
4519
  #
@@ -6180,7 +6296,7 @@ module Aws::OpenSearchService
6180
6296
  tracer: tracer
6181
6297
  )
6182
6298
  context[:gem_name] = 'aws-sdk-opensearchservice'
6183
- context[:gem_version] = '1.91.0'
6299
+ context[:gem_version] = '1.92.0'
6184
6300
  Seahorse::Client::Request.new(handlers, context)
6185
6301
  end
6186
6302
 
@@ -173,6 +173,8 @@ module Aws::OpenSearchService
173
173
  DescribeDryRunProgressResponse = Shapes::StructureShape.new(name: 'DescribeDryRunProgressResponse')
174
174
  DescribeInboundConnectionsRequest = Shapes::StructureShape.new(name: 'DescribeInboundConnectionsRequest')
175
175
  DescribeInboundConnectionsResponse = Shapes::StructureShape.new(name: 'DescribeInboundConnectionsResponse')
176
+ DescribeInsightDetailsRequest = Shapes::StructureShape.new(name: 'DescribeInsightDetailsRequest')
177
+ DescribeInsightDetailsResponse = Shapes::StructureShape.new(name: 'DescribeInsightDetailsResponse')
176
178
  DescribeInstanceTypeLimitsRequest = Shapes::StructureShape.new(name: 'DescribeInstanceTypeLimitsRequest')
177
179
  DescribeInstanceTypeLimitsResponse = Shapes::StructureShape.new(name: 'DescribeInstanceTypeLimitsResponse')
178
180
  DescribeOutboundConnectionsRequest = Shapes::StructureShape.new(name: 'DescribeOutboundConnectionsRequest')
@@ -296,6 +298,20 @@ module Aws::OpenSearchService
296
298
  IndexSchema = Shapes::DocumentShape.new(name: 'IndexSchema', document: true)
297
299
  IndexStatus = Shapes::StringShape.new(name: 'IndexStatus')
298
300
  InitiatedBy = Shapes::StringShape.new(name: 'InitiatedBy')
301
+ Insight = Shapes::StructureShape.new(name: 'Insight')
302
+ InsightEntity = Shapes::StructureShape.new(name: 'InsightEntity')
303
+ InsightEntityType = Shapes::StringShape.new(name: 'InsightEntityType')
304
+ InsightEntityValue = Shapes::StringShape.new(name: 'InsightEntityValue')
305
+ InsightField = Shapes::StructureShape.new(name: 'InsightField')
306
+ InsightFieldList = Shapes::ListShape.new(name: 'InsightFieldList')
307
+ InsightFieldType = Shapes::StringShape.new(name: 'InsightFieldType')
308
+ InsightList = Shapes::ListShape.new(name: 'InsightList')
309
+ InsightPageSize = Shapes::IntegerShape.new(name: 'InsightPageSize')
310
+ InsightPriorityLevel = Shapes::StringShape.new(name: 'InsightPriorityLevel')
311
+ InsightSortOrder = Shapes::StringShape.new(name: 'InsightSortOrder')
312
+ InsightStatus = Shapes::StringShape.new(name: 'InsightStatus')
313
+ InsightTimeRange = Shapes::StructureShape.new(name: 'InsightTimeRange')
314
+ InsightType = Shapes::StringShape.new(name: 'InsightType')
299
315
  InstanceCount = Shapes::IntegerShape.new(name: 'InstanceCount')
300
316
  InstanceCountLimits = Shapes::StructureShape.new(name: 'InstanceCountLimits')
301
317
  InstanceLimits = Shapes::StructureShape.new(name: 'InstanceLimits')
@@ -336,6 +352,8 @@ module Aws::OpenSearchService
336
352
  ListDomainNamesResponse = Shapes::StructureShape.new(name: 'ListDomainNamesResponse')
337
353
  ListDomainsForPackageRequest = Shapes::StructureShape.new(name: 'ListDomainsForPackageRequest')
338
354
  ListDomainsForPackageResponse = Shapes::StructureShape.new(name: 'ListDomainsForPackageResponse')
355
+ ListInsightsRequest = Shapes::StructureShape.new(name: 'ListInsightsRequest')
356
+ ListInsightsResponse = Shapes::StructureShape.new(name: 'ListInsightsResponse')
339
357
  ListInstanceTypeDetailsRequest = Shapes::StructureShape.new(name: 'ListInstanceTypeDetailsRequest')
340
358
  ListInstanceTypeDetailsResponse = Shapes::StructureShape.new(name: 'ListInstanceTypeDetailsResponse')
341
359
  ListPackagesForDomainRequest = Shapes::StructureShape.new(name: 'ListPackagesForDomainRequest')
@@ -1120,6 +1138,14 @@ module Aws::OpenSearchService
1120
1138
  DescribeInboundConnectionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
1121
1139
  DescribeInboundConnectionsResponse.struct_class = Types::DescribeInboundConnectionsResponse
1122
1140
 
1141
+ DescribeInsightDetailsRequest.add_member(:entity, Shapes::ShapeRef.new(shape: InsightEntity, required: true, location_name: "Entity"))
1142
+ DescribeInsightDetailsRequest.add_member(:insight_id, Shapes::ShapeRef.new(shape: GUID, required: true, location_name: "InsightId"))
1143
+ DescribeInsightDetailsRequest.add_member(:show_html_content, Shapes::ShapeRef.new(shape: Boolean, location_name: "ShowHtmlContent"))
1144
+ DescribeInsightDetailsRequest.struct_class = Types::DescribeInsightDetailsRequest
1145
+
1146
+ DescribeInsightDetailsResponse.add_member(:fields, Shapes::ShapeRef.new(shape: InsightFieldList, required: true, location_name: "Fields"))
1147
+ DescribeInsightDetailsResponse.struct_class = Types::DescribeInsightDetailsResponse
1148
+
1123
1149
  DescribeInstanceTypeLimitsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location: "querystring", location_name: "domainName"))
1124
1150
  DescribeInstanceTypeLimitsRequest.add_member(:instance_type, Shapes::ShapeRef.new(shape: OpenSearchPartitionInstanceType, required: true, location: "uri", location_name: "InstanceType"))
1125
1151
  DescribeInstanceTypeLimitsRequest.add_member(:engine_version, Shapes::ShapeRef.new(shape: VersionString, required: true, location: "uri", location_name: "EngineVersion"))
@@ -1545,6 +1571,33 @@ module Aws::OpenSearchService
1545
1571
 
1546
1572
  InboundConnections.member = Shapes::ShapeRef.new(shape: InboundConnection)
1547
1573
 
1574
+ Insight.add_member(:insight_id, Shapes::ShapeRef.new(shape: GUID, location_name: "InsightId"))
1575
+ Insight.add_member(:display_name, Shapes::ShapeRef.new(shape: String, location_name: "DisplayName"))
1576
+ Insight.add_member(:type, Shapes::ShapeRef.new(shape: InsightType, location_name: "Type"))
1577
+ Insight.add_member(:priority, Shapes::ShapeRef.new(shape: InsightPriorityLevel, location_name: "Priority"))
1578
+ Insight.add_member(:status, Shapes::ShapeRef.new(shape: InsightStatus, location_name: "Status"))
1579
+ Insight.add_member(:creation_time, Shapes::ShapeRef.new(shape: UpdateTimestamp, location_name: "CreationTime"))
1580
+ Insight.add_member(:update_time, Shapes::ShapeRef.new(shape: UpdateTimestamp, location_name: "UpdateTime"))
1581
+ Insight.add_member(:is_experimental, Shapes::ShapeRef.new(shape: Boolean, location_name: "IsExperimental"))
1582
+ Insight.struct_class = Types::Insight
1583
+
1584
+ InsightEntity.add_member(:type, Shapes::ShapeRef.new(shape: InsightEntityType, required: true, location_name: "Type"))
1585
+ InsightEntity.add_member(:value, Shapes::ShapeRef.new(shape: InsightEntityValue, location_name: "Value"))
1586
+ InsightEntity.struct_class = Types::InsightEntity
1587
+
1588
+ InsightField.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
1589
+ InsightField.add_member(:type, Shapes::ShapeRef.new(shape: InsightFieldType, required: true, location_name: "Type"))
1590
+ InsightField.add_member(:value, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Value"))
1591
+ InsightField.struct_class = Types::InsightField
1592
+
1593
+ InsightFieldList.member = Shapes::ShapeRef.new(shape: InsightField)
1594
+
1595
+ InsightList.member = Shapes::ShapeRef.new(shape: Insight)
1596
+
1597
+ InsightTimeRange.add_member(:from, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "From"))
1598
+ InsightTimeRange.add_member(:to, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "To"))
1599
+ InsightTimeRange.struct_class = Types::InsightTimeRange
1600
+
1548
1601
  InstanceCountLimits.add_member(:minimum_instance_count, Shapes::ShapeRef.new(shape: MinimumInstanceCount, location_name: "MinimumInstanceCount"))
1549
1602
  InstanceCountLimits.add_member(:maximum_instance_count, Shapes::ShapeRef.new(shape: MaximumInstanceCount, location_name: "MaximumInstanceCount"))
1550
1603
  InstanceCountLimits.struct_class = Types::InstanceCountLimits
@@ -1650,6 +1703,17 @@ module Aws::OpenSearchService
1650
1703
  ListDomainsForPackageResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1651
1704
  ListDomainsForPackageResponse.struct_class = Types::ListDomainsForPackageResponse
1652
1705
 
1706
+ ListInsightsRequest.add_member(:entity, Shapes::ShapeRef.new(shape: InsightEntity, required: true, location_name: "Entity"))
1707
+ ListInsightsRequest.add_member(:time_range, Shapes::ShapeRef.new(shape: InsightTimeRange, location_name: "TimeRange"))
1708
+ ListInsightsRequest.add_member(:sort_order, Shapes::ShapeRef.new(shape: InsightSortOrder, location_name: "SortOrder"))
1709
+ ListInsightsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: InsightPageSize, location_name: "MaxResults"))
1710
+ ListInsightsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1711
+ ListInsightsRequest.struct_class = Types::ListInsightsRequest
1712
+
1713
+ ListInsightsResponse.add_member(:insights, Shapes::ShapeRef.new(shape: InsightList, location_name: "Insights"))
1714
+ ListInsightsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
1715
+ ListInsightsResponse.struct_class = Types::ListInsightsResponse
1716
+
1653
1717
  ListInstanceTypeDetailsRequest.add_member(:engine_version, Shapes::ShapeRef.new(shape: VersionString, required: true, location: "uri", location_name: "EngineVersion"))
1654
1718
  ListInstanceTypeDetailsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location: "querystring", location_name: "domainName"))
1655
1719
  ListInstanceTypeDetailsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
@@ -2725,6 +2789,20 @@ module Aws::OpenSearchService
2725
2789
  )
2726
2790
  end)
2727
2791
 
2792
+ api.add_operation(:describe_insight_details, Seahorse::Model::Operation.new.tap do |o|
2793
+ o.name = "DescribeInsightDetails"
2794
+ o.http_method = "POST"
2795
+ o.http_request_uri = "/2021-01-01/opensearch/insight-details"
2796
+ o.input = Shapes::ShapeRef.new(shape: DescribeInsightDetailsRequest)
2797
+ o.output = Shapes::ShapeRef.new(shape: DescribeInsightDetailsResponse)
2798
+ o.errors << Shapes::ShapeRef.new(shape: BaseException)
2799
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
2800
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
2801
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
2802
+ o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
2803
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
2804
+ end)
2805
+
2728
2806
  api.add_operation(:describe_instance_type_limits, Seahorse::Model::Operation.new.tap do |o|
2729
2807
  o.name = "DescribeInstanceTypeLimits"
2730
2808
  o.http_method = "GET"
@@ -3090,6 +3168,20 @@ module Aws::OpenSearchService
3090
3168
  )
3091
3169
  end)
3092
3170
 
3171
+ api.add_operation(:list_insights, Seahorse::Model::Operation.new.tap do |o|
3172
+ o.name = "ListInsights"
3173
+ o.http_method = "POST"
3174
+ o.http_request_uri = "/2021-01-01/opensearch/insights"
3175
+ o.input = Shapes::ShapeRef.new(shape: ListInsightsRequest)
3176
+ o.output = Shapes::ShapeRef.new(shape: ListInsightsResponse)
3177
+ o.errors << Shapes::ShapeRef.new(shape: BaseException)
3178
+ o.errors << Shapes::ShapeRef.new(shape: InternalException)
3179
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
3180
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
3181
+ o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
3182
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
3183
+ end)
3184
+
3093
3185
  api.add_operation(:list_instance_type_details, Seahorse::Model::Operation.new.tap do |o|
3094
3186
  o.name = "ListInstanceTypeDetails"
3095
3187
  o.http_method = "GET"
@@ -2896,6 +2896,50 @@ module Aws::OpenSearchService
2896
2896
  include Aws::Structure
2897
2897
  end
2898
2898
 
2899
+ # Container for the parameters to the `DescribeInsightDetails`
2900
+ # operation.
2901
+ #
2902
+ # @!attribute [rw] entity
2903
+ # The entity for which to retrieve insight details. Specifies the type
2904
+ # and value of the entity, such as a domain name or Amazon Web
2905
+ # Services account ID.
2906
+ # @return [Types::InsightEntity]
2907
+ #
2908
+ # @!attribute [rw] insight_id
2909
+ # The unique identifier of the insight to describe.
2910
+ # @return [String]
2911
+ #
2912
+ # @!attribute [rw] show_html_content
2913
+ # Specifies whether to show response with HTML content in response or
2914
+ # not.
2915
+ # @return [Boolean]
2916
+ #
2917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInsightDetailsRequest AWS API Documentation
2918
+ #
2919
+ class DescribeInsightDetailsRequest < Struct.new(
2920
+ :entity,
2921
+ :insight_id,
2922
+ :show_html_content)
2923
+ SENSITIVE = []
2924
+ include Aws::Structure
2925
+ end
2926
+
2927
+ # The result of a `DescribeInsightDetails` request. Contains the
2928
+ # detailed fields associated with the specified insight.
2929
+ #
2930
+ # @!attribute [rw] fields
2931
+ # The list of fields that contain detailed information about the
2932
+ # insight.
2933
+ # @return [Array<Types::InsightField>]
2934
+ #
2935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInsightDetailsResponse AWS API Documentation
2936
+ #
2937
+ class DescribeInsightDetailsResponse < Struct.new(
2938
+ :fields)
2939
+ SENSITIVE = []
2940
+ include Aws::Structure
2941
+ end
2942
+
2899
2943
  # Container for the parameters to the `DescribeInstanceTypeLimits`
2900
2944
  # operation.
2901
2945
  #
@@ -5054,6 +5098,128 @@ module Aws::OpenSearchService
5054
5098
  include Aws::Structure
5055
5099
  end
5056
5100
 
5101
+ # Represents an insight returned by the `ListInsights` operation. An
5102
+ # insight is a notification about a domain event or recommendation that
5103
+ # helps you optimize your Amazon OpenSearch Service domain.
5104
+ #
5105
+ # @!attribute [rw] insight_id
5106
+ # The unique identifier of the insight.
5107
+ # @return [String]
5108
+ #
5109
+ # @!attribute [rw] display_name
5110
+ # The display name of the insight.
5111
+ # @return [String]
5112
+ #
5113
+ # @!attribute [rw] type
5114
+ # The type of the insight. Possible values are `EVENT` and
5115
+ # `RECOMMENDATION`.
5116
+ # @return [String]
5117
+ #
5118
+ # @!attribute [rw] priority
5119
+ # The priority level of the insight. Possible values are `CRITICAL`,
5120
+ # `HIGH`, `MEDIUM`, and `LOW`.
5121
+ # @return [String]
5122
+ #
5123
+ # @!attribute [rw] status
5124
+ # The current status of the insight. Possible values are `ACTIVE`,
5125
+ # `RESOLVED`, and `DISMISSED`.
5126
+ # @return [String]
5127
+ #
5128
+ # @!attribute [rw] creation_time
5129
+ # The timestamp when the insight was created, in epoch milliseconds.
5130
+ # @return [Time]
5131
+ #
5132
+ # @!attribute [rw] update_time
5133
+ # The timestamp when the insight was last updated, in epoch
5134
+ # milliseconds.
5135
+ # @return [Time]
5136
+ #
5137
+ # @!attribute [rw] is_experimental
5138
+ # Indicates whether the insight is experimental.
5139
+ # @return [Boolean]
5140
+ #
5141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/Insight AWS API Documentation
5142
+ #
5143
+ class Insight < Struct.new(
5144
+ :insight_id,
5145
+ :display_name,
5146
+ :type,
5147
+ :priority,
5148
+ :status,
5149
+ :creation_time,
5150
+ :update_time,
5151
+ :is_experimental)
5152
+ SENSITIVE = []
5153
+ include Aws::Structure
5154
+ end
5155
+
5156
+ # Specifies the entity for which to retrieve insights. An entity can be
5157
+ # an Amazon OpenSearch Service domain or an Amazon Web Services account.
5158
+ #
5159
+ # @!attribute [rw] type
5160
+ # The type of the entity. Possible values are `Account` and
5161
+ # `DomainName`.
5162
+ # @return [String]
5163
+ #
5164
+ # @!attribute [rw] value
5165
+ # The value of the entity. For `DomainName`, this is the domain name.
5166
+ # For `Account`, this is the Amazon Web Services account ID.
5167
+ # @return [String]
5168
+ #
5169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InsightEntity AWS API Documentation
5170
+ #
5171
+ class InsightEntity < Struct.new(
5172
+ :type,
5173
+ :value)
5174
+ SENSITIVE = []
5175
+ include Aws::Structure
5176
+ end
5177
+
5178
+ # Represents a field in the detailed view of an insight, returned by the
5179
+ # `DescribeInsightDetails` operation.
5180
+ #
5181
+ # @!attribute [rw] name
5182
+ # The name of the insight field.
5183
+ # @return [String]
5184
+ #
5185
+ # @!attribute [rw] type
5186
+ # The type of the insight field. Possible values are `text` and
5187
+ # `metric`.
5188
+ # @return [String]
5189
+ #
5190
+ # @!attribute [rw] value
5191
+ # The value of the insight field.
5192
+ # @return [String]
5193
+ #
5194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InsightField AWS API Documentation
5195
+ #
5196
+ class InsightField < Struct.new(
5197
+ :name,
5198
+ :type,
5199
+ :value)
5200
+ SENSITIVE = []
5201
+ include Aws::Structure
5202
+ end
5203
+
5204
+ # Specifies the time range for filtering insights.
5205
+ #
5206
+ # @!attribute [rw] from
5207
+ # The start of the time range, in epoch milliseconds.
5208
+ # @return [Integer]
5209
+ #
5210
+ # @!attribute [rw] to
5211
+ # The end of the time range, in epoch milliseconds.
5212
+ # @return [Integer]
5213
+ #
5214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InsightTimeRange AWS API Documentation
5215
+ #
5216
+ class InsightTimeRange < Struct.new(
5217
+ :from,
5218
+ :to)
5219
+ SENSITIVE = []
5220
+ include Aws::Structure
5221
+ end
5222
+
5057
5223
  # Limits on the number of instances that can be created in OpenSearch
5058
5224
  # Service for a given instance type.
5059
5225
  #
@@ -5535,6 +5701,71 @@ module Aws::OpenSearchService
5535
5701
  include Aws::Structure
5536
5702
  end
5537
5703
 
5704
+ # Container for the parameters to the `ListInsights` operation.
5705
+ #
5706
+ # @!attribute [rw] entity
5707
+ # The entity for which to list insights. Specifies the type and value
5708
+ # of the entity, such as a domain name or Amazon Web Services account
5709
+ # ID.
5710
+ # @return [Types::InsightEntity]
5711
+ #
5712
+ # @!attribute [rw] time_range
5713
+ # The time range for filtering insights, specified as epoch
5714
+ # millisecond timestamps.
5715
+ # @return [Types::InsightTimeRange]
5716
+ #
5717
+ # @!attribute [rw] sort_order
5718
+ # The sort order for the results. Possible values are `ASC`
5719
+ # (ascending) and `DESC` (descending).
5720
+ # @return [String]
5721
+ #
5722
+ # @!attribute [rw] max_results
5723
+ # An optional parameter that specifies the maximum number of results
5724
+ # to return. You can use `NextToken` to get the next page of results.
5725
+ # Valid values are 1 to 500.
5726
+ # @return [Integer]
5727
+ #
5728
+ # @!attribute [rw] next_token
5729
+ # If your initial `ListInsights` operation returns a `NextToken`,
5730
+ # include the returned `NextToken` in subsequent `ListInsights`
5731
+ # operations to retrieve the next page of results.
5732
+ # @return [String]
5733
+ #
5734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInsightsRequest AWS API Documentation
5735
+ #
5736
+ class ListInsightsRequest < Struct.new(
5737
+ :entity,
5738
+ :time_range,
5739
+ :sort_order,
5740
+ :max_results,
5741
+ :next_token)
5742
+ SENSITIVE = []
5743
+ include Aws::Structure
5744
+ end
5745
+
5746
+ # The result of a `ListInsights` request. Contains the list of insights
5747
+ # and a pagination token for retrieving the next page of results.
5748
+ #
5749
+ # @!attribute [rw] insights
5750
+ # The list of insights returned for the specified entity.
5751
+ # @return [Array<Types::Insight>]
5752
+ #
5753
+ # @!attribute [rw] next_token
5754
+ # When `NextToken` is returned, there are more results available. The
5755
+ # value of `NextToken` is a unique pagination token for each page.
5756
+ # Send the request again using the returned token to retrieve the next
5757
+ # page.
5758
+ # @return [String]
5759
+ #
5760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInsightsResponse AWS API Documentation
5761
+ #
5762
+ class ListInsightsResponse < Struct.new(
5763
+ :insights,
5764
+ :next_token)
5765
+ SENSITIVE = []
5766
+ include Aws::Structure
5767
+ end
5768
+
5538
5769
  # @!attribute [rw] engine_version
5539
5770
  # The version of OpenSearch or Elasticsearch, in the format
5540
5771
  # Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
@@ -54,7 +54,7 @@ module Aws::OpenSearchService
54
54
  autoload :EndpointProvider, 'aws-sdk-opensearchservice/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-opensearchservice/endpoints'
56
56
 
57
- GEM_VERSION = '1.91.0'
57
+ GEM_VERSION = '1.92.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -732,6 +732,21 @@ module Aws
732
732
  ) -> _DescribeInboundConnectionsResponseSuccess
733
733
  | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeInboundConnectionsResponseSuccess
734
734
 
735
+ interface _DescribeInsightDetailsResponseSuccess
736
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeInsightDetailsResponse]
737
+ def fields: () -> ::Array[Types::InsightField]
738
+ end
739
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#describe_insight_details-instance_method
740
+ def describe_insight_details: (
741
+ entity: {
742
+ type: ("Account" | "DomainName"),
743
+ value: ::String?
744
+ },
745
+ insight_id: ::String,
746
+ ?show_html_content: bool
747
+ ) -> _DescribeInsightDetailsResponseSuccess
748
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeInsightDetailsResponseSuccess
749
+
735
750
  interface _DescribeInstanceTypeLimitsResponseSuccess
736
751
  include ::Seahorse::Client::_ResponseSuccess[Types::DescribeInstanceTypeLimitsResponse]
737
752
  def limits_by_role: () -> ::Hash[::String, Types::Limits]
@@ -1045,6 +1060,27 @@ module Aws
1045
1060
  ) -> _ListDomainsForPackageResponseSuccess
1046
1061
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDomainsForPackageResponseSuccess
1047
1062
 
1063
+ interface _ListInsightsResponseSuccess
1064
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListInsightsResponse]
1065
+ def insights: () -> ::Array[Types::Insight]
1066
+ def next_token: () -> ::String
1067
+ end
1068
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#list_insights-instance_method
1069
+ def list_insights: (
1070
+ entity: {
1071
+ type: ("Account" | "DomainName"),
1072
+ value: ::String?
1073
+ },
1074
+ ?time_range: {
1075
+ from: ::Integer,
1076
+ to: ::Integer
1077
+ },
1078
+ ?sort_order: ("ASC" | "DESC"),
1079
+ ?max_results: ::Integer,
1080
+ ?next_token: ::String
1081
+ ) -> _ListInsightsResponseSuccess
1082
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListInsightsResponseSuccess
1083
+
1048
1084
  interface _ListInstanceTypeDetailsResponseSuccess
1049
1085
  include ::Seahorse::Client::_ResponseSuccess[Types::ListInstanceTypeDetailsResponse]
1050
1086
  def instance_type_details: () -> ::Array[Types::InstanceTypeDetails]
data/sig/types.rbs CHANGED
@@ -741,6 +741,18 @@ module Aws::OpenSearchService
741
741
  SENSITIVE: []
742
742
  end
743
743
 
744
+ class DescribeInsightDetailsRequest
745
+ attr_accessor entity: Types::InsightEntity
746
+ attr_accessor insight_id: ::String
747
+ attr_accessor show_html_content: bool
748
+ SENSITIVE: []
749
+ end
750
+
751
+ class DescribeInsightDetailsResponse
752
+ attr_accessor fields: ::Array[Types::InsightField]
753
+ SENSITIVE: []
754
+ end
755
+
744
756
  class DescribeInstanceTypeLimitsRequest
745
757
  attr_accessor domain_name: ::String
746
758
  attr_accessor instance_type: ("m3.medium.search" | "m3.large.search" | "m3.xlarge.search" | "m3.2xlarge.search" | "m4.large.search" | "m4.xlarge.search" | "m4.2xlarge.search" | "m4.4xlarge.search" | "m4.10xlarge.search" | "m5.large.search" | "m5.xlarge.search" | "m5.2xlarge.search" | "m5.4xlarge.search" | "m5.12xlarge.search" | "m5.24xlarge.search" | "r5.large.search" | "r5.xlarge.search" | "r5.2xlarge.search" | "r5.4xlarge.search" | "r5.12xlarge.search" | "r5.24xlarge.search" | "c5.large.search" | "c5.xlarge.search" | "c5.2xlarge.search" | "c5.4xlarge.search" | "c5.9xlarge.search" | "c5.18xlarge.search" | "t3.nano.search" | "t3.micro.search" | "t3.small.search" | "t3.medium.search" | "t3.large.search" | "t3.xlarge.search" | "t3.2xlarge.search" | "or1.medium.search" | "or1.large.search" | "or1.xlarge.search" | "or1.2xlarge.search" | "or1.4xlarge.search" | "or1.8xlarge.search" | "or1.12xlarge.search" | "or1.16xlarge.search" | "ultrawarm1.medium.search" | "ultrawarm1.large.search" | "ultrawarm1.xlarge.search" | "t2.micro.search" | "t2.small.search" | "t2.medium.search" | "r3.large.search" | "r3.xlarge.search" | "r3.2xlarge.search" | "r3.4xlarge.search" | "r3.8xlarge.search" | "i2.xlarge.search" | "i2.2xlarge.search" | "d2.xlarge.search" | "d2.2xlarge.search" | "d2.4xlarge.search" | "d2.8xlarge.search" | "c4.large.search" | "c4.xlarge.search" | "c4.2xlarge.search" | "c4.4xlarge.search" | "c4.8xlarge.search" | "r4.large.search" | "r4.xlarge.search" | "r4.2xlarge.search" | "r4.4xlarge.search" | "r4.8xlarge.search" | "r4.16xlarge.search" | "i3.large.search" | "i3.xlarge.search" | "i3.2xlarge.search" | "i3.4xlarge.search" | "i3.8xlarge.search" | "i3.16xlarge.search" | "r6g.large.search" | "r6g.xlarge.search" | "r6g.2xlarge.search" | "r6g.4xlarge.search" | "r6g.8xlarge.search" | "r6g.12xlarge.search" | "m6g.large.search" | "m6g.xlarge.search" | "m6g.2xlarge.search" | "m6g.4xlarge.search" | "m6g.8xlarge.search" | "m6g.12xlarge.search" | "c6g.large.search" | "c6g.xlarge.search" | "c6g.2xlarge.search" | "c6g.4xlarge.search" | "c6g.8xlarge.search" | "c6g.12xlarge.search" | "r6gd.large.search" | "r6gd.xlarge.search" | "r6gd.2xlarge.search" | "r6gd.4xlarge.search" | "r6gd.8xlarge.search" | "r6gd.12xlarge.search" | "r6gd.16xlarge.search" | "t4g.small.search" | "t4g.medium.search")
@@ -1276,6 +1288,37 @@ module Aws::OpenSearchService
1276
1288
  SENSITIVE: []
1277
1289
  end
1278
1290
 
1291
+ class Insight
1292
+ attr_accessor insight_id: ::String
1293
+ attr_accessor display_name: ::String
1294
+ attr_accessor type: ("EVENT" | "RECOMMENDATION")
1295
+ attr_accessor priority: ("CRITICAL" | "HIGH" | "MEDIUM" | "LOW")
1296
+ attr_accessor status: ("ACTIVE" | "RESOLVED" | "DISMISSED")
1297
+ attr_accessor creation_time: ::Time
1298
+ attr_accessor update_time: ::Time
1299
+ attr_accessor is_experimental: bool
1300
+ SENSITIVE: []
1301
+ end
1302
+
1303
+ class InsightEntity
1304
+ attr_accessor type: ("Account" | "DomainName")
1305
+ attr_accessor value: ::String
1306
+ SENSITIVE: []
1307
+ end
1308
+
1309
+ class InsightField
1310
+ attr_accessor name: ::String
1311
+ attr_accessor type: ("text" | "metric")
1312
+ attr_accessor value: ::String
1313
+ SENSITIVE: []
1314
+ end
1315
+
1316
+ class InsightTimeRange
1317
+ attr_accessor from: ::Integer
1318
+ attr_accessor to: ::Integer
1319
+ SENSITIVE: []
1320
+ end
1321
+
1279
1322
  class InstanceCountLimits
1280
1323
  attr_accessor minimum_instance_count: ::Integer
1281
1324
  attr_accessor maximum_instance_count: ::Integer
@@ -1412,6 +1455,21 @@ module Aws::OpenSearchService
1412
1455
  SENSITIVE: []
1413
1456
  end
1414
1457
 
1458
+ class ListInsightsRequest
1459
+ attr_accessor entity: Types::InsightEntity
1460
+ attr_accessor time_range: Types::InsightTimeRange
1461
+ attr_accessor sort_order: ("ASC" | "DESC")
1462
+ attr_accessor max_results: ::Integer
1463
+ attr_accessor next_token: ::String
1464
+ SENSITIVE: []
1465
+ end
1466
+
1467
+ class ListInsightsResponse
1468
+ attr_accessor insights: ::Array[Types::Insight]
1469
+ attr_accessor next_token: ::String
1470
+ SENSITIVE: []
1471
+ end
1472
+
1415
1473
  class ListInstanceTypeDetailsRequest
1416
1474
  attr_accessor engine_version: ::String
1417
1475
  attr_accessor domain_name: ::String
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-opensearchservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.91.0
4
+ version: 1.92.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services