@aws-sdk/client-opensearchserverless 3.879.0 → 3.883.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 +11 -11
package/README.md CHANGED
@@ -6,16 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript OpenSearchServerless Client for Node.js, Browser and React Native.
8
8
 
9
- <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
10
- security policies.</p>
11
- <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for
12
- Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning,
13
- configuring, and tuning your OpenSearch clusters. It enables you to easily search and
14
- analyze petabytes of data without having to worry about the underlying infrastructure
15
- and data management.</p>
16
- <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
17
- Amazon OpenSearch Serverless?</a>
18
- </p>
9
+ <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>
19
10
 
20
11
  ## Installing
21
12
 
@@ -296,16 +296,7 @@ export interface OpenSearchServerless {
296
296
  updateVpcEndpoint(args: UpdateVpcEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVpcEndpointCommandOutput) => void): void;
297
297
  }
298
298
  /**
299
- * <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
300
- * security policies.</p>
301
- * <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for
302
- * Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning,
303
- * configuring, and tuning your OpenSearch clusters. It enables you to easily search and
304
- * analyze petabytes of data without having to worry about the underlying infrastructure
305
- * and data management.</p>
306
- * <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
307
- * Amazon OpenSearch Serverless?</a>
308
- * </p>
299
+ * <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>
309
300
  * @public
310
301
  */
311
302
  export declare class OpenSearchServerless extends OpenSearchServerlessClient implements OpenSearchServerless {
@@ -210,16 +210,7 @@ export type OpenSearchServerlessClientResolvedConfigType = __SmithyResolvedConfi
210
210
  export interface OpenSearchServerlessClientResolvedConfig extends OpenSearchServerlessClientResolvedConfigType {
211
211
  }
212
212
  /**
213
- * <p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and
214
- * security policies.</p>
215
- * <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for
216
- * Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning,
217
- * configuring, and tuning your OpenSearch clusters. It enables you to easily search and
218
- * analyze petabytes of data without having to worry about the underlying infrastructure
219
- * and data management.</p>
220
- * <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
221
- * Amazon OpenSearch Serverless?</a>
222
- * </p>
213
+ * <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>
223
214
  * @public
224
215
  */
225
216
  export declare class OpenSearchServerlessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, OpenSearchServerlessClientResolvedConfig> {
@@ -27,9 +27,7 @@ declare const BatchGetCollectionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns attributes for one or more collections, including the collection endpoint and
31
- * the OpenSearch Dashboards endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and
32
- * managing Amazon OpenSearch Serverless collections</a>.</p>
30
+ * <p>Returns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. 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>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -61,6 +59,10 @@ declare const BatchGetCollectionCommand_base: {
61
59
  * // lastModifiedDate: Number("long"),
62
60
  * // collectionEndpoint: "STRING_VALUE",
63
61
  * // dashboardEndpoint: "STRING_VALUE",
62
+ * // fipsEndpoints: { // FipsEndpoints
63
+ * // collectionEndpoint: "STRING_VALUE",
64
+ * // dashboardEndpoint: "STRING_VALUE",
65
+ * // },
64
66
  * // failureCode: "STRING_VALUE",
65
67
  * // failureMessage: "STRING_VALUE",
66
68
  * // },
@@ -87,8 +89,7 @@ declare const BatchGetCollectionCommand_base: {
87
89
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
88
90
  *
89
91
  * @throws {@link ValidationException} (client fault)
90
- * <p>Thrown when the HTTP request contains invalid input or is missing required
91
- * input.</p>
92
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
92
93
  *
93
94
  * @throws {@link OpenSearchServerlessServiceException}
94
95
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const BatchGetEffectiveLifecyclePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more
31
- * information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.</p>
30
+ * <p>Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</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
@@ -78,8 +77,7 @@ declare const BatchGetEffectiveLifecyclePolicyCommand_base: {
78
77
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
79
78
  *
80
79
  * @throws {@link ValidationException} (client fault)
81
- * <p>Thrown when the HTTP request contains invalid input or is missing required
82
- * input.</p>
80
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
83
81
  *
84
82
  * @throws {@link OpenSearchServerlessServiceException}
85
83
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const BatchGetLifecyclePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see
31
- * <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.</p>
30
+ * <p>Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</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
@@ -79,8 +78,7 @@ declare const BatchGetLifecyclePolicyCommand_base: {
79
78
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
80
79
  *
81
80
  * @throws {@link ValidationException} (client fault)
82
- * <p>Thrown when the HTTP request contains invalid input or is missing required
83
- * input.</p>
81
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
84
82
  *
85
83
  * @throws {@link OpenSearchServerlessServiceException}
86
84
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const BatchGetVpcEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns attributes for one or more VPC endpoints associated with the current account.
31
- * 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 attributes for one or more 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
@@ -82,8 +80,7 @@ declare const BatchGetVpcEndpointCommand_base: {
82
80
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
83
81
  *
84
82
  * @throws {@link ValidationException} (client fault)
85
- * <p>Thrown when the HTTP request contains invalid input or is missing required
86
- * input.</p>
83
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
87
84
  *
88
85
  * @throws {@link OpenSearchServerlessServiceException}
89
86
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,10 +27,7 @@ declare const CreateAccessPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections
31
- * and the resources within them, and allow a user to access that data irrespective of the
32
- * access mechanism or network source. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data
33
- * access control for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. 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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -67,20 +64,16 @@ declare const CreateAccessPolicyCommand_base: {
67
64
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
68
65
  *
69
66
  * @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>
67
+ * <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
68
  *
74
69
  * @throws {@link InternalServerException} (server fault)
75
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
76
71
  *
77
72
  * @throws {@link ServiceQuotaExceededException} (client fault)
78
- * <p>Thrown when you attempt to create more resources than the service allows based on
79
- * service quotas.</p>
73
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
80
74
  *
81
75
  * @throws {@link ValidationException} (client fault)
82
- * <p>Thrown when the HTTP request contains invalid input or is missing required
83
- * input.</p>
76
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
84
77
  *
85
78
  * @throws {@link OpenSearchServerlessServiceException}
86
79
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const CreateCollectionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <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
31
- * managing Amazon OpenSearch Serverless collections</a>.</p>
30
+ * <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>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -74,24 +73,19 @@ declare const CreateCollectionCommand_base: {
74
73
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
75
74
  *
76
75
  * @throws {@link ConflictException} (client fault)
77
- * <p>When creating a resource, thrown when a resource with the same name already exists or
78
- * is being created. When deleting a resource, thrown when the resource is not in the
79
- * ACTIVE or FAILED state.</p>
76
+ * <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>
80
77
  *
81
78
  * @throws {@link InternalServerException} (server fault)
82
79
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
83
80
  *
84
81
  * @throws {@link OcuLimitExceededException} (client fault)
85
- * <p>Thrown when the collection you're attempting to create results in a number of search
86
- * or indexing OCUs that exceeds the account limit. </p>
82
+ * <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>
87
83
  *
88
84
  * @throws {@link ServiceQuotaExceededException} (client fault)
89
- * <p>Thrown when you attempt to create more resources than the service allows based on
90
- * service quotas.</p>
85
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
91
86
  *
92
87
  * @throws {@link ValidationException} (client fault)
93
- * <p>Thrown when the HTTP request contains invalid input or is missing required
94
- * input.</p>
88
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
95
89
  *
96
90
  * @throws {@link OpenSearchServerlessServiceException}
97
91
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,10 +27,7 @@ declare const CreateIndexCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes
31
- * created by this API are automatically configured to conduct automatic semantic
32
- * 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
33
- * Guide</i>.</p>
30
+ * <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>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -55,9 +52,7 @@ declare const CreateIndexCommand_base: {
55
52
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
56
53
  *
57
54
  * @throws {@link ConflictException} (client fault)
58
- * <p>When creating a resource, thrown when a resource with the same name already exists or
59
- * is being created. When deleting a resource, thrown when the resource is not in the
60
- * ACTIVE or FAILED state.</p>
55
+ * <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>
61
56
  *
62
57
  * @throws {@link InternalServerException} (server fault)
63
58
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -66,8 +61,7 @@ declare const CreateIndexCommand_base: {
66
61
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
67
62
  *
68
63
  * @throws {@link ValidationException} (client fault)
69
- * <p>Thrown when the HTTP request contains invalid input or is missing required
70
- * input.</p>
64
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
71
65
  *
72
66
  * @throws {@link OpenSearchServerlessServiceException}
73
67
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const CreateLifecyclePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define
31
- * the number of days or hours to retain the data on an OpenSearch Serverless index. For more information,
32
- * see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create">Creating data lifecycle policies</a>.</p>
30
+ * <p>Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create">Creating data lifecycle policies</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
@@ -66,20 +64,16 @@ declare const CreateLifecyclePolicyCommand_base: {
66
64
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
67
65
  *
68
66
  * @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>
67
+ * <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
68
  *
73
69
  * @throws {@link InternalServerException} (server fault)
74
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
75
71
  *
76
72
  * @throws {@link ServiceQuotaExceededException} (client fault)
77
- * <p>Thrown when you attempt to create more resources than the service allows based on
78
- * service quotas.</p>
73
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
79
74
  *
80
75
  * @throws {@link ValidationException} (client fault)
81
- * <p>Thrown when the HTTP request contains invalid input or is missing required
82
- * input.</p>
76
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
83
77
  *
84
78
  * @throws {@link OpenSearchServerlessServiceException}
85
79
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const CreateSecurityConfigCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Specifies 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>Specifies 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
@@ -98,20 +97,16 @@ declare const CreateSecurityConfigCommand_base: {
98
97
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
99
98
  *
100
99
  * @throws {@link ConflictException} (client fault)
101
- * <p>When creating a resource, thrown when a resource with the same name already exists or
102
- * is being created. When deleting a resource, thrown when the resource is not in the
103
- * ACTIVE or FAILED state.</p>
100
+ * <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>
104
101
  *
105
102
  * @throws {@link InternalServerException} (server fault)
106
103
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
107
104
  *
108
105
  * @throws {@link ServiceQuotaExceededException} (client fault)
109
- * <p>Thrown when you attempt to create more resources than the service allows based on
110
- * service quotas.</p>
106
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
111
107
  *
112
108
  * @throws {@link ValidationException} (client fault)
113
- * <p>Thrown when the HTTP request contains invalid input or is missing required
114
- * input.</p>
109
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
115
110
  *
116
111
  * @throws {@link OpenSearchServerlessServiceException}
117
112
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,12 +27,7 @@ declare const CreateSecurityPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a security policy to be used by one or more OpenSearch Serverless collections. Security
31
- * policies provide access to a collection and its OpenSearch Dashboards endpoint from
32
- * public networks or specific VPC endpoints. They also allow you to secure a collection
33
- * with a KMS encryption key. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network
34
- * access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption
35
- * at rest for Amazon OpenSearch Serverless</a>.</p>
30
+ * <p>Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. 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>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -69,20 +64,16 @@ declare const CreateSecurityPolicyCommand_base: {
69
64
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
70
65
  *
71
66
  * @throws {@link ConflictException} (client fault)
72
- * <p>When creating a resource, thrown when a resource with the same name already exists or
73
- * is being created. When deleting a resource, thrown when the resource is not in the
74
- * ACTIVE or FAILED state.</p>
67
+ * <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>
75
68
  *
76
69
  * @throws {@link InternalServerException} (server fault)
77
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
78
71
  *
79
72
  * @throws {@link ServiceQuotaExceededException} (client fault)
80
- * <p>Thrown when you attempt to create more resources than the service allows based on
81
- * service quotas.</p>
73
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
82
74
  *
83
75
  * @throws {@link ValidationException} (client fault)
84
- * <p>Thrown when the HTTP request contains invalid input or is missing required
85
- * input.</p>
76
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
86
77
  *
87
78
  * @throws {@link OpenSearchServerlessServiceException}
88
79
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const CreateVpcEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an OpenSearch Serverless-managed interface VPC 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>Creates an OpenSearch Serverless-managed interface VPC 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
@@ -65,20 +64,16 @@ declare const CreateVpcEndpointCommand_base: {
65
64
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
66
65
  *
67
66
  * @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>
67
+ * <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
68
  *
72
69
  * @throws {@link InternalServerException} (server fault)
73
70
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
74
71
  *
75
72
  * @throws {@link ServiceQuotaExceededException} (client fault)
76
- * <p>Thrown when you attempt to create more resources than the service allows based on
77
- * service quotas.</p>
73
+ * <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
78
74
  *
79
75
  * @throws {@link ValidationException} (client fault)
80
- * <p>Thrown when the HTTP request contains invalid input or is missing required
81
- * input.</p>
76
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
82
77
  *
83
78
  * @throws {@link OpenSearchServerlessServiceException}
84
79
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const DeleteAccessPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes 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>Deletes 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
@@ -53,9 +52,7 @@ declare const DeleteAccessPolicyCommand_base: {
53
52
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
54
53
  *
55
54
  * @throws {@link ConflictException} (client fault)
56
- * <p>When creating a resource, thrown when a resource with the same name already exists or
57
- * is being created. When deleting a resource, thrown when the resource is not in the
58
- * ACTIVE or FAILED state.</p>
55
+ * <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>
59
56
  *
60
57
  * @throws {@link InternalServerException} (server fault)
61
58
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -64,8 +61,7 @@ declare const DeleteAccessPolicyCommand_base: {
64
61
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
65
62
  *
66
63
  * @throws {@link ValidationException} (client fault)
67
- * <p>Thrown when the HTTP request contains invalid input or is missing required
68
- * input.</p>
64
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
69
65
  *
70
66
  * @throws {@link OpenSearchServerlessServiceException}
71
67
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const DeleteCollectionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <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
31
- * managing Amazon OpenSearch Serverless collections</a>.</p>
30
+ * <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>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -58,9 +57,7 @@ declare const DeleteCollectionCommand_base: {
58
57
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
59
58
  *
60
59
  * @throws {@link ConflictException} (client fault)
61
- * <p>When creating a resource, thrown when a resource with the same name already exists or
62
- * is being created. When deleting a resource, thrown when the resource is not in the
63
- * ACTIVE or FAILED state.</p>
60
+ * <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>
64
61
  *
65
62
  * @throws {@link InternalServerException} (server fault)
66
63
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -69,8 +66,7 @@ declare const DeleteCollectionCommand_base: {
69
66
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
70
67
  *
71
68
  * @throws {@link ValidationException} (client fault)
72
- * <p>Thrown when the HTTP request contains invalid input or is missing required
73
- * input.</p>
69
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
74
70
  *
75
71
  * @throws {@link OpenSearchServerlessServiceException}
76
72
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,9 +27,7 @@ declare const DeleteIndexCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an index from an OpenSearch Serverless collection. Be aware that the index might be
31
- * configured to conduct automatic semantic enrichment ingestion and search. For more
32
- * 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>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>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -59,8 +57,7 @@ declare const DeleteIndexCommand_base: {
59
57
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
60
58
  *
61
59
  * @throws {@link ValidationException} (client fault)
62
- * <p>Thrown when the HTTP request contains invalid input or is missing required
63
- * input.</p>
60
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
64
61
  *
65
62
  * @throws {@link OpenSearchServerlessServiceException}
66
63
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -52,9 +52,7 @@ declare const DeleteLifecyclePolicyCommand_base: {
52
52
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
53
53
  *
54
54
  * @throws {@link ConflictException} (client fault)
55
- * <p>When creating a resource, thrown when a resource with the same name already exists or
56
- * is being created. When deleting a resource, thrown when the resource is not in the
57
- * ACTIVE or FAILED state.</p>
55
+ * <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>
58
56
  *
59
57
  * @throws {@link InternalServerException} (server fault)
60
58
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -63,8 +61,7 @@ declare const DeleteLifecyclePolicyCommand_base: {
63
61
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
64
62
  *
65
63
  * @throws {@link ValidationException} (client fault)
66
- * <p>Thrown when the HTTP request contains invalid input or is missing required
67
- * input.</p>
64
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
68
65
  *
69
66
  * @throws {@link OpenSearchServerlessServiceException}
70
67
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const DeleteSecurityConfigCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes 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>Deletes 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
@@ -52,9 +51,7 @@ declare const DeleteSecurityConfigCommand_base: {
52
51
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
53
52
  *
54
53
  * @throws {@link ConflictException} (client fault)
55
- * <p>When creating a resource, thrown when a resource with the same name already exists or
56
- * is being created. When deleting a resource, thrown when the resource is not in the
57
- * ACTIVE or FAILED state.</p>
54
+ * <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>
58
55
  *
59
56
  * @throws {@link InternalServerException} (server fault)
60
57
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -63,8 +60,7 @@ declare const DeleteSecurityConfigCommand_base: {
63
60
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
64
61
  *
65
62
  * @throws {@link ValidationException} (client fault)
66
- * <p>Thrown when the HTTP request contains invalid input or is missing required
67
- * input.</p>
63
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
68
64
  *
69
65
  * @throws {@link OpenSearchServerlessServiceException}
70
66
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -52,9 +52,7 @@ declare const DeleteSecurityPolicyCommand_base: {
52
52
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
53
53
  *
54
54
  * @throws {@link ConflictException} (client fault)
55
- * <p>When creating a resource, thrown when a resource with the same name already exists or
56
- * is being created. When deleting a resource, thrown when the resource is not in the
57
- * ACTIVE or FAILED state.</p>
55
+ * <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>
58
56
  *
59
57
  * @throws {@link InternalServerException} (server fault)
60
58
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -63,8 +61,7 @@ declare const DeleteSecurityPolicyCommand_base: {
63
61
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
64
62
  *
65
63
  * @throws {@link ValidationException} (client fault)
66
- * <p>Thrown when the HTTP request contains invalid input or is missing required
67
- * input.</p>
64
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
68
65
  *
69
66
  * @throws {@link OpenSearchServerlessServiceException}
70
67
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>
@@ -27,8 +27,7 @@ declare const DeleteVpcEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes 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>Deletes 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
@@ -58,9 +57,7 @@ declare const DeleteVpcEndpointCommand_base: {
58
57
  * @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
59
58
  *
60
59
  * @throws {@link ConflictException} (client fault)
61
- * <p>When creating a resource, thrown when a resource with the same name already exists or
62
- * is being created. When deleting a resource, thrown when the resource is not in the
63
- * ACTIVE or FAILED state.</p>
60
+ * <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>
64
61
  *
65
62
  * @throws {@link InternalServerException} (server fault)
66
63
  * <p>Thrown when an error internal to the service occurs while processing a request.</p>
@@ -69,8 +66,7 @@ declare const DeleteVpcEndpointCommand_base: {
69
66
  * <p>Thrown when accessing or deleting a resource that does not exist.</p>
70
67
  *
71
68
  * @throws {@link ValidationException} (client fault)
72
- * <p>Thrown when the HTTP request contains invalid input or is missing required
73
- * input.</p>
69
+ * <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
74
70
  *
75
71
  * @throws {@link OpenSearchServerlessServiceException}
76
72
  * <p>Base exception class for all service exceptions from OpenSearchServerless service.</p>