Skip to content

Commit d8d13a9

Browse files
author
AWS
committed
OpenSearch Service Serverless Update: Features: add Index APIs in OpenSearchServerless to support managed semantic enrichment
1 parent 8cc998d commit d8d13a9

File tree

2 files changed

+183
-6
lines changed

2 files changed

+183
-6
lines changed

‎.changes/next-release/feature-OpenSearchServiceServerless-f8a43bd.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": "OpenSearch Service Serverless",
4+
"contributor": "",
5+
"description": "Features: add Index APIs in OpenSearchServerless to support managed semantic enrichment"
6+
}

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

Lines changed: 177 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,23 @@
106106
"documentation":"<p>Creates a new OpenSearch Serverless collection. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html\">Creating and managing Amazon OpenSearch Serverless collections</a>.</p>",
107107
"idempotent":true
108108
},
109+
"CreateIndex":{
110+
"name":"CreateIndex",
111+
"http":{
112+
"method":"POST",
113+
"requestUri":"/"
114+
},
115+
"input":{"shape":"CreateIndexRequest"},
116+
"output":{"shape":"CreateIndexResponse"},
117+
"errors":[
118+
{"shape":"InternalServerException"},
119+
{"shape":"ResourceNotFoundException"},
120+
{"shape":"ConflictException"},
121+
{"shape":"ValidationException"}
122+
],
123+
"documentation":"<p>Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment\">About automatic semantic enrichment</a> in the <i>OpenSearch User Guide</i>.</p>",
124+
"idempotent":true
125+
},
109126
"CreateLifecyclePolicy":{
110127
"name":"CreateLifecyclePolicy",
111128
"http":{
@@ -208,6 +225,22 @@
208225
"documentation":"<p>Deletes an OpenSearch Serverless collection. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html\">Creating and managing Amazon OpenSearch Serverless collections</a>.</p>",
209226
"idempotent":true
210227
},
228+
"DeleteIndex":{
229+
"name":"DeleteIndex",
230+
"http":{
231+
"method":"POST",
232+
"requestUri":"/"
233+
},
234+
"input":{"shape":"DeleteIndexRequest"},
235+
"output":{"shape":"DeleteIndexResponse"},
236+
"errors":[
237+
{"shape":"InternalServerException"},
238+
{"shape":"ResourceNotFoundException"},
239+
{"shape":"ValidationException"}
240+
],
241+
"documentation":"<p>Deletes an index from an OpenSearch Serverless collection. Be aware that the index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment\">About automatic semantic enrichment</a>.</p>",
242+
"idempotent":true
243+
},
211244
"DeleteLifecyclePolicy":{
212245
"name":"DeleteLifecyclePolicy",
213246
"http":{
@@ -305,6 +338,21 @@
305338
],
306339
"documentation":"<p>Returns account-level settings related to OpenSearch Serverless.</p>"
307340
},
341+
"GetIndex":{
342+
"name":"GetIndex",
343+
"http":{
344+
"method":"POST",
345+
"requestUri":"/"
346+
},
347+
"input":{"shape":"GetIndexRequest"},
348+
"output":{"shape":"GetIndexResponse"},
349+
"errors":[
350+
{"shape":"InternalServerException"},
351+
{"shape":"ResourceNotFoundException"},
352+
{"shape":"ValidationException"}
353+
],
354+
"documentation":"<p>Retrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment\">About automatic semantic enrichment</a>.</p>"
355+
},
308356
"GetPoliciesStats":{
309357
"name":"GetPoliciesStats",
310358
"http":{
@@ -527,6 +575,22 @@
527575
"documentation":"<p>Updates an OpenSearch Serverless collection.</p>",
528576
"idempotent":true
529577
},
578+
"UpdateIndex":{
579+
"name":"UpdateIndex",
580+
"http":{
581+
"method":"POST",
582+
"requestUri":"/"
583+
},
584+
"input":{"shape":"UpdateIndexRequest"},
585+
"output":{"shape":"UpdateIndexResponse"},
586+
"errors":[
587+
{"shape":"InternalServerException"},
588+
{"shape":"ResourceNotFoundException"},
589+
{"shape":"ValidationException"}
590+
],
591+
"documentation":"<p>Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment\">About automatic semantic enrichment</a>.</p>",
592+
"idempotent":true
593+
},
530594
"UpdateLifecyclePolicy":{
531595
"name":"UpdateLifecyclePolicy",
532596
"http":{
@@ -1152,6 +1216,32 @@
11521216
},
11531217
"documentation":"<p>Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.</p>"
11541218
},
1219+
"CreateIndexRequest":{
1220+
"type":"structure",
1221+
"required":[
1222+
"id",
1223+
"indexName"
1224+
],
1225+
"members":{
1226+
"id":{
1227+
"shape":"CollectionId",
1228+
"documentation":"<p>The unique identifier of the collection in which to create the index.</p>"
1229+
},
1230+
"indexName":{
1231+
"shape":"IndexName",
1232+
"documentation":"<p>The name of the index to create. Index names must be lowercase and can't begin with underscores (_) or hyphens (-).</p>"
1233+
},
1234+
"indexSchema":{
1235+
"shape":"IndexSchema",
1236+
"documentation":"<p>The JSON schema definition for the index, including field mappings and settings.</p>"
1237+
}
1238+
}
1239+
},
1240+
"CreateIndexResponse":{
1241+
"type":"structure",
1242+
"members":{
1243+
}
1244+
},
11551245
"CreateLifecyclePolicyRequest":{
11561246
"type":"structure",
11571247
"required":[
@@ -1406,6 +1496,28 @@
14061496
}
14071497
}
14081498
},
1499+
"DeleteIndexRequest":{
1500+
"type":"structure",
1501+
"required":[
1502+
"id",
1503+
"indexName"
1504+
],
1505+
"members":{
1506+
"id":{
1507+
"shape":"CollectionId",
1508+
"documentation":"<p>The unique identifier of the collection containing the index to delete.</p>"
1509+
},
1510+
"indexName":{
1511+
"shape":"IndexName",
1512+
"documentation":"<p>The name of the index to delete.</p>"
1513+
}
1514+
}
1515+
},
1516+
"DeleteIndexResponse":{
1517+
"type":"structure",
1518+
"members":{
1519+
}
1520+
},
14091521
"DeleteLifecyclePolicyRequest":{
14101522
"type":"structure",
14111523
"required":[
@@ -1628,6 +1740,32 @@
16281740
}
16291741
}
16301742
},
1743+
"GetIndexRequest":{
1744+
"type":"structure",
1745+
"required":[
1746+
"id",
1747+
"indexName"
1748+
],
1749+
"members":{
1750+
"id":{
1751+
"shape":"CollectionId",
1752+
"documentation":"<p>The unique identifier of the collection containing the index.</p>"
1753+
},
1754+
"indexName":{
1755+
"shape":"IndexName",
1756+
"documentation":"<p>The name of the index to retrieve information about.</p>"
1757+
}
1758+
}
1759+
},
1760+
"GetIndexResponse":{
1761+
"type":"structure",
1762+
"members":{
1763+
"indexSchema":{
1764+
"shape":"IndexSchema",
1765+
"documentation":"<p>The JSON schema definition for the index, including field mappings and settings.</p>"
1766+
}
1767+
}
1768+
},
16311769
"GetPoliciesStatsRequest":{
16321770
"type":"structure",
16331771
"members":{
@@ -1774,6 +1912,13 @@
17741912
"Email"
17751913
]
17761914
},
1915+
"IndexName":{"type":"string"},
1916+
"IndexSchema":{
1917+
"type":"structure",
1918+
"members":{
1919+
},
1920+
"document":true
1921+
},
17771922
"IndexingCapacityValue":{
17781923
"type":"integer",
17791924
"box":true,
@@ -2001,7 +2146,7 @@
20012146
"members":{
20022147
"collectionFilters":{
20032148
"shape":"CollectionFilters",
2004-
"documentation":"<p>A list of filter names and values that you can use for requests.</p>"
2149+
"documentation":"<p> A list of filter names and values that you can use for requests.</p>"
20052150
},
20062151
"nextToken":{
20072152
"shape":"String",
@@ -2126,7 +2271,7 @@
21262271
},
21272272
"resource":{
21282273
"shape":"ListSecurityPoliciesRequestResourceList",
2129-
"documentation":"<p>Resource filters (can be collection or indexes) that policies can apply to.</p>"
2274+
"documentation":"<p>Resource filters (can be collection or indexes) that policies can apply to. </p>"
21302275
},
21312276
"nextToken":{
21322277
"shape":"String",
@@ -2191,7 +2336,7 @@
21912336
},
21922337
"nextToken":{
21932338
"shape":"String",
2194-
"documentation":"<p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page.</p>"
2339+
"documentation":"<p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page. </p>"
21952340
},
21962341
"maxResults":{
21972342
"shape":"ListVpcEndpointsRequestMaxResultsInteger",
@@ -2231,7 +2376,7 @@
22312376
"documentation":"<p>Description of the error.</p>"
22322377
}
22332378
},
2234-
"documentation":"<p>Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.</p>",
2379+
"documentation":"<p>Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit. </p>",
22352380
"exception":true
22362381
},
22372382
"PolicyDescription":{
@@ -2791,6 +2936,32 @@
27912936
},
27922937
"documentation":"<p>Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.</p>"
27932938
},
2939+
"UpdateIndexRequest":{
2940+
"type":"structure",
2941+
"required":[
2942+
"id",
2943+
"indexName"
2944+
],
2945+
"members":{
2946+
"id":{
2947+
"shape":"CollectionId",
2948+
"documentation":"<p>The unique identifier of the collection containing the index to update.</p>"
2949+
},
2950+
"indexName":{
2951+
"shape":"IndexName",
2952+
"documentation":"<p>The name of the index to update.</p>"
2953+
},
2954+
"indexSchema":{
2955+
"shape":"IndexSchema",
2956+
"documentation":"<p>The updated JSON schema definition for the index, including field mappings and settings. </p>"
2957+
}
2958+
}
2959+
},
2960+
"UpdateIndexResponse":{
2961+
"type":"structure",
2962+
"members":{
2963+
}
2964+
},
27942965
"UpdateLifecyclePolicyRequest":{
27952966
"type":"structure",
27962967
"required":[
@@ -2801,7 +2972,7 @@
28012972
"members":{
28022973
"type":{
28032974
"shape":"LifecyclePolicyType",
2804-
"documentation":"<p>The type of lifecycle policy.</p>"
2975+
"documentation":"<p> The type of lifecycle policy.</p>"
28052976
},
28062977
"name":{
28072978
"shape":"PolicyName",
@@ -2878,7 +3049,7 @@
28783049
"members":{
28793050
"securityConfigDetail":{
28803051
"shape":"SecurityConfigDetail",
2881-
"documentation":"<p>Details about the updated security configuration.</p>"
3052+
"documentation":"<p>Details about the updated security configuration. </p>"
28823053
}
28833054
}
28843055
},

0 commit comments

Comments
 (0)