@aws-sdk/client-opensearchserverless 3.876.0 → 3.882.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 (48) hide show
  1. package/README.md +1 -10
  2. package/dist-types/OpenSearchServerless.d.ts +1 -10
  3. package/dist-types/OpenSearchServerlessClient.d.ts +1 -10
  4. package/dist-types/commands/BatchGetCollectionCommand.d.ts +6 -5
  5. package/dist-types/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +2 -4
  6. package/dist-types/commands/BatchGetLifecyclePolicyCommand.d.ts +2 -4
  7. package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +2 -5
  8. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +4 -11
  9. package/dist-types/commands/CreateCollectionCommand.d.ts +5 -11
  10. package/dist-types/commands/CreateIndexCommand.d.ts +3 -9
  11. package/dist-types/commands/CreateLifecyclePolicyCommand.d.ts +4 -10
  12. package/dist-types/commands/CreateSecurityConfigCommand.d.ts +4 -9
  13. package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +4 -13
  14. package/dist-types/commands/CreateVpcEndpointCommand.d.ts +4 -9
  15. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +3 -7
  16. package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -7
  17. package/dist-types/commands/DeleteIndexCommand.d.ts +2 -5
  18. package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +2 -5
  19. package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +3 -7
  20. package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +2 -5
  21. package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +3 -7
  22. package/dist-types/commands/GetAccessPolicyCommand.d.ts +2 -4
  23. package/dist-types/commands/GetAccountSettingsCommand.d.ts +1 -2
  24. package/dist-types/commands/GetIndexCommand.d.ts +2 -5
  25. package/dist-types/commands/GetPoliciesStatsCommand.d.ts +1 -2
  26. package/dist-types/commands/GetSecurityConfigCommand.d.ts +2 -5
  27. package/dist-types/commands/GetSecurityPolicyCommand.d.ts +2 -6
  28. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -2
  29. package/dist-types/commands/ListCollectionsCommand.d.ts +2 -8
  30. package/dist-types/commands/ListLifecyclePoliciesCommand.d.ts +1 -2
  31. package/dist-types/commands/ListSecurityConfigsCommand.d.ts +2 -5
  32. package/dist-types/commands/ListSecurityPoliciesCommand.d.ts +1 -2
  33. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
  34. package/dist-types/commands/ListVpcEndpointsCommand.d.ts +2 -5
  35. package/dist-types/commands/TagResourceCommand.d.ts +4 -9
  36. package/dist-types/commands/UntagResourceCommand.d.ts +3 -7
  37. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +3 -7
  38. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -5
  39. package/dist-types/commands/UpdateCollectionCommand.d.ts +2 -5
  40. package/dist-types/commands/UpdateIndexCommand.d.ts +2 -6
  41. package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +3 -7
  42. package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +3 -7
  43. package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +4 -10
  44. package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +3 -7
  45. package/dist-types/index.d.ts +1 -10
  46. package/dist-types/models/models_0.d.ts +111 -222
  47. package/dist-types/ts3.4/models/models_0.d.ts +5 -0
  48. package/package.json +12 -12
@@ -27,8 +27,7 @@ declare const GetAccessPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
31
- * access control for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Returns an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -68,8 +67,7 @@ declare const GetAccessPolicyCommand_base: {
68
67
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
69
68
  *
70
69
  * @throws {@link ValidationException} (client fault)
71
- * <p>Thrown when the HTTP request contains invalid input or is missing required
72
- * input.</p>
70
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
73
71
  *
74
72
  * @throws {@link OpenSearchServerlessServiceException}
75
73
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -58,8 +58,7 @@ declare const GetAccountSettingsCommand_base: {
58
58
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
59
59
  *
60
60
  * @throws {@link ValidationException} (client fault)
61
- * <p>Thrown when the HTTP request contains invalid input or is missing required
62
- * input.</p>
61
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
63
62
  *
64
63
  * @throws {@link OpenSearchServerlessServiceException}
65
64
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const GetIndexCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves information about an index in an OpenSearch Serverless collection, including its schema
31
- * definition. The index might be configured to conduct automatic semantic enrichment
32
- * 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>
30
+ * <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>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -61,8 +59,7 @@ declare const GetIndexCommand_base: {
61
59
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
62
60
  *
63
61
  * @throws {@link ValidationException} (client fault)
64
- * <p>Thrown when the HTTP request contains invalid input or is missing required
65
- * input.</p>
62
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
66
63
  *
67
64
  * @throws {@link OpenSearchServerlessServiceException}
68
65
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const GetPoliciesStatsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns statistical information about your OpenSearch Serverless access policies, security
31
- * configurations, and security policies.</p>
30
+ * <p>Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const GetSecurityConfigCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns information about an OpenSearch Serverless security configuration. For more information, see
31
- * <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
32
- * authentication for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Returns information about an OpenSearch Serverless security configuration. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -86,8 +84,7 @@ declare const GetSecurityConfigCommand_base: {
86
84
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
87
85
  *
88
86
  * @throws {@link ValidationException} (client fault)
89
- * <p>Thrown when the HTTP request contains invalid input or is missing required
90
- * input.</p>
87
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
91
88
  *
92
89
  * @throws {@link OpenSearchServerlessServiceException}
93
90
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,10 +27,7 @@ declare const GetSecurityPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns information about a configured OpenSearch Serverless security policy. For more information,
31
- * see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network
32
- * access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption
33
- * at rest for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Returns information about a configured OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at rest for Amazon OpenSearch Serverless</a>.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -70,8 +67,7 @@ declare const GetSecurityPolicyCommand_base: {
70
67
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
71
68
  *
72
69
  * @throws {@link ValidationException} (client fault)
73
- * <p>Thrown when the HTTP request contains invalid input or is missing required
74
- * input.</p>
70
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
75
71
  *
76
72
  * @throws {@link OpenSearchServerlessServiceException}
77
73
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -70,8 +70,7 @@ declare const ListAccessPoliciesCommand_base: {
70
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
71
71
  *
72
72
  * @throws {@link ValidationException} (client fault)
73
- * <p>Thrown when the HTTP request contains invalid input or is missing required
74
- * input.</p>
73
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
75
74
  *
76
75
  * @throws {@link OpenSearchServerlessServiceException}
77
76
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,12 +27,7 @@ declare const ListCollectionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <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
31
- * managing Amazon OpenSearch Serverless collections</a>.</p>
32
- * <note>
33
- * <p>Make sure to include an empty request body \{\} if you don't include any collection
34
- * filters in the request.</p>
35
- * </note>
30
+ * <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 managing Amazon OpenSearch Serverless collections</a>.</p> <note> <p>Make sure to include an empty request body \{\} if you don't include any collection filters in the request.</p> </note>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -73,8 +68,7 @@ declare const ListCollectionsCommand_base: {
73
68
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
74
69
  *
75
70
  * @throws {@link ValidationException} (client fault)
76
- * <p>Thrown when the HTTP request contains invalid input or is missing required
77
- * input.</p>
71
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
78
72
  *
79
73
  * @throws {@link OpenSearchServerlessServiceException}
80
74
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -70,8 +70,7 @@ declare const ListLifecyclePoliciesCommand_base: {
70
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
71
71
  *
72
72
  * @throws {@link ValidationException} (client fault)
73
- * <p>Thrown when the HTTP request contains invalid input or is missing required
74
- * input.</p>
73
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
75
74
  *
76
75
  * @throws {@link OpenSearchServerlessServiceException}
77
76
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const ListSecurityConfigsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns information about configured OpenSearch Serverless security configurations. For more
31
- * information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
32
- * authentication for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Returns information about configured OpenSearch Serverless security configurations. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -69,8 +67,7 @@ declare const ListSecurityConfigsCommand_base: {
69
67
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
70
68
  *
71
69
  * @throws {@link ValidationException} (client fault)
72
- * <p>Thrown when the HTTP request contains invalid input or is missing required
73
- * input.</p>
70
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
74
71
  *
75
72
  * @throws {@link OpenSearchServerlessServiceException}
76
73
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -70,8 +70,7 @@ declare const ListSecurityPoliciesCommand_base: {
70
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
71
71
  *
72
72
  * @throws {@link ValidationException} (client fault)
73
- * <p>Thrown when the HTTP request contains invalid input or is missing required
74
- * input.</p>
73
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
75
74
  *
76
75
  * @throws {@link OpenSearchServerlessServiceException}
77
76
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const ListTagsForResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the tags for an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging
31
- * Amazon OpenSearch Serverless collections</a>.</p>
30
+ * <p>Returns the tags for an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -64,8 +63,7 @@ declare const ListTagsForResourceCommand_base: {
64
63
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
65
64
  *
66
65
  * @throws {@link ValidationException} (client fault)
67
- * <p>Thrown when the HTTP request contains invalid input or is missing required
68
- * input.</p>
66
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
69
67
  *
70
68
  * @throws {@link OpenSearchServerlessServiceException}
71
69
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const ListVpcEndpointsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current
31
- * account. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
32
- * Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
30
+ * <p>Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -68,8 +66,7 @@ declare const ListVpcEndpointsCommand_base: {
68
66
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
69
67
  *
70
68
  * @throws {@link ValidationException} (client fault)
71
- * <p>Thrown when the HTTP request contains invalid input or is missing required
72
- * input.</p>
69
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
73
70
  *
74
71
  * @throws {@link OpenSearchServerlessServiceException}
75
72
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Associates tags with an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging
31
- * Amazon OpenSearch Serverless collections</a>.</p>
30
+ * <p>Associates tags with an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -57,9 +56,7 @@ declare const TagResourceCommand_base: {
57
56
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
58
57
  *
59
58
  * @throws {@link ConflictException} (client fault)
60
- * <p>When creating a resource, thrown when a resource with the same name already exists or
61
- * is being created. When deleting a resource, thrown when the resource is not in the
62
- * ACTIVE or FAILED state.</p>
59
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
63
60
  *
64
61
  * @throws {@link InternalServerException} (server fault)
65
62
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -68,12 +65,10 @@ declare const TagResourceCommand_base: {
68
65
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
69
66
  *
70
67
  * @throws {@link ServiceQuotaExceededException} (client fault)
71
- * <p>Thrown when you attempt to create more resources than the service allows based on
72
- * service quotas.</p>
68
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
73
69
  *
74
70
  * @throws {@link ValidationException} (client fault)
75
- * <p>Thrown when the HTTP request contains invalid input or is missing required
76
- * input.</p>
71
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
77
72
  *
78
73
  * @throws {@link OpenSearchServerlessServiceException}
79
74
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging
31
- * Amazon OpenSearch Serverless collections</a>.</p>
30
+ * <p>Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-collection.html">Tagging Amazon OpenSearch Serverless collections</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -54,9 +53,7 @@ declare const UntagResourceCommand_base: {
54
53
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
55
54
  *
56
55
  * @throws {@link ConflictException} (client fault)
57
- * <p>When creating a resource, thrown when a resource with the same name already exists or
58
- * is being created. When deleting a resource, thrown when the resource is not in the
59
- * ACTIVE or FAILED state.</p>
56
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
60
57
  *
61
58
  * @throws {@link InternalServerException} (server fault)
62
59
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -65,8 +62,7 @@ declare const UntagResourceCommand_base: {
65
62
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
66
63
  *
67
64
  * @throws {@link ValidationException} (client fault)
68
- * <p>Thrown when the HTTP request contains invalid input or is missing required
69
- * input.</p>
65
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
70
66
  *
71
67
  * @throws {@link OpenSearchServerlessServiceException}
72
68
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const UpdateAccessPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
31
- * access control for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Updates an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -66,9 +65,7 @@ declare const UpdateAccessPolicyCommand_base: {
66
65
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
67
66
  *
68
67
  * @throws {@link ConflictException} (client fault)
69
- * <p>When creating a resource, thrown when a resource with the same name already exists or
70
- * is being created. When deleting a resource, thrown when the resource is not in the
71
- * ACTIVE or FAILED state.</p>
68
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
72
69
  *
73
70
  * @throws {@link InternalServerException} (server fault)
74
71
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -77,8 +74,7 @@ declare const UpdateAccessPolicyCommand_base: {
77
74
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
78
75
  *
79
76
  * @throws {@link ValidationException} (client fault)
80
- * <p>Thrown when the HTTP request contains invalid input or is missing required
81
- * input.</p>
77
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
82
78
  *
83
79
  * @throws {@link OpenSearchServerlessServiceException}
84
80
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const UpdateAccountSettingsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more
31
- * information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-scaling.html">Managing
32
- * capacity limits for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more 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>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -65,8 +63,7 @@ declare const UpdateAccountSettingsCommand_base: {
65
63
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
66
64
  *
67
65
  * @throws {@link ValidationException} (client fault)
68
- * <p>Thrown when the HTTP request contains invalid input or is missing required
69
- * input.</p>
66
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
70
67
  *
71
68
  * @throws {@link OpenSearchServerlessServiceException}
72
69
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -63,16 +63,13 @@ declare const UpdateCollectionCommand_base: {
63
63
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
64
64
  *
65
65
  * @throws {@link ConflictException} (client fault)
66
- * <p>When creating a resource, thrown when a resource with the same name already exists or
67
- * is being created. When deleting a resource, thrown when the resource is not in the
68
- * ACTIVE or FAILED state.</p>
66
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
69
67
  *
70
68
  * @throws {@link InternalServerException} (server fault)
71
69
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
72
70
  *
73
71
  * @throws {@link ValidationException} (client fault)
74
- * <p>Thrown when the HTTP request contains invalid input or is missing required
75
- * input.</p>
72
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
76
73
  *
77
74
  * @throws {@link OpenSearchServerlessServiceException}
78
75
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,10 +27,7 @@ declare const UpdateIndexCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates an existing index in an OpenSearch Serverless collection. This operation allows you to modify
31
- * the index schema, including adding new fields or changing field mappings. You can also
32
- * enable automatic semantic enrichment ingestion and search. For more information, see
33
- * <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html#serverless-semantic-enrichment">About automatic semantic enrichment</a>.</p>
30
+ * <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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -61,8 +58,7 @@ declare const UpdateIndexCommand_base: {
61
58
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
62
59
  *
63
60
  * @throws {@link ValidationException} (client fault)
64
- * <p>Thrown when the HTTP request contains invalid input or is missing required
65
- * input.</p>
61
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
66
62
  *
67
63
  * @throws {@link OpenSearchServerlessServiceException}
68
64
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -65,9 +65,7 @@ declare const UpdateLifecyclePolicyCommand_base: {
65
65
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
66
66
  *
67
67
  * @throws {@link ConflictException} (client fault)
68
- * <p>When creating a resource, thrown when a resource with the same name already exists or
69
- * is being created. When deleting a resource, thrown when the resource is not in the
70
- * ACTIVE or FAILED state.</p>
68
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
71
69
  *
72
70
  * @throws {@link InternalServerException} (server fault)
73
71
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -76,12 +74,10 @@ declare const UpdateLifecyclePolicyCommand_base: {
76
74
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
77
75
  *
78
76
  * @throws {@link ServiceQuotaExceededException} (client fault)
79
- * <p>Thrown when you attempt to create more resources than the service allows based on
80
- * service quotas.</p>
77
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
81
78
  *
82
79
  * @throws {@link ValidationException} (client fault)
83
- * <p>Thrown when the HTTP request contains invalid input or is missing required
84
- * input.</p>
80
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
85
81
  *
86
82
  * @throws {@link OpenSearchServerlessServiceException}
87
83
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const UpdateSecurityConfigCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
31
- * authentication for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Updates a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -97,9 +96,7 @@ declare const UpdateSecurityConfigCommand_base: {
97
96
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
98
97
  *
99
98
  * @throws {@link ConflictException} (client fault)
100
- * <p>When creating a resource, thrown when a resource with the same name already exists or
101
- * is being created. When deleting a resource, thrown when the resource is not in the
102
- * ACTIVE or FAILED state.</p>
99
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
103
100
  *
104
101
  * @throws {@link InternalServerException} (server fault)
105
102
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -108,8 +105,7 @@ declare const UpdateSecurityConfigCommand_base: {
108
105
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
109
106
  *
110
107
  * @throws {@link ValidationException} (client fault)
111
- * <p>Thrown when the HTTP request contains invalid input or is missing required
112
- * input.</p>
108
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
113
109
  *
114
110
  * @throws {@link OpenSearchServerlessServiceException}
115
111
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const UpdateSecurityPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates an OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network
31
- * access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption
32
- * at rest for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Updates an OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at rest for Amazon OpenSearch Serverless</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -67,9 +65,7 @@ declare const UpdateSecurityPolicyCommand_base: {
67
65
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
68
66
  *
69
67
  * @throws {@link ConflictException} (client fault)
70
- * <p>When creating a resource, thrown when a resource with the same name already exists or
71
- * is being created. When deleting a resource, thrown when the resource is not in the
72
- * ACTIVE or FAILED state.</p>
68
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
73
69
  *
74
70
  * @throws {@link InternalServerException} (server fault)
75
71
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -78,12 +74,10 @@ declare const UpdateSecurityPolicyCommand_base: {
78
74
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
79
75
  *
80
76
  * @throws {@link ServiceQuotaExceededException} (client fault)
81
- * <p>Thrown when you attempt to create more resources than the service allows based on
82
- * service quotas.</p>
77
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
83
78
  *
84
79
  * @throws {@link ValidationException} (client fault)
85
- * <p>Thrown when the HTTP request contains invalid input or is missing required
86
- * input.</p>
80
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
87
81
  *
88
82
  * @throws {@link OpenSearchServerlessServiceException}
89
83
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const UpdateVpcEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates an OpenSearch Serverless-managed interface endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
31
- * Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
30
+ * <p>Updates an OpenSearch Serverless-managed interface endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -77,16 +76,13 @@ declare const UpdateVpcEndpointCommand_base: {
77
76
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
78
77
  *
79
78
  * @throws {@link ConflictException} (client fault)
80
- * <p>When creating a resource, thrown when a resource with the same name already exists or
81
- * is being created. When deleting a resource, thrown when the resource is not in the
82
- * ACTIVE or FAILED state.</p>
79
+ * <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.</p>
83
80
  *
84
81
  * @throws {@link InternalServerException} (server fault)
85
82
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
86
83
  *
87
84
  * @throws {@link ValidationException} (client fault)
88
- * <p>Thrown when the HTTP request contains invalid input or is missing required
89
- * input.</p>
85
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
90
86
  *
91
87
  * @throws {@link OpenSearchServerlessServiceException}
92
88
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -1,14 +1,5 @@
1
1
  /**
2
- * <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
3
- * security policies.</p>
4
- * <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for
5
- * Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning,
6
- * configuring, and tuning your OpenSearch clusters. It enables you to easily search and
7
- * analyze petabytes of data without having to worry about the underlying infrastructure
8
- * and data management.</p>
9
- * <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
10
- * Amazon OpenSearch Serverless?</a>
11
- * </p>
2
+ * <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.</p> <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.</p> <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is Amazon OpenSearch Serverless?</a> </p>
12
3
  *
13
4
  * @packageDocumentation
14
5
  */