@aws-sdk/client-opensearchserverless 3.855.0 → 3.856.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.
- package/README.md +1 -1
- package/dist-cjs/index.js +6 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +2 -0
- package/dist-types/OpenSearchServerless.d.ts +1 -1
- package/dist-types/OpenSearchServerlessClient.d.ts +1 -1
- package/dist-types/commands/BatchGetEffectiveLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetLifecyclePolicyCommand.d.ts +2 -1
- package/dist-types/commands/BatchGetVpcEndpointCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +7 -6
- package/dist-types/commands/CreateCollectionCommand.d.ts +7 -5
- package/dist-types/commands/CreateLifecyclePolicyCommand.d.ts +7 -5
- package/dist-types/commands/CreateSecurityConfigCommand.d.ts +15 -7
- package/dist-types/commands/CreateSecurityPolicyCommand.d.ts +8 -7
- package/dist-types/commands/CreateVpcEndpointCommand.d.ts +5 -4
- package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteLifecyclePolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteSecurityConfigCommand.d.ts +4 -5
- package/dist-types/commands/DeleteSecurityPolicyCommand.d.ts +3 -3
- package/dist-types/commands/DeleteVpcEndpointCommand.d.ts +5 -5
- package/dist-types/commands/GetAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetSecurityConfigCommand.d.ts +4 -0
- package/dist-types/commands/GetSecurityPolicyCommand.d.ts +4 -3
- package/dist-types/commands/ListSecurityConfigsCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListVpcEndpointsCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +7 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -4
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +4 -4
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCollectionCommand.d.ts +3 -3
- package/dist-types/commands/UpdateLifecyclePolicyCommand.d.ts +5 -4
- package/dist-types/commands/UpdateSecurityConfigCommand.d.ts +12 -5
- package/dist-types/commands/UpdateSecurityPolicyCommand.d.ts +8 -7
- package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +5 -5
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +136 -54
- package/dist-types/ts3.4/models/models_0.d.ts +8 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ Amazon OpenSearch Service. OpenSearch Serverless removes the operational complex
|
|
|
13
13
|
configuring, and tuning your OpenSearch clusters. It enables you to easily search and
|
|
14
14
|
analyze petabytes of data without having to worry about the underlying infrastructure
|
|
15
15
|
and data management.</p>
|
|
16
|
-
<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
17
|
Amazon OpenSearch Serverless?</a>
|
|
18
18
|
</p>
|
|
19
19
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -494,6 +494,10 @@ var IamIdentityCenterUserAttribute = {
|
|
|
494
494
|
UserName: "UserName"
|
|
495
495
|
};
|
|
496
496
|
var SecurityConfigType = {
|
|
497
|
+
/**
|
|
498
|
+
* iam federation
|
|
499
|
+
*/
|
|
500
|
+
iamfederation: "iamfederation",
|
|
497
501
|
/**
|
|
498
502
|
* iam identity center
|
|
499
503
|
*/
|
|
@@ -1338,6 +1342,7 @@ var se_CreateSecurityConfigRequest = /* @__PURE__ */ __name((input, context) =>
|
|
|
1338
1342
|
return (0, import_smithy_client.take)(input, {
|
|
1339
1343
|
clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
|
|
1340
1344
|
description: [],
|
|
1345
|
+
iamFederationOptions: import_smithy_client._json,
|
|
1341
1346
|
iamIdentityCenterOptions: import_smithy_client._json,
|
|
1342
1347
|
name: [],
|
|
1343
1348
|
samlOptions: import_smithy_client._json,
|
|
@@ -1433,6 +1438,7 @@ var se_UpdateSecurityConfigRequest = /* @__PURE__ */ __name((input, context) =>
|
|
|
1433
1438
|
clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
|
|
1434
1439
|
configVersion: [],
|
|
1435
1440
|
description: [],
|
|
1441
|
+
iamFederationOptions: import_smithy_client._json,
|
|
1436
1442
|
iamIdentityCenterOptionsUpdates: import_smithy_client._json,
|
|
1437
1443
|
id: [],
|
|
1438
1444
|
samlOptions: import_smithy_client._json
|
|
@@ -827,6 +827,7 @@ const se_CreateSecurityConfigRequest = (input, context) => {
|
|
|
827
827
|
return take(input, {
|
|
828
828
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
829
829
|
description: [],
|
|
830
|
+
iamFederationOptions: _json,
|
|
830
831
|
iamIdentityCenterOptions: _json,
|
|
831
832
|
name: [],
|
|
832
833
|
samlOptions: _json,
|
|
@@ -922,6 +923,7 @@ const se_UpdateSecurityConfigRequest = (input, context) => {
|
|
|
922
923
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
923
924
|
configVersion: [],
|
|
924
925
|
description: [],
|
|
926
|
+
iamFederationOptions: _json,
|
|
925
927
|
iamIdentityCenterOptionsUpdates: _json,
|
|
926
928
|
id: [],
|
|
927
929
|
samlOptions: _json,
|
|
@@ -275,7 +275,7 @@ export interface OpenSearchServerless {
|
|
|
275
275
|
* configuring, and tuning your OpenSearch clusters. It enables you to easily search and
|
|
276
276
|
* analyze petabytes of data without having to worry about the underlying infrastructure
|
|
277
277
|
* and data management.</p>
|
|
278
|
-
* <p>
|
|
278
|
+
* <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
|
|
279
279
|
* Amazon OpenSearch Serverless?</a>
|
|
280
280
|
* </p>
|
|
281
281
|
* @public
|
|
@@ -213,7 +213,7 @@ export interface OpenSearchServerlessClientResolvedConfig extends OpenSearchServ
|
|
|
213
213
|
* configuring, and tuning your OpenSearch clusters. It enables you to easily search and
|
|
214
214
|
* analyze petabytes of data without having to worry about the underlying infrastructure
|
|
215
215
|
* and data management.</p>
|
|
216
|
-
* <p>
|
|
216
|
+
* <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
|
|
217
217
|
* Amazon OpenSearch Serverless?</a>
|
|
218
218
|
* </p>
|
|
219
219
|
* @public
|
|
@@ -27,7 +27,8 @@ 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
|
|
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>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ 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
|
|
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>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -28,8 +28,8 @@ declare const BatchGetVpcEndpointCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns attributes for one or more VPC endpoints associated with the current account.
|
|
31
|
-
* For more information, see
|
|
32
|
-
*
|
|
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>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -29,8 +29,8 @@ declare const CreateAccessPolicyCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections
|
|
31
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
|
-
* control for Amazon OpenSearch Serverless</a>.</p>
|
|
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>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -67,15 +67,16 @@ declare const CreateAccessPolicyCommand_base: {
|
|
|
67
67
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ConflictException} (client fault)
|
|
70
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
71
|
-
*
|
|
72
|
-
*
|
|
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>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link InternalServerException} (server fault)
|
|
75
75
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
78
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
79
|
+
* service quotas.</p>
|
|
79
80
|
*
|
|
80
81
|
* @throws {@link ValidationException} (client fault)
|
|
81
82
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -74,18 +74,20 @@ declare const CreateCollectionCommand_base: {
|
|
|
74
74
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ConflictException} (client fault)
|
|
77
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
78
|
-
*
|
|
79
|
-
*
|
|
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>
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link InternalServerException} (server fault)
|
|
82
82
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link OcuLimitExceededException} (client fault)
|
|
85
|
-
* <p>Thrown when the collection you're attempting to create results in a number of search
|
|
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>
|
|
86
87
|
*
|
|
87
88
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
88
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
89
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
90
|
+
* service quotas.</p>
|
|
89
91
|
*
|
|
90
92
|
* @throws {@link ValidationException} (client fault)
|
|
91
93
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -28,7 +28,8 @@ declare const CreateLifecyclePolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
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,
|
|
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>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -65,15 +66,16 @@ declare const CreateLifecyclePolicyCommand_base: {
|
|
|
65
66
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link ConflictException} (client fault)
|
|
68
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
69
|
-
*
|
|
70
|
-
*
|
|
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>
|
|
71
72
|
*
|
|
72
73
|
* @throws {@link InternalServerException} (server fault)
|
|
73
74
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
74
75
|
*
|
|
75
76
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
76
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
77
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
78
|
+
* service quotas.</p>
|
|
77
79
|
*
|
|
78
80
|
* @throws {@link ValidationException} (client fault)
|
|
79
81
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -27,9 +27,8 @@ 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
|
|
31
|
-
*
|
|
32
|
-
* 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
|
|
31
|
+
* authentication for Amazon OpenSearch Serverless</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|
|
@@ -52,6 +51,10 @@ declare const CreateSecurityConfigCommand_base: {
|
|
|
52
51
|
* userAttribute: "STRING_VALUE",
|
|
53
52
|
* groupAttribute: "STRING_VALUE",
|
|
54
53
|
* },
|
|
54
|
+
* iamFederationOptions: { // IamFederationConfigOptions
|
|
55
|
+
* groupAttribute: "STRING_VALUE",
|
|
56
|
+
* userAttribute: "STRING_VALUE",
|
|
57
|
+
* },
|
|
55
58
|
* clientToken: "STRING_VALUE",
|
|
56
59
|
* };
|
|
57
60
|
* const command = new CreateSecurityConfigCommand(input);
|
|
@@ -77,6 +80,10 @@ declare const CreateSecurityConfigCommand_base: {
|
|
|
77
80
|
* // userAttribute: "STRING_VALUE",
|
|
78
81
|
* // groupAttribute: "STRING_VALUE",
|
|
79
82
|
* // },
|
|
83
|
+
* // iamFederationOptions: { // IamFederationConfigOptions
|
|
84
|
+
* // groupAttribute: "STRING_VALUE",
|
|
85
|
+
* // userAttribute: "STRING_VALUE",
|
|
86
|
+
* // },
|
|
80
87
|
* // createdDate: Number("long"),
|
|
81
88
|
* // lastModifiedDate: Number("long"),
|
|
82
89
|
* // },
|
|
@@ -91,15 +98,16 @@ declare const CreateSecurityConfigCommand_base: {
|
|
|
91
98
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
92
99
|
*
|
|
93
100
|
* @throws {@link ConflictException} (client fault)
|
|
94
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
95
|
-
*
|
|
96
|
-
*
|
|
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>
|
|
97
104
|
*
|
|
98
105
|
* @throws {@link InternalServerException} (server fault)
|
|
99
106
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
100
107
|
*
|
|
101
108
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
102
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
109
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
110
|
+
* service quotas.</p>
|
|
103
111
|
*
|
|
104
112
|
* @throws {@link ValidationException} (client fault)
|
|
105
113
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -30,9 +30,9 @@ declare const CreateSecurityPolicyCommand_base: {
|
|
|
30
30
|
* <p>Creates a security policy to be used by one or more OpenSearch Serverless collections. Security
|
|
31
31
|
* policies provide access to a collection and its OpenSearch Dashboards endpoint from
|
|
32
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
|
-
* for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption
|
|
35
|
-
* rest for Amazon OpenSearch Serverless</a>.</p>
|
|
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>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
38
|
* ```javascript
|
|
@@ -69,15 +69,16 @@ declare const CreateSecurityPolicyCommand_base: {
|
|
|
69
69
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ConflictException} (client fault)
|
|
72
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
73
|
-
*
|
|
74
|
-
*
|
|
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>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link InternalServerException} (server fault)
|
|
77
77
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
80
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
80
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
81
|
+
* service quotas.</p>
|
|
81
82
|
*
|
|
82
83
|
* @throws {@link ValidationException} (client fault)
|
|
83
84
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -65,15 +65,16 @@ declare const CreateVpcEndpointCommand_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
|
|
69
|
-
*
|
|
70
|
-
*
|
|
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>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link InternalServerException} (server fault)
|
|
73
73
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
76
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
76
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
77
|
+
* service quotas.</p>
|
|
77
78
|
*
|
|
78
79
|
* @throws {@link ValidationException} (client fault)
|
|
79
80
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -53,9 +53,9 @@ declare const DeleteAccessPolicyCommand_base: {
|
|
|
53
53
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link ConflictException} (client fault)
|
|
56
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
57
|
-
*
|
|
58
|
-
*
|
|
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>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link InternalServerException} (server fault)
|
|
61
61
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -58,9 +58,9 @@ declare const DeleteCollectionCommand_base: {
|
|
|
58
58
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConflictException} (client fault)
|
|
61
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
62
|
-
*
|
|
63
|
-
*
|
|
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>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link InternalServerException} (server fault)
|
|
66
66
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -52,9 +52,9 @@ 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
|
|
56
|
-
*
|
|
57
|
-
*
|
|
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>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link InternalServerException} (server fault)
|
|
60
60
|
* <p>Thrown when an error internal to the service occurs while processing a request.</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
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
|
|
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
|
|
32
31
|
* authentication for Amazon OpenSearch Serverless</a>.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,9 +52,9 @@ declare const DeleteSecurityConfigCommand_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
|
|
57
|
-
*
|
|
58
|
-
*
|
|
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>
|
|
59
58
|
*
|
|
60
59
|
* @throws {@link InternalServerException} (server fault)
|
|
61
60
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -52,9 +52,9 @@ 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
|
|
56
|
-
*
|
|
57
|
-
*
|
|
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>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link InternalServerException} (server fault)
|
|
60
60
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -27,8 +27,8 @@ 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
|
|
31
|
-
*
|
|
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>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -58,9 +58,9 @@ declare const DeleteVpcEndpointCommand_base: {
|
|
|
58
58
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConflictException} (client fault)
|
|
61
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
62
|
-
*
|
|
63
|
-
*
|
|
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>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link InternalServerException} (server fault)
|
|
66
66
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -28,7 +28,7 @@ declare const GetAccessPolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
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
|
-
*
|
|
31
|
+
* access control for Amazon OpenSearch Serverless</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -62,6 +62,10 @@ declare const GetSecurityConfigCommand_base: {
|
|
|
62
62
|
* // userAttribute: "STRING_VALUE",
|
|
63
63
|
* // groupAttribute: "STRING_VALUE",
|
|
64
64
|
* // },
|
|
65
|
+
* // iamFederationOptions: { // IamFederationConfigOptions
|
|
66
|
+
* // groupAttribute: "STRING_VALUE",
|
|
67
|
+
* // userAttribute: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
65
69
|
* // createdDate: Number("long"),
|
|
66
70
|
* // lastModifiedDate: Number("long"),
|
|
67
71
|
* // },
|
|
@@ -27,9 +27,10 @@ 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
|
-
*
|
|
32
|
-
*
|
|
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>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ 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
|
-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
|
|
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
32
|
* authentication for Amazon OpenSearch Serverless</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,7 +27,8 @@ 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
|
|
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>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -28,8 +28,8 @@ declare const ListVpcEndpointsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current
|
|
31
|
-
* account. For more information, see
|
|
32
|
-
*
|
|
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>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ 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
|
|
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>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -56,9 +57,9 @@ declare const TagResourceCommand_base: {
|
|
|
56
57
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
57
58
|
*
|
|
58
59
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
60
|
-
*
|
|
61
|
-
*
|
|
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>
|
|
62
63
|
*
|
|
63
64
|
* @throws {@link InternalServerException} (server fault)
|
|
64
65
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -67,7 +68,8 @@ declare const TagResourceCommand_base: {
|
|
|
67
68
|
* <p>Thrown when accessing or deleting a resource that does not exist.</p>
|
|
68
69
|
*
|
|
69
70
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
70
|
-
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
71
|
+
* <p>Thrown when you attempt to create more resources than the service allows based on
|
|
72
|
+
* service quotas.</p>
|
|
71
73
|
*
|
|
72
74
|
* @throws {@link ValidationException} (client fault)
|
|
73
75
|
* <p>Thrown when the HTTP request contains invalid input or is missing required
|
|
@@ -27,7 +27,8 @@ 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
|
|
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>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -53,9 +54,9 @@ declare const UntagResourceCommand_base: {
|
|
|
53
54
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
54
55
|
*
|
|
55
56
|
* @throws {@link ConflictException} (client fault)
|
|
56
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
57
|
-
*
|
|
58
|
-
*
|
|
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>
|
|
59
60
|
*
|
|
60
61
|
* @throws {@link InternalServerException} (server fault)
|
|
61
62
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -28,7 +28,7 @@ declare const UpdateAccessPolicyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
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
|
-
*
|
|
31
|
+
* access control for Amazon OpenSearch Serverless</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -66,9 +66,9 @@ declare const UpdateAccessPolicyCommand_base: {
|
|
|
66
66
|
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ConflictException} (client fault)
|
|
69
|
-
* <p>When creating a resource, thrown when a resource with the same name already exists
|
|
70
|
-
*
|
|
71
|
-
*
|
|
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>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link InternalServerException} (server fault)
|
|
74
74
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|
|
@@ -28,7 +28,8 @@ declare const UpdateAccountSettingsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
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
|
|
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>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -63,9 +63,9 @@ 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
|
|
67
|
-
*
|
|
68
|
-
*
|
|
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>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link InternalServerException} (server fault)
|
|
71
71
|
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
|