@aws-sdk/client-opensearch 3.682.0 → 3.686.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 (69) hide show
  1. package/README.md +47 -7
  2. package/dist-cjs/index.js +344 -29
  3. package/dist-es/OpenSearch.js +10 -0
  4. package/dist-es/commands/CreateApplicationCommand.js +22 -0
  5. package/dist-es/commands/DeleteApplicationCommand.js +22 -0
  6. package/dist-es/commands/GetApplicationCommand.js +22 -0
  7. package/dist-es/commands/ListApplicationsCommand.js +22 -0
  8. package/dist-es/commands/UpdateApplicationCommand.js +22 -0
  9. package/dist-es/commands/UpdateDomainConfigCommand.js +1 -1
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/models_0.js +23 -28
  12. package/dist-es/models/models_1.js +30 -1
  13. package/dist-es/pagination/ListApplicationsPaginator.js +4 -0
  14. package/dist-es/pagination/index.js +1 -0
  15. package/dist-es/protocols/Aws_restJson1.js +191 -3
  16. package/dist-types/OpenSearch.d.ts +36 -0
  17. package/dist-types/OpenSearchClient.d.ts +7 -2
  18. package/dist-types/commands/AuthorizeVpcEndpointAccessCommand.d.ts +2 -1
  19. package/dist-types/commands/CreateApplicationCommand.d.ts +140 -0
  20. package/dist-types/commands/CreateDomainCommand.d.ts +14 -0
  21. package/dist-types/commands/DeleteApplicationCommand.d.ts +90 -0
  22. package/dist-types/commands/DeleteDomainCommand.d.ts +8 -0
  23. package/dist-types/commands/DescribeDomainCommand.d.ts +8 -0
  24. package/dist-types/commands/DescribeDomainConfigCommand.d.ts +11 -0
  25. package/dist-types/commands/DescribeDomainsCommand.d.ts +8 -0
  26. package/dist-types/commands/DescribeDryRunProgressCommand.d.ts +8 -0
  27. package/dist-types/commands/GetApplicationCommand.d.ts +113 -0
  28. package/dist-types/commands/ListApplicationsCommand.d.ts +104 -0
  29. package/dist-types/commands/RejectInboundConnectionCommand.d.ts +2 -1
  30. package/dist-types/commands/RemoveTagsCommand.d.ts +1 -1
  31. package/dist-types/commands/RevokeVpcEndpointAccessCommand.d.ts +3 -2
  32. package/dist-types/commands/StartDomainMaintenanceCommand.d.ts +1 -1
  33. package/dist-types/commands/StartServiceSoftwareUpdateCommand.d.ts +1 -1
  34. package/dist-types/commands/UpdateApplicationCommand.d.ts +126 -0
  35. package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateDomainConfigCommand.d.ts +18 -1
  37. package/dist-types/commands/UpdatePackageCommand.d.ts +1 -1
  38. package/dist-types/commands/UpdateScheduledActionCommand.d.ts +1 -1
  39. package/dist-types/commands/UpdateVpcEndpointCommand.d.ts +1 -1
  40. package/dist-types/commands/index.d.ts +5 -0
  41. package/dist-types/models/models_0.d.ts +538 -565
  42. package/dist-types/models/models_1.d.ts +603 -1
  43. package/dist-types/pagination/ListApplicationsPaginator.d.ts +7 -0
  44. package/dist-types/pagination/index.d.ts +1 -0
  45. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  46. package/dist-types/ts3.4/OpenSearch.d.ts +86 -0
  47. package/dist-types/ts3.4/OpenSearchClient.d.ts +30 -0
  48. package/dist-types/ts3.4/commands/CreateApplicationCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/DeleteApplicationCommand.d.ts +51 -0
  50. package/dist-types/ts3.4/commands/GetApplicationCommand.d.ts +50 -0
  51. package/dist-types/ts3.4/commands/ListApplicationsCommand.d.ts +50 -0
  52. package/dist-types/ts3.4/commands/RejectInboundConnectionCommand.d.ts +2 -4
  53. package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/RevokeVpcEndpointAccessCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/StartDomainMaintenanceCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/StartServiceSoftwareUpdateCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/UpdateApplicationCommand.d.ts +51 -0
  58. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/UpdateDomainConfigCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/UpdatePackageCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/UpdateScheduledActionCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/UpdateVpcEndpointCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  64. package/dist-types/ts3.4/models/models_0.d.ts +129 -114
  65. package/dist-types/ts3.4/models/models_1.d.ts +169 -1
  66. package/dist-types/ts3.4/pagination/ListApplicationsPaginator.d.ts +11 -0
  67. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  68. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  69. package/package.json +38 -36
@@ -1058,6 +1058,17 @@ export declare class ConflictException extends __BaseException {
1058
1058
  */
1059
1059
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
1060
1060
  }
1061
+ /**
1062
+ * @public
1063
+ * @enum
1064
+ */
1065
+ export declare const AWSServicePrincipal: {
1066
+ readonly application_opensearchservice_amazonaws_com: "application.opensearchservice.amazonaws.com";
1067
+ };
1068
+ /**
1069
+ * @public
1070
+ */
1071
+ export type AWSServicePrincipal = (typeof AWSServicePrincipal)[keyof typeof AWSServicePrincipal];
1061
1072
  /**
1062
1073
  * @public
1063
1074
  */
@@ -1071,7 +1082,12 @@ export interface AuthorizeVpcEndpointAccessRequest {
1071
1082
  * <p>The Amazon Web Services account ID to grant access to.</p>
1072
1083
  * @public
1073
1084
  */
1074
- Account: string | undefined;
1085
+ Account?: string;
1086
+ /**
1087
+ * <p>The Amazon Web Services service SP to grant access to.</p>
1088
+ * @public
1089
+ */
1090
+ Service?: AWSServicePrincipal;
1075
1091
  }
1076
1092
  /**
1077
1093
  * @public
@@ -1261,6 +1277,188 @@ export interface CancelServiceSoftwareUpdateResponse {
1261
1277
  */
1262
1278
  ServiceSoftwareOptions?: ServiceSoftwareOptions;
1263
1279
  }
1280
+ /**
1281
+ * @public
1282
+ * @enum
1283
+ */
1284
+ export declare const AppConfigType: {
1285
+ readonly OpensearchDashboardAdminGroups: "opensearchDashboards.dashboardAdmin.groups";
1286
+ readonly OpensearchDashboardAdminUsers: "opensearchDashboards.dashboardAdmin.users";
1287
+ };
1288
+ /**
1289
+ * @public
1290
+ */
1291
+ export type AppConfigType = (typeof AppConfigType)[keyof typeof AppConfigType];
1292
+ /**
1293
+ * <p>Configurations of the OpenSearch Application.</p>
1294
+ * @public
1295
+ */
1296
+ export interface AppConfig {
1297
+ /**
1298
+ * <p>Specify the item to configure, such as admin role for the OpenSearch Application.</p>
1299
+ * @public
1300
+ */
1301
+ key?: AppConfigType;
1302
+ /**
1303
+ * <p>Specifies the value to configure for the key, such as an IAM user ARN.</p>
1304
+ * @public
1305
+ */
1306
+ value?: string;
1307
+ }
1308
+ /**
1309
+ * <p>Data sources that are associated with an OpenSearch Application. </p>
1310
+ * @public
1311
+ */
1312
+ export interface DataSource {
1313
+ /**
1314
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
1315
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
1316
+ * </p>
1317
+ * @public
1318
+ */
1319
+ dataSourceArn?: string;
1320
+ /**
1321
+ * <p>Detailed description of a data source.</p>
1322
+ * @public
1323
+ */
1324
+ dataSourceDescription?: string;
1325
+ }
1326
+ /**
1327
+ * <p>Settings for IAM Identity Center.</p>
1328
+ * @public
1329
+ */
1330
+ export interface IamIdentityCenterOptionsInput {
1331
+ /**
1332
+ * <p>Enable/disable settings for IAM Identity Center.</p>
1333
+ * @public
1334
+ */
1335
+ enabled?: boolean;
1336
+ /**
1337
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
1338
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
1339
+ * </p>
1340
+ * @public
1341
+ */
1342
+ iamIdentityCenterInstanceArn?: string;
1343
+ /**
1344
+ * <p>Amazon Resource Name of IAM Identity Center's application.</p>
1345
+ * @public
1346
+ */
1347
+ iamRoleForIdentityCenterApplicationArn?: string;
1348
+ }
1349
+ /**
1350
+ * @public
1351
+ */
1352
+ export interface CreateApplicationRequest {
1353
+ /**
1354
+ * <p>A unique client idempotency token. It will be auto generated if not provided.</p>
1355
+ * @public
1356
+ */
1357
+ clientToken?: string;
1358
+ /**
1359
+ * <p>Name of the OpenSearch Appication to create. Application names are unique across the applications
1360
+ * owned by an account within an Amazon Web Services Region.</p>
1361
+ * @public
1362
+ */
1363
+ name: string | undefined;
1364
+ /**
1365
+ * <p>Data sources to be associated with the OpenSearch Application.</p>
1366
+ * @public
1367
+ */
1368
+ dataSources?: DataSource[];
1369
+ /**
1370
+ * <p>Settings of IAM Identity Center for the OpenSearch Application.</p>
1371
+ * @public
1372
+ */
1373
+ iamIdentityCenterOptions?: IamIdentityCenterOptionsInput;
1374
+ /**
1375
+ * <p>Configurations of the OpenSearch Application, inlcuding admin configuration.</p>
1376
+ * @public
1377
+ */
1378
+ appConfigs?: AppConfig[];
1379
+ /**
1380
+ * <p>A list of tags attached to a domain.</p>
1381
+ * @public
1382
+ */
1383
+ tagList?: Tag[];
1384
+ }
1385
+ /**
1386
+ * <p>Settings for IAM Identity Center for an OpenSearch Application.</p>
1387
+ * @public
1388
+ */
1389
+ export interface IamIdentityCenterOptions {
1390
+ /**
1391
+ * <p>IAM Identity Center is enabled for the OpenSearch Application.</p>
1392
+ * @public
1393
+ */
1394
+ enabled?: boolean;
1395
+ /**
1396
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
1397
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
1398
+ * </p>
1399
+ * @public
1400
+ */
1401
+ iamIdentityCenterInstanceArn?: string;
1402
+ /**
1403
+ * <p>Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.</p>
1404
+ * @public
1405
+ */
1406
+ iamRoleForIdentityCenterApplicationArn?: string;
1407
+ /**
1408
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
1409
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
1410
+ * </p>
1411
+ * @public
1412
+ */
1413
+ iamIdentityCenterApplicationArn?: string;
1414
+ }
1415
+ /**
1416
+ * @public
1417
+ */
1418
+ export interface CreateApplicationResponse {
1419
+ /**
1420
+ * <p>Unique identifier for the created OpenSearch Application.</p>
1421
+ * @public
1422
+ */
1423
+ id?: string;
1424
+ /**
1425
+ * <p>Name of the created OpenSearch Application.</p>
1426
+ * @public
1427
+ */
1428
+ name?: string;
1429
+ /**
1430
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
1431
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
1432
+ * </p>
1433
+ * @public
1434
+ */
1435
+ arn?: string;
1436
+ /**
1437
+ * <p>Data sources associated with the created OpenSearch Application.</p>
1438
+ * @public
1439
+ */
1440
+ dataSources?: DataSource[];
1441
+ /**
1442
+ * <p>Settings of IAM Identity Center for the created OpenSearch Application.</p>
1443
+ * @public
1444
+ */
1445
+ iamIdentityCenterOptions?: IamIdentityCenterOptions;
1446
+ /**
1447
+ * <p>Configurations of the OpenSearch Application, inlcuding admin configuration.</p>
1448
+ * @public
1449
+ */
1450
+ appConfigs?: AppConfig[];
1451
+ /**
1452
+ * <p>A list of tags attached to a domain.</p>
1453
+ * @public
1454
+ */
1455
+ tagList?: Tag[];
1456
+ /**
1457
+ * <p>Timestamp when the OpenSearch Application was created.</p>
1458
+ * @public
1459
+ */
1460
+ createdAt?: Date;
1461
+ }
1264
1462
  /**
1265
1463
  * @public
1266
1464
  * @enum
@@ -1792,6 +1990,57 @@ export interface EncryptionAtRestOptions {
1792
1990
  */
1793
1991
  KmsKeyId?: string;
1794
1992
  }
1993
+ /**
1994
+ * @public
1995
+ * @enum
1996
+ */
1997
+ export declare const RolesKeyIdCOption: {
1998
+ readonly GroupId: "GroupId";
1999
+ readonly GroupName: "GroupName";
2000
+ };
2001
+ /**
2002
+ * @public
2003
+ */
2004
+ export type RolesKeyIdCOption = (typeof RolesKeyIdCOption)[keyof typeof RolesKeyIdCOption];
2005
+ /**
2006
+ * @public
2007
+ * @enum
2008
+ */
2009
+ export declare const SubjectKeyIdCOption: {
2010
+ readonly Email: "Email";
2011
+ readonly UserId: "UserId";
2012
+ readonly UserName: "UserName";
2013
+ };
2014
+ /**
2015
+ * @public
2016
+ */
2017
+ export type SubjectKeyIdCOption = (typeof SubjectKeyIdCOption)[keyof typeof SubjectKeyIdCOption];
2018
+ /**
2019
+ * <p>Container for IAM Identity Center Options settings.</p>
2020
+ * @public
2021
+ */
2022
+ export interface IdentityCenterOptionsInput {
2023
+ /**
2024
+ * <p>True to enable IAM Identity Center for API access in Amazon OpenSearch Service.</p>
2025
+ * @public
2026
+ */
2027
+ EnabledAPIAccess?: boolean;
2028
+ /**
2029
+ * <p>The ARN for IAM Identity Center Instance which will be used for IAM Identity Center Application creation.</p>
2030
+ * @public
2031
+ */
2032
+ IdentityCenterInstanceARN?: string;
2033
+ /**
2034
+ * <p>Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.</p>
2035
+ * @public
2036
+ */
2037
+ SubjectKey?: SubjectKeyIdCOption;
2038
+ /**
2039
+ * <p>Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center</p>
2040
+ * @public
2041
+ */
2042
+ RolesKey?: RolesKeyIdCOption;
2043
+ }
1795
2044
  /**
1796
2045
  * @public
1797
2046
  * @enum
@@ -2076,6 +2325,11 @@ export interface CreateDomainRequest {
2076
2325
  * @public
2077
2326
  */
2078
2327
  AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
2328
+ /**
2329
+ * <p>Options for IAM Identity Center Option control for the domain.</p>
2330
+ * @public
2331
+ */
2332
+ IdentityCenterOptions?: IdentityCenterOptionsInput;
2079
2333
  /**
2080
2334
  * <p>List of tags to add to the domain upon creation.</p>
2081
2335
  * @public
@@ -2229,6 +2483,42 @@ export declare const DomainProcessingStatusType: {
2229
2483
  * @public
2230
2484
  */
2231
2485
  export type DomainProcessingStatusType = (typeof DomainProcessingStatusType)[keyof typeof DomainProcessingStatusType];
2486
+ /**
2487
+ * <p>Container for IAM Identity Center Options settings.</p>
2488
+ * @public
2489
+ */
2490
+ export interface IdentityCenterOptions {
2491
+ /**
2492
+ * <p>True to enable IAM Identity Center for API access in Amazon OpenSearch Service.</p>
2493
+ * @public
2494
+ */
2495
+ EnabledAPIAccess?: boolean;
2496
+ /**
2497
+ * <p>The ARN for IAM Identity Center Instance.</p>
2498
+ * @public
2499
+ */
2500
+ IdentityCenterInstanceARN?: string;
2501
+ /**
2502
+ * <p>Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.</p>
2503
+ * @public
2504
+ */
2505
+ SubjectKey?: SubjectKeyIdCOption;
2506
+ /**
2507
+ * <p>Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center</p>
2508
+ * @public
2509
+ */
2510
+ RolesKey?: RolesKeyIdCOption;
2511
+ /**
2512
+ * <p>The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.</p>
2513
+ * @public
2514
+ */
2515
+ IdentityCenterApplicationARN?: string;
2516
+ /**
2517
+ * <p>The ID of IAM Identity Store.</p>
2518
+ * @public
2519
+ */
2520
+ IdentityStoreId?: string;
2521
+ }
2232
2522
  /**
2233
2523
  * @public
2234
2524
  * @enum
@@ -2471,6 +2761,11 @@ export interface DomainStatus {
2471
2761
  * @public
2472
2762
  */
2473
2763
  AdvancedSecurityOptions?: AdvancedSecurityOptions;
2764
+ /**
2765
+ * <p>Container for IAM Identity Center Option control for the domain.</p>
2766
+ * @public
2767
+ */
2768
+ IdentityCenterOptions?: IdentityCenterOptions;
2474
2769
  /**
2475
2770
  * <p>Auto-Tune settings for the domain.</p>
2476
2771
  * @public
@@ -2996,6 +3291,21 @@ export interface CreateVpcEndpointResponse {
2996
3291
  */
2997
3292
  VpcEndpoint: VpcEndpoint | undefined;
2998
3293
  }
3294
+ /**
3295
+ * @public
3296
+ */
3297
+ export interface DeleteApplicationRequest {
3298
+ /**
3299
+ * <p>Unique identifier for the OpenSearch Application that you want to delete.</p>
3300
+ * @public
3301
+ */
3302
+ id: string | undefined;
3303
+ }
3304
+ /**
3305
+ * @public
3306
+ */
3307
+ export interface DeleteApplicationResponse {
3308
+ }
2999
3309
  /**
3000
3310
  * <p>Container for the parameters to the <code>DeleteDataSource</code>
3001
3311
  * operation.</p>
@@ -3692,6 +4002,22 @@ export interface VersionStatus {
3692
4002
  */
3693
4003
  Status: OptionStatus | undefined;
3694
4004
  }
4005
+ /**
4006
+ * <p>The status of IAM Identity Center Options settings for a domain.</p>
4007
+ * @public
4008
+ */
4009
+ export interface IdentityCenterOptionsStatus {
4010
+ /**
4011
+ * <p>Container for IAM Identity Center Options settings.</p>
4012
+ * @public
4013
+ */
4014
+ Options: IdentityCenterOptions | undefined;
4015
+ /**
4016
+ * <p>The status of IAM Identity Center Options settings for a domain.</p>
4017
+ * @public
4018
+ */
4019
+ Status: OptionStatus | undefined;
4020
+ }
3695
4021
  /**
3696
4022
  * <p>The IP address type status for the domain.</p>
3697
4023
  * @public
@@ -3886,6 +4212,11 @@ export interface DomainConfig {
3886
4212
  * @public
3887
4213
  */
3888
4214
  AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus;
4215
+ /**
4216
+ * <p>Container for IAM Identity Center Option control for the domain.</p>
4217
+ * @public
4218
+ */
4219
+ IdentityCenterOptions?: IdentityCenterOptionsStatus;
3889
4220
  /**
3890
4221
  * <p>Container for Auto-Tune settings for the domain.</p>
3891
4222
  * @public
@@ -5089,64 +5420,146 @@ export interface DissociatePackageResponse {
5089
5420
  DomainPackageDetails?: DomainPackageDetails;
5090
5421
  }
5091
5422
  /**
5092
- * <p>Container for the request parameters to <code>GetCompatibleVersions</code> operation.</p>
5093
5423
  * @public
5094
5424
  */
5095
- export interface GetCompatibleVersionsRequest {
5425
+ export interface GetApplicationRequest {
5096
5426
  /**
5097
- * <p>The name of an existing domain. Provide this parameter to limit the results to a single
5098
- * domain.</p>
5427
+ * <p>Unique identifier of the checked OpenSearch Application.</p>
5099
5428
  * @public
5100
5429
  */
5101
- DomainName?: string;
5430
+ id: string | undefined;
5102
5431
  }
5103
5432
  /**
5104
- * <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
5105
- * to.</p>
5106
5433
  * @public
5434
+ * @enum
5107
5435
  */
5108
- export interface CompatibleVersionsMap {
5436
+ export declare const ApplicationStatus: {
5437
+ readonly ACTIVE: "ACTIVE";
5438
+ readonly CREATING: "CREATING";
5439
+ readonly DELETING: "DELETING";
5440
+ readonly FAILED: "FAILED";
5441
+ readonly UPDATING: "UPDATING";
5442
+ };
5443
+ /**
5444
+ * @public
5445
+ */
5446
+ export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
5447
+ /**
5448
+ * @public
5449
+ */
5450
+ export interface GetApplicationResponse {
5109
5451
  /**
5110
- * <p>The current version that the OpenSearch Service domain is running.</p>
5452
+ * <p>Unique identifier of the checked OpenSearch Application.</p>
5111
5453
  * @public
5112
5454
  */
5113
- SourceVersion?: string;
5455
+ id?: string;
5114
5456
  /**
5115
- * <p>The possible versions that you can upgrade the domain to.</p>
5457
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
5458
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
5459
+ * </p>
5116
5460
  * @public
5117
5461
  */
5118
- TargetVersions?: string[];
5119
- }
5120
- /**
5121
- * <p>Container for the response returned by the <code>GetCompatibleVersions</code> operation.</p>
5122
- * @public
5123
- */
5124
- export interface GetCompatibleVersionsResponse {
5462
+ arn?: string;
5125
5463
  /**
5126
- * <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
5127
- * to.</p>
5464
+ * <p>Name of the checked OpenSearch Application.</p>
5128
5465
  * @public
5129
5466
  */
5130
- CompatibleVersions?: CompatibleVersionsMap[];
5131
- }
5132
- /**
5133
- * <p>Container for the parameters to the <code>GetDataSource</code>
5134
- * operation.</p>
5135
- * @public
5136
- */
5137
- export interface GetDataSourceRequest {
5467
+ name?: string;
5138
5468
  /**
5139
- * <p>The name of the domain.</p>
5469
+ * <p>Endpoint URL of the checked OpenSearch Application.</p>
5140
5470
  * @public
5141
5471
  */
5142
- DomainName: string | undefined;
5472
+ endpoint?: string;
5143
5473
  /**
5144
- * <p>The name of the data source to get information about.</p>
5474
+ * <p>Current status of the checked OpenSearch Application. Possible values are <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
5145
5475
  * @public
5146
5476
  */
5147
- Name: string | undefined;
5148
- }
5149
- /**
5477
+ status?: ApplicationStatus;
5478
+ /**
5479
+ * <p>IAM Identity Center settings for the checked OpenSearch Application.</p>
5480
+ * @public
5481
+ */
5482
+ iamIdentityCenterOptions?: IamIdentityCenterOptions;
5483
+ /**
5484
+ * <p>Associated data sources to the checked OpenSearch Application.</p>
5485
+ * @public
5486
+ */
5487
+ dataSources?: DataSource[];
5488
+ /**
5489
+ * <p>App configurations of the checked OpenSearch Application.</p>
5490
+ * @public
5491
+ */
5492
+ appConfigs?: AppConfig[];
5493
+ /**
5494
+ * <p>Timestamp at which the checked OpenSearch Application was created.</p>
5495
+ * @public
5496
+ */
5497
+ createdAt?: Date;
5498
+ /**
5499
+ * <p>Timestamp at which the checked OpenSearch Application was last updated.</p>
5500
+ * @public
5501
+ */
5502
+ lastUpdatedAt?: Date;
5503
+ }
5504
+ /**
5505
+ * <p>Container for the request parameters to <code>GetCompatibleVersions</code> operation.</p>
5506
+ * @public
5507
+ */
5508
+ export interface GetCompatibleVersionsRequest {
5509
+ /**
5510
+ * <p>The name of an existing domain. Provide this parameter to limit the results to a single
5511
+ * domain.</p>
5512
+ * @public
5513
+ */
5514
+ DomainName?: string;
5515
+ }
5516
+ /**
5517
+ * <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
5518
+ * to.</p>
5519
+ * @public
5520
+ */
5521
+ export interface CompatibleVersionsMap {
5522
+ /**
5523
+ * <p>The current version that the OpenSearch Service domain is running.</p>
5524
+ * @public
5525
+ */
5526
+ SourceVersion?: string;
5527
+ /**
5528
+ * <p>The possible versions that you can upgrade the domain to.</p>
5529
+ * @public
5530
+ */
5531
+ TargetVersions?: string[];
5532
+ }
5533
+ /**
5534
+ * <p>Container for the response returned by the <code>GetCompatibleVersions</code> operation.</p>
5535
+ * @public
5536
+ */
5537
+ export interface GetCompatibleVersionsResponse {
5538
+ /**
5539
+ * <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
5540
+ * to.</p>
5541
+ * @public
5542
+ */
5543
+ CompatibleVersions?: CompatibleVersionsMap[];
5544
+ }
5545
+ /**
5546
+ * <p>Container for the parameters to the <code>GetDataSource</code>
5547
+ * operation.</p>
5548
+ * @public
5549
+ */
5550
+ export interface GetDataSourceRequest {
5551
+ /**
5552
+ * <p>The name of the domain.</p>
5553
+ * @public
5554
+ */
5555
+ DomainName: string | undefined;
5556
+ /**
5557
+ * <p>The name of the data source to get information about.</p>
5558
+ * @public
5559
+ */
5560
+ Name: string | undefined;
5561
+ }
5562
+ /**
5150
5563
  * @public
5151
5564
  * @enum
5152
5565
  */
@@ -5534,6 +5947,89 @@ export interface GetUpgradeStatusResponse {
5534
5947
  */
5535
5948
  UpgradeName?: string;
5536
5949
  }
5950
+ /**
5951
+ * @public
5952
+ */
5953
+ export interface ListApplicationsRequest {
5954
+ /**
5955
+ * <p>When <code>nextToken</code> is returned, there are more results available. The value of
5956
+ * <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
5957
+ * returned token to retrieve the next page.</p>
5958
+ * @public
5959
+ */
5960
+ nextToken?: string;
5961
+ /**
5962
+ * <p>OpenSearch Application Status can be used as filters for the listing request. Possible values are <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
5963
+ * @public
5964
+ */
5965
+ statuses?: ApplicationStatus[];
5966
+ /**
5967
+ * <p>An optional parameter that specifies the maximum number of results to return for a given
5968
+ * request.</p>
5969
+ * @public
5970
+ */
5971
+ maxResults?: number;
5972
+ }
5973
+ /**
5974
+ * <p>Basic information of the OpenSearch Application.</p>
5975
+ * @public
5976
+ */
5977
+ export interface ApplicationSummary {
5978
+ /**
5979
+ * <p>Unique identifier for an OpenSearch application.</p>
5980
+ * @public
5981
+ */
5982
+ id?: string;
5983
+ /**
5984
+ * <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
5985
+ * </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
5986
+ * </p>
5987
+ * @public
5988
+ */
5989
+ arn?: string;
5990
+ /**
5991
+ * <p>Name of an OpenSearch Application.</p>
5992
+ * @public
5993
+ */
5994
+ name?: string;
5995
+ /**
5996
+ * <p>Endpoint URL of an OpenSearch Application.</p>
5997
+ * @public
5998
+ */
5999
+ endpoint?: string;
6000
+ /**
6001
+ * <p>Status of an OpenSearch Application. Possible values are <code>CREATING</code>, <code>UPDATING</code>,<code> DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
6002
+ * @public
6003
+ */
6004
+ status?: ApplicationStatus;
6005
+ /**
6006
+ * <p>Timestamp at which an OpenSearch Application was created.</p>
6007
+ * @public
6008
+ */
6009
+ createdAt?: Date;
6010
+ /**
6011
+ * <p>Timestamp at which an OpenSearch Application was last updated.</p>
6012
+ * @public
6013
+ */
6014
+ lastUpdatedAt?: Date;
6015
+ }
6016
+ /**
6017
+ * @public
6018
+ */
6019
+ export interface ListApplicationsResponse {
6020
+ /**
6021
+ * <p>Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.</p>
6022
+ * @public
6023
+ */
6024
+ ApplicationSummaries?: ApplicationSummary[];
6025
+ /**
6026
+ * <p>When <code>nextToken</code> is returned, there are more results available. The value of
6027
+ * <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
6028
+ * returned token to retrieve the next page.</p>
6029
+ * @public
6030
+ */
6031
+ nextToken?: string;
6032
+ }
5537
6033
  /**
5538
6034
  * <p>Container for the parameters to the <code>ListDataSources</code>
5539
6035
  * operation.</p>
@@ -6240,541 +6736,18 @@ export interface RejectInboundConnectionRequest {
6240
6736
  ConnectionId: string | undefined;
6241
6737
  }
6242
6738
  /**
6243
- * <p>Represents the output of a <code>RejectInboundConnection</code> operation.</p>
6244
- * @public
6245
- */
6246
- export interface RejectInboundConnectionResponse {
6247
- /**
6248
- * <p>Contains details about the rejected inbound connection.</p>
6249
- * @public
6250
- */
6251
- Connection?: InboundConnection;
6252
- }
6253
- /**
6254
- * <p>Container for the request parameters to the <code>RemoveTags</code> operation.</p>
6255
- * @public
6256
- */
6257
- export interface RemoveTagsRequest {
6258
- /**
6259
- * <p>The Amazon Resource Name (ARN) of the domain from which you want to delete the specified
6260
- * tags.</p>
6261
- * @public
6262
- */
6263
- ARN: string | undefined;
6264
- /**
6265
- * <p>The list of tag keys to remove from the domain.</p>
6266
- * @public
6267
- */
6268
- TagKeys: string[] | undefined;
6269
- }
6270
- /**
6271
- * @public
6272
- */
6273
- export interface RevokeVpcEndpointAccessRequest {
6274
- /**
6275
- * <p>The name of the OpenSearch Service domain.</p>
6276
- * @public
6277
- */
6278
- DomainName: string | undefined;
6279
- /**
6280
- * <p>The account ID to revoke access from.</p>
6281
- * @public
6282
- */
6283
- Account: string | undefined;
6284
- }
6285
- /**
6286
- * @public
6287
- */
6288
- export interface RevokeVpcEndpointAccessResponse {
6289
- }
6290
- /**
6291
- * <p>Container for the parameters to the <code>StartDomainMaintenance</code>
6292
- * operation.</p>
6293
- * @public
6294
- */
6295
- export interface StartDomainMaintenanceRequest {
6296
- /**
6297
- * <p>The name of the domain.</p>
6298
- * @public
6299
- */
6300
- DomainName: string | undefined;
6301
- /**
6302
- * <p>The name of the action.</p>
6303
- * @public
6304
- */
6305
- Action: MaintenanceType | undefined;
6306
- /**
6307
- * <p>The ID of the data node.</p>
6308
- * @public
6309
- */
6310
- NodeId?: string;
6311
- }
6312
- /**
6313
- * <p>The result of a <code>StartDomainMaintenance</code> request that information about the requested action. </p>
6314
- * @public
6315
- */
6316
- export interface StartDomainMaintenanceResponse {
6317
- /**
6318
- * <p>The request ID of requested action.</p>
6319
- * @public
6320
- */
6321
- MaintenanceId?: string;
6322
- }
6323
- /**
6324
- * @public
6325
- * @enum
6326
- */
6327
- export declare const ScheduleAt: {
6328
- readonly NOW: "NOW";
6329
- readonly OFF_PEAK_WINDOW: "OFF_PEAK_WINDOW";
6330
- readonly TIMESTAMP: "TIMESTAMP";
6331
- };
6332
- /**
6333
- * @public
6739
+ * @internal
6334
6740
  */
6335
- export type ScheduleAt = (typeof ScheduleAt)[keyof typeof ScheduleAt];
6741
+ export declare const MasterUserOptionsFilterSensitiveLog: (obj: MasterUserOptions) => any;
6336
6742
  /**
6337
- * <p>Container for the request parameters to the <code>StartServiceSoftwareUpdate</code>
6338
- * operation.</p>
6339
- * @public
6743
+ * @internal
6340
6744
  */
6341
- export interface StartServiceSoftwareUpdateRequest {
6342
- /**
6343
- * <p>The name of the domain that you want to update to the latest service software.</p>
6344
- * @public
6345
- */
6346
- DomainName: string | undefined;
6347
- /**
6348
- * <p>When to start the service software update.</p>
6349
- * <ul>
6350
- * <li>
6351
- * <p>
6352
- * <code>NOW</code> - Immediately schedules the update to happen in the current hour if
6353
- * there's capacity available.</p>
6354
- * </li>
6355
- * <li>
6356
- * <p>
6357
- * <code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If
6358
- * you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p>
6359
- * </li>
6360
- * <li>
6361
- * <p>
6362
- * <code>OFF_PEAK_WINDOW</code> - Marks the update to be picked up during an upcoming
6363
- * off-peak window. There's no guarantee that the update will happen during the next immediate
6364
- * window. Depending on capacity, it might happen in subsequent days.</p>
6365
- * </li>
6366
- * </ul>
6367
- * <p>Default: <code>NOW</code> if you don't specify a value for <code>DesiredStartTime</code>,
6368
- * and <code>TIMESTAMP</code> if you do.</p>
6369
- * @public
6370
- */
6371
- ScheduleAt?: ScheduleAt;
6372
- /**
6373
- * <p>The Epoch timestamp when you want the service software update to start. You only need to
6374
- * specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
6375
- * @public
6376
- */
6377
- DesiredStartTime?: number;
6378
- }
6745
+ export declare const SAMLOptionsInputFilterSensitiveLog: (obj: SAMLOptionsInput) => any;
6379
6746
  /**
6380
- * <p>Represents the output of a <code>StartServiceSoftwareUpdate</code> operation. Contains the
6381
- * status of the update.</p>
6382
- * @public
6747
+ * @internal
6383
6748
  */
6384
- export interface StartServiceSoftwareUpdateResponse {
6385
- /**
6386
- * <p>The current status of the OpenSearch Service software update.</p>
6387
- * @public
6388
- */
6389
- ServiceSoftwareOptions?: ServiceSoftwareOptions;
6390
- }
6749
+ export declare const AdvancedSecurityOptionsInputFilterSensitiveLog: (obj: AdvancedSecurityOptionsInput) => any;
6391
6750
  /**
6392
- * <p>Container for the parameters to the <code>UpdateDataSource</code>
6393
- * operation.</p>
6394
- * @public
6395
- */
6396
- export interface UpdateDataSourceRequest {
6397
- /**
6398
- * <p>The name of the domain.</p>
6399
- * @public
6400
- */
6401
- DomainName: string | undefined;
6402
- /**
6403
- * <p>The name of the data source to modify.</p>
6404
- * @public
6405
- */
6406
- Name: string | undefined;
6407
- /**
6408
- * <p>The type of data source.</p>
6409
- * @public
6410
- */
6411
- DataSourceType: DataSourceType | undefined;
6412
- /**
6413
- * <p>A new description of the data source.</p>
6414
- * @public
6415
- */
6416
- Description?: string;
6417
- /**
6418
- * <p>The status of the data source update.</p>
6419
- * @public
6420
- */
6421
- Status?: DataSourceStatus;
6422
- }
6423
- /**
6424
- * <p>The result of an <code>UpdateDataSource</code> operation.</p>
6425
- * @public
6426
- */
6427
- export interface UpdateDataSourceResponse {
6428
- /**
6429
- * <p>A message associated with the updated data source.</p>
6430
- * @public
6431
- */
6432
- Message?: string;
6433
- }
6434
- /**
6435
- * @public
6436
- * @enum
6437
- */
6438
- export declare const DryRunMode: {
6439
- readonly Basic: "Basic";
6440
- readonly Verbose: "Verbose";
6441
- };
6442
- /**
6443
- * @public
6444
- */
6445
- export type DryRunMode = (typeof DryRunMode)[keyof typeof DryRunMode];
6446
- /**
6447
- * <p>Container for the request parameters to the <code>UpdateDomain</code> operation.</p>
6448
- * @public
6449
- */
6450
- export interface UpdateDomainConfigRequest {
6451
- /**
6452
- * <p>The name of the domain that you're updating.</p>
6453
- * @public
6454
- */
6455
- DomainName: string | undefined;
6456
- /**
6457
- * <p>Changes that you want to make to the cluster configuration, such as the instance type and
6458
- * number of EC2 instances.</p>
6459
- * @public
6460
- */
6461
- ClusterConfig?: ClusterConfig;
6462
- /**
6463
- * <p>The type and size of the EBS volume to attach to instances in the domain.</p>
6464
- * @public
6465
- */
6466
- EBSOptions?: EBSOptions;
6467
- /**
6468
- * <p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours.
6469
- * </p>
6470
- * @public
6471
- */
6472
- SnapshotOptions?: SnapshotOptions;
6473
- /**
6474
- * <p>Options to specify the subnets and security groups for a VPC endpoint. For more information,
6475
- * see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching
6476
- * your Amazon OpenSearch Service domains using a VPC</a>.</p>
6477
- * @public
6478
- */
6479
- VPCOptions?: VPCOptions;
6480
- /**
6481
- * <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>
6482
- * @public
6483
- */
6484
- CognitoOptions?: CognitoOptions;
6485
- /**
6486
- * <p>Key-value pairs to specify advanced configuration options. The following key-value pairs are
6487
- * supported:</p>
6488
- * <ul>
6489
- * <li>
6490
- * <p>
6491
- * <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note the use of
6492
- * a string rather than a boolean. Specifies whether explicit references to indexes are allowed
6493
- * inside the body of HTTP requests. If you want to configure access policies for domain
6494
- * sub-resources, such as specific indexes and domain APIs, you must disable this property.
6495
- * Default is true.</p>
6496
- * </li>
6497
- * <li>
6498
- * <p>
6499
- * <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string rather than
6500
- * a boolean. Specifies the percentage of heap space allocated to field data. Default is
6501
- * unbounded.</p>
6502
- * </li>
6503
- * <li>
6504
- * <p>
6505
- * <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a string
6506
- * rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean
6507
- * query. Default is 1,024. Queries with more than the permitted number of clauses result in a
6508
- * <code>TooManyClauses</code> error.</p>
6509
- * </li>
6510
- * </ul>
6511
- * <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</p>
6512
- * @public
6513
- */
6514
- AdvancedOptions?: Record<string, string>;
6515
- /**
6516
- * <p>Identity and Access Management (IAM) access policy as a JSON-formatted string.</p>
6517
- * @public
6518
- */
6519
- AccessPolicies?: string;
6520
- /**
6521
- * <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across
6522
- * IPv4 and IPv6 address types, and is the recommended option.
6523
- * If your IP address type is currently set to dual stack, you can't change it.
6524
- * </p>
6525
- * @public
6526
- */
6527
- IPAddressType?: IPAddressType;
6528
- /**
6529
- * <p>Options to publish OpenSearch logs to Amazon CloudWatch Logs.</p>
6530
- * @public
6531
- */
6532
- LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>>;
6533
- /**
6534
- * <p>Encryption at rest options for the domain.</p>
6535
- * @public
6536
- */
6537
- EncryptionAtRestOptions?: EncryptionAtRestOptions;
6538
- /**
6539
- * <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
6540
- * traffic.</p>
6541
- * @public
6542
- */
6543
- DomainEndpointOptions?: DomainEndpointOptions;
6544
- /**
6545
- * <p>Node-to-node encryption options for the domain.</p>
6546
- * @public
6547
- */
6548
- NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
6549
- /**
6550
- * <p>Options for fine-grained access control.</p>
6551
- * @public
6552
- */
6553
- AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
6554
- /**
6555
- * <p>Options for Auto-Tune.</p>
6556
- * @public
6557
- */
6558
- AutoTuneOptions?: AutoTuneOptions;
6559
- /**
6560
- * <p>This flag, when set to True, specifies whether the <code>UpdateDomain</code> request should
6561
- * return the results of a dry run analysis without actually applying the change. A dry run
6562
- * determines what type of deployment the update will cause.</p>
6563
- * @public
6564
- */
6565
- DryRun?: boolean;
6566
- /**
6567
- * <p>The type of dry run to perform.</p>
6568
- * <ul>
6569
- * <li>
6570
- * <p>
6571
- * <code>Basic</code> only returns the type of deployment (blue/green or dynamic) that the update
6572
- * will cause.</p>
6573
- * </li>
6574
- * <li>
6575
- * <p>
6576
- * <code>Verbose</code> runs an additional check to validate the changes you're making. For
6577
- * more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check">Validating a domain update</a>.</p>
6578
- * </li>
6579
- * </ul>
6580
- * @public
6581
- */
6582
- DryRunMode?: DryRunMode;
6583
- /**
6584
- * <p>Off-peak window options for the domain.</p>
6585
- * @public
6586
- */
6587
- OffPeakWindowOptions?: OffPeakWindowOptions;
6588
- /**
6589
- * <p>Service software update options for the domain.</p>
6590
- * @public
6591
- */
6592
- SoftwareUpdateOptions?: SoftwareUpdateOptions;
6593
- /**
6594
- * <p>Options for all machine learning features for the specified domain.</p>
6595
- * @public
6596
- */
6597
- AIMLOptions?: AIMLOptionsInput;
6598
- }
6599
- /**
6600
- * <p>The results of an <code>UpdateDomain</code> request. Contains the status of the domain being
6601
- * updated.</p>
6602
- * @public
6603
- */
6604
- export interface UpdateDomainConfigResponse {
6605
- /**
6606
- * <p>The status of the updated domain.</p>
6607
- * @public
6608
- */
6609
- DomainConfig: DomainConfig | undefined;
6610
- /**
6611
- * <p>Results of the dry run performed in the update domain request.</p>
6612
- * @public
6613
- */
6614
- DryRunResults?: DryRunResults;
6615
- /**
6616
- * <p>The status of the dry run being performed on the domain, if any.</p>
6617
- * @public
6618
- */
6619
- DryRunProgressStatus?: DryRunProgressStatus;
6620
- }
6621
- /**
6622
- * <p>Container for request parameters to the <code>UpdatePackage</code> operation.</p>
6623
- * @public
6624
- */
6625
- export interface UpdatePackageRequest {
6626
- /**
6627
- * <p>The unique identifier for the package.</p>
6628
- * @public
6629
- */
6630
- PackageID: string | undefined;
6631
- /**
6632
- * <p>Amazon S3 bucket and key for the package.</p>
6633
- * @public
6634
- */
6635
- PackageSource: PackageSource | undefined;
6636
- /**
6637
- * <p>A new description of the package.</p>
6638
- * @public
6639
- */
6640
- PackageDescription?: string;
6641
- /**
6642
- * <p>Commit message for the updated file, which is shown as part of
6643
- * <code>GetPackageVersionHistoryResponse</code>.</p>
6644
- * @public
6645
- */
6646
- CommitMessage?: string;
6647
- }
6648
- /**
6649
- * <p>Container for the response returned by the <code>UpdatePackage</code> operation.</p>
6650
- * @public
6651
- */
6652
- export interface UpdatePackageResponse {
6653
- /**
6654
- * <p>Information about a package.</p>
6655
- * @public
6656
- */
6657
- PackageDetails?: PackageDetails;
6658
- }
6659
- /**
6660
- * <p>An exception for attempting to schedule a domain action during an unavailable time slot.</p>
6661
- * @public
6662
- */
6663
- export declare class SlotNotAvailableException extends __BaseException {
6664
- readonly name: "SlotNotAvailableException";
6665
- readonly $fault: "client";
6666
- /**
6667
- * <p>Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.</p>
6668
- * @public
6669
- */
6670
- SlotSuggestions?: number[];
6671
- /**
6672
- * @internal
6673
- */
6674
- constructor(opts: __ExceptionOptionType<SlotNotAvailableException, __BaseException>);
6675
- }
6676
- /**
6677
- * @public
6678
- */
6679
- export interface UpdateScheduledActionRequest {
6680
- /**
6681
- * <p>The name of the domain to reschedule an action for.</p>
6682
- * @public
6683
- */
6684
- DomainName: string | undefined;
6685
- /**
6686
- * <p>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
6687
- * @public
6688
- */
6689
- ActionID: string | undefined;
6690
- /**
6691
- * <p>The type of action to reschedule. Can be one of <code>SERVICE_SOFTWARE_UPDATE</code>,
6692
- * <code>JVM_HEAP_SIZE_TUNING</code>, or <code>JVM_YOUNG_GEN_TUNING</code>. To retrieve this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>
6693
- * @public
6694
- */
6695
- ActionType: ActionType | undefined;
6696
- /**
6697
- * <p>When to schedule the action.</p>
6698
- * <ul>
6699
- * <li>
6700
- * <p>
6701
- * <code>NOW</code> - Immediately schedules the update to happen in the current hour if
6702
- * there's capacity available.</p>
6703
- * </li>
6704
- * <li>
6705
- * <p>
6706
- * <code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If
6707
- * you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p>
6708
- * </li>
6709
- * <li>
6710
- * <p>
6711
- * <code>OFF_PEAK_WINDOW</code> - Marks the action to be picked up during an upcoming
6712
- * off-peak window. There's no guarantee that the change will be implemented during the next
6713
- * immediate window. Depending on capacity, it might happen in subsequent days.</p>
6714
- * </li>
6715
- * </ul>
6716
- * @public
6717
- */
6718
- ScheduleAt: ScheduleAt | undefined;
6719
- /**
6720
- * <p>The time to implement the change, in Coordinated Universal Time (UTC). Only specify this
6721
- * parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>
6722
- * @public
6723
- */
6724
- DesiredStartTime?: number;
6725
- }
6726
- /**
6727
- * @public
6728
- */
6729
- export interface UpdateScheduledActionResponse {
6730
- /**
6731
- * <p>Information about the rescheduled action.</p>
6732
- * @public
6733
- */
6734
- ScheduledAction?: ScheduledAction;
6735
- }
6736
- /**
6737
- * @public
6738
- */
6739
- export interface UpdateVpcEndpointRequest {
6740
- /**
6741
- * <p>The unique identifier of the endpoint.</p>
6742
- * @public
6743
- */
6744
- VpcEndpointId: string | undefined;
6745
- /**
6746
- * <p>The security groups and/or subnets to add, remove, or modify.</p>
6747
- * @public
6748
- */
6749
- VpcOptions: VPCOptions | undefined;
6750
- }
6751
- /**
6752
- * @public
6753
- */
6754
- export interface UpdateVpcEndpointResponse {
6755
- /**
6756
- * <p>The endpoint to be updated.</p>
6757
- * @public
6758
- */
6759
- VpcEndpoint: VpcEndpoint | undefined;
6760
- }
6761
- /**
6762
- * @internal
6763
- */
6764
- export declare const MasterUserOptionsFilterSensitiveLog: (obj: MasterUserOptions) => any;
6765
- /**
6766
- * @internal
6767
- */
6768
- export declare const SAMLOptionsInputFilterSensitiveLog: (obj: SAMLOptionsInput) => any;
6769
- /**
6770
- * @internal
6771
- */
6772
- export declare const AdvancedSecurityOptionsInputFilterSensitiveLog: (obj: AdvancedSecurityOptionsInput) => any;
6773
- /**
6774
- * @internal
6751
+ * @internal
6775
6752
  */
6776
6753
  export declare const CreateDomainRequestFilterSensitiveLog: (obj: CreateDomainRequest) => any;
6777
- /**
6778
- * @internal
6779
- */
6780
- export declare const UpdateDomainConfigRequestFilterSensitiveLog: (obj: UpdateDomainConfigRequest) => any;