aws-sdk-opensearchservice 1.92.0 → 1.93.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +134 -1
- data/lib/aws-sdk-opensearchservice/client_api.rb +117 -0
- data/lib/aws-sdk-opensearchservice/errors.rb +11 -0
- data/lib/aws-sdk-opensearchservice/types.rb +256 -0
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- data/sig/client.rbs +44 -0
- data/sig/errors.rbs +2 -0
- data/sig/types.rbs +86 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6df190b1ab8efc84f574af7737100aaa3c1908ad17a5f0926a649a4b52e67931
|
|
4
|
+
data.tar.gz: 109be15b74bfd5ef2abdff355f9191afa316106da745bf126206bcacc61acb80
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1bcf42058a86dfac4cd8c1cf85e7c879d3813ef71b6cd4da3cd59dafe79d2a7575cbfa73c4522084810aa2ca73cde2e2226b2ff23583a50144c4ee5b3805ca46
|
|
7
|
+
data.tar.gz: cad656ba77b499194ec4309f7117f75240703019d2e582f0ad8b5d065b8ed0bd7984f74d50069bea7880377b6d06e2e83fd5aca932d827cdabbe01bdf2253a8a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.93.0 (2026-03-31)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Support RegisterCapability, GetCapability, DeregisterCapability API for AI Assistant feature management for OpenSearch UI Applications
|
|
8
|
+
|
|
4
9
|
1.92.0 (2026-03-30)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.93.0
|
|
@@ -2233,6 +2233,40 @@ module Aws::OpenSearchService
|
|
|
2233
2233
|
req.send_request(options)
|
|
2234
2234
|
end
|
|
2235
2235
|
|
|
2236
|
+
# Deregisters a capability from an OpenSearch UI application. This
|
|
2237
|
+
# operation removes the capability and its associated configuration.
|
|
2238
|
+
#
|
|
2239
|
+
# @option params [required, String] :application_id
|
|
2240
|
+
# The unique identifier of the OpenSearch UI application to deregister
|
|
2241
|
+
# the capability from.
|
|
2242
|
+
#
|
|
2243
|
+
# @option params [required, String] :capability_name
|
|
2244
|
+
# The name of the capability to deregister.
|
|
2245
|
+
#
|
|
2246
|
+
# @return [Types::DeregisterCapabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2247
|
+
#
|
|
2248
|
+
# * {Types::DeregisterCapabilityResponse#status #status} => String
|
|
2249
|
+
#
|
|
2250
|
+
# @example Request syntax with placeholder values
|
|
2251
|
+
#
|
|
2252
|
+
# resp = client.deregister_capability({
|
|
2253
|
+
# application_id: "ApplicationId", # required
|
|
2254
|
+
# capability_name: "CapabilityName", # required
|
|
2255
|
+
# })
|
|
2256
|
+
#
|
|
2257
|
+
# @example Response structure
|
|
2258
|
+
#
|
|
2259
|
+
# resp.status #=> String, one of "creating", "create_failed", "active", "updating", "update_failed", "deleting", "delete_failed"
|
|
2260
|
+
#
|
|
2261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeregisterCapability AWS API Documentation
|
|
2262
|
+
#
|
|
2263
|
+
# @overload deregister_capability(params = {})
|
|
2264
|
+
# @param [Hash] params ({})
|
|
2265
|
+
def deregister_capability(params = {}, options = {})
|
|
2266
|
+
req = build_request(:deregister_capability, params)
|
|
2267
|
+
req.send_request(options)
|
|
2268
|
+
end
|
|
2269
|
+
|
|
2236
2270
|
# Describes the domain configuration for the specified Amazon OpenSearch
|
|
2237
2271
|
# Service domain, including the domain ID, domain service endpoint, and
|
|
2238
2272
|
# domain ARN.
|
|
@@ -3787,6 +3821,48 @@ module Aws::OpenSearchService
|
|
|
3787
3821
|
req.send_request(options)
|
|
3788
3822
|
end
|
|
3789
3823
|
|
|
3824
|
+
# Retrieves information about a registered capability for an OpenSearch
|
|
3825
|
+
# UI application, including its configuration and current status.
|
|
3826
|
+
#
|
|
3827
|
+
# @option params [required, String] :application_id
|
|
3828
|
+
# The unique identifier of the OpenSearch UI application.
|
|
3829
|
+
#
|
|
3830
|
+
# @option params [required, String] :capability_name
|
|
3831
|
+
# The name of the capability to retrieve information about.
|
|
3832
|
+
#
|
|
3833
|
+
# @return [Types::GetCapabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3834
|
+
#
|
|
3835
|
+
# * {Types::GetCapabilityResponse#capability_name #capability_name} => String
|
|
3836
|
+
# * {Types::GetCapabilityResponse#application_id #application_id} => String
|
|
3837
|
+
# * {Types::GetCapabilityResponse#status #status} => String
|
|
3838
|
+
# * {Types::GetCapabilityResponse#capability_config #capability_config} => Types::CapabilityExtendedResponseConfig
|
|
3839
|
+
# * {Types::GetCapabilityResponse#failures #failures} => Array<Types::CapabilityFailure>
|
|
3840
|
+
#
|
|
3841
|
+
# @example Request syntax with placeholder values
|
|
3842
|
+
#
|
|
3843
|
+
# resp = client.get_capability({
|
|
3844
|
+
# application_id: "ApplicationId", # required
|
|
3845
|
+
# capability_name: "CapabilityName", # required
|
|
3846
|
+
# })
|
|
3847
|
+
#
|
|
3848
|
+
# @example Response structure
|
|
3849
|
+
#
|
|
3850
|
+
# resp.capability_name #=> String
|
|
3851
|
+
# resp.application_id #=> String
|
|
3852
|
+
# resp.status #=> String, one of "creating", "create_failed", "active", "updating", "update_failed", "deleting", "delete_failed"
|
|
3853
|
+
# resp.failures #=> Array
|
|
3854
|
+
# resp.failures[0].reason #=> String, one of "KMS_KEY_INSUFFICIENT_PERMISSION"
|
|
3855
|
+
# resp.failures[0].details #=> String
|
|
3856
|
+
#
|
|
3857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCapability AWS API Documentation
|
|
3858
|
+
#
|
|
3859
|
+
# @overload get_capability(params = {})
|
|
3860
|
+
# @param [Hash] params ({})
|
|
3861
|
+
def get_capability(params = {}, options = {})
|
|
3862
|
+
req = build_request(:get_capability, params)
|
|
3863
|
+
req.send_request(options)
|
|
3864
|
+
end
|
|
3865
|
+
|
|
3790
3866
|
# Returns a map of OpenSearch or Elasticsearch versions and the versions
|
|
3791
3867
|
# you can upgrade them to.
|
|
3792
3868
|
#
|
|
@@ -4991,6 +5067,63 @@ module Aws::OpenSearchService
|
|
|
4991
5067
|
req.send_request(options)
|
|
4992
5068
|
end
|
|
4993
5069
|
|
|
5070
|
+
# Registers a capability for an OpenSearch UI application. Use this
|
|
5071
|
+
# operation to enable specific capabilities, such as AI features, for a
|
|
5072
|
+
# given application. The capability configuration defines the type and
|
|
5073
|
+
# settings of the capability to register. For more information about the
|
|
5074
|
+
# AI features, see [Agentic AI for OpenSearch UI][1].
|
|
5075
|
+
#
|
|
5076
|
+
#
|
|
5077
|
+
#
|
|
5078
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application-ai-assistant.html
|
|
5079
|
+
#
|
|
5080
|
+
# @option params [required, String] :application_id
|
|
5081
|
+
# The unique identifier of the OpenSearch UI application to register the
|
|
5082
|
+
# capability for.
|
|
5083
|
+
#
|
|
5084
|
+
# @option params [required, String] :capability_name
|
|
5085
|
+
# The name of the capability to register. Must be between 3 and 30
|
|
5086
|
+
# characters and contain only alphanumeric characters and hyphens. This
|
|
5087
|
+
# identifies the type of capability being enabled for the application.
|
|
5088
|
+
# For registering AI Assistant capability, use `ai-capability`
|
|
5089
|
+
#
|
|
5090
|
+
# @option params [required, Types::CapabilityBaseRequestConfig] :capability_config
|
|
5091
|
+
# The configuration settings for the capability being registered. This
|
|
5092
|
+
# includes capability-specific settings such as AI configuration.
|
|
5093
|
+
#
|
|
5094
|
+
# @return [Types::RegisterCapabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5095
|
+
#
|
|
5096
|
+
# * {Types::RegisterCapabilityResponse#capability_name #capability_name} => String
|
|
5097
|
+
# * {Types::RegisterCapabilityResponse#application_id #application_id} => String
|
|
5098
|
+
# * {Types::RegisterCapabilityResponse#status #status} => String
|
|
5099
|
+
# * {Types::RegisterCapabilityResponse#capability_config #capability_config} => Types::CapabilityBaseResponseConfig
|
|
5100
|
+
#
|
|
5101
|
+
# @example Request syntax with placeholder values
|
|
5102
|
+
#
|
|
5103
|
+
# resp = client.register_capability({
|
|
5104
|
+
# application_id: "ApplicationId", # required
|
|
5105
|
+
# capability_name: "CapabilityName", # required
|
|
5106
|
+
# capability_config: { # required
|
|
5107
|
+
# ai_config: {
|
|
5108
|
+
# },
|
|
5109
|
+
# },
|
|
5110
|
+
# })
|
|
5111
|
+
#
|
|
5112
|
+
# @example Response structure
|
|
5113
|
+
#
|
|
5114
|
+
# resp.capability_name #=> String
|
|
5115
|
+
# resp.application_id #=> String
|
|
5116
|
+
# resp.status #=> String, one of "creating", "create_failed", "active", "updating", "update_failed", "deleting", "delete_failed"
|
|
5117
|
+
#
|
|
5118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RegisterCapability AWS API Documentation
|
|
5119
|
+
#
|
|
5120
|
+
# @overload register_capability(params = {})
|
|
5121
|
+
# @param [Hash] params ({})
|
|
5122
|
+
def register_capability(params = {}, options = {})
|
|
5123
|
+
req = build_request(:register_capability, params)
|
|
5124
|
+
req.send_request(options)
|
|
5125
|
+
end
|
|
5126
|
+
|
|
4994
5127
|
# Allows the remote Amazon OpenSearch Service domain owner to reject an
|
|
4995
5128
|
# inbound cross-cluster connection request.
|
|
4996
5129
|
#
|
|
@@ -6296,7 +6429,7 @@ module Aws::OpenSearchService
|
|
|
6296
6429
|
tracer: tracer
|
|
6297
6430
|
)
|
|
6298
6431
|
context[:gem_name] = 'aws-sdk-opensearchservice'
|
|
6299
|
-
context[:gem_version] = '1.
|
|
6432
|
+
context[:gem_version] = '1.93.0'
|
|
6300
6433
|
Seahorse::Client::Request.new(handlers, context)
|
|
6301
6434
|
end
|
|
6302
6435
|
|
|
@@ -14,6 +14,7 @@ module Aws::OpenSearchService
|
|
|
14
14
|
|
|
15
15
|
include Seahorse::Model
|
|
16
16
|
|
|
17
|
+
AIConfig = Shapes::StructureShape.new(name: 'AIConfig')
|
|
17
18
|
AIMLOptionsInput = Shapes::StructureShape.new(name: 'AIMLOptionsInput')
|
|
18
19
|
AIMLOptionsOutput = Shapes::StructureShape.new(name: 'AIMLOptionsOutput')
|
|
19
20
|
AIMLOptionsStatus = Shapes::StructureShape.new(name: 'AIMLOptionsStatus')
|
|
@@ -45,6 +46,7 @@ module Aws::OpenSearchService
|
|
|
45
46
|
AppConfigType = Shapes::StringShape.new(name: 'AppConfigType')
|
|
46
47
|
AppConfigValue = Shapes::StringShape.new(name: 'AppConfigValue')
|
|
47
48
|
AppConfigs = Shapes::ListShape.new(name: 'AppConfigs')
|
|
49
|
+
ApplicationId = Shapes::StringShape.new(name: 'ApplicationId')
|
|
48
50
|
ApplicationName = Shapes::StringShape.new(name: 'ApplicationName')
|
|
49
51
|
ApplicationStatus = Shapes::StringShape.new(name: 'ApplicationStatus')
|
|
50
52
|
ApplicationStatuses = Shapes::ListShape.new(name: 'ApplicationStatuses')
|
|
@@ -85,6 +87,15 @@ module Aws::OpenSearchService
|
|
|
85
87
|
CancelServiceSoftwareUpdateResponse = Shapes::StructureShape.new(name: 'CancelServiceSoftwareUpdateResponse')
|
|
86
88
|
CancelledChangeProperty = Shapes::StructureShape.new(name: 'CancelledChangeProperty')
|
|
87
89
|
CancelledChangePropertyList = Shapes::ListShape.new(name: 'CancelledChangePropertyList')
|
|
90
|
+
CapabilityBaseRequestConfig = Shapes::UnionShape.new(name: 'CapabilityBaseRequestConfig')
|
|
91
|
+
CapabilityBaseResponseConfig = Shapes::UnionShape.new(name: 'CapabilityBaseResponseConfig')
|
|
92
|
+
CapabilityExtendedResponseConfig = Shapes::UnionShape.new(name: 'CapabilityExtendedResponseConfig')
|
|
93
|
+
CapabilityFailure = Shapes::StructureShape.new(name: 'CapabilityFailure')
|
|
94
|
+
CapabilityFailureDetails = Shapes::StringShape.new(name: 'CapabilityFailureDetails')
|
|
95
|
+
CapabilityFailureReason = Shapes::StringShape.new(name: 'CapabilityFailureReason')
|
|
96
|
+
CapabilityFailures = Shapes::ListShape.new(name: 'CapabilityFailures')
|
|
97
|
+
CapabilityName = Shapes::StringShape.new(name: 'CapabilityName')
|
|
98
|
+
CapabilityStatus = Shapes::StringShape.new(name: 'CapabilityStatus')
|
|
88
99
|
ChangeProgressDetails = Shapes::StructureShape.new(name: 'ChangeProgressDetails')
|
|
89
100
|
ChangeProgressStage = Shapes::StructureShape.new(name: 'ChangeProgressStage')
|
|
90
101
|
ChangeProgressStageList = Shapes::ListShape.new(name: 'ChangeProgressStageList')
|
|
@@ -155,6 +166,8 @@ module Aws::OpenSearchService
|
|
|
155
166
|
DeploymentStrategyOptions = Shapes::StructureShape.new(name: 'DeploymentStrategyOptions')
|
|
156
167
|
DeploymentStrategyOptionsStatus = Shapes::StructureShape.new(name: 'DeploymentStrategyOptionsStatus')
|
|
157
168
|
DeploymentType = Shapes::StringShape.new(name: 'DeploymentType')
|
|
169
|
+
DeregisterCapabilityRequest = Shapes::StructureShape.new(name: 'DeregisterCapabilityRequest')
|
|
170
|
+
DeregisterCapabilityResponse = Shapes::StructureShape.new(name: 'DeregisterCapabilityResponse')
|
|
158
171
|
DescribeDomainAutoTunesRequest = Shapes::StructureShape.new(name: 'DescribeDomainAutoTunesRequest')
|
|
159
172
|
DescribeDomainAutoTunesResponse = Shapes::StructureShape.new(name: 'DescribeDomainAutoTunesResponse')
|
|
160
173
|
DescribeDomainChangeProgressRequest = Shapes::StructureShape.new(name: 'DescribeDomainChangeProgressRequest')
|
|
@@ -255,6 +268,8 @@ module Aws::OpenSearchService
|
|
|
255
268
|
GUIDList = Shapes::ListShape.new(name: 'GUIDList')
|
|
256
269
|
GetApplicationRequest = Shapes::StructureShape.new(name: 'GetApplicationRequest')
|
|
257
270
|
GetApplicationResponse = Shapes::StructureShape.new(name: 'GetApplicationResponse')
|
|
271
|
+
GetCapabilityRequest = Shapes::StructureShape.new(name: 'GetCapabilityRequest')
|
|
272
|
+
GetCapabilityResponse = Shapes::StructureShape.new(name: 'GetCapabilityResponse')
|
|
258
273
|
GetCompatibleVersionsRequest = Shapes::StructureShape.new(name: 'GetCompatibleVersionsRequest')
|
|
259
274
|
GetCompatibleVersionsResponse = Shapes::StructureShape.new(name: 'GetCompatibleVersionsResponse')
|
|
260
275
|
GetDataSourceRequest = Shapes::StructureShape.new(name: 'GetDataSourceRequest')
|
|
@@ -457,6 +472,8 @@ module Aws::OpenSearchService
|
|
|
457
472
|
RecurringChargeList = Shapes::ListShape.new(name: 'RecurringChargeList')
|
|
458
473
|
ReferencePath = Shapes::StringShape.new(name: 'ReferencePath')
|
|
459
474
|
Region = Shapes::StringShape.new(name: 'Region')
|
|
475
|
+
RegisterCapabilityRequest = Shapes::StructureShape.new(name: 'RegisterCapabilityRequest')
|
|
476
|
+
RegisterCapabilityResponse = Shapes::StructureShape.new(name: 'RegisterCapabilityResponse')
|
|
460
477
|
RejectInboundConnectionRequest = Shapes::StructureShape.new(name: 'RejectInboundConnectionRequest')
|
|
461
478
|
RejectInboundConnectionResponse = Shapes::StructureShape.new(name: 'RejectInboundConnectionResponse')
|
|
462
479
|
RemoveTagsRequest = Shapes::StructureShape.new(name: 'RemoveTagsRequest')
|
|
@@ -495,6 +512,7 @@ module Aws::OpenSearchService
|
|
|
495
512
|
ScheduledBy = Shapes::StringShape.new(name: 'ScheduledBy')
|
|
496
513
|
SecurityLakeDirectQueryDataSource = Shapes::StructureShape.new(name: 'SecurityLakeDirectQueryDataSource')
|
|
497
514
|
ServerlessVectorAcceleration = Shapes::StructureShape.new(name: 'ServerlessVectorAcceleration')
|
|
515
|
+
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
|
498
516
|
ServiceSoftwareOptions = Shapes::StructureShape.new(name: 'ServiceSoftwareOptions')
|
|
499
517
|
ServiceUrl = Shapes::StringShape.new(name: 'ServiceUrl')
|
|
500
518
|
SkipUnavailableStatus = Shapes::StringShape.new(name: 'SkipUnavailableStatus')
|
|
@@ -589,6 +607,8 @@ module Aws::OpenSearchService
|
|
|
589
607
|
ZoneAwarenessConfig = Shapes::StructureShape.new(name: 'ZoneAwarenessConfig')
|
|
590
608
|
ZoneStatus = Shapes::StringShape.new(name: 'ZoneStatus')
|
|
591
609
|
|
|
610
|
+
AIConfig.struct_class = Types::AIConfig
|
|
611
|
+
|
|
592
612
|
AIMLOptionsInput.add_member(:natural_language_query_generation_options, Shapes::ShapeRef.new(shape: NaturalLanguageQueryGenerationOptionsInput, location_name: "NaturalLanguageQueryGenerationOptions"))
|
|
593
613
|
AIMLOptionsInput.add_member(:s3_vectors_engine, Shapes::ShapeRef.new(shape: S3VectorsEngine, location_name: "S3VectorsEngine"))
|
|
594
614
|
AIMLOptionsInput.add_member(:serverless_vector_acceleration, Shapes::ShapeRef.new(shape: ServerlessVectorAcceleration, location_name: "ServerlessVectorAcceleration"))
|
|
@@ -809,6 +829,30 @@ module Aws::OpenSearchService
|
|
|
809
829
|
|
|
810
830
|
CancelledChangePropertyList.member = Shapes::ShapeRef.new(shape: CancelledChangeProperty)
|
|
811
831
|
|
|
832
|
+
CapabilityBaseRequestConfig.add_member(:ai_config, Shapes::ShapeRef.new(shape: AIConfig, location_name: "aiConfig"))
|
|
833
|
+
CapabilityBaseRequestConfig.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
834
|
+
CapabilityBaseRequestConfig.add_member_subclass(:ai_config, Types::CapabilityBaseRequestConfig::AiConfig)
|
|
835
|
+
CapabilityBaseRequestConfig.add_member_subclass(:unknown, Types::CapabilityBaseRequestConfig::Unknown)
|
|
836
|
+
CapabilityBaseRequestConfig.struct_class = Types::CapabilityBaseRequestConfig
|
|
837
|
+
|
|
838
|
+
CapabilityBaseResponseConfig.add_member(:ai_config, Shapes::ShapeRef.new(shape: AIConfig, location_name: "aiConfig"))
|
|
839
|
+
CapabilityBaseResponseConfig.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
840
|
+
CapabilityBaseResponseConfig.add_member_subclass(:ai_config, Types::CapabilityBaseResponseConfig::AiConfig)
|
|
841
|
+
CapabilityBaseResponseConfig.add_member_subclass(:unknown, Types::CapabilityBaseResponseConfig::Unknown)
|
|
842
|
+
CapabilityBaseResponseConfig.struct_class = Types::CapabilityBaseResponseConfig
|
|
843
|
+
|
|
844
|
+
CapabilityExtendedResponseConfig.add_member(:ai_config, Shapes::ShapeRef.new(shape: AIConfig, location_name: "aiConfig"))
|
|
845
|
+
CapabilityExtendedResponseConfig.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
846
|
+
CapabilityExtendedResponseConfig.add_member_subclass(:ai_config, Types::CapabilityExtendedResponseConfig::AiConfig)
|
|
847
|
+
CapabilityExtendedResponseConfig.add_member_subclass(:unknown, Types::CapabilityExtendedResponseConfig::Unknown)
|
|
848
|
+
CapabilityExtendedResponseConfig.struct_class = Types::CapabilityExtendedResponseConfig
|
|
849
|
+
|
|
850
|
+
CapabilityFailure.add_member(:reason, Shapes::ShapeRef.new(shape: CapabilityFailureReason, location_name: "reason"))
|
|
851
|
+
CapabilityFailure.add_member(:details, Shapes::ShapeRef.new(shape: CapabilityFailureDetails, location_name: "details"))
|
|
852
|
+
CapabilityFailure.struct_class = Types::CapabilityFailure
|
|
853
|
+
|
|
854
|
+
CapabilityFailures.member = Shapes::ShapeRef.new(shape: CapabilityFailure)
|
|
855
|
+
|
|
812
856
|
ChangeProgressDetails.add_member(:change_id, Shapes::ShapeRef.new(shape: GUID, location_name: "ChangeId"))
|
|
813
857
|
ChangeProgressDetails.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
|
814
858
|
ChangeProgressDetails.add_member(:config_change_status, Shapes::ShapeRef.new(shape: ConfigChangeStatus, location_name: "ConfigChangeStatus"))
|
|
@@ -1061,6 +1105,13 @@ module Aws::OpenSearchService
|
|
|
1061
1105
|
DeploymentStrategyOptionsStatus.add_member(:status, Shapes::ShapeRef.new(shape: OptionStatus, required: true, location_name: "Status"))
|
|
1062
1106
|
DeploymentStrategyOptionsStatus.struct_class = Types::DeploymentStrategyOptionsStatus
|
|
1063
1107
|
|
|
1108
|
+
DeregisterCapabilityRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "ApplicationId"))
|
|
1109
|
+
DeregisterCapabilityRequest.add_member(:capability_name, Shapes::ShapeRef.new(shape: CapabilityName, required: true, location: "uri", location_name: "CapabilityName"))
|
|
1110
|
+
DeregisterCapabilityRequest.struct_class = Types::DeregisterCapabilityRequest
|
|
1111
|
+
|
|
1112
|
+
DeregisterCapabilityResponse.add_member(:status, Shapes::ShapeRef.new(shape: CapabilityStatus, location_name: "status"))
|
|
1113
|
+
DeregisterCapabilityResponse.struct_class = Types::DeregisterCapabilityResponse
|
|
1114
|
+
|
|
1064
1115
|
DescribeDomainAutoTunesRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location: "uri", location_name: "DomainName"))
|
|
1065
1116
|
DescribeDomainAutoTunesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
|
1066
1117
|
DescribeDomainAutoTunesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
|
@@ -1437,6 +1488,17 @@ module Aws::OpenSearchService
|
|
|
1437
1488
|
GetApplicationResponse.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
|
|
1438
1489
|
GetApplicationResponse.struct_class = Types::GetApplicationResponse
|
|
1439
1490
|
|
|
1491
|
+
GetCapabilityRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "ApplicationId"))
|
|
1492
|
+
GetCapabilityRequest.add_member(:capability_name, Shapes::ShapeRef.new(shape: CapabilityName, required: true, location: "uri", location_name: "CapabilityName"))
|
|
1493
|
+
GetCapabilityRequest.struct_class = Types::GetCapabilityRequest
|
|
1494
|
+
|
|
1495
|
+
GetCapabilityResponse.add_member(:capability_name, Shapes::ShapeRef.new(shape: CapabilityName, location_name: "capabilityName"))
|
|
1496
|
+
GetCapabilityResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, location_name: "applicationId"))
|
|
1497
|
+
GetCapabilityResponse.add_member(:status, Shapes::ShapeRef.new(shape: CapabilityStatus, location_name: "status"))
|
|
1498
|
+
GetCapabilityResponse.add_member(:capability_config, Shapes::ShapeRef.new(shape: CapabilityExtendedResponseConfig, location_name: "capabilityConfig"))
|
|
1499
|
+
GetCapabilityResponse.add_member(:failures, Shapes::ShapeRef.new(shape: CapabilityFailures, location_name: "failures"))
|
|
1500
|
+
GetCapabilityResponse.struct_class = Types::GetCapabilityResponse
|
|
1501
|
+
|
|
1440
1502
|
GetCompatibleVersionsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location: "querystring", location_name: "domainName"))
|
|
1441
1503
|
GetCompatibleVersionsRequest.struct_class = Types::GetCompatibleVersionsRequest
|
|
1442
1504
|
|
|
@@ -1956,6 +2018,17 @@ module Aws::OpenSearchService
|
|
|
1956
2018
|
|
|
1957
2019
|
RecurringChargeList.member = Shapes::ShapeRef.new(shape: RecurringCharge)
|
|
1958
2020
|
|
|
2021
|
+
RegisterCapabilityRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "ApplicationId"))
|
|
2022
|
+
RegisterCapabilityRequest.add_member(:capability_name, Shapes::ShapeRef.new(shape: CapabilityName, required: true, location_name: "capabilityName"))
|
|
2023
|
+
RegisterCapabilityRequest.add_member(:capability_config, Shapes::ShapeRef.new(shape: CapabilityBaseRequestConfig, required: true, location_name: "capabilityConfig"))
|
|
2024
|
+
RegisterCapabilityRequest.struct_class = Types::RegisterCapabilityRequest
|
|
2025
|
+
|
|
2026
|
+
RegisterCapabilityResponse.add_member(:capability_name, Shapes::ShapeRef.new(shape: CapabilityName, location_name: "capabilityName"))
|
|
2027
|
+
RegisterCapabilityResponse.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, location_name: "applicationId"))
|
|
2028
|
+
RegisterCapabilityResponse.add_member(:status, Shapes::ShapeRef.new(shape: CapabilityStatus, location_name: "status"))
|
|
2029
|
+
RegisterCapabilityResponse.add_member(:capability_config, Shapes::ShapeRef.new(shape: CapabilityBaseResponseConfig, location_name: "capabilityConfig"))
|
|
2030
|
+
RegisterCapabilityResponse.struct_class = Types::RegisterCapabilityResponse
|
|
2031
|
+
|
|
1959
2032
|
RejectInboundConnectionRequest.add_member(:connection_id, Shapes::ShapeRef.new(shape: ConnectionId, required: true, location: "uri", location_name: "ConnectionId"))
|
|
1960
2033
|
RejectInboundConnectionRequest.struct_class = Types::RejectInboundConnectionRequest
|
|
1961
2034
|
|
|
@@ -2058,6 +2131,8 @@ module Aws::OpenSearchService
|
|
|
2058
2131
|
ServerlessVectorAcceleration.add_member(:enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "Enabled"))
|
|
2059
2132
|
ServerlessVectorAcceleration.struct_class = Types::ServerlessVectorAcceleration
|
|
2060
2133
|
|
|
2134
|
+
ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
|
|
2135
|
+
|
|
2061
2136
|
ServiceSoftwareOptions.add_member(:current_version, Shapes::ShapeRef.new(shape: String, location_name: "CurrentVersion"))
|
|
2062
2137
|
ServiceSoftwareOptions.add_member(:new_version, Shapes::ShapeRef.new(shape: String, location_name: "NewVersion"))
|
|
2063
2138
|
ServiceSoftwareOptions.add_member(:update_available, Shapes::ShapeRef.new(shape: Boolean, location_name: "UpdateAvailable"))
|
|
@@ -2668,6 +2743,20 @@ module Aws::OpenSearchService
|
|
|
2668
2743
|
o.errors << Shapes::ShapeRef.new(shape: BaseException)
|
|
2669
2744
|
end)
|
|
2670
2745
|
|
|
2746
|
+
api.add_operation(:deregister_capability, Seahorse::Model::Operation.new.tap do |o|
|
|
2747
|
+
o.name = "DeregisterCapability"
|
|
2748
|
+
o.http_method = "DELETE"
|
|
2749
|
+
o.http_request_uri = "/2021-01-01/opensearch/application/{ApplicationId}/capability/deregister/{CapabilityName}"
|
|
2750
|
+
o.input = Shapes::ShapeRef.new(shape: DeregisterCapabilityRequest)
|
|
2751
|
+
o.output = Shapes::ShapeRef.new(shape: DeregisterCapabilityResponse)
|
|
2752
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
2753
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
2754
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
2755
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalException)
|
|
2756
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
2757
|
+
o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
|
|
2758
|
+
end)
|
|
2759
|
+
|
|
2671
2760
|
api.add_operation(:describe_domain, Seahorse::Model::Operation.new.tap do |o|
|
|
2672
2761
|
o.name = "DescribeDomain"
|
|
2673
2762
|
o.http_method = "GET"
|
|
@@ -2942,6 +3031,19 @@ module Aws::OpenSearchService
|
|
|
2942
3031
|
o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
|
|
2943
3032
|
end)
|
|
2944
3033
|
|
|
3034
|
+
api.add_operation(:get_capability, Seahorse::Model::Operation.new.tap do |o|
|
|
3035
|
+
o.name = "GetCapability"
|
|
3036
|
+
o.http_method = "GET"
|
|
3037
|
+
o.http_request_uri = "/2021-01-01/opensearch/application/{ApplicationId}/capability/{CapabilityName}"
|
|
3038
|
+
o.input = Shapes::ShapeRef.new(shape: GetCapabilityRequest)
|
|
3039
|
+
o.output = Shapes::ShapeRef.new(shape: GetCapabilityResponse)
|
|
3040
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
3041
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
3042
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalException)
|
|
3043
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
3044
|
+
o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
|
|
3045
|
+
end)
|
|
3046
|
+
|
|
2945
3047
|
api.add_operation(:get_compatible_versions, Seahorse::Model::Operation.new.tap do |o|
|
|
2946
3048
|
o.name = "GetCompatibleVersions"
|
|
2947
3049
|
o.http_method = "GET"
|
|
@@ -3329,6 +3431,21 @@ module Aws::OpenSearchService
|
|
|
3329
3431
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
3330
3432
|
end)
|
|
3331
3433
|
|
|
3434
|
+
api.add_operation(:register_capability, Seahorse::Model::Operation.new.tap do |o|
|
|
3435
|
+
o.name = "RegisterCapability"
|
|
3436
|
+
o.http_method = "POST"
|
|
3437
|
+
o.http_request_uri = "/2021-01-01/opensearch/application/{ApplicationId}/capability/register"
|
|
3438
|
+
o.input = Shapes::ShapeRef.new(shape: RegisterCapabilityRequest)
|
|
3439
|
+
o.output = Shapes::ShapeRef.new(shape: RegisterCapabilityResponse)
|
|
3440
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
|
3441
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
3442
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
3443
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalException)
|
|
3444
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
3445
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
|
|
3446
|
+
o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
|
|
3447
|
+
end)
|
|
3448
|
+
|
|
3332
3449
|
api.add_operation(:reject_inbound_connection, Seahorse::Model::Operation.new.tap do |o|
|
|
3333
3450
|
o.name = "RejectInboundConnection"
|
|
3334
3451
|
o.http_method = "PUT"
|
|
@@ -38,6 +38,7 @@ module Aws::OpenSearchService
|
|
|
38
38
|
# * {LimitExceededException}
|
|
39
39
|
# * {ResourceAlreadyExistsException}
|
|
40
40
|
# * {ResourceNotFoundException}
|
|
41
|
+
# * {ServiceQuotaExceededException}
|
|
41
42
|
# * {SlotNotAvailableException}
|
|
42
43
|
# * {ThrottlingException}
|
|
43
44
|
# * {ValidationException}
|
|
@@ -163,6 +164,16 @@ module Aws::OpenSearchService
|
|
|
163
164
|
end
|
|
164
165
|
end
|
|
165
166
|
|
|
167
|
+
class ServiceQuotaExceededException < ServiceError
|
|
168
|
+
|
|
169
|
+
# @param [Seahorse::Client::RequestContext] context
|
|
170
|
+
# @param [String] message
|
|
171
|
+
# @param [Aws::OpenSearchService::Types::ServiceQuotaExceededException] data
|
|
172
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
|
173
|
+
super(context, message, data)
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
|
|
166
177
|
class SlotNotAvailableException < ServiceError
|
|
167
178
|
|
|
168
179
|
# @param [Seahorse::Client::RequestContext] context
|
|
@@ -10,6 +10,15 @@
|
|
|
10
10
|
module Aws::OpenSearchService
|
|
11
11
|
module Types
|
|
12
12
|
|
|
13
|
+
# Configuration settings for AI-powered capabilities of an OpenSearch UI
|
|
14
|
+
# application.
|
|
15
|
+
#
|
|
16
|
+
# @api private
|
|
17
|
+
#
|
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AIConfig AWS API Documentation
|
|
19
|
+
#
|
|
20
|
+
class AIConfig < Aws::EmptyStructure; end
|
|
21
|
+
|
|
13
22
|
# Container for parameters required to enable all machine learning
|
|
14
23
|
# features.
|
|
15
24
|
#
|
|
@@ -1155,6 +1164,91 @@ module Aws::OpenSearchService
|
|
|
1155
1164
|
include Aws::Structure
|
|
1156
1165
|
end
|
|
1157
1166
|
|
|
1167
|
+
# The base configuration for registering a capability. Contains
|
|
1168
|
+
# capability-specific configuration such as AI settings.
|
|
1169
|
+
#
|
|
1170
|
+
# @note CapabilityBaseRequestConfig is a union - when making an API calls you must set exactly one of the members.
|
|
1171
|
+
#
|
|
1172
|
+
# @!attribute [rw] ai_config
|
|
1173
|
+
# Configuration settings for AI-powered capabilities.
|
|
1174
|
+
# @return [Types::AIConfig]
|
|
1175
|
+
#
|
|
1176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CapabilityBaseRequestConfig AWS API Documentation
|
|
1177
|
+
#
|
|
1178
|
+
class CapabilityBaseRequestConfig < Struct.new(
|
|
1179
|
+
:ai_config,
|
|
1180
|
+
:unknown)
|
|
1181
|
+
SENSITIVE = []
|
|
1182
|
+
include Aws::Structure
|
|
1183
|
+
include Aws::Structure::Union
|
|
1184
|
+
|
|
1185
|
+
class AiConfig < CapabilityBaseRequestConfig; end
|
|
1186
|
+
class Unknown < CapabilityBaseRequestConfig; end
|
|
1187
|
+
end
|
|
1188
|
+
|
|
1189
|
+
# The base configuration returned for a registered capability.
|
|
1190
|
+
#
|
|
1191
|
+
# @note CapabilityBaseResponseConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CapabilityBaseResponseConfig corresponding to the set member.
|
|
1192
|
+
#
|
|
1193
|
+
# @!attribute [rw] ai_config
|
|
1194
|
+
# Configuration settings for AI-powered capabilities.
|
|
1195
|
+
# @return [Types::AIConfig]
|
|
1196
|
+
#
|
|
1197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CapabilityBaseResponseConfig AWS API Documentation
|
|
1198
|
+
#
|
|
1199
|
+
class CapabilityBaseResponseConfig < Struct.new(
|
|
1200
|
+
:ai_config,
|
|
1201
|
+
:unknown)
|
|
1202
|
+
SENSITIVE = []
|
|
1203
|
+
include Aws::Structure
|
|
1204
|
+
include Aws::Structure::Union
|
|
1205
|
+
|
|
1206
|
+
class AiConfig < CapabilityBaseResponseConfig; end
|
|
1207
|
+
class Unknown < CapabilityBaseResponseConfig; end
|
|
1208
|
+
end
|
|
1209
|
+
|
|
1210
|
+
# The extended configuration returned for a registered capability,
|
|
1211
|
+
# including additional details beyond the base configuration.
|
|
1212
|
+
#
|
|
1213
|
+
# @note CapabilityExtendedResponseConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CapabilityExtendedResponseConfig corresponding to the set member.
|
|
1214
|
+
#
|
|
1215
|
+
# @!attribute [rw] ai_config
|
|
1216
|
+
# Configuration settings for AI-powered capabilities.
|
|
1217
|
+
# @return [Types::AIConfig]
|
|
1218
|
+
#
|
|
1219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CapabilityExtendedResponseConfig AWS API Documentation
|
|
1220
|
+
#
|
|
1221
|
+
class CapabilityExtendedResponseConfig < Struct.new(
|
|
1222
|
+
:ai_config,
|
|
1223
|
+
:unknown)
|
|
1224
|
+
SENSITIVE = []
|
|
1225
|
+
include Aws::Structure
|
|
1226
|
+
include Aws::Structure::Union
|
|
1227
|
+
|
|
1228
|
+
class AiConfig < CapabilityExtendedResponseConfig; end
|
|
1229
|
+
class Unknown < CapabilityExtendedResponseConfig; end
|
|
1230
|
+
end
|
|
1231
|
+
|
|
1232
|
+
# Information about a capability failure.
|
|
1233
|
+
#
|
|
1234
|
+
# @!attribute [rw] reason
|
|
1235
|
+
# The reason for the capability failure. Possible values:
|
|
1236
|
+
# `KMS_KEY_INSUFFICIENT_PERMISSION`.
|
|
1237
|
+
# @return [String]
|
|
1238
|
+
#
|
|
1239
|
+
# @!attribute [rw] details
|
|
1240
|
+
# Additional details about the capability failure.
|
|
1241
|
+
# @return [String]
|
|
1242
|
+
#
|
|
1243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CapabilityFailure AWS API Documentation
|
|
1244
|
+
#
|
|
1245
|
+
class CapabilityFailure < Struct.new(
|
|
1246
|
+
:reason,
|
|
1247
|
+
:details)
|
|
1248
|
+
SENSITIVE = []
|
|
1249
|
+
include Aws::Structure
|
|
1250
|
+
end
|
|
1251
|
+
|
|
1158
1252
|
# Container for information about a configuration change happening on a
|
|
1159
1253
|
# domain.
|
|
1160
1254
|
#
|
|
@@ -2469,6 +2563,41 @@ module Aws::OpenSearchService
|
|
|
2469
2563
|
include Aws::Structure
|
|
2470
2564
|
end
|
|
2471
2565
|
|
|
2566
|
+
# Container for the parameters to the `DeregisterCapability` operation.
|
|
2567
|
+
#
|
|
2568
|
+
# @!attribute [rw] application_id
|
|
2569
|
+
# The unique identifier of the OpenSearch UI application to deregister
|
|
2570
|
+
# the capability from.
|
|
2571
|
+
# @return [String]
|
|
2572
|
+
#
|
|
2573
|
+
# @!attribute [rw] capability_name
|
|
2574
|
+
# The name of the capability to deregister.
|
|
2575
|
+
# @return [String]
|
|
2576
|
+
#
|
|
2577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeregisterCapabilityRequest AWS API Documentation
|
|
2578
|
+
#
|
|
2579
|
+
class DeregisterCapabilityRequest < Struct.new(
|
|
2580
|
+
:application_id,
|
|
2581
|
+
:capability_name)
|
|
2582
|
+
SENSITIVE = []
|
|
2583
|
+
include Aws::Structure
|
|
2584
|
+
end
|
|
2585
|
+
|
|
2586
|
+
# The result of a `DeregisterCapability` request.
|
|
2587
|
+
#
|
|
2588
|
+
# @!attribute [rw] status
|
|
2589
|
+
# The status of the deregistration operation. Returns `deleting` when
|
|
2590
|
+
# the capability is being removed.
|
|
2591
|
+
# @return [String]
|
|
2592
|
+
#
|
|
2593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeregisterCapabilityResponse AWS API Documentation
|
|
2594
|
+
#
|
|
2595
|
+
class DeregisterCapabilityResponse < Struct.new(
|
|
2596
|
+
:status)
|
|
2597
|
+
SENSITIVE = []
|
|
2598
|
+
include Aws::Structure
|
|
2599
|
+
end
|
|
2600
|
+
|
|
2472
2601
|
# Container for the parameters to the `DescribeDomainAutoTunes`
|
|
2473
2602
|
# operation.
|
|
2474
2603
|
#
|
|
@@ -4363,6 +4492,64 @@ module Aws::OpenSearchService
|
|
|
4363
4492
|
include Aws::Structure
|
|
4364
4493
|
end
|
|
4365
4494
|
|
|
4495
|
+
# Container for the parameters to the `GetCapability` operation.
|
|
4496
|
+
#
|
|
4497
|
+
# @!attribute [rw] application_id
|
|
4498
|
+
# The unique identifier of the OpenSearch UI application.
|
|
4499
|
+
# @return [String]
|
|
4500
|
+
#
|
|
4501
|
+
# @!attribute [rw] capability_name
|
|
4502
|
+
# The name of the capability to retrieve information about.
|
|
4503
|
+
# @return [String]
|
|
4504
|
+
#
|
|
4505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCapabilityRequest AWS API Documentation
|
|
4506
|
+
#
|
|
4507
|
+
class GetCapabilityRequest < Struct.new(
|
|
4508
|
+
:application_id,
|
|
4509
|
+
:capability_name)
|
|
4510
|
+
SENSITIVE = []
|
|
4511
|
+
include Aws::Structure
|
|
4512
|
+
end
|
|
4513
|
+
|
|
4514
|
+
# The result of a `GetCapability` request. Contains details about the
|
|
4515
|
+
# capability.
|
|
4516
|
+
#
|
|
4517
|
+
# @!attribute [rw] capability_name
|
|
4518
|
+
# The name of the capability.
|
|
4519
|
+
# @return [String]
|
|
4520
|
+
#
|
|
4521
|
+
# @!attribute [rw] application_id
|
|
4522
|
+
# The unique identifier of the OpenSearch UI application.
|
|
4523
|
+
# @return [String]
|
|
4524
|
+
#
|
|
4525
|
+
# @!attribute [rw] status
|
|
4526
|
+
# The current status of the capability. Possible values: `creating`,
|
|
4527
|
+
# `create_failed`, `active`, `updating`, `update_failed`, `deleting`,
|
|
4528
|
+
# `delete_failed`.
|
|
4529
|
+
# @return [String]
|
|
4530
|
+
#
|
|
4531
|
+
# @!attribute [rw] capability_config
|
|
4532
|
+
# The configuration settings for the capability, including
|
|
4533
|
+
# capability-specific settings such as AI configuration.
|
|
4534
|
+
# @return [Types::CapabilityExtendedResponseConfig]
|
|
4535
|
+
#
|
|
4536
|
+
# @!attribute [rw] failures
|
|
4537
|
+
# A list of failures associated with the capability, if any. Each
|
|
4538
|
+
# failure includes a reason and details about what went wrong.
|
|
4539
|
+
# @return [Array<Types::CapabilityFailure>]
|
|
4540
|
+
#
|
|
4541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCapabilityResponse AWS API Documentation
|
|
4542
|
+
#
|
|
4543
|
+
class GetCapabilityResponse < Struct.new(
|
|
4544
|
+
:capability_name,
|
|
4545
|
+
:application_id,
|
|
4546
|
+
:status,
|
|
4547
|
+
:capability_config,
|
|
4548
|
+
:failures)
|
|
4549
|
+
SENSITIVE = []
|
|
4550
|
+
include Aws::Structure
|
|
4551
|
+
end
|
|
4552
|
+
|
|
4366
4553
|
# Container for the request parameters to `GetCompatibleVersions`
|
|
4367
4554
|
# operation.
|
|
4368
4555
|
#
|
|
@@ -6998,6 +7185,68 @@ module Aws::OpenSearchService
|
|
|
6998
7185
|
include Aws::Structure
|
|
6999
7186
|
end
|
|
7000
7187
|
|
|
7188
|
+
# Container for the parameters to the `RegisterCapability` operation.
|
|
7189
|
+
#
|
|
7190
|
+
# @!attribute [rw] application_id
|
|
7191
|
+
# The unique identifier of the OpenSearch UI application to register
|
|
7192
|
+
# the capability for.
|
|
7193
|
+
# @return [String]
|
|
7194
|
+
#
|
|
7195
|
+
# @!attribute [rw] capability_name
|
|
7196
|
+
# The name of the capability to register. Must be between 3 and 30
|
|
7197
|
+
# characters and contain only alphanumeric characters and hyphens.
|
|
7198
|
+
# This identifies the type of capability being enabled for the
|
|
7199
|
+
# application. For registering AI Assistant capability, use
|
|
7200
|
+
# `ai-capability`
|
|
7201
|
+
# @return [String]
|
|
7202
|
+
#
|
|
7203
|
+
# @!attribute [rw] capability_config
|
|
7204
|
+
# The configuration settings for the capability being registered. This
|
|
7205
|
+
# includes capability-specific settings such as AI configuration.
|
|
7206
|
+
# @return [Types::CapabilityBaseRequestConfig]
|
|
7207
|
+
#
|
|
7208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RegisterCapabilityRequest AWS API Documentation
|
|
7209
|
+
#
|
|
7210
|
+
class RegisterCapabilityRequest < Struct.new(
|
|
7211
|
+
:application_id,
|
|
7212
|
+
:capability_name,
|
|
7213
|
+
:capability_config)
|
|
7214
|
+
SENSITIVE = []
|
|
7215
|
+
include Aws::Structure
|
|
7216
|
+
end
|
|
7217
|
+
|
|
7218
|
+
# The result of a `RegisterCapability` request. Contains details about
|
|
7219
|
+
# the registered capability.
|
|
7220
|
+
#
|
|
7221
|
+
# @!attribute [rw] capability_name
|
|
7222
|
+
# The name of the registered capability.
|
|
7223
|
+
# @return [String]
|
|
7224
|
+
#
|
|
7225
|
+
# @!attribute [rw] application_id
|
|
7226
|
+
# The unique identifier of the OpenSearch UI application.
|
|
7227
|
+
# @return [String]
|
|
7228
|
+
#
|
|
7229
|
+
# @!attribute [rw] status
|
|
7230
|
+
# The current status of the capability. Possible values: `creating`,
|
|
7231
|
+
# `create_failed`, `active`, `updating`, `update_failed`, `deleting`,
|
|
7232
|
+
# `delete_failed`.
|
|
7233
|
+
# @return [String]
|
|
7234
|
+
#
|
|
7235
|
+
# @!attribute [rw] capability_config
|
|
7236
|
+
# The configuration settings for the registered capability.
|
|
7237
|
+
# @return [Types::CapabilityBaseResponseConfig]
|
|
7238
|
+
#
|
|
7239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RegisterCapabilityResponse AWS API Documentation
|
|
7240
|
+
#
|
|
7241
|
+
class RegisterCapabilityResponse < Struct.new(
|
|
7242
|
+
:capability_name,
|
|
7243
|
+
:application_id,
|
|
7244
|
+
:status,
|
|
7245
|
+
:capability_config)
|
|
7246
|
+
SENSITIVE = []
|
|
7247
|
+
include Aws::Structure
|
|
7248
|
+
end
|
|
7249
|
+
|
|
7001
7250
|
# Container for the request parameters to the `RejectInboundConnection`
|
|
7002
7251
|
# operation.
|
|
7003
7252
|
#
|
|
@@ -7493,6 +7742,13 @@ module Aws::OpenSearchService
|
|
|
7493
7742
|
include Aws::Structure
|
|
7494
7743
|
end
|
|
7495
7744
|
|
|
7745
|
+
# An exception for when a request would cause a service quota to be
|
|
7746
|
+
# exceeded.
|
|
7747
|
+
#
|
|
7748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ServiceQuotaExceededException AWS API Documentation
|
|
7749
|
+
#
|
|
7750
|
+
class ServiceQuotaExceededException < Aws::EmptyStructure; end
|
|
7751
|
+
|
|
7496
7752
|
# The current status of the service software for an Amazon OpenSearch
|
|
7497
7753
|
# Service domain. For more information, see [Service software updates in
|
|
7498
7754
|
# Amazon OpenSearch Service][1].
|
data/sig/client.rbs
CHANGED
|
@@ -614,6 +614,17 @@ module Aws
|
|
|
614
614
|
) -> _DeleteVpcEndpointResponseSuccess
|
|
615
615
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteVpcEndpointResponseSuccess
|
|
616
616
|
|
|
617
|
+
interface _DeregisterCapabilityResponseSuccess
|
|
618
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeregisterCapabilityResponse]
|
|
619
|
+
def status: () -> ("creating" | "create_failed" | "active" | "updating" | "update_failed" | "deleting" | "delete_failed")
|
|
620
|
+
end
|
|
621
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#deregister_capability-instance_method
|
|
622
|
+
def deregister_capability: (
|
|
623
|
+
application_id: ::String,
|
|
624
|
+
capability_name: ::String
|
|
625
|
+
) -> _DeregisterCapabilityResponseSuccess
|
|
626
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeregisterCapabilityResponseSuccess
|
|
627
|
+
|
|
617
628
|
interface _DescribeDomainResponseSuccess
|
|
618
629
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeDomainResponse]
|
|
619
630
|
def domain_status: () -> Types::DomainStatus
|
|
@@ -874,6 +885,21 @@ module Aws
|
|
|
874
885
|
) -> _GetApplicationResponseSuccess
|
|
875
886
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetApplicationResponseSuccess
|
|
876
887
|
|
|
888
|
+
interface _GetCapabilityResponseSuccess
|
|
889
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCapabilityResponse]
|
|
890
|
+
def capability_name: () -> ::String
|
|
891
|
+
def application_id: () -> ::String
|
|
892
|
+
def status: () -> ("creating" | "create_failed" | "active" | "updating" | "update_failed" | "deleting" | "delete_failed")
|
|
893
|
+
def capability_config: () -> Types::CapabilityExtendedResponseConfig
|
|
894
|
+
def failures: () -> ::Array[Types::CapabilityFailure]
|
|
895
|
+
end
|
|
896
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#get_capability-instance_method
|
|
897
|
+
def get_capability: (
|
|
898
|
+
application_id: ::String,
|
|
899
|
+
capability_name: ::String
|
|
900
|
+
) -> _GetCapabilityResponseSuccess
|
|
901
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCapabilityResponseSuccess
|
|
902
|
+
|
|
877
903
|
interface _GetCompatibleVersionsResponseSuccess
|
|
878
904
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetCompatibleVersionsResponse]
|
|
879
905
|
def compatible_versions: () -> ::Array[Types::CompatibleVersionsMap]
|
|
@@ -1204,6 +1230,24 @@ module Aws
|
|
|
1204
1230
|
) -> _PutDefaultApplicationSettingResponseSuccess
|
|
1205
1231
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutDefaultApplicationSettingResponseSuccess
|
|
1206
1232
|
|
|
1233
|
+
interface _RegisterCapabilityResponseSuccess
|
|
1234
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RegisterCapabilityResponse]
|
|
1235
|
+
def capability_name: () -> ::String
|
|
1236
|
+
def application_id: () -> ::String
|
|
1237
|
+
def status: () -> ("creating" | "create_failed" | "active" | "updating" | "update_failed" | "deleting" | "delete_failed")
|
|
1238
|
+
def capability_config: () -> Types::CapabilityBaseResponseConfig
|
|
1239
|
+
end
|
|
1240
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/OpenSearchService/Client.html#register_capability-instance_method
|
|
1241
|
+
def register_capability: (
|
|
1242
|
+
application_id: ::String,
|
|
1243
|
+
capability_name: ::String,
|
|
1244
|
+
capability_config: {
|
|
1245
|
+
ai_config: {
|
|
1246
|
+
}?
|
|
1247
|
+
}
|
|
1248
|
+
) -> _RegisterCapabilityResponseSuccess
|
|
1249
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RegisterCapabilityResponseSuccess
|
|
1250
|
+
|
|
1207
1251
|
interface _RejectInboundConnectionResponseSuccess
|
|
1208
1252
|
include ::Seahorse::Client::_ResponseSuccess[Types::RejectInboundConnectionResponse]
|
|
1209
1253
|
def connection: () -> Types::InboundConnection
|
data/sig/errors.rbs
CHANGED
|
@@ -34,6 +34,8 @@ module Aws
|
|
|
34
34
|
end
|
|
35
35
|
class ResourceNotFoundException < ::Aws::Errors::ServiceError
|
|
36
36
|
end
|
|
37
|
+
class ServiceQuotaExceededException < ::Aws::Errors::ServiceError
|
|
38
|
+
end
|
|
37
39
|
class SlotNotAvailableException < ::Aws::Errors::ServiceError
|
|
38
40
|
def slot_suggestions: () -> ::String
|
|
39
41
|
end
|
data/sig/types.rbs
CHANGED
|
@@ -8,6 +8,9 @@
|
|
|
8
8
|
module Aws::OpenSearchService
|
|
9
9
|
module Types
|
|
10
10
|
|
|
11
|
+
class AIConfig < Aws::EmptyStructure
|
|
12
|
+
end
|
|
13
|
+
|
|
11
14
|
class AIMLOptionsInput
|
|
12
15
|
attr_accessor natural_language_query_generation_options: Types::NaturalLanguageQueryGenerationOptionsInput
|
|
13
16
|
attr_accessor s3_vectors_engine: Types::S3VectorsEngine
|
|
@@ -288,6 +291,45 @@ module Aws::OpenSearchService
|
|
|
288
291
|
SENSITIVE: []
|
|
289
292
|
end
|
|
290
293
|
|
|
294
|
+
class CapabilityBaseRequestConfig
|
|
295
|
+
attr_accessor ai_config: Types::AIConfig
|
|
296
|
+
attr_accessor unknown: untyped
|
|
297
|
+
SENSITIVE: []
|
|
298
|
+
|
|
299
|
+
class AiConfig < CapabilityBaseRequestConfig
|
|
300
|
+
end
|
|
301
|
+
class Unknown < CapabilityBaseRequestConfig
|
|
302
|
+
end
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
class CapabilityBaseResponseConfig
|
|
306
|
+
attr_accessor ai_config: Types::AIConfig
|
|
307
|
+
attr_accessor unknown: untyped
|
|
308
|
+
SENSITIVE: []
|
|
309
|
+
|
|
310
|
+
class AiConfig < CapabilityBaseResponseConfig
|
|
311
|
+
end
|
|
312
|
+
class Unknown < CapabilityBaseResponseConfig
|
|
313
|
+
end
|
|
314
|
+
end
|
|
315
|
+
|
|
316
|
+
class CapabilityExtendedResponseConfig
|
|
317
|
+
attr_accessor ai_config: Types::AIConfig
|
|
318
|
+
attr_accessor unknown: untyped
|
|
319
|
+
SENSITIVE: []
|
|
320
|
+
|
|
321
|
+
class AiConfig < CapabilityExtendedResponseConfig
|
|
322
|
+
end
|
|
323
|
+
class Unknown < CapabilityExtendedResponseConfig
|
|
324
|
+
end
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
class CapabilityFailure
|
|
328
|
+
attr_accessor reason: ("KMS_KEY_INSUFFICIENT_PERMISSION")
|
|
329
|
+
attr_accessor details: ::String
|
|
330
|
+
SENSITIVE: []
|
|
331
|
+
end
|
|
332
|
+
|
|
291
333
|
class ChangeProgressDetails
|
|
292
334
|
attr_accessor change_id: ::String
|
|
293
335
|
attr_accessor message: ::String
|
|
@@ -628,6 +670,17 @@ module Aws::OpenSearchService
|
|
|
628
670
|
SENSITIVE: []
|
|
629
671
|
end
|
|
630
672
|
|
|
673
|
+
class DeregisterCapabilityRequest
|
|
674
|
+
attr_accessor application_id: ::String
|
|
675
|
+
attr_accessor capability_name: ::String
|
|
676
|
+
SENSITIVE: []
|
|
677
|
+
end
|
|
678
|
+
|
|
679
|
+
class DeregisterCapabilityResponse
|
|
680
|
+
attr_accessor status: ("creating" | "create_failed" | "active" | "updating" | "update_failed" | "deleting" | "delete_failed")
|
|
681
|
+
SENSITIVE: []
|
|
682
|
+
end
|
|
683
|
+
|
|
631
684
|
class DescribeDomainAutoTunesRequest
|
|
632
685
|
attr_accessor domain_name: ::String
|
|
633
686
|
attr_accessor max_results: ::Integer
|
|
@@ -1101,6 +1154,21 @@ module Aws::OpenSearchService
|
|
|
1101
1154
|
SENSITIVE: []
|
|
1102
1155
|
end
|
|
1103
1156
|
|
|
1157
|
+
class GetCapabilityRequest
|
|
1158
|
+
attr_accessor application_id: ::String
|
|
1159
|
+
attr_accessor capability_name: ::String
|
|
1160
|
+
SENSITIVE: []
|
|
1161
|
+
end
|
|
1162
|
+
|
|
1163
|
+
class GetCapabilityResponse
|
|
1164
|
+
attr_accessor capability_name: ::String
|
|
1165
|
+
attr_accessor application_id: ::String
|
|
1166
|
+
attr_accessor status: ("creating" | "create_failed" | "active" | "updating" | "update_failed" | "deleting" | "delete_failed")
|
|
1167
|
+
attr_accessor capability_config: Types::CapabilityExtendedResponseConfig
|
|
1168
|
+
attr_accessor failures: ::Array[Types::CapabilityFailure]
|
|
1169
|
+
SENSITIVE: []
|
|
1170
|
+
end
|
|
1171
|
+
|
|
1104
1172
|
class GetCompatibleVersionsRequest
|
|
1105
1173
|
attr_accessor domain_name: ::String
|
|
1106
1174
|
SENSITIVE: []
|
|
@@ -1785,6 +1853,21 @@ module Aws::OpenSearchService
|
|
|
1785
1853
|
SENSITIVE: []
|
|
1786
1854
|
end
|
|
1787
1855
|
|
|
1856
|
+
class RegisterCapabilityRequest
|
|
1857
|
+
attr_accessor application_id: ::String
|
|
1858
|
+
attr_accessor capability_name: ::String
|
|
1859
|
+
attr_accessor capability_config: Types::CapabilityBaseRequestConfig
|
|
1860
|
+
SENSITIVE: []
|
|
1861
|
+
end
|
|
1862
|
+
|
|
1863
|
+
class RegisterCapabilityResponse
|
|
1864
|
+
attr_accessor capability_name: ::String
|
|
1865
|
+
attr_accessor application_id: ::String
|
|
1866
|
+
attr_accessor status: ("creating" | "create_failed" | "active" | "updating" | "update_failed" | "deleting" | "delete_failed")
|
|
1867
|
+
attr_accessor capability_config: Types::CapabilityBaseResponseConfig
|
|
1868
|
+
SENSITIVE: []
|
|
1869
|
+
end
|
|
1870
|
+
|
|
1788
1871
|
class RejectInboundConnectionRequest
|
|
1789
1872
|
attr_accessor connection_id: ::String
|
|
1790
1873
|
SENSITIVE: []
|
|
@@ -1914,6 +1997,9 @@ module Aws::OpenSearchService
|
|
|
1914
1997
|
SENSITIVE: []
|
|
1915
1998
|
end
|
|
1916
1999
|
|
|
2000
|
+
class ServiceQuotaExceededException < Aws::EmptyStructure
|
|
2001
|
+
end
|
|
2002
|
+
|
|
1917
2003
|
class ServiceSoftwareOptions
|
|
1918
2004
|
attr_accessor current_version: ::String
|
|
1919
2005
|
attr_accessor new_version: ::String
|