Skip to content

Commit a440fc3

Browse files
author
awstools
committed
feat(client-opensearchserverless): This is to support Granular access control support for SAML with IAMFedraton in AOSS
1 parent a590885 commit a440fc3

37 files changed

+426
-234
lines changed

‎clients/client-opensearchserverless/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Amazon OpenSearch Service. OpenSearch Serverless removes the operational complex
1313
configuring, and tuning your OpenSearch clusters. It enables you to easily search and
1414
analyze petabytes of data without having to worry about the underlying infrastructure
1515
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
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
1717
Amazon OpenSearch Serverless?</a>
1818
</p>
1919

‎clients/client-opensearchserverless/src/OpenSearchServerless.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -852,7 +852,7 @@ export interface OpenSearchServerless {
852852
* configuring, and tuning your OpenSearch clusters. It enables you to easily search and
853853
* analyze petabytes of data without having to worry about the underlying infrastructure
854854
* and data management.</p>
855-
* <p> To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
855+
* <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
856856
* Amazon OpenSearch Serverless?</a>
857857
* </p>
858858
* @public

‎clients/client-opensearchserverless/src/OpenSearchServerlessClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ export interface OpenSearchServerlessClientResolvedConfig extends OpenSearchServ
434434
* configuring, and tuning your OpenSearch clusters. It enables you to easily search and
435435
* analyze petabytes of data without having to worry about the underlying infrastructure
436436
* and data management.</p>
437-
* <p> To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
437+
* <p>To learn more about OpenSearch Serverless, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html">What is
438438
* Amazon OpenSearch Serverless?</a>
439439
* </p>
440440
* @public

‎clients/client-opensearchserverless/src/commands/BatchGetEffectiveLifecyclePolicyCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ export interface BatchGetEffectiveLifecyclePolicyCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <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>
40+
* <p>Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more
41+
* 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>
4142
* @example
4243
* Use a bare-bones client and the command you need to make an API call.
4344
* ```javascript

‎clients/client-opensearchserverless/src/commands/BatchGetLifecyclePolicyCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface BatchGetLifecyclePolicyCommandInput extends BatchGetLifecyclePo
3232
export interface BatchGetLifecyclePolicyCommandOutput extends BatchGetLifecyclePolicyResponse, __MetadataBearer {}
3333

3434
/**
35-
* <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>
35+
* <p>Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see
36+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-list">Viewing data lifecycle policies</a>.</p>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

‎clients/client-opensearchserverless/src/commands/BatchGetVpcEndpointCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface BatchGetVpcEndpointCommandOutput extends BatchGetVpcEndpointRes
3333

3434
/**
3535
* <p>Returns attributes for one or more VPC endpoints associated with the current account.
36-
* For more information, see
37-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
36+
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html">Access
37+
* Amazon OpenSearch Serverless using an interface endpoint</a>.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

‎clients/client-opensearchserverless/src/commands/CreateAccessPolicyCommand.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
3434
/**
3535
* <p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections
3636
* and the resources within them, and allow a user to access that data irrespective of the
37-
* 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
38-
* control for Amazon OpenSearch Serverless</a>.</p>
37+
* 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
38+
* access control for Amazon OpenSearch Serverless</a>.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.
4141
* ```javascript
@@ -72,15 +72,16 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
7272
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
7373
*
7474
* @throws {@link ConflictException} (client fault)
75-
* <p>When creating a resource, thrown when a resource with the same name already exists
76-
* or is being created. When deleting a resource, thrown when the resource is not in
77-
* the ACTIVE or FAILED state.</p>
75+
* <p>When creating a resource, thrown when a resource with the same name already exists or
76+
* is being created. When deleting a resource, thrown when the resource is not in the
77+
* ACTIVE or FAILED state.</p>
7878
*
7979
* @throws {@link InternalServerException} (server fault)
8080
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
8181
*
8282
* @throws {@link ServiceQuotaExceededException} (client fault)
83-
* <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
83+
* <p>Thrown when you attempt to create more resources than the service allows based on
84+
* service quotas.</p>
8485
*
8586
* @throws {@link ValidationException} (client fault)
8687
* <p>Thrown when the HTTP request contains invalid input or is missing required

‎clients/client-opensearchserverless/src/commands/CreateCollectionCommand.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,18 +79,20 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
7979
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
8080
*
8181
* @throws {@link ConflictException} (client fault)
82-
* <p>When creating a resource, thrown when a resource with the same name already exists
83-
* or is being created. When deleting a resource, thrown when the resource is not in
84-
* the ACTIVE or FAILED state.</p>
82+
* <p>When creating a resource, thrown when a resource with the same name already exists or
83+
* is being created. When deleting a resource, thrown when the resource is not in the
84+
* ACTIVE or FAILED state.</p>
8585
*
8686
* @throws {@link InternalServerException} (server fault)
8787
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
8888
*
8989
* @throws {@link OcuLimitExceededException} (client fault)
90-
* <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>
90+
* <p>Thrown when the collection you're attempting to create results in a number of search
91+
* or indexing OCUs that exceeds the account limit.</p>
9192
*
9293
* @throws {@link ServiceQuotaExceededException} (client fault)
93-
* <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
94+
* <p>Thrown when you attempt to create more resources than the service allows based on
95+
* service quotas.</p>
9496
*
9597
* @throws {@link ValidationException} (client fault)
9698
* <p>Thrown when the HTTP request contains invalid input or is missing required

‎clients/client-opensearchserverless/src/commands/CreateLifecyclePolicyCommand.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface CreateLifecyclePolicyCommandOutput extends CreateLifecyclePolic
3333

3434
/**
3535
* <p>Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define
36-
* 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>
36+
* the number of days or hours to retain the data on an OpenSearch Serverless index. For more information,
37+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create">Creating data lifecycle policies</a>.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript
@@ -70,15 +71,16 @@ export interface CreateLifecyclePolicyCommandOutput extends CreateLifecyclePolic
7071
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
7172
*
7273
* @throws {@link ConflictException} (client fault)
73-
* <p>When creating a resource, thrown when a resource with the same name already exists
74-
* or is being created. When deleting a resource, thrown when the resource is not in
75-
* the ACTIVE or FAILED state.</p>
74+
* <p>When creating a resource, thrown when a resource with the same name already exists or
75+
* is being created. When deleting a resource, thrown when the resource is not in the
76+
* ACTIVE or FAILED state.</p>
7677
*
7778
* @throws {@link InternalServerException} (server fault)
7879
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
7980
*
8081
* @throws {@link ServiceQuotaExceededException} (client fault)
81-
* <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
82+
* <p>Thrown when you attempt to create more resources than the service allows based on
83+
* service quotas.</p>
8284
*
8385
* @throws {@link ValidationException} (client fault)
8486
* <p>Thrown when the HTTP request contains invalid input or is missing required

‎clients/client-opensearchserverless/src/commands/CreateSecurityConfigCommand.ts

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ export interface CreateSecurityConfigCommandInput extends CreateSecurityConfigRe
3232
export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Specifies a security configuration for OpenSearch Serverless. For more information, see
36-
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML
37-
* authentication for Amazon OpenSearch Serverless</a>. </p>
35+
* <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
36+
* authentication for Amazon OpenSearch Serverless</a>.</p>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript
@@ -57,6 +56,10 @@ export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigR
5756
* userAttribute: "STRING_VALUE",
5857
* groupAttribute: "STRING_VALUE",
5958
* },
59+
* iamFederationOptions: { // IamFederationConfigOptions
60+
* groupAttribute: "STRING_VALUE",
61+
* userAttribute: "STRING_VALUE",
62+
* },
6063
* clientToken: "STRING_VALUE",
6164
* };
6265
* const command = new CreateSecurityConfigCommand(input);
@@ -82,6 +85,10 @@ export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigR
8285
* // userAttribute: "STRING_VALUE",
8386
* // groupAttribute: "STRING_VALUE",
8487
* // },
88+
* // iamFederationOptions: { // IamFederationConfigOptions
89+
* // groupAttribute: "STRING_VALUE",
90+
* // userAttribute: "STRING_VALUE",
91+
* // },
8592
* // createdDate: Number("long"),
8693
* // lastModifiedDate: Number("long"),
8794
* // },
@@ -96,15 +103,16 @@ export interface CreateSecurityConfigCommandOutput extends CreateSecurityConfigR
96103
* @see {@link OpenSearchServerlessClientResolvedConfig | config} for OpenSearchServerlessClient's `config` shape.
97104
*
98105
* @throws {@link ConflictException} (client fault)
99-
* <p>When creating a resource, thrown when a resource with the same name already exists
100-
* or is being created. When deleting a resource, thrown when the resource is not in
101-
* the ACTIVE or FAILED state.</p>
106+
* <p>When creating a resource, thrown when a resource with the same name already exists or
107+
* is being created. When deleting a resource, thrown when the resource is not in the
108+
* ACTIVE or FAILED state.</p>
102109
*
103110
* @throws {@link InternalServerException} (server fault)
104111
* <p>Thrown when an error internal to the service occurs while processing a request.</p>
105112
*
106113
* @throws {@link ServiceQuotaExceededException} (client fault)
107-
* <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>
114+
* <p>Thrown when you attempt to create more resources than the service allows based on
115+
* service quotas.</p>
108116
*
109117
* @throws {@link ValidationException} (client fault)
110118
* <p>Thrown when the HTTP request contains invalid input or is missing required

0 commit comments

Comments
 (0)