@aws-sdk/client-opensearchserverless 3.300.0 → 3.302.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.
Files changed (42) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-cjs/models/models_0.js +31 -1
  3. package/dist-cjs/protocols/Aws_json1_0.js +56 -0
  4. package/dist-es/endpoint/ruleset.js +3 -3
  5. package/dist-es/models/models_0.js +28 -0
  6. package/dist-es/protocols/Aws_json1_0.js +57 -1
  7. package/dist-types/OpenSearchServerless.d.ts +5 -5
  8. package/dist-types/OpenSearchServerlessClient.d.ts +2 -2
  9. package/dist-types/commands/BatchGetCollectionCommand.d.ts +3 -3
  10. package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +2 -2
  11. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +6 -3
  12. package/dist-types/commands/CreateCollectionCommand.d.ts +11 -5
  13. package/dist-types/commands/CreateSecurityConfigCommand.d.ts +7 -4
  14. package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +6 -3
  15. package/dist-types/commands/CreateVpcEndpointCommand.d.ts +8 -5
  16. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +3 -3
  17. package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -3
  18. package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +3 -3
  19. package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +3 -3
  20. package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +3 -3
  21. package/dist-types/commands/GetAccessPolicyCommand.d.ts +1 -1
  22. package/dist-types/commands/GetSecurityConfigCommand.d.ts +1 -1
  23. package/dist-types/commands/GetSecurityPolicyCommand.d.ts +1 -1
  24. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +2 -2
  25. package/dist-types/commands/ListCollectionsCommand.d.ts +4 -4
  26. package/dist-types/commands/ListSecurityConfigsCommand.d.ts +1 -1
  27. package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +2 -2
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  29. package/dist-types/commands/ListVpcEndpointsCommand.d.ts +2 -2
  30. package/dist-types/commands/TagResourceCommand.d.ts +8 -5
  31. package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
  32. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +3 -3
  33. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +3 -3
  34. package/dist-types/commands/UpdateCollectionCommand.d.ts +3 -3
  35. package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +4 -4
  36. package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +6 -3
  37. package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +5 -5
  38. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  39. package/dist-types/models/models_0.d.ts +53 -10
  40. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  41. package/dist-types/ts3.4/models/models_0.d.ts +18 -0
  42. package/package.json +3 -3
@@ -27,13 +27,13 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointRespons
27
27
  * import { OpenSearchServerlessClient, CreateVpcEndpointCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, CreateVpcEndpointCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // CreateVpcEndpointRequest
31
31
  * name: "STRING_VALUE", // required
32
32
  * vpcId: "STRING_VALUE", // required
33
- * subnetIds: [ // required
33
+ * subnetIds: [ // SubnetIds // required
34
34
  * "STRING_VALUE",
35
35
  * ],
36
- * securityGroupIds: [
36
+ * securityGroupIds: [ // SecurityGroupIds
37
37
  * "STRING_VALUE",
38
38
  * ],
39
39
  * clientToken: "STRING_VALUE",
@@ -49,13 +49,16 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointRespons
49
49
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
50
50
  *
51
51
  * @throws {@link ConflictException} (client fault)
52
- * <p>When creating a collection, thrown when a collection with the same name already exists
53
- * or is being created. When deleting a collection, thrown when the collection is not in
52
+ * <p>When creating a resource, thrown when a resource with the same name already exists
53
+ * or is being created. When deleting a resource, thrown when the resource is not in
54
54
  * the ACTIVE or FAILED state.</p>
55
55
  *
56
56
  * @throws {@link InternalServerException} (server fault)
57
57
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
58
58
  *
59
+ * @throws {@link ServiceQuotaExceededException} (client fault)
60
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
61
+ *
59
62
  * @throws {@link ValidationException} (client fault)
60
63
  * <p>Thrown when the HTTP request contains invalid input or is missing required
61
64
  * input.</p>
@@ -27,7 +27,7 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
27
27
  * import { OpenSearchServerlessClient, DeleteAccessPolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, DeleteAccessPolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // DeleteAccessPolicyRequest
31
31
  * type: "STRING_VALUE", // required
32
32
  * name: "STRING_VALUE", // required
33
33
  * clientToken: "STRING_VALUE",
@@ -43,8 +43,8 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
43
43
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
44
44
  *
45
45
  * @throws {@link ConflictException} (client fault)
46
- * <p>When creating a collection, thrown when a collection with the same name already exists
47
- * or is being created. When deleting a collection, thrown when the collection is not in
46
+ * <p>When creating a resource, thrown when a resource with the same name already exists
47
+ * or is being created. When deleting a resource, thrown when the resource is not in
48
48
  * the ACTIVE or FAILED state.</p>
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
@@ -27,7 +27,7 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
27
27
  * import { OpenSearchServerlessClient, DeleteCollectionCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, DeleteCollectionCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // DeleteCollectionRequest
31
31
  * id: "STRING_VALUE", // required
32
32
  * clientToken: "STRING_VALUE",
33
33
  * };
@@ -42,8 +42,8 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
42
42
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
43
43
  *
44
44
  * @throws {@link ConflictException} (client fault)
45
- * <p>When creating a collection, thrown when a collection with the same name already exists
46
- * or is being created. When deleting a collection, thrown when the collection is not in
45
+ * <p>When creating a resource, thrown when a resource with the same name already exists
46
+ * or is being created. When deleting a resource, thrown when the resource is not in
47
47
  * the ACTIVE or FAILED state.</p>
48
48
  *
49
49
  * @throws {@link InternalServerException} (server fault)
@@ -28,7 +28,7 @@ export interface DeleteSecurityConfigCommandOutput extends DeleteSecurityConfigR
28
28
  * import { OpenSearchServerlessClient, DeleteSecurityConfigCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, DeleteSecurityConfigCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
31
+ * const input = { // DeleteSecurityConfigRequest
32
32
  * id: "STRING_VALUE", // required
33
33
  * clientToken: "STRING_VALUE",
34
34
  * };
@@ -43,8 +43,8 @@ export interface DeleteSecurityConfigCommandOutput extends DeleteSecurityConfigR
43
43
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
44
44
  *
45
45
  * @throws {@link ConflictException} (client fault)
46
- * <p>When creating a collection, thrown when a collection with the same name already exists
47
- * or is being created. When deleting a collection, thrown when the collection is not in
46
+ * <p>When creating a resource, thrown when a resource with the same name already exists
47
+ * or is being created. When deleting a resource, thrown when the resource is not in
48
48
  * the ACTIVE or FAILED state.</p>
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
@@ -26,7 +26,7 @@ export interface DeleteSecurityPolicyCommandOutput extends DeleteSecurityPolicyR
26
26
  * import { OpenSearchServerlessClient, DeleteSecurityPolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, DeleteSecurityPolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // DeleteSecurityPolicyRequest
30
30
  * type: "STRING_VALUE", // required
31
31
  * name: "STRING_VALUE", // required
32
32
  * clientToken: "STRING_VALUE",
@@ -42,8 +42,8 @@ export interface DeleteSecurityPolicyCommandOutput extends DeleteSecurityPolicyR
42
42
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
43
43
  *
44
44
  * @throws {@link ConflictException} (client fault)
45
- * <p>When creating a collection, thrown when a collection with the same name already exists
46
- * or is being created. When deleting a collection, thrown when the collection is not in
45
+ * <p>When creating a resource, thrown when a resource with the same name already exists
46
+ * or is being created. When deleting a resource, thrown when the resource is not in
47
47
  * the ACTIVE or FAILED state.</p>
48
48
  *
49
49
  * @throws {@link InternalServerException} (server fault)
@@ -27,7 +27,7 @@ export interface DeleteVpcEndpointCommandOutput extends DeleteVpcEndpointRespons
27
27
  * import { OpenSearchServerlessClient, DeleteVpcEndpointCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, DeleteVpcEndpointCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // DeleteVpcEndpointRequest
31
31
  * id: "STRING_VALUE", // required
32
32
  * clientToken: "STRING_VALUE",
33
33
  * };
@@ -42,8 +42,8 @@ export interface DeleteVpcEndpointCommandOutput extends DeleteVpcEndpointRespons
42
42
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
43
43
  *
44
44
  * @throws {@link ConflictException} (client fault)
45
- * <p>When creating a collection, thrown when a collection with the same name already exists
46
- * or is being created. When deleting a collection, thrown when the collection is not in
45
+ * <p>When creating a resource, thrown when a resource with the same name already exists
46
+ * or is being created. When deleting a resource, thrown when the resource is not in
47
47
  * the ACTIVE or FAILED state.</p>
48
48
  *
49
49
  * @throws {@link InternalServerException} (server fault)
@@ -27,7 +27,7 @@ export interface GetAccessPolicyCommandOutput extends GetAccessPolicyResponse, _
27
27
  * import { OpenSearchServerlessClient, GetAccessPolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, GetAccessPolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // GetAccessPolicyRequest
31
31
  * type: "STRING_VALUE", // required
32
32
  * name: "STRING_VALUE", // required
33
33
  * };
@@ -28,7 +28,7 @@ export interface GetSecurityConfigCommandOutput extends GetSecurityConfigRespons
28
28
  * import { OpenSearchServerlessClient, GetSecurityConfigCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, GetSecurityConfigCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
31
+ * const input = { // GetSecurityConfigRequest
32
32
  * id: "STRING_VALUE", // required
33
33
  * };
34
34
  * const command = new GetSecurityConfigCommand(input);
@@ -28,7 +28,7 @@ export interface GetSecurityPolicyCommandOutput extends GetSecurityPolicyRespons
28
28
  * import { OpenSearchServerlessClient, GetSecurityPolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, GetSecurityPolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
31
+ * const input = { // GetSecurityPolicyRequest
32
32
  * type: "STRING_VALUE", // required
33
33
  * name: "STRING_VALUE", // required
34
34
  * };
@@ -26,9 +26,9 @@ export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesRespo
26
26
  * import { OpenSearchServerlessClient, ListAccessPoliciesCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, ListAccessPoliciesCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // ListAccessPoliciesRequest
30
30
  * type: "STRING_VALUE", // required
31
- * resource: [
31
+ * resource: [ // ResourceFilter
32
32
  * "STRING_VALUE",
33
33
  * ],
34
34
  * nextToken: "STRING_VALUE",
@@ -21,18 +21,18 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
21
21
  * @public
22
22
  * <p>Lists all OpenSearch Serverless collections. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
23
23
  * managing Amazon OpenSearch Serverless collections</a>.</p>
24
- * <note>
24
+ * <note>
25
25
  * <p>Make sure to include an empty request body \{\} if you don't include any collection
26
26
  * filters in the request.</p>
27
- * </note>
27
+ * </note>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
31
31
  * import { OpenSearchServerlessClient, ListCollectionsCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
32
32
  * // const { OpenSearchServerlessClient, ListCollectionsCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
33
33
  * const client = new OpenSearchServerlessClient(config);
34
- * const input = {
35
- * collectionFilters: {
34
+ * const input = { // ListCollectionsRequest
35
+ * collectionFilters: { // CollectionFilters
36
36
  * name: "STRING_VALUE",
37
37
  * status: "STRING_VALUE",
38
38
  * },
@@ -28,7 +28,7 @@ export interface ListSecurityConfigsCommandOutput extends ListSecurityConfigsRes
28
28
  * import { OpenSearchServerlessClient, ListSecurityConfigsCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, ListSecurityConfigsCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
31
+ * const input = { // ListSecurityConfigsRequest
32
32
  * type: "STRING_VALUE", // required
33
33
  * nextToken: "STRING_VALUE",
34
34
  * maxResults: Number("int"),
@@ -26,9 +26,9 @@ export interface ListSecurityPoliciesCommandOutput extends ListSecurityPoliciesR
26
26
  * import { OpenSearchServerlessClient, ListSecurityPoliciesCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, ListSecurityPoliciesCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // ListSecurityPoliciesRequest
30
30
  * type: "STRING_VALUE", // required
31
- * resource: [
31
+ * resource: [ // ResourceFilter
32
32
  * "STRING_VALUE",
33
33
  * ],
34
34
  * nextToken: "STRING_VALUE",
@@ -26,7 +26,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
26
  * import { OpenSearchServerlessClient, ListTagsForResourceCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, ListTagsForResourceCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // ListTagsForResourceRequest
30
30
  * resourceArn: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
@@ -28,8 +28,8 @@ export interface ListVpcEndpointsCommandOutput extends ListVpcEndpointsResponse,
28
28
  * import { OpenSearchServerlessClient, ListVpcEndpointsCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, ListVpcEndpointsCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
32
- * vpcEndpointFilters: {
31
+ * const input = { // ListVpcEndpointsRequest
32
+ * vpcEndpointFilters: { // VpcEndpointFilters
33
33
  * status: "STRING_VALUE",
34
34
  * },
35
35
  * nextToken: "STRING_VALUE",
@@ -26,10 +26,10 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
26
  * import { OpenSearchServerlessClient, TagResourceCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, TagResourceCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // TagResourceRequest
30
30
  * resourceArn: "STRING_VALUE", // required
31
- * tags: [ // required
32
- * {
31
+ * tags: [ // Tags // required
32
+ * { // Tag
33
33
  * key: "STRING_VALUE", // required
34
34
  * value: "STRING_VALUE", // required
35
35
  * },
@@ -46,8 +46,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
46
46
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
47
47
  *
48
48
  * @throws {@link ConflictException} (client fault)
49
- * <p>When creating a collection, thrown when a collection with the same name already exists
50
- * or is being created. When deleting a collection, thrown when the collection is not in
49
+ * <p>When creating a resource, thrown when a resource with the same name already exists
50
+ * or is being created. When deleting a resource, thrown when the resource is not in
51
51
  * the ACTIVE or FAILED state.</p>
52
52
  *
53
53
  * @throws {@link InternalServerException} (server fault)
@@ -56,6 +56,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
56
56
  * @throws {@link ResourceNotFoundException} (client fault)
57
57
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
58
58
  *
59
+ * @throws {@link ServiceQuotaExceededException} (client fault)
60
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
61
+ *
59
62
  * @throws {@link ValidationException} (client fault)
60
63
  * <p>Thrown when the HTTP request contains invalid input or is missing required
61
64
  * input.</p>
@@ -26,9 +26,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
26
  * import { OpenSearchServerlessClient, UntagResourceCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, UntagResourceCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // UntagResourceRequest
30
30
  * resourceArn: "STRING_VALUE", // required
31
- * tagKeys: [ // required
31
+ * tagKeys: [ // TagKeys // required
32
32
  * "STRING_VALUE",
33
33
  * ],
34
34
  * };
@@ -43,8 +43,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
43
43
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
44
44
  *
45
45
  * @throws {@link ConflictException} (client fault)
46
- * <p>When creating a collection, thrown when a collection with the same name already exists
47
- * or is being created. When deleting a collection, thrown when the collection is not in
46
+ * <p>When creating a resource, thrown when a resource with the same name already exists
47
+ * or is being created. When deleting a resource, thrown when the resource is not in
48
48
  * the ACTIVE or FAILED state.</p>
49
49
  *
50
50
  * @throws {@link InternalServerException} (server fault)
@@ -27,7 +27,7 @@ export interface UpdateAccessPolicyCommandOutput extends UpdateAccessPolicyRespo
27
27
  * import { OpenSearchServerlessClient, UpdateAccessPolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, UpdateAccessPolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // UpdateAccessPolicyRequest
31
31
  * type: "STRING_VALUE", // required
32
32
  * name: "STRING_VALUE", // required
33
33
  * policyVersion: "STRING_VALUE", // required
@@ -46,8 +46,8 @@ export interface UpdateAccessPolicyCommandOutput extends UpdateAccessPolicyRespo
46
46
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
47
47
  *
48
48
  * @throws {@link ConflictException} (client fault)
49
- * <p>When creating a collection, thrown when a collection with the same name already exists
50
- * or is being created. When deleting a collection, thrown when the collection is not in
49
+ * <p>When creating a resource, thrown when a resource with the same name already exists
50
+ * or is being created. When deleting a resource, thrown when the resource is not in
51
51
  * the ACTIVE or FAILED state.</p>
52
52
  *
53
53
  * @throws {@link InternalServerException} (server fault)
@@ -20,15 +20,15 @@ export interface UpdateAccountSettingsCommandOutput extends UpdateAccountSetting
20
20
  /**
21
21
  * @public
22
22
  * <p>Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more
23
- * information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling">Autoscaling</a>.</p>
23
+ * information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing capacity limits for Amazon OpenSearch Serverless</a>.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
27
27
  * import { OpenSearchServerlessClient, UpdateAccountSettingsCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, UpdateAccountSettingsCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
31
- * capacityLimits: {
30
+ * const input = { // UpdateAccountSettingsRequest
31
+ * capacityLimits: { // CapacityLimits
32
32
  * maxIndexingCapacityInOCU: Number("int"),
33
33
  * maxSearchCapacityInOCU: Number("int"),
34
34
  * },
@@ -26,7 +26,7 @@ export interface UpdateCollectionCommandOutput extends UpdateCollectionResponse,
26
26
  * import { OpenSearchServerlessClient, UpdateCollectionCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
27
27
  * // const { OpenSearchServerlessClient, UpdateCollectionCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
28
28
  * const client = new OpenSearchServerlessClient(config);
29
- * const input = {
29
+ * const input = { // UpdateCollectionRequest
30
30
  * id: "STRING_VALUE", // required
31
31
  * description: "STRING_VALUE",
32
32
  * clientToken: "STRING_VALUE",
@@ -42,8 +42,8 @@ export interface UpdateCollectionCommandOutput extends UpdateCollectionResponse,
42
42
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
43
43
  *
44
44
  * @throws {@link ConflictException} (client fault)
45
- * <p>When creating a collection, thrown when a collection with the same name already exists
46
- * or is being created. When deleting a collection, thrown when the collection is not in
45
+ * <p>When creating a resource, thrown when a resource with the same name already exists
46
+ * or is being created. When deleting a resource, thrown when the resource is not in
47
47
  * the ACTIVE or FAILED state.</p>
48
48
  *
49
49
  * @throws {@link InternalServerException} (server fault)
@@ -28,11 +28,11 @@ export interface UpdateSecurityConfigCommandOutput extends UpdateSecurityConfigR
28
28
  * import { OpenSearchServerlessClient, UpdateSecurityConfigCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, UpdateSecurityConfigCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
31
+ * const input = { // UpdateSecurityConfigRequest
32
32
  * id: "STRING_VALUE", // required
33
33
  * configVersion: "STRING_VALUE", // required
34
34
  * description: "STRING_VALUE",
35
- * samlOptions: {
35
+ * samlOptions: { // SamlConfigOptions
36
36
  * metadata: "STRING_VALUE", // required
37
37
  * userAttribute: "STRING_VALUE",
38
38
  * groupAttribute: "STRING_VALUE",
@@ -51,8 +51,8 @@ export interface UpdateSecurityConfigCommandOutput extends UpdateSecurityConfigR
51
51
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
52
52
  *
53
53
  * @throws {@link ConflictException} (client fault)
54
- * <p>When creating a collection, thrown when a collection with the same name already exists
55
- * or is being created. When deleting a collection, thrown when the collection is not in
54
+ * <p>When creating a resource, thrown when a resource with the same name already exists
55
+ * or is being created. When deleting a resource, thrown when the resource is not in
56
56
  * the ACTIVE or FAILED state.</p>
57
57
  *
58
58
  * @throws {@link InternalServerException} (server fault)
@@ -28,7 +28,7 @@ export interface UpdateSecurityPolicyCommandOutput extends UpdateSecurityPolicyR
28
28
  * import { OpenSearchServerlessClient, UpdateSecurityPolicyCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
29
29
  * // const { OpenSearchServerlessClient, UpdateSecurityPolicyCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
30
30
  * const client = new OpenSearchServerlessClient(config);
31
- * const input = {
31
+ * const input = { // UpdateSecurityPolicyRequest
32
32
  * type: "STRING_VALUE", // required
33
33
  * name: "STRING_VALUE", // required
34
34
  * policyVersion: "STRING_VALUE", // required
@@ -47,8 +47,8 @@ export interface UpdateSecurityPolicyCommandOutput extends UpdateSecurityPolicyR
47
47
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
48
48
  *
49
49
  * @throws {@link ConflictException} (client fault)
50
- * <p>When creating a collection, thrown when a collection with the same name already exists
51
- * or is being created. When deleting a collection, thrown when the collection is not in
50
+ * <p>When creating a resource, thrown when a resource with the same name already exists
51
+ * or is being created. When deleting a resource, thrown when the resource is not in
52
52
  * the ACTIVE or FAILED state.</p>
53
53
  *
54
54
  * @throws {@link InternalServerException} (server fault)
@@ -57,6 +57,9 @@ export interface UpdateSecurityPolicyCommandOutput extends UpdateSecurityPolicyR
57
57
  * @throws {@link ResourceNotFoundException} (client fault)
58
58
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
59
59
  *
60
+ * @throws {@link ServiceQuotaExceededException} (client fault)
61
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
62
+ *
60
63
  * @throws {@link ValidationException} (client fault)
61
64
  * <p>Thrown when the HTTP request contains invalid input or is missing required
62
65
  * input.</p>
@@ -27,15 +27,15 @@ export interface UpdateVpcEndpointCommandOutput extends UpdateVpcEndpointRespons
27
27
  * import { OpenSearchServerlessClient, UpdateVpcEndpointCommand } from "@aws-sdk/client-opensearchserverless"; // ES Modules import
28
28
  * // const { OpenSearchServerlessClient, UpdateVpcEndpointCommand } = require("@aws-sdk/client-opensearchserverless"); // CommonJS import
29
29
  * const client = new OpenSearchServerlessClient(config);
30
- * const input = {
30
+ * const input = { // UpdateVpcEndpointRequest
31
31
  * id: "STRING_VALUE", // required
32
- * addSubnetIds: [
32
+ * addSubnetIds: [ // SubnetIds
33
33
  * "STRING_VALUE",
34
34
  * ],
35
35
  * removeSubnetIds: [
36
36
  * "STRING_VALUE",
37
37
  * ],
38
- * addSecurityGroupIds: [
38
+ * addSecurityGroupIds: [ // SecurityGroupIds
39
39
  * "STRING_VALUE",
40
40
  * ],
41
41
  * removeSecurityGroupIds: [
@@ -54,8 +54,8 @@ export interface UpdateVpcEndpointCommandOutput extends UpdateVpcEndpointRespons
54
54
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
55
55
  *
56
56
  * @throws {@link ConflictException} (client fault)
57
- * <p>When creating a collection, thrown when a collection with the same name already exists
58
- * or is being created. When deleting a collection, thrown when the collection is not in
57
+ * <p>When creating a resource, thrown when a resource with the same name already exists
58
+ * or is being created. When deleting a resource, thrown when the resource is not in
59
59
  * the ACTIVE or FAILED state.</p>
60
60
  *
61
61
  * @throws {@link InternalServerException} (server fault)
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;
@@ -12,8 +12,8 @@ export declare enum AccessPolicyType {
12
12
  }
13
13
  /**
14
14
  * @public
15
- * <p>When creating a collection, thrown when a collection with the same name already exists
16
- * or is being created. When deleting a collection, thrown when the collection is not in
15
+ * <p>When creating a resource, thrown when a resource with the same name already exists
16
+ * or is being created. When deleting a resource, thrown when the resource is not in
17
17
  * the ACTIVE or FAILED state.</p>
18
18
  */
19
19
  export declare class ConflictException extends __BaseException {
@@ -105,6 +105,34 @@ export declare class InternalServerException extends __BaseException {
105
105
  */
106
106
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
107
107
  }
108
+ /**
109
+ * @public
110
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
111
+ */
112
+ export declare class ServiceQuotaExceededException extends __BaseException {
113
+ readonly name: "ServiceQuotaExceededException";
114
+ readonly $fault: "client";
115
+ /**
116
+ * Identifier of the resource affected.
117
+ */
118
+ resourceId?: string;
119
+ /**
120
+ * Type of the resource affected.
121
+ */
122
+ resourceType?: string;
123
+ /**
124
+ * Service Quotas requirement to identify originating service.
125
+ */
126
+ serviceCode: string | undefined;
127
+ /**
128
+ * Service Quotas requirement to identify originating quota.
129
+ */
130
+ quotaCode?: string;
131
+ /**
132
+ * @internal
133
+ */
134
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
135
+ }
108
136
  /**
109
137
  * @public
110
138
  * <p>Thrown when the HTTP request contains invalid input or is missing required
@@ -183,7 +211,7 @@ export interface ListAccessPoliciesRequest {
183
211
  */
184
212
  type: AccessPolicyType | string | undefined;
185
213
  /**
186
- * <p>Resource filters (can be collection or indexes) that policies can apply to.</p>
214
+ * <p>Resource filters (can be collections or indexes) that policies can apply to.</p>
187
215
  */
188
216
  resource?: string[];
189
217
  /**
@@ -297,7 +325,8 @@ export interface AccessPolicyStats {
297
325
  * @public
298
326
  * <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
299
327
  * (OCUs). These limits are used to scale your collections based on the current workload.
300
- * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling">Autoscaling</a>.</p>
328
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
329
+ * capacity limits for Amazon OpenSearch Serverless</a>.</p>
301
330
  */
302
331
  export interface CapacityLimits {
303
332
  /**
@@ -317,7 +346,8 @@ export interface AccountSettingsDetail {
317
346
  /**
318
347
  * <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
319
348
  * (OCUs). These limits are used to scale your collections based on the current workload.
320
- * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling">Autoscaling</a>.</p>
349
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
350
+ * capacity limits for Amazon OpenSearch Serverless</a>.</p>
321
351
  */
322
352
  capacityLimits?: CapacityLimits;
323
353
  }
@@ -504,7 +534,7 @@ export interface VpcEndpointDetail {
504
534
  */
505
535
  name?: string;
506
536
  /**
507
- * <p>The ID of the VPC from which you access OpenSearch Serverless</p>
537
+ * <p>The ID of the VPC from which you access OpenSearch Serverless.</p>
508
538
  */
509
539
  vpcId?: string;
510
540
  /**
@@ -646,6 +676,18 @@ export interface CreateCollectionResponse {
646
676
  */
647
677
  createCollectionDetail?: CreateCollectionDetail;
648
678
  }
679
+ /**
680
+ * @public
681
+ * OCU Limit Exceeded for service limits
682
+ */
683
+ export declare class OcuLimitExceededException extends __BaseException {
684
+ readonly name: "OcuLimitExceededException";
685
+ readonly $fault: "client";
686
+ /**
687
+ * @internal
688
+ */
689
+ constructor(opts: __ExceptionOptionType<OcuLimitExceededException, __BaseException>);
690
+ }
649
691
  /**
650
692
  * @public
651
693
  */
@@ -842,8 +884,7 @@ export interface SamlConfigOptions {
842
884
  */
843
885
  groupAttribute?: string;
844
886
  /**
845
- * <p>The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24
846
- * hours or 1 day). Default is 60 minutes.</p>
887
+ * <p>The session timeout, in minutes. Default is 60 minutes (12 hours).</p>
847
888
  */
848
889
  sessionTimeout?: number;
849
890
  }
@@ -873,7 +914,8 @@ export interface CreateSecurityConfigRequest {
873
914
  */
874
915
  description?: string;
875
916
  /**
876
- * <p>Describes SAML options in in the form of a key-value map.</p>
917
+ * <p>Describes SAML options in in the form of a key-value map. This field is required if
918
+ * you specify <code>saml</code> for the <code>type</code> parameter.</p>
877
919
  */
878
920
  samlOptions?: SamlConfigOptions;
879
921
  /**
@@ -1595,7 +1637,8 @@ export interface UpdateAccountSettingsRequest {
1595
1637
  /**
1596
1638
  * <p>The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units
1597
1639
  * (OCUs). These limits are used to scale your collections based on the current workload.
1598
- * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-scaling">Autoscaling</a>.</p>
1640
+ * For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
1641
+ * capacity limits for Amazon OpenSearch Serverless</a>.</p>
1599
1642
  */
1600
1643
  capacityLimits?: CapacityLimits;
1601
1644
  }
@@ -26,7 +26,7 @@ export declare const resolveClientEndpointParameters: <T>(
26
26
  defaultSigningName: string;
27
27
  };
28
28
  export interface EndpointParameters extends __EndpointParameters {
29
- Region: string;
29
+ Region?: string;
30
30
  UseDualStack?: boolean;
31
31
  UseFIPS?: boolean;
32
32
  Endpoint?: string;