@aws-sdk/client-opensearchserverless 3.679.0 → 3.683.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 CHANGED
@@ -19,7 +19,7 @@ Amazon OpenSearch Serverless?</a>
19
19
 
20
20
  ## Installing
21
21
 
22
- To install the this package, simply type add or install @aws-sdk/client-opensearchserverless
22
+ To install this package, simply type add or install @aws-sdk/client-opensearchserverless
23
23
  using your favorite package manager:
24
24
 
25
25
  - `npm install @aws-sdk/client-opensearchserverless`
package/dist-cjs/index.js CHANGED
@@ -46,6 +46,8 @@ __export(src_exports, {
46
46
  GetPoliciesStatsCommand: () => GetPoliciesStatsCommand,
47
47
  GetSecurityConfigCommand: () => GetSecurityConfigCommand,
48
48
  GetSecurityPolicyCommand: () => GetSecurityPolicyCommand,
49
+ IamIdentityCenterGroupAttribute: () => IamIdentityCenterGroupAttribute,
50
+ IamIdentityCenterUserAttribute: () => IamIdentityCenterUserAttribute,
49
51
  InternalServerException: () => InternalServerException,
50
52
  LifecyclePolicyType: () => LifecyclePolicyType,
51
53
  ListAccessPoliciesCommand: () => ListAccessPoliciesCommand,
@@ -436,7 +438,35 @@ var _OcuLimitExceededException = class _OcuLimitExceededException extends OpenSe
436
438
  };
437
439
  __name(_OcuLimitExceededException, "OcuLimitExceededException");
438
440
  var OcuLimitExceededException = _OcuLimitExceededException;
441
+ var IamIdentityCenterGroupAttribute = {
442
+ /**
443
+ * Group ID
444
+ */
445
+ GroupId: "GroupId",
446
+ /**
447
+ * Group Name
448
+ */
449
+ GroupName: "GroupName"
450
+ };
451
+ var IamIdentityCenterUserAttribute = {
452
+ /**
453
+ * Email
454
+ */
455
+ Email: "Email",
456
+ /**
457
+ * User ID
458
+ */
459
+ UserId: "UserId",
460
+ /**
461
+ * User Name
462
+ */
463
+ UserName: "UserName"
464
+ };
439
465
  var SecurityConfigType = {
466
+ /**
467
+ * iam identity center
468
+ */
469
+ iamidentitycenter: "iamidentitycenter",
440
470
  /**
441
471
  * saml provider
442
472
  */
@@ -1277,6 +1307,7 @@ var se_CreateSecurityConfigRequest = /* @__PURE__ */ __name((input, context) =>
1277
1307
  return (0, import_smithy_client.take)(input, {
1278
1308
  clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
1279
1309
  description: [],
1310
+ iamIdentityCenterOptions: import_smithy_client._json,
1280
1311
  name: [],
1281
1312
  samlOptions: import_smithy_client._json,
1282
1313
  type: []
@@ -1371,6 +1402,7 @@ var se_UpdateSecurityConfigRequest = /* @__PURE__ */ __name((input, context) =>
1371
1402
  clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
1372
1403
  configVersion: [],
1373
1404
  description: [],
1405
+ iamIdentityCenterOptionsUpdates: import_smithy_client._json,
1374
1406
  id: [],
1375
1407
  samlOptions: import_smithy_client._json
1376
1408
  });
@@ -2164,6 +2196,8 @@ var paginateListVpcEndpoints = (0, import_core.createPaginator)(OpenSearchServer
2164
2196
  ResourceType,
2165
2197
  VpcEndpointStatus,
2166
2198
  OcuLimitExceededException,
2199
+ IamIdentityCenterGroupAttribute,
2200
+ IamIdentityCenterUserAttribute,
2167
2201
  SecurityConfigType,
2168
2202
  SecurityPolicyType
2169
2203
  });
@@ -105,7 +105,17 @@ export class OcuLimitExceededException extends __BaseException {
105
105
  Object.setPrototypeOf(this, OcuLimitExceededException.prototype);
106
106
  }
107
107
  }
108
+ export const IamIdentityCenterGroupAttribute = {
109
+ GroupId: "GroupId",
110
+ GroupName: "GroupName",
111
+ };
112
+ export const IamIdentityCenterUserAttribute = {
113
+ Email: "Email",
114
+ UserId: "UserId",
115
+ UserName: "UserName",
116
+ };
108
117
  export const SecurityConfigType = {
118
+ iamidentitycenter: "iamidentitycenter",
109
119
  saml: "saml",
110
120
  };
111
121
  export const SecurityPolicyType = {
@@ -827,6 +827,7 @@ const se_CreateSecurityConfigRequest = (input, context) => {
827
827
  return take(input, {
828
828
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
829
829
  description: [],
830
+ iamIdentityCenterOptions: _json,
830
831
  name: [],
831
832
  samlOptions: _json,
832
833
  type: [],
@@ -921,6 +922,7 @@ const se_UpdateSecurityConfigRequest = (input, context) => {
921
922
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
922
923
  configVersion: [],
923
924
  description: [],
925
+ iamIdentityCenterOptionsUpdates: _json,
924
926
  id: [],
925
927
  samlOptions: _json,
926
928
  });
@@ -46,6 +46,11 @@ declare const CreateSecurityConfigCommand_base: {
46
46
  * groupAttribute: "STRING_VALUE",
47
47
  * sessionTimeout: Number("int"),
48
48
  * },
49
+ * iamIdentityCenterOptions: { // CreateIamIdentityCenterConfigOptions
50
+ * instanceArn: "STRING_VALUE", // required
51
+ * userAttribute: "STRING_VALUE",
52
+ * groupAttribute: "STRING_VALUE",
53
+ * },
49
54
  * clientToken: "STRING_VALUE",
50
55
  * };
51
56
  * const command = new CreateSecurityConfigCommand(input);
@@ -62,6 +67,14 @@ declare const CreateSecurityConfigCommand_base: {
62
67
  * // groupAttribute: "STRING_VALUE",
63
68
  * // sessionTimeout: Number("int"),
64
69
  * // },
70
+ * // iamIdentityCenterOptions: { // IamIdentityCenterConfigOptions
71
+ * // instanceArn: "STRING_VALUE",
72
+ * // applicationArn: "STRING_VALUE",
73
+ * // applicationName: "STRING_VALUE",
74
+ * // applicationDescription: "STRING_VALUE",
75
+ * // userAttribute: "STRING_VALUE",
76
+ * // groupAttribute: "STRING_VALUE",
77
+ * // },
65
78
  * // createdDate: Number("long"),
66
79
  * // lastModifiedDate: Number("long"),
67
80
  * // },
@@ -53,6 +53,14 @@ declare const GetSecurityConfigCommand_base: {
53
53
  * // groupAttribute: "STRING_VALUE",
54
54
  * // sessionTimeout: Number("int"),
55
55
  * // },
56
+ * // iamIdentityCenterOptions: { // IamIdentityCenterConfigOptions
57
+ * // instanceArn: "STRING_VALUE",
58
+ * // applicationArn: "STRING_VALUE",
59
+ * // applicationName: "STRING_VALUE",
60
+ * // applicationDescription: "STRING_VALUE",
61
+ * // userAttribute: "STRING_VALUE",
62
+ * // groupAttribute: "STRING_VALUE",
63
+ * // },
56
64
  * // createdDate: Number("long"),
57
65
  * // lastModifiedDate: Number("long"),
58
66
  * // },
@@ -46,6 +46,10 @@ declare const UpdateSecurityConfigCommand_base: {
46
46
  * groupAttribute: "STRING_VALUE",
47
47
  * sessionTimeout: Number("int"),
48
48
  * },
49
+ * iamIdentityCenterOptionsUpdates: { // UpdateIamIdentityCenterConfigOptions
50
+ * userAttribute: "STRING_VALUE",
51
+ * groupAttribute: "STRING_VALUE",
52
+ * },
49
53
  * clientToken: "STRING_VALUE",
50
54
  * };
51
55
  * const command = new UpdateSecurityConfigCommand(input);
@@ -62,6 +66,14 @@ declare const UpdateSecurityConfigCommand_base: {
62
66
  * // groupAttribute: "STRING_VALUE",
63
67
  * // sessionTimeout: Number("int"),
64
68
  * // },
69
+ * // iamIdentityCenterOptions: { // IamIdentityCenterConfigOptions
70
+ * // instanceArn: "STRING_VALUE",
71
+ * // applicationArn: "STRING_VALUE",
72
+ * // applicationName: "STRING_VALUE",
73
+ * // applicationDescription: "STRING_VALUE",
74
+ * // userAttribute: "STRING_VALUE",
75
+ * // groupAttribute: "STRING_VALUE",
76
+ * // },
65
77
  * // createdDate: Number("long"),
66
78
  * // lastModifiedDate: Number("long"),
67
79
  * // },
@@ -1306,6 +1306,67 @@ export interface UpdateCollectionResponse {
1306
1306
  */
1307
1307
  updateCollectionDetail?: UpdateCollectionDetail;
1308
1308
  }
1309
+ /**
1310
+ * @public
1311
+ * @enum
1312
+ */
1313
+ export declare const IamIdentityCenterGroupAttribute: {
1314
+ /**
1315
+ * Group ID
1316
+ */
1317
+ readonly GroupId: "GroupId";
1318
+ /**
1319
+ * Group Name
1320
+ */
1321
+ readonly GroupName: "GroupName";
1322
+ };
1323
+ /**
1324
+ * @public
1325
+ */
1326
+ export type IamIdentityCenterGroupAttribute = (typeof IamIdentityCenterGroupAttribute)[keyof typeof IamIdentityCenterGroupAttribute];
1327
+ /**
1328
+ * @public
1329
+ * @enum
1330
+ */
1331
+ export declare const IamIdentityCenterUserAttribute: {
1332
+ /**
1333
+ * Email
1334
+ */
1335
+ readonly Email: "Email";
1336
+ /**
1337
+ * User ID
1338
+ */
1339
+ readonly UserId: "UserId";
1340
+ /**
1341
+ * User Name
1342
+ */
1343
+ readonly UserName: "UserName";
1344
+ };
1345
+ /**
1346
+ * @public
1347
+ */
1348
+ export type IamIdentityCenterUserAttribute = (typeof IamIdentityCenterUserAttribute)[keyof typeof IamIdentityCenterUserAttribute];
1349
+ /**
1350
+ * <p>Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.</p>
1351
+ * @public
1352
+ */
1353
+ export interface CreateIamIdentityCenterConfigOptions {
1354
+ /**
1355
+ * <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>
1356
+ * @public
1357
+ */
1358
+ instanceArn: string | undefined;
1359
+ /**
1360
+ * <p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>.</p>
1361
+ * @public
1362
+ */
1363
+ userAttribute?: IamIdentityCenterUserAttribute;
1364
+ /**
1365
+ * <p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>
1366
+ * @public
1367
+ */
1368
+ groupAttribute?: IamIdentityCenterGroupAttribute;
1369
+ }
1309
1370
  /**
1310
1371
  * @public
1311
1372
  */
@@ -1378,6 +1439,10 @@ export interface SamlConfigOptions {
1378
1439
  * @enum
1379
1440
  */
1380
1441
  export declare const SecurityConfigType: {
1442
+ /**
1443
+ * iam identity center
1444
+ */
1445
+ readonly iamidentitycenter: "iamidentitycenter";
1381
1446
  /**
1382
1447
  * saml provider
1383
1448
  */
@@ -1412,12 +1477,54 @@ export interface CreateSecurityConfigRequest {
1412
1477
  * @public
1413
1478
  */
1414
1479
  samlOptions?: SamlConfigOptions;
1480
+ /**
1481
+ * <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.</p>
1482
+ * @public
1483
+ */
1484
+ iamIdentityCenterOptions?: CreateIamIdentityCenterConfigOptions;
1415
1485
  /**
1416
1486
  * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
1417
1487
  * @public
1418
1488
  */
1419
1489
  clientToken?: string;
1420
1490
  }
1491
+ /**
1492
+ * <p>Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.</p>
1493
+ * @public
1494
+ */
1495
+ export interface IamIdentityCenterConfigOptions {
1496
+ /**
1497
+ * <p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>
1498
+ * @public
1499
+ */
1500
+ instanceArn?: string;
1501
+ /**
1502
+ * <p>The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>
1503
+ * @public
1504
+ */
1505
+ applicationArn?: string;
1506
+ /**
1507
+ * <p>The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>
1508
+ * @public
1509
+ */
1510
+ applicationName?: string;
1511
+ /**
1512
+ * <p>The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>
1513
+ * @public
1514
+ */
1515
+ applicationDescription?: string;
1516
+ /**
1517
+ * <p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>
1518
+ * </p>
1519
+ * @public
1520
+ */
1521
+ userAttribute?: IamIdentityCenterUserAttribute;
1522
+ /**
1523
+ * <p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>
1524
+ * @public
1525
+ */
1526
+ groupAttribute?: IamIdentityCenterGroupAttribute;
1527
+ }
1421
1528
  /**
1422
1529
  * <p>Details about a security configuration for OpenSearch Serverless. </p>
1423
1530
  * @public
@@ -1448,6 +1555,11 @@ export interface SecurityConfigDetail {
1448
1555
  * @public
1449
1556
  */
1450
1557
  samlOptions?: SamlConfigOptions;
1558
+ /**
1559
+ * <p>Describes IAM Identity Center options in the form of a key-value map.</p>
1560
+ * @public
1561
+ */
1562
+ iamIdentityCenterOptions?: IamIdentityCenterConfigOptions;
1451
1563
  /**
1452
1564
  * <p>The date the configuration was created.</p>
1453
1565
  * @public
@@ -2261,6 +2373,22 @@ export interface ListVpcEndpointsResponse {
2261
2373
  */
2262
2374
  nextToken?: string;
2263
2375
  }
2376
+ /**
2377
+ * <p>Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.</p>
2378
+ * @public
2379
+ */
2380
+ export interface UpdateIamIdentityCenterConfigOptions {
2381
+ /**
2382
+ * <p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>.</p>
2383
+ * @public
2384
+ */
2385
+ userAttribute?: IamIdentityCenterUserAttribute;
2386
+ /**
2387
+ * <p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>
2388
+ * @public
2389
+ */
2390
+ groupAttribute?: IamIdentityCenterGroupAttribute;
2391
+ }
2264
2392
  /**
2265
2393
  * @public
2266
2394
  */
@@ -2289,6 +2417,11 @@ export interface UpdateSecurityConfigRequest {
2289
2417
  * @public
2290
2418
  */
2291
2419
  samlOptions?: SamlConfigOptions;
2420
+ /**
2421
+ * <p>Describes IAM Identity Center options in the form of a key-value map.</p>
2422
+ * @public
2423
+ */
2424
+ iamIdentityCenterOptionsUpdates?: UpdateIamIdentityCenterConfigOptions;
2292
2425
  /**
2293
2426
  * <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
2294
2427
  * @public
@@ -339,6 +339,24 @@ export interface UpdateCollectionDetail {
339
339
  export interface UpdateCollectionResponse {
340
340
  updateCollectionDetail?: UpdateCollectionDetail;
341
341
  }
342
+ export declare const IamIdentityCenterGroupAttribute: {
343
+ readonly GroupId: "GroupId";
344
+ readonly GroupName: "GroupName";
345
+ };
346
+ export type IamIdentityCenterGroupAttribute =
347
+ (typeof IamIdentityCenterGroupAttribute)[keyof typeof IamIdentityCenterGroupAttribute];
348
+ export declare const IamIdentityCenterUserAttribute: {
349
+ readonly Email: "Email";
350
+ readonly UserId: "UserId";
351
+ readonly UserName: "UserName";
352
+ };
353
+ export type IamIdentityCenterUserAttribute =
354
+ (typeof IamIdentityCenterUserAttribute)[keyof typeof IamIdentityCenterUserAttribute];
355
+ export interface CreateIamIdentityCenterConfigOptions {
356
+ instanceArn: string | undefined;
357
+ userAttribute?: IamIdentityCenterUserAttribute;
358
+ groupAttribute?: IamIdentityCenterGroupAttribute;
359
+ }
342
360
  export interface CreateLifecyclePolicyRequest {
343
361
  type: LifecyclePolicyType | undefined;
344
362
  name: string | undefined;
@@ -356,6 +374,7 @@ export interface SamlConfigOptions {
356
374
  sessionTimeout?: number;
357
375
  }
358
376
  export declare const SecurityConfigType: {
377
+ readonly iamidentitycenter: "iamidentitycenter";
359
378
  readonly saml: "saml";
360
379
  };
361
380
  export type SecurityConfigType =
@@ -365,14 +384,24 @@ export interface CreateSecurityConfigRequest {
365
384
  name: string | undefined;
366
385
  description?: string;
367
386
  samlOptions?: SamlConfigOptions;
387
+ iamIdentityCenterOptions?: CreateIamIdentityCenterConfigOptions;
368
388
  clientToken?: string;
369
389
  }
390
+ export interface IamIdentityCenterConfigOptions {
391
+ instanceArn?: string;
392
+ applicationArn?: string;
393
+ applicationName?: string;
394
+ applicationDescription?: string;
395
+ userAttribute?: IamIdentityCenterUserAttribute;
396
+ groupAttribute?: IamIdentityCenterGroupAttribute;
397
+ }
370
398
  export interface SecurityConfigDetail {
371
399
  id?: string;
372
400
  type?: SecurityConfigType;
373
401
  configVersion?: string;
374
402
  description?: string;
375
403
  samlOptions?: SamlConfigOptions;
404
+ iamIdentityCenterOptions?: IamIdentityCenterConfigOptions;
376
405
  createdDate?: number;
377
406
  lastModifiedDate?: number;
378
407
  }
@@ -570,11 +599,16 @@ export interface ListVpcEndpointsResponse {
570
599
  vpcEndpointSummaries?: VpcEndpointSummary[];
571
600
  nextToken?: string;
572
601
  }
602
+ export interface UpdateIamIdentityCenterConfigOptions {
603
+ userAttribute?: IamIdentityCenterUserAttribute;
604
+ groupAttribute?: IamIdentityCenterGroupAttribute;
605
+ }
573
606
  export interface UpdateSecurityConfigRequest {
574
607
  id: string | undefined;
575
608
  configVersion: string | undefined;
576
609
  description?: string;
577
610
  samlOptions?: SamlConfigOptions;
611
+ iamIdentityCenterOptionsUpdates?: UpdateIamIdentityCenterConfigOptions;
578
612
  clientToken?: string;
579
613
  }
580
614
  export interface UpdateSecurityConfigResponse {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-opensearchserverless",
3
3
  "description": "AWS SDK for JavaScript Opensearchserverless Client for Node.js, Browser and React Native",
4
- "version": "3.679.0",
4
+ "version": "3.683.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-opensearchserverless",
@@ -20,19 +20,19 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.679.0",
24
- "@aws-sdk/client-sts": "3.679.0",
23
+ "@aws-sdk/client-sso-oidc": "3.682.0",
24
+ "@aws-sdk/client-sts": "3.682.0",
25
25
  "@aws-sdk/core": "3.679.0",
26
- "@aws-sdk/credential-provider-node": "3.679.0",
26
+ "@aws-sdk/credential-provider-node": "3.682.0",
27
27
  "@aws-sdk/middleware-host-header": "3.679.0",
28
28
  "@aws-sdk/middleware-logger": "3.679.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.679.0",
30
- "@aws-sdk/middleware-user-agent": "3.679.0",
30
+ "@aws-sdk/middleware-user-agent": "3.682.0",
31
31
  "@aws-sdk/region-config-resolver": "3.679.0",
32
32
  "@aws-sdk/types": "3.679.0",
33
33
  "@aws-sdk/util-endpoints": "3.679.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.679.0",
35
- "@aws-sdk/util-user-agent-node": "3.679.0",
35
+ "@aws-sdk/util-user-agent-node": "3.682.0",
36
36
  "@smithy/config-resolver": "^3.0.9",
37
37
  "@smithy/core": "^2.4.8",
38
38
  "@smithy/fetch-http-handler": "^3.2.9",