Skip to content

Commit 34e32c3

Browse files
author
AWS
committed
Amazon OpenSearch Service Update: This release adds index operation APIs to support Automatic Semantic Enrichment feature
1 parent c16dd03 commit 34e32c3

File tree

2 files changed

+241
-3
lines changed

2 files changed

+241
-3
lines changed

‎.changes/next-release/feature-AmazonOpenSearchService-2221528.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon OpenSearch Service",
4+
"contributor": "",
5+
"description": "This release adds index operation APIs to support Automatic Semantic Enrichment feature"
6+
}

‎services/opensearch/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 235 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,26 @@
204204
],
205205
"documentation":"<p>Creates an Amazon OpenSearch Service domain. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html\">Creating and managing Amazon OpenSearch Service domains</a>.</p>"
206206
},
207+
"CreateIndex":{
208+
"name":"CreateIndex",
209+
"http":{
210+
"method":"POST",
211+
"requestUri":"/2021-01-01/opensearch/domain/{DomainName}/index"
212+
},
213+
"input":{"shape":"CreateIndexRequest"},
214+
"output":{"shape":"CreateIndexResponse"},
215+
"errors":[
216+
{"shape":"ValidationException"},
217+
{"shape":"AccessDeniedException"},
218+
{"shape":"ResourceNotFoundException"},
219+
{"shape":"ResourceAlreadyExistsException"},
220+
{"shape":"InternalException"},
221+
{"shape":"DisabledOperationException"},
222+
{"shape":"DependencyFailureException"},
223+
{"shape":"ThrottlingException"}
224+
],
225+
"documentation":"<p>Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-semantic-enrichment.html\">Automatic semantic enrichment</a>.</p>"
226+
},
207227
"CreateOutboundConnection":{
208228
"name":"CreateOutboundConnection",
209229
"http":{
@@ -341,6 +361,25 @@
341361
],
342362
"documentation":"<p>Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html\">Cross-cluster search for Amazon OpenSearch Service</a>.</p>"
343363
},
364+
"DeleteIndex":{
365+
"name":"DeleteIndex",
366+
"http":{
367+
"method":"DELETE",
368+
"requestUri":"/2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}"
369+
},
370+
"input":{"shape":"DeleteIndexRequest"},
371+
"output":{"shape":"DeleteIndexResponse"},
372+
"errors":[
373+
{"shape":"ValidationException"},
374+
{"shape":"AccessDeniedException"},
375+
{"shape":"ResourceNotFoundException"},
376+
{"shape":"InternalException"},
377+
{"shape":"DisabledOperationException"},
378+
{"shape":"DependencyFailureException"},
379+
{"shape":"ThrottlingException"}
380+
],
381+
"documentation":"<p>Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.</p>"
382+
},
344383
"DeleteOutboundConnection":{
345384
"name":"DeleteOutboundConnection",
346385
"http":{
@@ -665,7 +704,7 @@
665704
{"shape":"ConflictException"},
666705
{"shape":"DisabledOperationException"}
667706
],
668-
"documentation":"<p>Dissociates multiple packages from a domain simulatneously.</p>"
707+
"documentation":"<p>Dissociates multiple packages from a domain simultaneously.</p>"
669708
},
670709
"GetApplication":{
671710
"name":"GetApplication",
@@ -772,6 +811,25 @@
772811
],
773812
"documentation":"<p>The status of the maintenance action.</p>"
774813
},
814+
"GetIndex":{
815+
"name":"GetIndex",
816+
"http":{
817+
"method":"GET",
818+
"requestUri":"/2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}"
819+
},
820+
"input":{"shape":"GetIndexRequest"},
821+
"output":{"shape":"GetIndexResponse"},
822+
"errors":[
823+
{"shape":"ValidationException"},
824+
{"shape":"AccessDeniedException"},
825+
{"shape":"ResourceNotFoundException"},
826+
{"shape":"InternalException"},
827+
{"shape":"DisabledOperationException"},
828+
{"shape":"DependencyFailureException"},
829+
{"shape":"ThrottlingException"}
830+
],
831+
"documentation":"<p>Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.</p>"
832+
},
775833
"GetPackageVersionHistory":{
776834
"name":"GetPackageVersionHistory",
777835
"http":{
@@ -1240,6 +1298,25 @@
12401298
],
12411299
"documentation":"<p>Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.</p>"
12421300
},
1301+
"UpdateIndex":{
1302+
"name":"UpdateIndex",
1303+
"http":{
1304+
"method":"PUT",
1305+
"requestUri":"/2021-01-01/opensearch/domain/{DomainName}/index/{IndexName}"
1306+
},
1307+
"input":{"shape":"UpdateIndexRequest"},
1308+
"output":{"shape":"UpdateIndexResponse"},
1309+
"errors":[
1310+
{"shape":"ValidationException"},
1311+
{"shape":"AccessDeniedException"},
1312+
{"shape":"ResourceNotFoundException"},
1313+
{"shape":"InternalException"},
1314+
{"shape":"DisabledOperationException"},
1315+
{"shape":"DependencyFailureException"},
1316+
{"shape":"ThrottlingException"}
1317+
],
1318+
"documentation":"<p>Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.</p>"
1319+
},
12431320
"UpdatePackage":{
12441321
"name":"UpdatePackage",
12451322
"http":{
@@ -1713,7 +1790,7 @@
17131790
"documentation":"<p>The value assigned to the configuration key, such as an IAM user ARN.</p>"
17141791
}
17151792
},
1716-
"documentation":"<p>Configuration settings for an OpenSearch application. For more information, see see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html\">Using the OpenSearch user interface in Amazon OpenSearch Service</a>.</p>"
1793+
"documentation":"<p>Configuration settings for an OpenSearch application. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html\">Using the OpenSearch user interface in Amazon OpenSearch Service</a>.</p>"
17171794
},
17181795
"AppConfigType":{
17191796
"type":"string",
@@ -2722,6 +2799,39 @@
27222799
},
27232800
"documentation":"<p>The result of a <code>CreateDomain</code> operation. Contains the status of the newly created domain.</p>"
27242801
},
2802+
"CreateIndexRequest":{
2803+
"type":"structure",
2804+
"required":[
2805+
"DomainName",
2806+
"IndexName",
2807+
"IndexSchema"
2808+
],
2809+
"members":{
2810+
"DomainName":{
2811+
"shape":"DomainName",
2812+
"location":"uri",
2813+
"locationName":"DomainName"
2814+
},
2815+
"IndexName":{
2816+
"shape":"IndexName",
2817+
"documentation":"<p>The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.</p>"
2818+
},
2819+
"IndexSchema":{
2820+
"shape":"IndexSchema",
2821+
"documentation":"<p>The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.</p>"
2822+
}
2823+
}
2824+
},
2825+
"CreateIndexResponse":{
2826+
"type":"structure",
2827+
"required":["Status"],
2828+
"members":{
2829+
"Status":{
2830+
"shape":"IndexStatus",
2831+
"documentation":"<p>The status of the index creation operation.</p>"
2832+
}
2833+
}
2834+
},
27252835
"CreateOutboundConnectionRequest":{
27262836
"type":"structure",
27272837
"required":[
@@ -3058,6 +3168,36 @@
30583168
},
30593169
"documentation":"<p>The results of a <code>DeleteInboundConnection</code> operation. Contains details about the deleted inbound connection.</p>"
30603170
},
3171+
"DeleteIndexRequest":{
3172+
"type":"structure",
3173+
"required":[
3174+
"DomainName",
3175+
"IndexName"
3176+
],
3177+
"members":{
3178+
"DomainName":{
3179+
"shape":"DomainName",
3180+
"location":"uri",
3181+
"locationName":"DomainName"
3182+
},
3183+
"IndexName":{
3184+
"shape":"IndexName",
3185+
"documentation":"<p>The name of the index to delete.</p>",
3186+
"location":"uri",
3187+
"locationName":"IndexName"
3188+
}
3189+
}
3190+
},
3191+
"DeleteIndexResponse":{
3192+
"type":"structure",
3193+
"required":["Status"],
3194+
"members":{
3195+
"Status":{
3196+
"shape":"IndexStatus",
3197+
"documentation":"<p>The status of the index deletion operation.</p>"
3198+
}
3199+
}
3200+
},
30613201
"DeleteOutboundConnectionRequest":{
30623202
"type":"structure",
30633203
"required":["ConnectionId"],
@@ -4218,7 +4358,7 @@
42184358
},
42194359
"ARN":{
42204360
"shape":"ARN",
4221-
"documentation":"<p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html\">IAM identifiers </a> in the <i>AWS Identity and Access Management User Guide</i>.</p>"
4361+
"documentation":"<p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html\">IAM identifiers </a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>"
42224362
},
42234363
"Created":{
42244364
"shape":"Boolean",
@@ -4800,6 +4940,36 @@
48004940
},
48014941
"documentation":"<p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about the requested action.</p>"
48024942
},
4943+
"GetIndexRequest":{
4944+
"type":"structure",
4945+
"required":[
4946+
"DomainName",
4947+
"IndexName"
4948+
],
4949+
"members":{
4950+
"DomainName":{
4951+
"shape":"DomainName",
4952+
"location":"uri",
4953+
"locationName":"DomainName"
4954+
},
4955+
"IndexName":{
4956+
"shape":"IndexName",
4957+
"documentation":"<p>The name of the index to retrieve information about.</p>",
4958+
"location":"uri",
4959+
"locationName":"IndexName"
4960+
}
4961+
}
4962+
},
4963+
"GetIndexResponse":{
4964+
"type":"structure",
4965+
"required":["IndexSchema"],
4966+
"members":{
4967+
"IndexSchema":{
4968+
"shape":"IndexSchema",
4969+
"documentation":"<p>The JSON schema of the index including mappings, settings, and semantic enrichment configuration.</p>"
4970+
}
4971+
}
4972+
},
48034973
"GetPackageVersionHistoryRequest":{
48044974
"type":"structure",
48054975
"required":["PackageID"],
@@ -5170,6 +5340,26 @@
51705340
"type":"list",
51715341
"member":{"shape":"InboundConnection"}
51725342
},
5343+
"IndexName":{
5344+
"type":"string",
5345+
"documentation":"Name of OpenSearch index to be created/updated/retrieved/deleted for customer's domain",
5346+
"max":255,
5347+
"min":1,
5348+
"pattern":"^(?!\\.\\.?$)[^_ ,:\"+/*\\\\|?#><A-Z-][^ ,:\"+/*\\\\|?#><A-Z]*$"
5349+
},
5350+
"IndexSchema":{
5351+
"type":"structure",
5352+
"members":{},
5353+
"document":true
5354+
},
5355+
"IndexStatus":{
5356+
"type":"string",
5357+
"enum":[
5358+
"CREATED",
5359+
"UPDATED",
5360+
"DELETED"
5361+
]
5362+
},
51735363
"InitiatedBy":{
51745364
"type":"string",
51755365
"enum":[
@@ -7634,6 +7824,13 @@
76347824
"min":0,
76357825
"pattern":".*"
76367826
},
7827+
"ThrottlingException":{
7828+
"type":"structure",
7829+
"members":{},
7830+
"documentation":"<p>The request was denied due to request throttling. Reduce the frequency of your requests and try again.</p>",
7831+
"error":{"httpStatusCode":429},
7832+
"exception":true
7833+
},
76377834
"TimeUnit":{
76387835
"type":"string",
76397836
"documentation":"<p>The unit of a maintenance schedule duration. Valid value is <code>HOUR</code>.</p>",
@@ -7891,6 +8088,41 @@
78918088
},
78928089
"documentation":"<p>The results of an <code>UpdateDomain</code> request. Contains the status of the domain being updated.</p>"
78938090
},
8091+
"UpdateIndexRequest":{
8092+
"type":"structure",
8093+
"required":[
8094+
"DomainName",
8095+
"IndexName",
8096+
"IndexSchema"
8097+
],
8098+
"members":{
8099+
"DomainName":{
8100+
"shape":"DomainName",
8101+
"location":"uri",
8102+
"locationName":"DomainName"
8103+
},
8104+
"IndexName":{
8105+
"shape":"IndexName",
8106+
"documentation":"<p>The name of the index to update.</p>",
8107+
"location":"uri",
8108+
"locationName":"IndexName"
8109+
},
8110+
"IndexSchema":{
8111+
"shape":"IndexSchema",
8112+
"documentation":"<p>The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.</p>"
8113+
}
8114+
}
8115+
},
8116+
"UpdateIndexResponse":{
8117+
"type":"structure",
8118+
"required":["Status"],
8119+
"members":{
8120+
"Status":{
8121+
"shape":"IndexStatus",
8122+
"documentation":"<p>The status of the index update operation.</p>"
8123+
}
8124+
}
8125+
},
78948126
"UpdatePackageRequest":{
78958127
"type":"structure",
78968128
"required":[

0 commit comments

Comments
 (0)