@aws-sdk/client-opensearch 3.840.0 → 3.845.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/dist-types/commands/AddDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/AddDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/AssociatePackageCommand.d.ts +1 -2
- package/dist-types/commands/AssociatePackagesCommand.d.ts +2 -1
- package/dist-types/commands/CreateApplicationCommand.d.ts +2 -1
- package/dist-types/commands/CreateDomainCommand.d.ts +6 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDirectQueryDataSourceCommand.d.ts +1 -3
- package/dist-types/commands/DeleteDomainCommand.d.ts +3 -0
- package/dist-types/commands/DescribeDomainChangeProgressCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainCommand.d.ts +3 -0
- package/dist-types/commands/DescribeDomainConfigCommand.d.ts +3 -0
- package/dist-types/commands/DescribeDomainHealthCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeDryRunProgressCommand.d.ts +5 -2
- package/dist-types/commands/DescribeReservedInstanceOfferingsCommand.d.ts +2 -1
- package/dist-types/commands/GetDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts +3 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +3 -3
- package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts +2 -4
- package/dist-types/commands/ListDomainsForPackageCommand.d.ts +2 -1
- package/dist-types/commands/ListScheduledActionsCommand.d.ts +1 -1
- package/dist-types/commands/StartDomainMaintenanceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateDomainConfigCommand.d.ts +7 -2
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateScheduledActionCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +368 -331
- package/dist-types/models/models_1.d.ts +71 -60
- package/dist-types/ts3.4/commands/ListDomainsForPackageCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +5 -4
- package/dist-types/ts3.4/models/models_1.d.ts +4 -0
- package/package.json +14 -14
|
@@ -368,8 +368,7 @@ export declare namespace DataSourceType {
|
|
|
368
368
|
const visit: <T>(value: DataSourceType, visitor: Visitor<T>) => T;
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
371
|
-
* <p>Container for the parameters to the <code>AddDataSource</code>
|
|
372
|
-
* operation.</p>
|
|
371
|
+
* <p>Container for the parameters to the <code>AddDataSource</code> operation.</p>
|
|
373
372
|
* @public
|
|
374
373
|
*/
|
|
375
374
|
export interface AddDataSourceRequest {
|
|
@@ -454,44 +453,33 @@ export declare class ValidationException extends __BaseException {
|
|
|
454
453
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
455
454
|
}
|
|
456
455
|
/**
|
|
457
|
-
* <p>
|
|
458
|
-
*
|
|
459
|
-
* that can be used for direct queries.
|
|
460
|
-
* </p>
|
|
456
|
+
* <p> Configuration details for a CloudWatch Logs data source that can be used for direct
|
|
457
|
+
* queries. </p>
|
|
461
458
|
* @public
|
|
462
459
|
*/
|
|
463
460
|
export interface CloudWatchDirectQueryDataSource {
|
|
464
461
|
/**
|
|
465
|
-
* <p>
|
|
466
|
-
*
|
|
467
|
-
* OpenSearch Service permission to access the specified data source.
|
|
468
|
-
* </p>
|
|
462
|
+
* <p> The unique identifier of the IAM role that grants OpenSearch Service permission to access
|
|
463
|
+
* the specified data source. </p>
|
|
469
464
|
* @public
|
|
470
465
|
*/
|
|
471
466
|
RoleArn: string | undefined;
|
|
472
467
|
}
|
|
473
468
|
/**
|
|
474
|
-
* <p>
|
|
475
|
-
* Configuration details for a Security Lake data source
|
|
476
|
-
* that can be used for direct queries.
|
|
469
|
+
* <p> Configuration details for a Security Lake data source that can be used for direct queries.
|
|
477
470
|
* </p>
|
|
478
471
|
* @public
|
|
479
472
|
*/
|
|
480
473
|
export interface SecurityLakeDirectQueryDataSource {
|
|
481
474
|
/**
|
|
482
|
-
* <p>
|
|
483
|
-
*
|
|
484
|
-
* Service permission to access the specified data source.
|
|
485
|
-
* </p>
|
|
475
|
+
* <p> The unique identifier of the IAM role that grants OpenSearch Service permission to access
|
|
476
|
+
* the specified data source. </p>
|
|
486
477
|
* @public
|
|
487
478
|
*/
|
|
488
479
|
RoleArn: string | undefined;
|
|
489
480
|
}
|
|
490
481
|
/**
|
|
491
|
-
* <p>
|
|
492
|
-
* The type of data source that is used for direct queries.
|
|
493
|
-
* This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.
|
|
494
|
-
* </p>
|
|
482
|
+
* <p> The type of data source that is used for direct queries. This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake. </p>
|
|
495
483
|
* @public
|
|
496
484
|
*/
|
|
497
485
|
export type DirectQueryDataSourceType = DirectQueryDataSourceType.CloudWatchLogMember | DirectQueryDataSourceType.SecurityLakeMember | DirectQueryDataSourceType.$UnknownMember;
|
|
@@ -500,9 +488,7 @@ export type DirectQueryDataSourceType = DirectQueryDataSourceType.CloudWatchLogM
|
|
|
500
488
|
*/
|
|
501
489
|
export declare namespace DirectQueryDataSourceType {
|
|
502
490
|
/**
|
|
503
|
-
* <p>
|
|
504
|
-
* Specifies CloudWatch Logs as a type of data source for direct queries.
|
|
505
|
-
* </p>
|
|
491
|
+
* <p> Specifies CloudWatch Logs as a type of data source for direct queries. </p>
|
|
506
492
|
* @public
|
|
507
493
|
*/
|
|
508
494
|
interface CloudWatchLogMember {
|
|
@@ -511,9 +497,7 @@ export declare namespace DirectQueryDataSourceType {
|
|
|
511
497
|
$unknown?: never;
|
|
512
498
|
}
|
|
513
499
|
/**
|
|
514
|
-
* <p>
|
|
515
|
-
* Specifies Security Lake as a type of data source for direct queries.
|
|
516
|
-
* </p>
|
|
500
|
+
* <p> Specifies Security Lake as a type of data source for direct queries. </p>
|
|
517
501
|
* @public
|
|
518
502
|
*/
|
|
519
503
|
interface SecurityLakeMember {
|
|
@@ -560,32 +544,26 @@ export interface Tag {
|
|
|
560
544
|
*/
|
|
561
545
|
export interface AddDirectQueryDataSourceRequest {
|
|
562
546
|
/**
|
|
563
|
-
* <p>
|
|
564
|
-
*
|
|
565
|
-
* within your OpenSearch Service environment.
|
|
566
|
-
* </p>
|
|
547
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch Service
|
|
548
|
+
* environment. </p>
|
|
567
549
|
* @public
|
|
568
550
|
*/
|
|
569
551
|
DataSourceName: string | undefined;
|
|
570
552
|
/**
|
|
571
|
-
* <p>
|
|
572
|
-
*
|
|
573
|
-
* </p>
|
|
553
|
+
* <p> The supported Amazon Web Services service that you want to use as the source for direct
|
|
554
|
+
* queries in OpenSearch Service. </p>
|
|
574
555
|
* @public
|
|
575
556
|
*/
|
|
576
557
|
DataSourceType: DirectQueryDataSourceType | undefined;
|
|
577
558
|
/**
|
|
578
|
-
* <p>
|
|
579
|
-
* An optional text field for providing additional context and details about the data source.
|
|
559
|
+
* <p> An optional text field for providing additional context and details about the data source.
|
|
580
560
|
* </p>
|
|
581
561
|
* @public
|
|
582
562
|
*/
|
|
583
563
|
Description?: string | undefined;
|
|
584
564
|
/**
|
|
585
|
-
* <p>
|
|
586
|
-
*
|
|
587
|
-
* collections that are associated with the direct query data source.
|
|
588
|
-
* </p>
|
|
565
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated
|
|
566
|
+
* with the direct query data source. </p>
|
|
589
567
|
* @public
|
|
590
568
|
*/
|
|
591
569
|
OpenSearchArns: string[] | undefined;
|
|
@@ -600,9 +578,7 @@ export interface AddDirectQueryDataSourceRequest {
|
|
|
600
578
|
*/
|
|
601
579
|
export interface AddDirectQueryDataSourceResponse {
|
|
602
580
|
/**
|
|
603
|
-
* <p>
|
|
604
|
-
* The unique, system-generated identifier that represents the data source.
|
|
605
|
-
* </p>
|
|
581
|
+
* <p> The unique, system-generated identifier that represents the data source. </p>
|
|
606
582
|
* @public
|
|
607
583
|
*/
|
|
608
584
|
DataSourceArn?: string | undefined;
|
|
@@ -677,7 +653,7 @@ export interface AddTagsRequest {
|
|
|
677
653
|
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a string
|
|
678
654
|
* rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean
|
|
679
655
|
* query. Default is 1,024. Queries with more than the permitted number of clauses result in a
|
|
680
|
-
*
|
|
656
|
+
* <code>TooManyClauses</code> error.</p>
|
|
681
657
|
* </li>
|
|
682
658
|
* <li>
|
|
683
659
|
* <p>
|
|
@@ -796,7 +772,8 @@ export interface AdvancedSecurityOptions {
|
|
|
796
772
|
*/
|
|
797
773
|
SAMLOptions?: SAMLOptionsOutput | undefined;
|
|
798
774
|
/**
|
|
799
|
-
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
775
|
+
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
776
|
+
* Service.</p>
|
|
800
777
|
* @public
|
|
801
778
|
*/
|
|
802
779
|
JWTOptions?: JWTOptionsOutput | undefined;
|
|
@@ -815,7 +792,8 @@ export interface AdvancedSecurityOptions {
|
|
|
815
792
|
AnonymousAuthEnabled?: boolean | undefined;
|
|
816
793
|
}
|
|
817
794
|
/**
|
|
818
|
-
* <p>The JWT authentication and authorization configuration for an Amazon OpenSearch Service
|
|
795
|
+
* <p>The JWT authentication and authorization configuration for an Amazon OpenSearch Service
|
|
796
|
+
* domain.</p>
|
|
819
797
|
* @public
|
|
820
798
|
*/
|
|
821
799
|
export interface JWTOptionsInput {
|
|
@@ -902,8 +880,8 @@ export interface SAMLOptionsInput {
|
|
|
902
880
|
*/
|
|
903
881
|
RolesKey?: string | undefined;
|
|
904
882
|
/**
|
|
905
|
-
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are
|
|
906
|
-
* and the default value is 60.</p>
|
|
883
|
+
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are
|
|
884
|
+
* between 1 and 1440, and the default value is 60.</p>
|
|
907
885
|
* @public
|
|
908
886
|
*/
|
|
909
887
|
SessionTimeoutMinutes?: number | undefined;
|
|
@@ -935,7 +913,8 @@ export interface AdvancedSecurityOptionsInput {
|
|
|
935
913
|
*/
|
|
936
914
|
SAMLOptions?: SAMLOptionsInput | undefined;
|
|
937
915
|
/**
|
|
938
|
-
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service.
|
|
916
|
+
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service.
|
|
917
|
+
* </p>
|
|
939
918
|
* @public
|
|
940
919
|
*/
|
|
941
920
|
JWTOptions?: JWTOptionsInput | undefined;
|
|
@@ -976,26 +955,45 @@ export declare const NaturalLanguageQueryGenerationDesiredState: {
|
|
|
976
955
|
*/
|
|
977
956
|
export type NaturalLanguageQueryGenerationDesiredState = (typeof NaturalLanguageQueryGenerationDesiredState)[keyof typeof NaturalLanguageQueryGenerationDesiredState];
|
|
978
957
|
/**
|
|
979
|
-
* <p>Container for parameters required to enable the natural language query generation
|
|
958
|
+
* <p>Container for parameters required to enable the natural language query generation
|
|
959
|
+
* feature.</p>
|
|
980
960
|
* @public
|
|
981
961
|
*/
|
|
982
962
|
export interface NaturalLanguageQueryGenerationOptionsInput {
|
|
983
963
|
/**
|
|
984
|
-
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED
|
|
964
|
+
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED
|
|
965
|
+
* and DISABLED.</p>
|
|
985
966
|
* @public
|
|
986
967
|
*/
|
|
987
968
|
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
988
969
|
}
|
|
970
|
+
/**
|
|
971
|
+
* <p>Options for enabling S3 vectors engine features on the specified domain.</p>
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
export interface S3VectorsEngine {
|
|
975
|
+
/**
|
|
976
|
+
* <p>Enables S3 vectors engine features.</p>
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
Enabled?: boolean | undefined;
|
|
980
|
+
}
|
|
989
981
|
/**
|
|
990
982
|
* <p>Container for parameters required to enable all machine learning features.</p>
|
|
991
983
|
* @public
|
|
992
984
|
*/
|
|
993
985
|
export interface AIMLOptionsInput {
|
|
994
986
|
/**
|
|
995
|
-
* <p>Container for parameters required for natural language query generation on the specified
|
|
987
|
+
* <p>Container for parameters required for natural language query generation on the specified
|
|
988
|
+
* domain.</p>
|
|
996
989
|
* @public
|
|
997
990
|
*/
|
|
998
991
|
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsInput | undefined;
|
|
992
|
+
/**
|
|
993
|
+
* <p>Container for parameters required to enable S3 vectors engine features on the specified domain.</p>
|
|
994
|
+
* @public
|
|
995
|
+
*/
|
|
996
|
+
S3VectorsEngine?: S3VectorsEngine | undefined;
|
|
999
997
|
}
|
|
1000
998
|
/**
|
|
1001
999
|
* @public
|
|
@@ -1015,31 +1013,41 @@ export declare const NaturalLanguageQueryGenerationCurrentState: {
|
|
|
1015
1013
|
*/
|
|
1016
1014
|
export type NaturalLanguageQueryGenerationCurrentState = (typeof NaturalLanguageQueryGenerationCurrentState)[keyof typeof NaturalLanguageQueryGenerationCurrentState];
|
|
1017
1015
|
/**
|
|
1018
|
-
* <p>Container for parameters representing the state of the natural language query generation
|
|
1016
|
+
* <p>Container for parameters representing the state of the natural language query generation
|
|
1017
|
+
* feature on the specified domain.</p>
|
|
1019
1018
|
* @public
|
|
1020
1019
|
*/
|
|
1021
1020
|
export interface NaturalLanguageQueryGenerationOptionsOutput {
|
|
1022
1021
|
/**
|
|
1023
|
-
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED
|
|
1022
|
+
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED
|
|
1023
|
+
* and DISABLED.</p>
|
|
1024
1024
|
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
1027
1027
|
/**
|
|
1028
|
-
* <p>The current state of the natural language query generation feature, indicating completion,
|
|
1028
|
+
* <p>The current state of the natural language query generation feature, indicating completion,
|
|
1029
|
+
* in progress, or failure.</p>
|
|
1029
1030
|
* @public
|
|
1030
1031
|
*/
|
|
1031
1032
|
CurrentState?: NaturalLanguageQueryGenerationCurrentState | undefined;
|
|
1032
1033
|
}
|
|
1033
1034
|
/**
|
|
1034
|
-
* <p>Container for parameters representing the state of machine learning features on the
|
|
1035
|
+
* <p>Container for parameters representing the state of machine learning features on the
|
|
1036
|
+
* specified domain.</p>
|
|
1035
1037
|
* @public
|
|
1036
1038
|
*/
|
|
1037
1039
|
export interface AIMLOptionsOutput {
|
|
1038
1040
|
/**
|
|
1039
|
-
* <p>Container for parameters required for natural language query generation on the specified
|
|
1041
|
+
* <p>Container for parameters required for natural language query generation on the specified
|
|
1042
|
+
* domain.</p>
|
|
1040
1043
|
* @public
|
|
1041
1044
|
*/
|
|
1042
1045
|
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsOutput | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>Container for parameters representing the state of S3 vectors engine features on the specified domain.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
S3VectorsEngine?: S3VectorsEngine | undefined;
|
|
1043
1051
|
}
|
|
1044
1052
|
/**
|
|
1045
1053
|
* <p>The status of machine learning options on the specified domain.</p>
|
|
@@ -1058,7 +1066,8 @@ export interface AIMLOptionsStatus {
|
|
|
1058
1066
|
Status?: OptionStatus | undefined;
|
|
1059
1067
|
}
|
|
1060
1068
|
/**
|
|
1061
|
-
* <p>The configuration parameters to enable access to the key store required by the
|
|
1069
|
+
* <p>The configuration parameters to enable access to the key store required by the
|
|
1070
|
+
* package.</p>
|
|
1062
1071
|
* @public
|
|
1063
1072
|
*/
|
|
1064
1073
|
export interface KeyStoreAccessOption {
|
|
@@ -1079,7 +1088,8 @@ export interface KeyStoreAccessOption {
|
|
|
1079
1088
|
*/
|
|
1080
1089
|
export interface PackageAssociationConfiguration {
|
|
1081
1090
|
/**
|
|
1082
|
-
* <p>The configuration parameters to enable accessing the key store required by the
|
|
1091
|
+
* <p>The configuration parameters to enable accessing the key store required by the
|
|
1092
|
+
* package.</p>
|
|
1083
1093
|
* @public
|
|
1084
1094
|
*/
|
|
1085
1095
|
KeyStoreAccessOption?: KeyStoreAccessOption | undefined;
|
|
@@ -1090,8 +1100,8 @@ export interface PackageAssociationConfiguration {
|
|
|
1090
1100
|
*/
|
|
1091
1101
|
export interface AssociatePackageRequest {
|
|
1092
1102
|
/**
|
|
1093
|
-
* <p>Internal ID of the package to associate with a domain. Use <code>DescribePackages</code> to
|
|
1094
|
-
*
|
|
1103
|
+
* <p>Internal ID of the package to associate with a domain. Use <code>DescribePackages</code> to
|
|
1104
|
+
* find this value. </p>
|
|
1095
1105
|
* @public
|
|
1096
1106
|
*/
|
|
1097
1107
|
PackageID: string | undefined;
|
|
@@ -1101,7 +1111,8 @@ export interface AssociatePackageRequest {
|
|
|
1101
1111
|
*/
|
|
1102
1112
|
DomainName: string | undefined;
|
|
1103
1113
|
/**
|
|
1104
|
-
* <p>A list of package IDs that must be associated with the domain before the package specified
|
|
1114
|
+
* <p>A list of package IDs that must be associated with the domain before the package specified
|
|
1115
|
+
* in the request can be associated.</p>
|
|
1105
1116
|
* @public
|
|
1106
1117
|
*/
|
|
1107
1118
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
@@ -1198,13 +1209,14 @@ export interface DomainPackageDetails {
|
|
|
1198
1209
|
*/
|
|
1199
1210
|
PackageVersion?: string | undefined;
|
|
1200
1211
|
/**
|
|
1201
|
-
* <p>A list of package IDs that must be associated with the domain before or with the package can
|
|
1212
|
+
* <p>A list of package IDs that must be associated with the domain before or with the package can
|
|
1213
|
+
* be associated.</p>
|
|
1202
1214
|
* @public
|
|
1203
1215
|
*/
|
|
1204
1216
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
1205
1217
|
/**
|
|
1206
|
-
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is
|
|
1207
|
-
*
|
|
1218
|
+
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is
|
|
1219
|
+
* <code>synonym_path</code> when the package is for synonym files.</p>
|
|
1208
1220
|
* @public
|
|
1209
1221
|
*/
|
|
1210
1222
|
ReferencePath?: string | undefined;
|
|
@@ -1253,7 +1265,8 @@ export interface PackageDetailsForAssociation {
|
|
|
1253
1265
|
*/
|
|
1254
1266
|
PackageID: string | undefined;
|
|
1255
1267
|
/**
|
|
1256
|
-
* <p>List of package IDs that must be linked to the domain before or simultaneously with the
|
|
1268
|
+
* <p>List of package IDs that must be linked to the domain before or simultaneously with the
|
|
1269
|
+
* package association.</p>
|
|
1257
1270
|
* @public
|
|
1258
1271
|
*/
|
|
1259
1272
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
@@ -1344,7 +1357,8 @@ export interface AuthorizedPrincipal {
|
|
|
1344
1357
|
*/
|
|
1345
1358
|
PrincipalType?: PrincipalType | undefined;
|
|
1346
1359
|
/**
|
|
1347
|
-
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM principal</a> that
|
|
1360
|
+
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM principal</a> that
|
|
1361
|
+
* is allowed access to the domain.</p>
|
|
1348
1362
|
* @public
|
|
1349
1363
|
*/
|
|
1350
1364
|
Principal?: string | undefined;
|
|
@@ -1371,7 +1385,8 @@ export interface CancelDomainConfigChangeRequest {
|
|
|
1371
1385
|
*/
|
|
1372
1386
|
DomainName: string | undefined;
|
|
1373
1387
|
/**
|
|
1374
|
-
* <p>When set to <code>True</code>, returns the list of change IDs and properties that will be
|
|
1388
|
+
* <p>When set to <code>True</code>, returns the list of change IDs and properties that will be
|
|
1389
|
+
* cancelled without actually cancelling the change.</p>
|
|
1375
1390
|
* @public
|
|
1376
1391
|
*/
|
|
1377
1392
|
DryRun?: boolean | undefined;
|
|
@@ -1387,7 +1402,8 @@ export interface CancelledChangeProperty {
|
|
|
1387
1402
|
*/
|
|
1388
1403
|
PropertyName?: string | undefined;
|
|
1389
1404
|
/**
|
|
1390
|
-
* <p>The pending value of the property that was cancelled. This would have been the eventual
|
|
1405
|
+
* <p>The pending value of the property that was cancelled. This would have been the eventual
|
|
1406
|
+
* value of the property if the chance had not been cancelled.</p>
|
|
1391
1407
|
* @public
|
|
1392
1408
|
*/
|
|
1393
1409
|
CancelledValue?: string | undefined;
|
|
@@ -1412,7 +1428,8 @@ export interface CancelDomainConfigChangeResponse {
|
|
|
1412
1428
|
*/
|
|
1413
1429
|
CancelledChangeProperties?: CancelledChangeProperty[] | undefined;
|
|
1414
1430
|
/**
|
|
1415
|
-
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not
|
|
1431
|
+
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not
|
|
1432
|
+
* actually cancelled. </p>
|
|
1416
1433
|
* @public
|
|
1417
1434
|
*/
|
|
1418
1435
|
DryRun?: boolean | undefined;
|
|
@@ -1484,8 +1501,8 @@ export interface ServiceSoftwareOptions {
|
|
|
1484
1501
|
*/
|
|
1485
1502
|
Description?: string | undefined;
|
|
1486
1503
|
/**
|
|
1487
|
-
* <p>The timestamp, in Epoch time, until which you can manually request a service software
|
|
1488
|
-
* we automatically update your service software.</p>
|
|
1504
|
+
* <p>The timestamp, in Epoch time, until which you can manually request a service software
|
|
1505
|
+
* update. After this date, we automatically update your service software.</p>
|
|
1489
1506
|
* @public
|
|
1490
1507
|
*/
|
|
1491
1508
|
AutomatedUpdateDate?: Date | undefined;
|
|
@@ -1521,8 +1538,8 @@ export declare const AppConfigType: {
|
|
|
1521
1538
|
*/
|
|
1522
1539
|
export type AppConfigType = (typeof AppConfigType)[keyof typeof AppConfigType];
|
|
1523
1540
|
/**
|
|
1524
|
-
* <p>Configuration settings for an OpenSearch application. For more information, see
|
|
1525
|
-
*
|
|
1541
|
+
* <p>Configuration settings for an OpenSearch application. For more information, see see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using the
|
|
1542
|
+
* OpenSearch user interface in Amazon OpenSearch Service</a>.</p>
|
|
1526
1543
|
* @public
|
|
1527
1544
|
*/
|
|
1528
1545
|
export interface AppConfig {
|
|
@@ -1538,14 +1555,13 @@ export interface AppConfig {
|
|
|
1538
1555
|
value?: string | undefined;
|
|
1539
1556
|
}
|
|
1540
1557
|
/**
|
|
1541
|
-
* <p>Data sources that are associated with an OpenSearch
|
|
1558
|
+
* <p>Data sources that are associated with an OpenSearch application. </p>
|
|
1542
1559
|
* @public
|
|
1543
1560
|
*/
|
|
1544
1561
|
export interface DataSource {
|
|
1545
1562
|
/**
|
|
1546
|
-
* <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
|
|
1547
|
-
*
|
|
1548
|
-
* </p>
|
|
1563
|
+
* <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 </a> in <i>Using
|
|
1564
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
1549
1565
|
* @public
|
|
1550
1566
|
*/
|
|
1551
1567
|
dataSourceArn?: string | undefined;
|
|
@@ -1566,9 +1582,8 @@ export interface IamIdentityCenterOptionsInput {
|
|
|
1566
1582
|
*/
|
|
1567
1583
|
enabled?: boolean | undefined;
|
|
1568
1584
|
/**
|
|
1569
|
-
* <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
|
|
1570
|
-
*
|
|
1571
|
-
* </p>
|
|
1585
|
+
* <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 </a> in <i>Using
|
|
1586
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
1572
1587
|
* @public
|
|
1573
1588
|
*/
|
|
1574
1589
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
@@ -1598,12 +1613,14 @@ export interface CreateApplicationRequest {
|
|
|
1598
1613
|
*/
|
|
1599
1614
|
dataSources?: DataSource[] | undefined;
|
|
1600
1615
|
/**
|
|
1601
|
-
* <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the
|
|
1616
|
+
* <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the
|
|
1617
|
+
* OpenSearch application.</p>
|
|
1602
1618
|
* @public
|
|
1603
1619
|
*/
|
|
1604
1620
|
iamIdentityCenterOptions?: IamIdentityCenterOptionsInput | undefined;
|
|
1605
1621
|
/**
|
|
1606
|
-
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1622
|
+
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1623
|
+
* options.</p>
|
|
1607
1624
|
* @public
|
|
1608
1625
|
*/
|
|
1609
1626
|
appConfigs?: AppConfig[] | undefined;
|
|
@@ -1614,31 +1631,30 @@ export interface CreateApplicationRequest {
|
|
|
1614
1631
|
tagList?: Tag[] | undefined;
|
|
1615
1632
|
}
|
|
1616
1633
|
/**
|
|
1617
|
-
* <p>Configuration settings for IAM Identity Center in an OpenSearch
|
|
1634
|
+
* <p>Configuration settings for IAM Identity Center in an OpenSearch application.</p>
|
|
1618
1635
|
* @public
|
|
1619
1636
|
*/
|
|
1620
1637
|
export interface IamIdentityCenterOptions {
|
|
1621
1638
|
/**
|
|
1622
|
-
* <p>Indicates whether IAM Identity Center is enabled for the OpenSearch
|
|
1639
|
+
* <p>Indicates whether IAM Identity Center is enabled for the OpenSearch application.</p>
|
|
1623
1640
|
* @public
|
|
1624
1641
|
*/
|
|
1625
1642
|
enabled?: boolean | undefined;
|
|
1626
1643
|
/**
|
|
1627
|
-
* <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
|
|
1628
|
-
*
|
|
1629
|
-
* </p>
|
|
1644
|
+
* <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 </a> in <i>Using
|
|
1645
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
1630
1646
|
* @public
|
|
1631
1647
|
*/
|
|
1632
1648
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
1633
1649
|
/**
|
|
1634
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center
|
|
1650
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center
|
|
1651
|
+
* application for the OpenSearch application.</p>
|
|
1635
1652
|
* @public
|
|
1636
1653
|
*/
|
|
1637
1654
|
iamRoleForIdentityCenterApplicationArn?: string | undefined;
|
|
1638
1655
|
/**
|
|
1639
|
-
* <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
|
|
1640
|
-
*
|
|
1641
|
-
* </p>
|
|
1656
|
+
* <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 </a> in <i>Using
|
|
1657
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
1642
1658
|
* @public
|
|
1643
1659
|
*/
|
|
1644
1660
|
iamIdentityCenterApplicationArn?: string | undefined;
|
|
@@ -1658,9 +1674,8 @@ export interface CreateApplicationResponse {
|
|
|
1658
1674
|
*/
|
|
1659
1675
|
name?: string | undefined;
|
|
1660
1676
|
/**
|
|
1661
|
-
* <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
|
|
1662
|
-
*
|
|
1663
|
-
* </p>
|
|
1677
|
+
* <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 </a> in <i>Using
|
|
1678
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
1664
1679
|
* @public
|
|
1665
1680
|
*/
|
|
1666
1681
|
arn?: string | undefined;
|
|
@@ -1675,7 +1690,8 @@ export interface CreateApplicationResponse {
|
|
|
1675
1690
|
*/
|
|
1676
1691
|
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
1677
1692
|
/**
|
|
1678
|
-
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1693
|
+
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1694
|
+
* options.</p>
|
|
1679
1695
|
* @public
|
|
1680
1696
|
*/
|
|
1681
1697
|
appConfigs?: AppConfig[] | undefined;
|
|
@@ -1733,11 +1749,10 @@ export interface Duration {
|
|
|
1733
1749
|
/**
|
|
1734
1750
|
* <note>
|
|
1735
1751
|
* <p>This object is deprecated. Use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak window</a> to
|
|
1736
|
-
* schedule Auto-Tune optimizations. For migration instructions, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate">Migrating from
|
|
1737
|
-
* maintenance windows</a>.</p>
|
|
1752
|
+
* schedule Auto-Tune optimizations. For migration instructions, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate">Migrating from
|
|
1753
|
+
* Auto-Tune maintenance windows</a>.</p>
|
|
1738
1754
|
* </note>
|
|
1739
|
-
* <p>The Auto-Tune maintenance schedule.
|
|
1740
|
-
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch
|
|
1755
|
+
* <p>The Auto-Tune maintenance schedule. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch
|
|
1741
1756
|
* Service</a>.</p>
|
|
1742
1757
|
* @public
|
|
1743
1758
|
*/
|
|
@@ -1773,12 +1788,14 @@ export interface AutoTuneOptionsInput {
|
|
|
1773
1788
|
*/
|
|
1774
1789
|
DesiredState?: AutoTuneDesiredState | undefined;
|
|
1775
1790
|
/**
|
|
1776
|
-
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance
|
|
1791
|
+
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance
|
|
1792
|
+
* windows are deprecated and have been replaced with <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak windows</a>.</p>
|
|
1777
1793
|
* @public
|
|
1778
1794
|
*/
|
|
1779
1795
|
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[] | undefined;
|
|
1780
1796
|
/**
|
|
1781
|
-
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the
|
|
1797
|
+
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the
|
|
1798
|
+
* domain's configured daily off-peak window.</p>
|
|
1782
1799
|
* @public
|
|
1783
1800
|
*/
|
|
1784
1801
|
UseOffPeakWindow?: boolean | undefined;
|
|
@@ -1791,7 +1808,8 @@ export interface AutoTuneOptionsInput {
|
|
|
1791
1808
|
*/
|
|
1792
1809
|
export interface ColdStorageOptions {
|
|
1793
1810
|
/**
|
|
1794
|
-
* <p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage
|
|
1811
|
+
* <p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage
|
|
1812
|
+
* to enable cold storage.</p>
|
|
1795
1813
|
* @public
|
|
1796
1814
|
*/
|
|
1797
1815
|
Enabled: boolean | undefined;
|
|
@@ -1985,7 +2003,8 @@ export interface ZoneAwarenessConfig {
|
|
|
1985
2003
|
}
|
|
1986
2004
|
/**
|
|
1987
2005
|
* <p>Container for the cluster configuration of an OpenSearch Service domain. For more
|
|
1988
|
-
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html">Creating and managing
|
|
2006
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html">Creating and managing
|
|
2007
|
+
* Amazon OpenSearch Service domains</a>.</p>
|
|
1989
2008
|
* @public
|
|
1990
2009
|
*/
|
|
1991
2010
|
export interface ClusterConfig {
|
|
@@ -2023,8 +2042,8 @@ export interface ClusterConfig {
|
|
|
2023
2042
|
*/
|
|
2024
2043
|
DedicatedMasterType?: OpenSearchPartitionInstanceType | undefined;
|
|
2025
2044
|
/**
|
|
2026
|
-
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not
|
|
2027
|
-
* otherwise you receive a validation exception.</p>
|
|
2045
|
+
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not
|
|
2046
|
+
* 4, otherwise you receive a validation exception.</p>
|
|
2028
2047
|
* @public
|
|
2029
2048
|
*/
|
|
2030
2049
|
DedicatedMasterCount?: number | undefined;
|
|
@@ -2049,7 +2068,9 @@ export interface ClusterConfig {
|
|
|
2049
2068
|
*/
|
|
2050
2069
|
ColdStorageOptions?: ColdStorageOptions | undefined;
|
|
2051
2070
|
/**
|
|
2052
|
-
* <p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more
|
|
2071
|
+
* <p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more
|
|
2072
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ
|
|
2073
|
+
* domain in Amazon OpenSearch Service</a>. </p>
|
|
2053
2074
|
* @public
|
|
2054
2075
|
*/
|
|
2055
2076
|
MultiAZWithStandbyEnabled?: boolean | undefined;
|
|
@@ -2204,9 +2225,9 @@ export interface EBSOptions {
|
|
|
2204
2225
|
}
|
|
2205
2226
|
/**
|
|
2206
2227
|
* <p>Specifies whether the domain should encrypt data at rest, and if so, the Key Management
|
|
2207
|
-
* Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at
|
|
2208
|
-
* for the first time on an existing domain. You can't modify this parameter after it's already
|
|
2209
|
-
* specified.</p>
|
|
2228
|
+
* Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at
|
|
2229
|
+
* rest for the first time on an existing domain. You can't modify this parameter after it's already
|
|
2230
|
+
* been specified.</p>
|
|
2210
2231
|
* @public
|
|
2211
2232
|
*/
|
|
2212
2233
|
export interface EncryptionAtRestOptions {
|
|
@@ -2252,22 +2273,26 @@ export type SubjectKeyIdCOption = (typeof SubjectKeyIdCOption)[keyof typeof Subj
|
|
|
2252
2273
|
*/
|
|
2253
2274
|
export interface IdentityCenterOptionsInput {
|
|
2254
2275
|
/**
|
|
2255
|
-
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch
|
|
2276
|
+
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch
|
|
2277
|
+
* Service.</p>
|
|
2256
2278
|
* @public
|
|
2257
2279
|
*/
|
|
2258
2280
|
EnabledAPIAccess?: boolean | undefined;
|
|
2259
2281
|
/**
|
|
2260
|
-
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that
|
|
2282
|
+
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that
|
|
2283
|
+
* uses IAM Identity Center for authentication.</p>
|
|
2261
2284
|
* @public
|
|
2262
2285
|
*/
|
|
2263
2286
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2264
2287
|
/**
|
|
2265
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2288
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2289
|
+
* email) in IAM Identity Center.</p>
|
|
2266
2290
|
* @public
|
|
2267
2291
|
*/
|
|
2268
2292
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2269
2293
|
/**
|
|
2270
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2294
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2295
|
+
* group ID) in IAM Identity Center.</p>
|
|
2271
2296
|
* @public
|
|
2272
2297
|
*/
|
|
2273
2298
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
@@ -2300,7 +2325,8 @@ export declare const LogType: {
|
|
|
2300
2325
|
export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
2301
2326
|
/**
|
|
2302
2327
|
* <p>Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application
|
|
2303
|
-
* and slow logs to Amazon CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html">Monitoring
|
|
2328
|
+
* and slow logs to Amazon CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html">Monitoring
|
|
2329
|
+
* OpenSearch logs with Amazon CloudWatch Logs</a>.</p>
|
|
2304
2330
|
* <note>
|
|
2305
2331
|
* <p>After you enable log publishing, you still have to enable the collection of slow logs using
|
|
2306
2332
|
* the OpenSearch REST API.</p>
|
|
@@ -2320,7 +2346,8 @@ export interface LogPublishingOption {
|
|
|
2320
2346
|
Enabled?: boolean | undefined;
|
|
2321
2347
|
}
|
|
2322
2348
|
/**
|
|
2323
|
-
* <p>Enables or disables node-to-node encryption. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html">Node-to-node
|
|
2349
|
+
* <p>Enables or disables node-to-node encryption. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html">Node-to-node
|
|
2350
|
+
* encryption for Amazon OpenSearch Service</a>.</p>
|
|
2324
2351
|
* @public
|
|
2325
2352
|
*/
|
|
2326
2353
|
export interface NodeToNodeEncryptionOptions {
|
|
@@ -2337,8 +2364,8 @@ export interface NodeToNodeEncryptionOptions {
|
|
|
2337
2364
|
*/
|
|
2338
2365
|
export interface WindowStartTime {
|
|
2339
2366
|
/**
|
|
2340
|
-
* <p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For
|
|
2341
|
-
* 5:00 P.M. UTC.</p>
|
|
2367
|
+
* <p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For
|
|
2368
|
+
* example, <code>17</code> refers to 5:00 P.M. UTC.</p>
|
|
2342
2369
|
* @public
|
|
2343
2370
|
*/
|
|
2344
2371
|
Hours: number | undefined;
|
|
@@ -2351,8 +2378,8 @@ export interface WindowStartTime {
|
|
|
2351
2378
|
/**
|
|
2352
2379
|
* <p>A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory
|
|
2353
2380
|
* configuration changes on the domain. These actions can include scheduled service software updates
|
|
2354
|
-
* and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these
|
|
2355
|
-
*
|
|
2381
|
+
* and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the
|
|
2382
|
+
* window that you specify.</p>
|
|
2356
2383
|
* <p>If you don't specify a window start time, it defaults to 10:00 P.M. local time.</p>
|
|
2357
2384
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">Defining off-peak maintenance
|
|
2358
2385
|
* windows for Amazon OpenSearch Service</a>.</p>
|
|
@@ -2427,7 +2454,8 @@ export interface VPCOptions {
|
|
|
2427
2454
|
SubnetIds?: string[] | undefined;
|
|
2428
2455
|
/**
|
|
2429
2456
|
* <p>The list of security group IDs associated with the VPC endpoints for the domain. If you do
|
|
2430
|
-
* not provide a security group ID, OpenSearch Service uses the default security group for the
|
|
2457
|
+
* not provide a security group ID, OpenSearch Service uses the default security group for the
|
|
2458
|
+
* VPC.</p>
|
|
2431
2459
|
* @public
|
|
2432
2460
|
*/
|
|
2433
2461
|
SecurityGroupIds?: string[] | undefined;
|
|
@@ -2469,8 +2497,8 @@ export interface CreateDomainRequest {
|
|
|
2469
2497
|
AccessPolicies?: string | undefined;
|
|
2470
2498
|
/**
|
|
2471
2499
|
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share
|
|
2472
|
-
* domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
2473
|
-
*
|
|
2500
|
+
* domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set
|
|
2501
|
+
* your IP address type to dual stack, you can't change your address type later.</p>
|
|
2474
2502
|
* @public
|
|
2475
2503
|
*/
|
|
2476
2504
|
IPAddressType?: IPAddressType | undefined;
|
|
@@ -2557,7 +2585,8 @@ export interface CreateDomainRequest {
|
|
|
2557
2585
|
*/
|
|
2558
2586
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
2559
2587
|
/**
|
|
2560
|
-
* <p>Configuration options for enabling and managing IAM Identity Center integration within a
|
|
2588
|
+
* <p>Configuration options for enabling and managing IAM Identity Center integration within a
|
|
2589
|
+
* domain.</p>
|
|
2561
2590
|
* @public
|
|
2562
2591
|
*/
|
|
2563
2592
|
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
@@ -2625,8 +2654,8 @@ export interface AutoTuneOptionsOutput {
|
|
|
2625
2654
|
*/
|
|
2626
2655
|
ErrorMessage?: string | undefined;
|
|
2627
2656
|
/**
|
|
2628
|
-
* <p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather
|
|
2629
|
-
*
|
|
2657
|
+
* <p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a
|
|
2658
|
+
* maintenance schedule.</p>
|
|
2630
2659
|
* @public
|
|
2631
2660
|
*/
|
|
2632
2661
|
UseOffPeakWindow?: boolean | undefined;
|
|
@@ -2687,7 +2716,8 @@ export interface ChangeProgressDetails {
|
|
|
2687
2716
|
*/
|
|
2688
2717
|
InitiatedBy?: InitiatedBy | undefined;
|
|
2689
2718
|
/**
|
|
2690
|
-
* <p>The time that the configuration change was initiated, in Universal Coordinated Time
|
|
2719
|
+
* <p>The time that the configuration change was initiated, in Universal Coordinated Time
|
|
2720
|
+
* (UTC).</p>
|
|
2691
2721
|
* @public
|
|
2692
2722
|
*/
|
|
2693
2723
|
StartTime?: Date | undefined;
|
|
@@ -2716,8 +2746,9 @@ export declare const DomainProcessingStatusType: {
|
|
|
2716
2746
|
export type DomainProcessingStatusType = (typeof DomainProcessingStatusType)[keyof typeof DomainProcessingStatusType];
|
|
2717
2747
|
/**
|
|
2718
2748
|
* <p>Settings container for integrating IAM Identity Center with OpenSearch UI applications,
|
|
2719
|
-
* which enables enabling secure user authentication and access control across multiple data
|
|
2720
|
-
* This setup supports single sign-on (SSO) through IAM Identity Center, allowing
|
|
2749
|
+
* which enables enabling secure user authentication and access control across multiple data
|
|
2750
|
+
* sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing
|
|
2751
|
+
* centralized user management.</p>
|
|
2721
2752
|
* @public
|
|
2722
2753
|
*/
|
|
2723
2754
|
export interface IdentityCenterOptions {
|
|
@@ -2732,17 +2763,20 @@ export interface IdentityCenterOptions {
|
|
|
2732
2763
|
*/
|
|
2733
2764
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2734
2765
|
/**
|
|
2735
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2766
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2767
|
+
* email) in IAM Identity Center.</p>
|
|
2736
2768
|
* @public
|
|
2737
2769
|
*/
|
|
2738
2770
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2739
2771
|
/**
|
|
2740
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2772
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2773
|
+
* group ID) in IAM Identity Center.</p>
|
|
2741
2774
|
* @public
|
|
2742
2775
|
*/
|
|
2743
2776
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
2744
2777
|
/**
|
|
2745
|
-
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch
|
|
2778
|
+
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch
|
|
2779
|
+
* Service.</p>
|
|
2746
2780
|
* @public
|
|
2747
2781
|
*/
|
|
2748
2782
|
IdentityCenterApplicationARN?: string | undefined;
|
|
@@ -2789,11 +2823,13 @@ export interface ModifyingProperties {
|
|
|
2789
2823
|
* <ul>
|
|
2790
2824
|
* <li>
|
|
2791
2825
|
* <p>
|
|
2792
|
-
* <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or
|
|
2826
|
+
* <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or
|
|
2827
|
+
* "c5.large.search".</p>
|
|
2793
2828
|
* </li>
|
|
2794
2829
|
* <li>
|
|
2795
2830
|
* <p>
|
|
2796
|
-
* <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as
|
|
2831
|
+
* <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as
|
|
2832
|
+
* \{"Enabled":"True"\}".</p>
|
|
2797
2833
|
* </li>
|
|
2798
2834
|
* </ul>
|
|
2799
2835
|
* @public
|
|
@@ -2871,15 +2907,15 @@ export interface DomainStatus {
|
|
|
2871
2907
|
*/
|
|
2872
2908
|
Endpoint?: string | undefined;
|
|
2873
2909
|
/**
|
|
2874
|
-
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint
|
|
2875
|
-
* This endpoint functions like a normal endpoint, except that it works with both
|
|
2876
|
-
* Normal endpoints work only with IPv4 IP addresses.
|
|
2877
|
-
* </p>
|
|
2910
|
+
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint
|
|
2911
|
+
* is provisioned. This endpoint functions like a normal endpoint, except that it works with both
|
|
2912
|
+
* IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. </p>
|
|
2878
2913
|
* @public
|
|
2879
2914
|
*/
|
|
2880
2915
|
EndpointV2?: string | undefined;
|
|
2881
2916
|
/**
|
|
2882
|
-
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For
|
|
2917
|
+
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For
|
|
2918
|
+
* example:</p>
|
|
2883
2919
|
* <ul>
|
|
2884
2920
|
* <li>
|
|
2885
2921
|
* <p>
|
|
@@ -2995,7 +3031,8 @@ export interface DomainStatus {
|
|
|
2995
3031
|
*/
|
|
2996
3032
|
AdvancedSecurityOptions?: AdvancedSecurityOptions | undefined;
|
|
2997
3033
|
/**
|
|
2998
|
-
* <p>Configuration options for controlling IAM Identity Center integration within a
|
|
3034
|
+
* <p>Configuration options for controlling IAM Identity Center integration within a
|
|
3035
|
+
* domain.</p>
|
|
2999
3036
|
* @public
|
|
3000
3037
|
*/
|
|
3001
3038
|
IdentityCenterOptions?: IdentityCenterOptions | undefined;
|
|
@@ -3187,40 +3224,43 @@ export interface OutboundConnectionStatus {
|
|
|
3187
3224
|
* </li>
|
|
3188
3225
|
* <li>
|
|
3189
3226
|
* <p>
|
|
3190
|
-
* <b>PENDING_ACCEPTANCE</b>: Outbound connection request is
|
|
3191
|
-
* not yet accepted by the remote domain owner.</p>
|
|
3227
|
+
* <b>PENDING_ACCEPTANCE</b>: Outbound connection request is
|
|
3228
|
+
* validated and is not yet accepted by the remote domain owner.</p>
|
|
3192
3229
|
* </li>
|
|
3193
3230
|
* <li>
|
|
3194
3231
|
* <p>
|
|
3195
|
-
* <b>APPROVED</b> - Outbound connection has been approved by the
|
|
3196
|
-
* owner for getting provisioned.</p>
|
|
3232
|
+
* <b>APPROVED</b> - Outbound connection has been approved by the
|
|
3233
|
+
* remote domain owner for getting provisioned.</p>
|
|
3197
3234
|
* </li>
|
|
3198
3235
|
* <li>
|
|
3199
3236
|
* <p>
|
|
3200
|
-
* <b>PROVISIONING</b> - Outbound connection request is in
|
|
3237
|
+
* <b>PROVISIONING</b> - Outbound connection request is in
|
|
3238
|
+
* process.</p>
|
|
3201
3239
|
* </li>
|
|
3202
3240
|
* <li>
|
|
3203
3241
|
* <p>
|
|
3204
|
-
* <b>ACTIVE</b> - Outbound connection is active and ready to
|
|
3242
|
+
* <b>ACTIVE</b> - Outbound connection is active and ready to
|
|
3243
|
+
* use.</p>
|
|
3205
3244
|
* </li>
|
|
3206
3245
|
* <li>
|
|
3207
3246
|
* <p>
|
|
3208
|
-
* <b>REJECTING</b> - Outbound connection rejection by remote
|
|
3209
|
-
* progress.</p>
|
|
3247
|
+
* <b>REJECTING</b> - Outbound connection rejection by remote
|
|
3248
|
+
* domain owner is in progress.</p>
|
|
3210
3249
|
* </li>
|
|
3211
3250
|
* <li>
|
|
3212
3251
|
* <p>
|
|
3213
|
-
* <b>REJECTED</b> - Outbound connection request is rejected by
|
|
3214
|
-
* owner.</p>
|
|
3252
|
+
* <b>REJECTED</b> - Outbound connection request is rejected by
|
|
3253
|
+
* remote domain owner.</p>
|
|
3215
3254
|
* </li>
|
|
3216
3255
|
* <li>
|
|
3217
3256
|
* <p>
|
|
3218
|
-
* <b>DELETING</b> - Outbound connection deletion is in
|
|
3257
|
+
* <b>DELETING</b> - Outbound connection deletion is in
|
|
3258
|
+
* progress.</p>
|
|
3219
3259
|
* </li>
|
|
3220
3260
|
* <li>
|
|
3221
3261
|
* <p>
|
|
3222
|
-
* <b>DELETED</b> - Outbound connection is deleted and can no
|
|
3223
|
-
* used.</p>
|
|
3262
|
+
* <b>DELETED</b> - Outbound connection is deleted and can no
|
|
3263
|
+
* longer be used.</p>
|
|
3224
3264
|
* </li>
|
|
3225
3265
|
* </ul>
|
|
3226
3266
|
* @public
|
|
@@ -3309,7 +3349,8 @@ export interface PackageConfiguration {
|
|
|
3309
3349
|
*/
|
|
3310
3350
|
ConfigurationRequirement: RequirementLevel | undefined;
|
|
3311
3351
|
/**
|
|
3312
|
-
* <p>This indicates whether a B/G deployment is required for updating the configuration that the
|
|
3352
|
+
* <p>This indicates whether a B/G deployment is required for updating the configuration that the
|
|
3353
|
+
* plugin is prerequisite for.</p>
|
|
3313
3354
|
* @public
|
|
3314
3355
|
*/
|
|
3315
3356
|
RequiresRestartForConfigurationUpdate?: boolean | undefined;
|
|
@@ -3347,12 +3388,14 @@ export interface PackageSource {
|
|
|
3347
3388
|
S3Key?: string | undefined;
|
|
3348
3389
|
}
|
|
3349
3390
|
/**
|
|
3350
|
-
* <p>Configuration options for determining whether a package can be made available for use by
|
|
3391
|
+
* <p>Configuration options for determining whether a package can be made available for use by
|
|
3392
|
+
* other users.</p>
|
|
3351
3393
|
* @public
|
|
3352
3394
|
*/
|
|
3353
3395
|
export interface PackageVendingOptions {
|
|
3354
3396
|
/**
|
|
3355
|
-
* <p>Indicates whether the package vending feature is enabled, allowing the package to be used by
|
|
3397
|
+
* <p>Indicates whether the package vending feature is enabled, allowing the package to be used by
|
|
3398
|
+
* other users.</p>
|
|
3356
3399
|
* @public
|
|
3357
3400
|
*/
|
|
3358
3401
|
VendingEnabled: boolean | undefined;
|
|
@@ -3388,13 +3431,15 @@ export interface CreatePackageRequest {
|
|
|
3388
3431
|
*/
|
|
3389
3432
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
3390
3433
|
/**
|
|
3391
|
-
* <p>The version of the Amazon OpenSearch Service engine for which is compatible with the
|
|
3434
|
+
* <p>The version of the Amazon OpenSearch Service engine for which is compatible with the
|
|
3435
|
+
* package. This can only be specified for package type <code>ZIP-PLUGIN</code>
|
|
3392
3436
|
* </p>
|
|
3393
3437
|
* @public
|
|
3394
3438
|
*/
|
|
3395
3439
|
EngineVersion?: string | undefined;
|
|
3396
3440
|
/**
|
|
3397
|
-
* <p> The vending options for the package being created. They determine if the package can be
|
|
3441
|
+
* <p> The vending options for the package being created. They determine if the package can be
|
|
3442
|
+
* vended to other users.</p>
|
|
3398
3443
|
* @public
|
|
3399
3444
|
*/
|
|
3400
3445
|
PackageVendingOptions?: PackageVendingOptions | undefined;
|
|
@@ -3479,7 +3524,9 @@ export interface PackageDetails {
|
|
|
3479
3524
|
*/
|
|
3480
3525
|
PackageDescription?: string | undefined;
|
|
3481
3526
|
/**
|
|
3482
|
-
* <p>The current status of the package. The available options are <code>AVAILABLE</code>,
|
|
3527
|
+
* <p>The current status of the package. The available options are <code>AVAILABLE</code>,
|
|
3528
|
+
* <code>COPYING</code>, <code>COPY_FAILED</code>, <code>VALIDATNG</code>,
|
|
3529
|
+
* <code>VALIDATION_FAILED</code>, <code>DELETING</code>, and <code>DELETE_FAILED</code>.</p>
|
|
3483
3530
|
* @public
|
|
3484
3531
|
*/
|
|
3485
3532
|
PackageStatus?: PackageStatus | undefined;
|
|
@@ -3510,7 +3557,8 @@ export interface PackageDetails {
|
|
|
3510
3557
|
*/
|
|
3511
3558
|
EngineVersion?: string | undefined;
|
|
3512
3559
|
/**
|
|
3513
|
-
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin
|
|
3560
|
+
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin
|
|
3561
|
+
* properties.</p>
|
|
3514
3562
|
* @public
|
|
3515
3563
|
*/
|
|
3516
3564
|
AvailablePluginProperties?: PluginProperties | undefined;
|
|
@@ -3520,12 +3568,14 @@ export interface PackageDetails {
|
|
|
3520
3568
|
*/
|
|
3521
3569
|
AvailablePackageConfiguration?: PackageConfiguration | undefined;
|
|
3522
3570
|
/**
|
|
3523
|
-
* <p> A list of users who are allowed to view and associate the package. This field is only
|
|
3571
|
+
* <p> A list of users who are allowed to view and associate the package. This field is only
|
|
3572
|
+
* visible to the owner of a package.</p>
|
|
3524
3573
|
* @public
|
|
3525
3574
|
*/
|
|
3526
3575
|
AllowListedUserList?: string[] | undefined;
|
|
3527
3576
|
/**
|
|
3528
|
-
* <p>The owner of the package who is allowed to create and update a package and add users to the
|
|
3577
|
+
* <p>The owner of the package who is allowed to create and update a package and add users to the
|
|
3578
|
+
* package scope.</p>
|
|
3529
3579
|
* @public
|
|
3530
3580
|
*/
|
|
3531
3581
|
PackageOwner?: string | undefined;
|
|
@@ -3652,8 +3702,7 @@ export interface DeleteApplicationRequest {
|
|
|
3652
3702
|
export interface DeleteApplicationResponse {
|
|
3653
3703
|
}
|
|
3654
3704
|
/**
|
|
3655
|
-
* <p>Container for the parameters to the <code>DeleteDataSource</code>
|
|
3656
|
-
* operation.</p>
|
|
3705
|
+
* <p>Container for the parameters to the <code>DeleteDataSource</code> operation.</p>
|
|
3657
3706
|
* @public
|
|
3658
3707
|
*/
|
|
3659
3708
|
export interface DeleteDataSourceRequest {
|
|
@@ -3684,10 +3733,8 @@ export interface DeleteDataSourceResponse {
|
|
|
3684
3733
|
*/
|
|
3685
3734
|
export interface DeleteDirectQueryDataSourceRequest {
|
|
3686
3735
|
/**
|
|
3687
|
-
* <p>
|
|
3688
|
-
*
|
|
3689
|
-
* within your OpenSearch Service environment.
|
|
3690
|
-
* </p>
|
|
3736
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch Service
|
|
3737
|
+
* environment. </p>
|
|
3691
3738
|
* @public
|
|
3692
3739
|
*/
|
|
3693
3740
|
DataSourceName: string | undefined;
|
|
@@ -3705,7 +3752,8 @@ export interface DeleteDomainRequest {
|
|
|
3705
3752
|
}
|
|
3706
3753
|
/**
|
|
3707
3754
|
* <p>The results of a <code>DeleteDomain</code> request. Contains the status of the pending
|
|
3708
|
-
* deletion, or a "domain not found" error if the domain and all of its resources have been
|
|
3755
|
+
* deletion, or a "domain not found" error if the domain and all of its resources have been
|
|
3756
|
+
* deleted.</p>
|
|
3709
3757
|
* @public
|
|
3710
3758
|
*/
|
|
3711
3759
|
export interface DeleteDomainResponse {
|
|
@@ -3808,7 +3856,8 @@ export interface DeleteOutboundConnectionResponse {
|
|
|
3808
3856
|
*/
|
|
3809
3857
|
export interface DeletePackageRequest {
|
|
3810
3858
|
/**
|
|
3811
|
-
* <p>The internal ID of the package you want to delete. Use <code>DescribePackages</code> to find
|
|
3859
|
+
* <p>The internal ID of the package you want to delete. Use <code>DescribePackages</code> to find
|
|
3860
|
+
* this value.</p>
|
|
3812
3861
|
* @public
|
|
3813
3862
|
*/
|
|
3814
3863
|
PackageID: string | undefined;
|
|
@@ -4022,8 +4071,8 @@ export interface DescribeDomainAutoTunesResponse {
|
|
|
4022
4071
|
AutoTunes?: AutoTune[] | undefined;
|
|
4023
4072
|
/**
|
|
4024
4073
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
4025
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
4026
|
-
* returned token to retrieve the next page.</p>
|
|
4074
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
4075
|
+
* the returned token to retrieve the next page.</p>
|
|
4027
4076
|
* @public
|
|
4028
4077
|
*/
|
|
4029
4078
|
NextToken?: string | undefined;
|
|
@@ -4122,7 +4171,8 @@ export interface ChangeProgressStatusDetails {
|
|
|
4122
4171
|
*/
|
|
4123
4172
|
TotalNumberOfStages?: number | undefined;
|
|
4124
4173
|
/**
|
|
4125
|
-
* <p>The specific stages that the domain is going through to perform the configuration
|
|
4174
|
+
* <p>The specific stages that the domain is going through to perform the configuration
|
|
4175
|
+
* change.</p>
|
|
4126
4176
|
* @public
|
|
4127
4177
|
*/
|
|
4128
4178
|
ChangeProgressStages?: ChangeProgressStage[] | undefined;
|
|
@@ -4149,7 +4199,8 @@ export interface ChangeProgressStatusDetails {
|
|
|
4149
4199
|
*/
|
|
4150
4200
|
export interface DescribeDomainChangeProgressResponse {
|
|
4151
4201
|
/**
|
|
4152
|
-
* <p>Container for information about the stages of a configuration change happening on a
|
|
4202
|
+
* <p>Container for information about the stages of a configuration change happening on a
|
|
4203
|
+
* domain.</p>
|
|
4153
4204
|
* @public
|
|
4154
4205
|
*/
|
|
4155
4206
|
ChangeProgressStatus?: ChangeProgressStatusDetails | undefined;
|
|
@@ -4469,7 +4520,8 @@ export interface SoftwareUpdateOptionsStatus {
|
|
|
4469
4520
|
*/
|
|
4470
4521
|
Options?: SoftwareUpdateOptions | undefined;
|
|
4471
4522
|
/**
|
|
4472
|
-
* <p>The status of service software update options, including creation date and last updated
|
|
4523
|
+
* <p>The status of service software update options, including creation date and last updated
|
|
4524
|
+
* date.</p>
|
|
4473
4525
|
* @public
|
|
4474
4526
|
*/
|
|
4475
4527
|
Status?: OptionStatus | undefined;
|
|
@@ -4516,9 +4568,9 @@ export interface DomainConfig {
|
|
|
4516
4568
|
*/
|
|
4517
4569
|
AccessPolicies?: AccessPoliciesStatus | undefined;
|
|
4518
4570
|
/**
|
|
4519
|
-
* <p>Choose either dual stack or IPv4 as your IP address type.
|
|
4520
|
-
*
|
|
4521
|
-
*
|
|
4571
|
+
* <p>Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share
|
|
4572
|
+
* domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set
|
|
4573
|
+
* your IP address type to dual stack, you can't change your address type later.</p>
|
|
4522
4574
|
* @public
|
|
4523
4575
|
*/
|
|
4524
4576
|
IPAddressType?: IPAddressTypeStatus | undefined;
|
|
@@ -4571,7 +4623,8 @@ export interface DomainConfig {
|
|
|
4571
4623
|
*/
|
|
4572
4624
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus | undefined;
|
|
4573
4625
|
/**
|
|
4574
|
-
* <p>Configuration options for enabling and managing IAM Identity Center integration within a
|
|
4626
|
+
* <p>Configuration options for enabling and managing IAM Identity Center integration within a
|
|
4627
|
+
* domain.</p>
|
|
4575
4628
|
* @public
|
|
4576
4629
|
*/
|
|
4577
4630
|
IdentityCenterOptions?: IdentityCenterOptionsStatus | undefined;
|
|
@@ -4679,7 +4732,8 @@ export interface AvailabilityZoneInfo {
|
|
|
4679
4732
|
*/
|
|
4680
4733
|
AvailabilityZoneName?: string | undefined;
|
|
4681
4734
|
/**
|
|
4682
|
-
* <p>The current state of the Availability Zone. Current options are <code>Active</code> and
|
|
4735
|
+
* <p>The current state of the Availability Zone. Current options are <code>Active</code> and
|
|
4736
|
+
* <code>StandBy</code>.</p>
|
|
4683
4737
|
* <ul>
|
|
4684
4738
|
* <li>
|
|
4685
4739
|
* <p>
|
|
@@ -4713,7 +4767,8 @@ export interface AvailabilityZoneInfo {
|
|
|
4713
4767
|
*/
|
|
4714
4768
|
TotalShards?: string | undefined;
|
|
4715
4769
|
/**
|
|
4716
|
-
* <p>The total number of primary and replica shards that aren't allocated to any of the nodes in
|
|
4770
|
+
* <p>The total number of primary and replica shards that aren't allocated to any of the nodes in
|
|
4771
|
+
* the Availability Zone.</p>
|
|
4717
4772
|
* @public
|
|
4718
4773
|
*/
|
|
4719
4774
|
TotalUnAssignedShards?: string | undefined;
|
|
@@ -4742,7 +4797,8 @@ export declare const MasterNodeStatus: {
|
|
|
4742
4797
|
*/
|
|
4743
4798
|
export type MasterNodeStatus = (typeof MasterNodeStatus)[keyof typeof MasterNodeStatus];
|
|
4744
4799
|
/**
|
|
4745
|
-
* <p>The result of a <code>DescribeDomainHealth</code> request. Contains health information for
|
|
4800
|
+
* <p>The result of a <code>DescribeDomainHealth</code> request. Contains health information for
|
|
4801
|
+
* the requested domain.</p>
|
|
4746
4802
|
* @public
|
|
4747
4803
|
*/
|
|
4748
4804
|
export interface DescribeDomainHealthResponse {
|
|
@@ -4755,29 +4811,34 @@ export interface DescribeDomainHealthResponse {
|
|
|
4755
4811
|
* </li>
|
|
4756
4812
|
* <li>
|
|
4757
4813
|
* <p>
|
|
4758
|
-
* <code>Active</code> - Requested changes have been processed and deployed to the
|
|
4814
|
+
* <code>Active</code> - Requested changes have been processed and deployed to the
|
|
4815
|
+
* domain.</p>
|
|
4759
4816
|
* </li>
|
|
4760
4817
|
* </ul>
|
|
4761
4818
|
* @public
|
|
4762
4819
|
*/
|
|
4763
4820
|
DomainState?: DomainState | undefined;
|
|
4764
4821
|
/**
|
|
4765
|
-
* <p>The number of Availability Zones configured for the domain. If the service is unable to
|
|
4822
|
+
* <p>The number of Availability Zones configured for the domain. If the service is unable to
|
|
4823
|
+
* fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4766
4824
|
* @public
|
|
4767
4825
|
*/
|
|
4768
4826
|
AvailabilityZoneCount?: string | undefined;
|
|
4769
4827
|
/**
|
|
4770
|
-
* <p>The number of active Availability Zones configured for the domain. If the service is unable
|
|
4828
|
+
* <p>The number of active Availability Zones configured for the domain. If the service is unable
|
|
4829
|
+
* to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4771
4830
|
* @public
|
|
4772
4831
|
*/
|
|
4773
4832
|
ActiveAvailabilityZoneCount?: string | undefined;
|
|
4774
4833
|
/**
|
|
4775
|
-
* <p>The number of standby Availability Zones configured for the domain. If the service is unable
|
|
4834
|
+
* <p>The number of standby Availability Zones configured for the domain. If the service is unable
|
|
4835
|
+
* to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4776
4836
|
* @public
|
|
4777
4837
|
*/
|
|
4778
4838
|
StandByAvailabilityZoneCount?: string | undefined;
|
|
4779
4839
|
/**
|
|
4780
|
-
* <p>The number of data nodes configured for the domain. If the service is unable to fetch this
|
|
4840
|
+
* <p>The number of data nodes configured for the domain. If the service is unable to fetch this
|
|
4841
|
+
* information, it will return <code>NotAvailable</code>.</p>
|
|
4781
4842
|
* @public
|
|
4782
4843
|
*/
|
|
4783
4844
|
DataNodeCount?: string | undefined;
|
|
@@ -4787,8 +4848,9 @@ export interface DescribeDomainHealthResponse {
|
|
|
4787
4848
|
*/
|
|
4788
4849
|
DedicatedMaster?: boolean | undefined;
|
|
4789
4850
|
/**
|
|
4790
|
-
* <p>The number of nodes that can be elected as a master node. If dedicated master nodes is
|
|
4791
|
-
*
|
|
4851
|
+
* <p>The number of nodes that can be elected as a master node. If dedicated master nodes is
|
|
4852
|
+
* turned on, this value is the number of dedicated master nodes configured for the domain. If the
|
|
4853
|
+
* service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4792
4854
|
* @public
|
|
4793
4855
|
*/
|
|
4794
4856
|
MasterEligibleNodeCount?: string | undefined;
|
|
@@ -4806,7 +4868,8 @@ export interface DescribeDomainHealthResponse {
|
|
|
4806
4868
|
* </li>
|
|
4807
4869
|
* <li>
|
|
4808
4870
|
* <p>
|
|
4809
|
-
* <b>UnAvailable</b> - The master node hasn't yet been elected,
|
|
4871
|
+
* <b>UnAvailable</b> - The master node hasn't yet been elected,
|
|
4872
|
+
* and a quorum to elect a new master node hasn't been reached.</p>
|
|
4810
4873
|
* </li>
|
|
4811
4874
|
* </ul>
|
|
4812
4875
|
* @public
|
|
@@ -4821,7 +4884,8 @@ export interface DescribeDomainHealthResponse {
|
|
|
4821
4884
|
* </li>
|
|
4822
4885
|
* <li>
|
|
4823
4886
|
* <p>
|
|
4824
|
-
* <code>Yellow</code> - All primary shards are allocated to nodes, but some replicas
|
|
4887
|
+
* <code>Yellow</code> - All primary shards are allocated to nodes, but some replicas
|
|
4888
|
+
* aren’t.</p>
|
|
4825
4889
|
* </li>
|
|
4826
4890
|
* <li>
|
|
4827
4891
|
* <p>
|
|
@@ -4841,7 +4905,8 @@ export interface DescribeDomainHealthResponse {
|
|
|
4841
4905
|
*/
|
|
4842
4906
|
TotalShards?: string | undefined;
|
|
4843
4907
|
/**
|
|
4844
|
-
* <p>The total number of primary and replica shards not allocated to any of the nodes for the
|
|
4908
|
+
* <p>The total number of primary and replica shards not allocated to any of the nodes for the
|
|
4909
|
+
* cluster.</p>
|
|
4845
4910
|
* @public
|
|
4846
4911
|
*/
|
|
4847
4912
|
TotalUnAssignedShards?: string | undefined;
|
|
@@ -4852,8 +4917,7 @@ export interface DescribeDomainHealthResponse {
|
|
|
4852
4917
|
EnvironmentInformation?: EnvironmentInfo[] | undefined;
|
|
4853
4918
|
}
|
|
4854
4919
|
/**
|
|
4855
|
-
* <p>Container for the parameters to the <code>DescribeDomainNodes</code>
|
|
4856
|
-
* operation.</p>
|
|
4920
|
+
* <p>Container for the parameters to the <code>DescribeDomainNodes</code> operation.</p>
|
|
4857
4921
|
* @public
|
|
4858
4922
|
*/
|
|
4859
4923
|
export interface DescribeDomainNodesRequest {
|
|
@@ -4937,13 +5001,14 @@ export interface DomainNodesStatus {
|
|
|
4937
5001
|
StorageSize?: string | undefined;
|
|
4938
5002
|
}
|
|
4939
5003
|
/**
|
|
4940
|
-
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about the
|
|
5004
|
+
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about the
|
|
5005
|
+
* nodes on the requested domain. </p>
|
|
4941
5006
|
* @public
|
|
4942
5007
|
*/
|
|
4943
5008
|
export interface DescribeDomainNodesResponse {
|
|
4944
5009
|
/**
|
|
4945
|
-
* <p>Contains nodes information list <code>DomainNodesStatusList</code> with
|
|
4946
|
-
*
|
|
5010
|
+
* <p>Contains nodes information list <code>DomainNodesStatusList</code> with details about the
|
|
5011
|
+
* all nodes on the requested domain.</p>
|
|
4947
5012
|
* @public
|
|
4948
5013
|
*/
|
|
4949
5014
|
DomainNodesStatusList?: DomainNodesStatus[] | undefined;
|
|
@@ -5117,7 +5182,8 @@ export interface Filter {
|
|
|
5117
5182
|
Values?: string[] | undefined;
|
|
5118
5183
|
}
|
|
5119
5184
|
/**
|
|
5120
|
-
* <p>Container for the parameters to the <code>DescribeInboundConnections</code>
|
|
5185
|
+
* <p>Container for the parameters to the <code>DescribeInboundConnections</code>
|
|
5186
|
+
* operation.</p>
|
|
5121
5187
|
* @public
|
|
5122
5188
|
*/
|
|
5123
5189
|
export interface DescribeInboundConnectionsRequest {
|
|
@@ -5153,8 +5219,8 @@ export interface DescribeInboundConnectionsResponse {
|
|
|
5153
5219
|
Connections?: InboundConnection[] | undefined;
|
|
5154
5220
|
/**
|
|
5155
5221
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5156
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5157
|
-
* returned token to retrieve the next page.</p>
|
|
5222
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5223
|
+
* the returned token to retrieve the next page.</p>
|
|
5158
5224
|
* @public
|
|
5159
5225
|
*/
|
|
5160
5226
|
NextToken?: string | undefined;
|
|
@@ -5172,7 +5238,8 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
5172
5238
|
constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
|
|
5173
5239
|
}
|
|
5174
5240
|
/**
|
|
5175
|
-
* <p>Container for the parameters to the <code>DescribeInstanceTypeLimits</code>
|
|
5241
|
+
* <p>Container for the parameters to the <code>DescribeInstanceTypeLimits</code>
|
|
5242
|
+
* operation.</p>
|
|
5176
5243
|
* @public
|
|
5177
5244
|
*/
|
|
5178
5245
|
export interface DescribeInstanceTypeLimitsRequest {
|
|
@@ -5232,23 +5299,23 @@ export interface StorageTypeLimit {
|
|
|
5232
5299
|
* <ul>
|
|
5233
5300
|
* <li>
|
|
5234
5301
|
* <p>
|
|
5235
|
-
* <b>MinimumVolumeSize</b> - Minimum volume size that is available
|
|
5236
|
-
* given storage type. Can be empty if not applicable.</p>
|
|
5302
|
+
* <b>MinimumVolumeSize</b> - Minimum volume size that is available
|
|
5303
|
+
* for the given storage type. Can be empty if not applicable.</p>
|
|
5237
5304
|
* </li>
|
|
5238
5305
|
* <li>
|
|
5239
5306
|
* <p>
|
|
5240
|
-
* <b>MaximumVolumeSize</b> - Maximum volume size that is available
|
|
5241
|
-
* given storage type. Can be empty if not applicable.</p>
|
|
5307
|
+
* <b>MaximumVolumeSize</b> - Maximum volume size that is available
|
|
5308
|
+
* for the given storage type. Can be empty if not applicable.</p>
|
|
5242
5309
|
* </li>
|
|
5243
5310
|
* <li>
|
|
5244
5311
|
* <p>
|
|
5245
|
-
* <b>MaximumIops</b> - Maximum amount of IOPS that is available
|
|
5246
|
-
* the storage type. Can be empty if not applicable.</p>
|
|
5312
|
+
* <b>MaximumIops</b> - Maximum amount of IOPS that is available
|
|
5313
|
+
* for the given the storage type. Can be empty if not applicable.</p>
|
|
5247
5314
|
* </li>
|
|
5248
5315
|
* <li>
|
|
5249
5316
|
* <p>
|
|
5250
|
-
* <b>MinimumIops</b> - Minimum amount of IOPS that is available
|
|
5251
|
-
* the storage type. Can be empty if not applicable.</p>
|
|
5317
|
+
* <b>MinimumIops</b> - Minimum amount of IOPS that is available
|
|
5318
|
+
* for the given the storage type. Can be empty if not applicable.</p>
|
|
5252
5319
|
* </li>
|
|
5253
5320
|
* <li>
|
|
5254
5321
|
* <p>
|
|
@@ -5322,13 +5389,14 @@ export interface Limits {
|
|
|
5322
5389
|
export interface DescribeInstanceTypeLimitsResponse {
|
|
5323
5390
|
/**
|
|
5324
5391
|
* <p>Map that contains all applicable instance type limits.<code>data</code> refers to data
|
|
5325
|
-
*
|
|
5392
|
+
* nodes.<code>master</code> refers to dedicated master nodes.</p>
|
|
5326
5393
|
* @public
|
|
5327
5394
|
*/
|
|
5328
5395
|
LimitsByRole?: Record<string, Limits> | undefined;
|
|
5329
5396
|
}
|
|
5330
5397
|
/**
|
|
5331
|
-
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code>
|
|
5398
|
+
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code>
|
|
5399
|
+
* operation.</p>
|
|
5332
5400
|
* @public
|
|
5333
5401
|
*/
|
|
5334
5402
|
export interface DescribeOutboundConnectionsRequest {
|
|
@@ -5364,8 +5432,8 @@ export interface DescribeOutboundConnectionsResponse {
|
|
|
5364
5432
|
Connections?: OutboundConnection[] | undefined;
|
|
5365
5433
|
/**
|
|
5366
5434
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5367
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5368
|
-
* returned token to retrieve the next page.</p>
|
|
5435
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5436
|
+
* the returned token to retrieve the next page.</p>
|
|
5369
5437
|
* @public
|
|
5370
5438
|
*/
|
|
5371
5439
|
NextToken?: string | undefined;
|
|
@@ -5414,14 +5482,14 @@ export interface DescribePackagesRequest {
|
|
|
5414
5482
|
Filters?: DescribePackagesFilter[] | undefined;
|
|
5415
5483
|
/**
|
|
5416
5484
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
5417
|
-
*
|
|
5485
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
5418
5486
|
* @public
|
|
5419
5487
|
*/
|
|
5420
5488
|
MaxResults?: number | undefined;
|
|
5421
5489
|
/**
|
|
5422
5490
|
* <p>If your initial <code>DescribePackageFilters</code> operation returns a
|
|
5423
|
-
*
|
|
5424
|
-
*
|
|
5491
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
5492
|
+
* <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>
|
|
5425
5493
|
* @public
|
|
5426
5494
|
*/
|
|
5427
5495
|
NextToken?: string | undefined;
|
|
@@ -5438,8 +5506,8 @@ export interface DescribePackagesResponse {
|
|
|
5438
5506
|
PackageDetailsList?: PackageDetails[] | undefined;
|
|
5439
5507
|
/**
|
|
5440
5508
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5441
|
-
*
|
|
5442
|
-
* returned token to retrieve the next page.</p>
|
|
5509
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5510
|
+
* the returned token to retrieve the next page.</p>
|
|
5443
5511
|
* @public
|
|
5444
5512
|
*/
|
|
5445
5513
|
NextToken?: string | undefined;
|
|
@@ -5517,7 +5585,8 @@ export interface ReservedInstanceOffering {
|
|
|
5517
5585
|
*/
|
|
5518
5586
|
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
5519
5587
|
/**
|
|
5520
|
-
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch
|
|
5588
|
+
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch
|
|
5589
|
+
* instance.</p>
|
|
5521
5590
|
* @public
|
|
5522
5591
|
*/
|
|
5523
5592
|
Duration?: number | undefined;
|
|
@@ -5556,8 +5625,8 @@ export interface ReservedInstanceOffering {
|
|
|
5556
5625
|
export interface DescribeReservedInstanceOfferingsResponse {
|
|
5557
5626
|
/**
|
|
5558
5627
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5559
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5560
|
-
* returned token to retrieve the next page.</p>
|
|
5628
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5629
|
+
* the returned token to retrieve the next page.</p>
|
|
5561
5630
|
* @public
|
|
5562
5631
|
*/
|
|
5563
5632
|
NextToken?: string | undefined;
|
|
@@ -5574,8 +5643,8 @@ export interface DescribeReservedInstanceOfferingsResponse {
|
|
|
5574
5643
|
*/
|
|
5575
5644
|
export interface DescribeReservedInstancesRequest {
|
|
5576
5645
|
/**
|
|
5577
|
-
* <p>The reserved instance identifier filter value. Use this parameter to show only the
|
|
5578
|
-
* specified reserved OpenSearch instance ID.</p>
|
|
5646
|
+
* <p>The reserved instance identifier filter value. Use this parameter to show only the
|
|
5647
|
+
* reservation that matches the specified reserved OpenSearch instance ID.</p>
|
|
5579
5648
|
* @public
|
|
5580
5649
|
*/
|
|
5581
5650
|
ReservedInstanceId?: string | undefined;
|
|
@@ -5680,8 +5749,8 @@ export interface ReservedInstance {
|
|
|
5680
5749
|
export interface DescribeReservedInstancesResponse {
|
|
5681
5750
|
/**
|
|
5682
5751
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5683
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5684
|
-
* returned token to retrieve the next page.</p>
|
|
5752
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5753
|
+
* the returned token to retrieve the next page.</p>
|
|
5685
5754
|
* @public
|
|
5686
5755
|
*/
|
|
5687
5756
|
NextToken?: string | undefined;
|
|
@@ -5839,9 +5908,8 @@ export interface GetApplicationResponse {
|
|
|
5839
5908
|
*/
|
|
5840
5909
|
id?: string | undefined;
|
|
5841
5910
|
/**
|
|
5842
|
-
* <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
|
|
5843
|
-
*
|
|
5844
|
-
* </p>
|
|
5911
|
+
* <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 </a> in <i>Using
|
|
5912
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
5845
5913
|
* @public
|
|
5846
5914
|
*/
|
|
5847
5915
|
arn?: string | undefined;
|
|
@@ -5856,7 +5924,9 @@ export interface GetApplicationResponse {
|
|
|
5856
5924
|
*/
|
|
5857
5925
|
endpoint?: string | undefined;
|
|
5858
5926
|
/**
|
|
5859
|
-
* <p>The current status of the OpenSearch application. Possible values: <code>CREATING</code>,
|
|
5927
|
+
* <p>The current status of the OpenSearch application. Possible values: <code>CREATING</code>,
|
|
5928
|
+
* <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and
|
|
5929
|
+
* <code>DELETED</code>.</p>
|
|
5860
5930
|
* @public
|
|
5861
5931
|
*/
|
|
5862
5932
|
status?: ApplicationStatus | undefined;
|
|
@@ -5916,7 +5986,8 @@ export interface CompatibleVersionsMap {
|
|
|
5916
5986
|
TargetVersions?: string[] | undefined;
|
|
5917
5987
|
}
|
|
5918
5988
|
/**
|
|
5919
|
-
* <p>Container for the response returned by the <code>GetCompatibleVersions</code>
|
|
5989
|
+
* <p>Container for the response returned by the <code>GetCompatibleVersions</code>
|
|
5990
|
+
* operation.</p>
|
|
5920
5991
|
* @public
|
|
5921
5992
|
*/
|
|
5922
5993
|
export interface GetCompatibleVersionsResponse {
|
|
@@ -5928,8 +5999,7 @@ export interface GetCompatibleVersionsResponse {
|
|
|
5928
5999
|
CompatibleVersions?: CompatibleVersionsMap[] | undefined;
|
|
5929
6000
|
}
|
|
5930
6001
|
/**
|
|
5931
|
-
* <p>Container for the parameters to the <code>GetDataSource</code>
|
|
5932
|
-
* operation.</p>
|
|
6002
|
+
* <p>Container for the parameters to the <code>GetDataSource</code> operation.</p>
|
|
5933
6003
|
* @public
|
|
5934
6004
|
*/
|
|
5935
6005
|
export interface GetDataSourceRequest {
|
|
@@ -5987,10 +6057,8 @@ export interface GetDataSourceResponse {
|
|
|
5987
6057
|
*/
|
|
5988
6058
|
export interface GetDirectQueryDataSourceRequest {
|
|
5989
6059
|
/**
|
|
5990
|
-
* <p>
|
|
5991
|
-
*
|
|
5992
|
-
* your OpenSearch Service environment.
|
|
5993
|
-
* </p>
|
|
6060
|
+
* <p> A unique, user-defined label that identifies the data source within your OpenSearch Service
|
|
6061
|
+
* environment. </p>
|
|
5994
6062
|
* @public
|
|
5995
6063
|
*/
|
|
5996
6064
|
DataSourceName: string | undefined;
|
|
@@ -6000,40 +6068,30 @@ export interface GetDirectQueryDataSourceRequest {
|
|
|
6000
6068
|
*/
|
|
6001
6069
|
export interface GetDirectQueryDataSourceResponse {
|
|
6002
6070
|
/**
|
|
6003
|
-
* <p>
|
|
6004
|
-
*
|
|
6005
|
-
* within your OpenSearch Service environment.
|
|
6006
|
-
* </p>
|
|
6071
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch Service
|
|
6072
|
+
* environment. </p>
|
|
6007
6073
|
* @public
|
|
6008
6074
|
*/
|
|
6009
6075
|
DataSourceName?: string | undefined;
|
|
6010
6076
|
/**
|
|
6011
|
-
* <p>
|
|
6012
|
-
*
|
|
6013
|
-
* direct queries in OpenSearch Service.
|
|
6014
|
-
* </p>
|
|
6077
|
+
* <p> The supported Amazon Web Services service that is used as the source for direct queries in
|
|
6078
|
+
* OpenSearch Service. </p>
|
|
6015
6079
|
* @public
|
|
6016
6080
|
*/
|
|
6017
6081
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6018
6082
|
/**
|
|
6019
|
-
* <p>
|
|
6020
|
-
* A description that provides additional context and details about the data source.
|
|
6021
|
-
* </p>
|
|
6083
|
+
* <p> A description that provides additional context and details about the data source. </p>
|
|
6022
6084
|
* @public
|
|
6023
6085
|
*/
|
|
6024
6086
|
Description?: string | undefined;
|
|
6025
6087
|
/**
|
|
6026
|
-
* <p>
|
|
6027
|
-
*
|
|
6028
|
-
* collections that are associated with the direct query data source.
|
|
6029
|
-
* </p>
|
|
6088
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated
|
|
6089
|
+
* with the direct query data source. </p>
|
|
6030
6090
|
* @public
|
|
6031
6091
|
*/
|
|
6032
6092
|
OpenSearchArns?: string[] | undefined;
|
|
6033
6093
|
/**
|
|
6034
|
-
* <p>
|
|
6035
|
-
* The unique, system-generated identifier that represents the data source.
|
|
6036
|
-
* </p>
|
|
6094
|
+
* <p> The unique, system-generated identifier that represents the data source. </p>
|
|
6037
6095
|
* @public
|
|
6038
6096
|
*/
|
|
6039
6097
|
DataSourceArn?: string | undefined;
|
|
@@ -6084,7 +6142,8 @@ export declare const MaintenanceStatus: {
|
|
|
6084
6142
|
*/
|
|
6085
6143
|
export type MaintenanceStatus = (typeof MaintenanceStatus)[keyof typeof MaintenanceStatus];
|
|
6086
6144
|
/**
|
|
6087
|
-
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about the
|
|
6145
|
+
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about the
|
|
6146
|
+
* requested action.</p>
|
|
6088
6147
|
* @public
|
|
6089
6148
|
*/
|
|
6090
6149
|
export interface GetDomainMaintenanceStatusResponse {
|
|
@@ -6120,7 +6179,8 @@ export interface GetDomainMaintenanceStatusResponse {
|
|
|
6120
6179
|
UpdatedAt?: Date | undefined;
|
|
6121
6180
|
}
|
|
6122
6181
|
/**
|
|
6123
|
-
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code>
|
|
6182
|
+
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code>
|
|
6183
|
+
* operation.</p>
|
|
6124
6184
|
* @public
|
|
6125
6185
|
*/
|
|
6126
6186
|
export interface GetPackageVersionHistoryRequest {
|
|
@@ -6165,7 +6225,8 @@ export interface PackageVersionHistory {
|
|
|
6165
6225
|
*/
|
|
6166
6226
|
CreatedAt?: Date | undefined;
|
|
6167
6227
|
/**
|
|
6168
|
-
* <p>Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code>
|
|
6228
|
+
* <p>Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code>
|
|
6229
|
+
* package.</p>
|
|
6169
6230
|
* @public
|
|
6170
6231
|
*/
|
|
6171
6232
|
PluginProperties?: PluginProperties | undefined;
|
|
@@ -6176,7 +6237,7 @@ export interface PackageVersionHistory {
|
|
|
6176
6237
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
6177
6238
|
}
|
|
6178
6239
|
/**
|
|
6179
|
-
* <p>Container for response returned by <code>GetPackageVersionHistory</code>
|
|
6240
|
+
* <p>Container for response returned by <code>GetPackageVersionHistory</code> operation.</p>
|
|
6180
6241
|
* @public
|
|
6181
6242
|
*/
|
|
6182
6243
|
export interface GetPackageVersionHistoryResponse {
|
|
@@ -6192,8 +6253,8 @@ export interface GetPackageVersionHistoryResponse {
|
|
|
6192
6253
|
PackageVersionHistoryList?: PackageVersionHistory[] | undefined;
|
|
6193
6254
|
/**
|
|
6194
6255
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6195
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6196
|
-
* returned token to retrieve the next page.</p>
|
|
6256
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6257
|
+
* the returned token to retrieve the next page.</p>
|
|
6197
6258
|
* @public
|
|
6198
6259
|
*/
|
|
6199
6260
|
NextToken?: string | undefined;
|
|
@@ -6290,7 +6351,8 @@ export interface UpgradeStepItem {
|
|
|
6290
6351
|
*/
|
|
6291
6352
|
UpgradeStepStatus?: UpgradeStatus | undefined;
|
|
6292
6353
|
/**
|
|
6293
|
-
* <p>A list of strings containing detailed information about the errors encountered in a
|
|
6354
|
+
* <p>A list of strings containing detailed information about the errors encountered in a
|
|
6355
|
+
* particular step.</p>
|
|
6294
6356
|
* @public
|
|
6295
6357
|
*/
|
|
6296
6358
|
Issues?: string[] | undefined;
|
|
@@ -6337,7 +6399,8 @@ export interface UpgradeHistory {
|
|
|
6337
6399
|
*/
|
|
6338
6400
|
UpgradeStatus?: UpgradeStatus | undefined;
|
|
6339
6401
|
/**
|
|
6340
|
-
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility
|
|
6402
|
+
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility
|
|
6403
|
+
* check.</p>
|
|
6341
6404
|
* @public
|
|
6342
6405
|
*/
|
|
6343
6406
|
StepsList?: UpgradeStepItem[] | undefined;
|
|
@@ -6355,8 +6418,8 @@ export interface GetUpgradeHistoryResponse {
|
|
|
6355
6418
|
UpgradeHistories?: UpgradeHistory[] | undefined;
|
|
6356
6419
|
/**
|
|
6357
6420
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6358
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6359
|
-
* returned token to retrieve the next page.</p>
|
|
6421
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6422
|
+
* the returned token to retrieve the next page.</p>
|
|
6360
6423
|
* @public
|
|
6361
6424
|
*/
|
|
6362
6425
|
NextToken?: string | undefined;
|
|
@@ -6399,13 +6462,15 @@ export interface GetUpgradeStatusResponse {
|
|
|
6399
6462
|
export interface ListApplicationsRequest {
|
|
6400
6463
|
/**
|
|
6401
6464
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6402
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6403
|
-
* returned token to retrieve the next page.</p>
|
|
6465
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6466
|
+
* the returned token to retrieve the next page.</p>
|
|
6404
6467
|
* @public
|
|
6405
6468
|
*/
|
|
6406
6469
|
nextToken?: string | undefined;
|
|
6407
6470
|
/**
|
|
6408
|
-
* <p>Filters the list of OpenSearch applications by status. Possible values:
|
|
6471
|
+
* <p>Filters the list of OpenSearch applications by status. Possible values:
|
|
6472
|
+
* <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>,
|
|
6473
|
+
* <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6409
6474
|
* @public
|
|
6410
6475
|
*/
|
|
6411
6476
|
statuses?: ApplicationStatus[] | undefined;
|
|
@@ -6427,9 +6492,8 @@ export interface ApplicationSummary {
|
|
|
6427
6492
|
*/
|
|
6428
6493
|
id?: string | undefined;
|
|
6429
6494
|
/**
|
|
6430
|
-
* <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
|
|
6431
|
-
*
|
|
6432
|
-
* </p>
|
|
6495
|
+
* <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 </a> in <i>Using
|
|
6496
|
+
* Amazon Web Services Identity and Access Management</i> for more information. </p>
|
|
6433
6497
|
* @public
|
|
6434
6498
|
*/
|
|
6435
6499
|
arn?: string | undefined;
|
|
@@ -6444,7 +6508,9 @@ export interface ApplicationSummary {
|
|
|
6444
6508
|
*/
|
|
6445
6509
|
endpoint?: string | undefined;
|
|
6446
6510
|
/**
|
|
6447
|
-
* <p>The current status of an OpenSearch application. Possible values: <code>CREATING</code>,
|
|
6511
|
+
* <p>The current status of an OpenSearch application. Possible values: <code>CREATING</code>,
|
|
6512
|
+
* <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and
|
|
6513
|
+
* <code>DELETED</code>.</p>
|
|
6448
6514
|
* @public
|
|
6449
6515
|
*/
|
|
6450
6516
|
status?: ApplicationStatus | undefined;
|
|
@@ -6464,21 +6530,21 @@ export interface ApplicationSummary {
|
|
|
6464
6530
|
*/
|
|
6465
6531
|
export interface ListApplicationsResponse {
|
|
6466
6532
|
/**
|
|
6467
|
-
* <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation
|
|
6533
|
+
* <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation
|
|
6534
|
+
* time, and last update time.</p>
|
|
6468
6535
|
* @public
|
|
6469
6536
|
*/
|
|
6470
6537
|
ApplicationSummaries?: ApplicationSummary[] | undefined;
|
|
6471
6538
|
/**
|
|
6472
6539
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6473
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6474
|
-
* returned token to retrieve the next page.</p>
|
|
6540
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6541
|
+
* the returned token to retrieve the next page.</p>
|
|
6475
6542
|
* @public
|
|
6476
6543
|
*/
|
|
6477
6544
|
nextToken?: string | undefined;
|
|
6478
6545
|
}
|
|
6479
6546
|
/**
|
|
6480
|
-
* <p>Container for the parameters to the <code>ListDataSources</code>
|
|
6481
|
-
* operation.</p>
|
|
6547
|
+
* <p>Container for the parameters to the <code>ListDataSources</code> operation.</p>
|
|
6482
6548
|
* @public
|
|
6483
6549
|
*/
|
|
6484
6550
|
export interface ListDataSourcesRequest {
|
|
@@ -6531,57 +6597,47 @@ export interface ListDataSourcesResponse {
|
|
|
6531
6597
|
export interface ListDirectQueryDataSourcesRequest {
|
|
6532
6598
|
/**
|
|
6533
6599
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6534
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6535
|
-
* returned token to retrieve the next page.</p>
|
|
6600
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6601
|
+
* the returned token to retrieve the next page.</p>
|
|
6536
6602
|
* @public
|
|
6537
6603
|
*/
|
|
6538
6604
|
NextToken?: string | undefined;
|
|
6539
6605
|
}
|
|
6540
6606
|
/**
|
|
6541
|
-
* <p>
|
|
6542
|
-
* The configuration details for a data source that can be directly queried.
|
|
6543
|
-
* </p>
|
|
6607
|
+
* <p> The configuration details for a data source that can be directly queried. </p>
|
|
6544
6608
|
* @public
|
|
6545
6609
|
*/
|
|
6546
6610
|
export interface DirectQueryDataSource {
|
|
6547
6611
|
/**
|
|
6548
|
-
* <p>
|
|
6549
|
-
*
|
|
6550
|
-
* within your OpenSearch Service environment.
|
|
6551
|
-
* </p>
|
|
6612
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch Service
|
|
6613
|
+
* environment. </p>
|
|
6552
6614
|
* @public
|
|
6553
6615
|
*/
|
|
6554
6616
|
DataSourceName?: string | undefined;
|
|
6555
6617
|
/**
|
|
6556
|
-
* <p>
|
|
6557
|
-
*
|
|
6558
|
-
* </p>
|
|
6618
|
+
* <p> The supported Amazon Web Services service that is used as the source for direct queries in
|
|
6619
|
+
* OpenSearch Service. </p>
|
|
6559
6620
|
* @public
|
|
6560
6621
|
*/
|
|
6561
6622
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6562
6623
|
/**
|
|
6563
|
-
* <p>
|
|
6564
|
-
* A description that provides additional context and details about the data source.</p>
|
|
6624
|
+
* <p> A description that provides additional context and details about the data source.</p>
|
|
6565
6625
|
* @public
|
|
6566
6626
|
*/
|
|
6567
6627
|
Description?: string | undefined;
|
|
6568
6628
|
/**
|
|
6569
|
-
* <p>
|
|
6570
|
-
*
|
|
6571
|
-
* collections that are associated with the direct query data source.
|
|
6572
|
-
* </p>
|
|
6629
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated
|
|
6630
|
+
* with the direct query data source. </p>
|
|
6573
6631
|
* @public
|
|
6574
6632
|
*/
|
|
6575
6633
|
OpenSearchArns?: string[] | undefined;
|
|
6576
6634
|
/**
|
|
6577
|
-
* <p>
|
|
6578
|
-
* The unique, system-generated identifier that represents the data source.</p>
|
|
6635
|
+
* <p> The unique, system-generated identifier that represents the data source.</p>
|
|
6579
6636
|
* @public
|
|
6580
6637
|
*/
|
|
6581
6638
|
DataSourceArn?: string | undefined;
|
|
6582
6639
|
/**
|
|
6583
|
-
* <p>
|
|
6584
|
-
* A list of tags attached to a direct query data source.</p>
|
|
6640
|
+
* <p> A list of tags attached to a direct query data source.</p>
|
|
6585
6641
|
* @public
|
|
6586
6642
|
*/
|
|
6587
6643
|
TagList?: Tag[] | undefined;
|
|
@@ -6592,23 +6648,20 @@ export interface DirectQueryDataSource {
|
|
|
6592
6648
|
export interface ListDirectQueryDataSourcesResponse {
|
|
6593
6649
|
/**
|
|
6594
6650
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6595
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6596
|
-
* returned token to retrieve the next page.</p>
|
|
6651
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6652
|
+
* the returned token to retrieve the next page.</p>
|
|
6597
6653
|
* @public
|
|
6598
6654
|
*/
|
|
6599
6655
|
NextToken?: string | undefined;
|
|
6600
6656
|
/**
|
|
6601
|
-
* <p>
|
|
6602
|
-
*
|
|
6603
|
-
* the <code>ListDirectQueryDataSources</code> API operation.
|
|
6604
|
-
* </p>
|
|
6657
|
+
* <p> A list of the direct query data sources that are returned by the
|
|
6658
|
+
* <code>ListDirectQueryDataSources</code> API operation. </p>
|
|
6605
6659
|
* @public
|
|
6606
6660
|
*/
|
|
6607
6661
|
DirectQueryDataSources?: DirectQueryDataSource[] | undefined;
|
|
6608
6662
|
}
|
|
6609
6663
|
/**
|
|
6610
|
-
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
6611
|
-
* operation.</p>
|
|
6664
|
+
* <p>Container for the parameters to the <code>ListDomainMaintenances</code> operation.</p>
|
|
6612
6665
|
* @public
|
|
6613
6666
|
*/
|
|
6614
6667
|
export interface ListDomainMaintenancesRequest {
|
|
@@ -6629,14 +6682,14 @@ export interface ListDomainMaintenancesRequest {
|
|
|
6629
6682
|
Status?: MaintenanceStatus | undefined;
|
|
6630
6683
|
/**
|
|
6631
6684
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6632
|
-
*
|
|
6685
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
6633
6686
|
* @public
|
|
6634
6687
|
*/
|
|
6635
6688
|
MaxResults?: number | undefined;
|
|
6636
6689
|
/**
|
|
6637
6690
|
* <p>If your initial <code>ListDomainMaintenances</code> operation returns a
|
|
6638
|
-
*
|
|
6639
|
-
*
|
|
6691
|
+
* <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent
|
|
6692
|
+
* <code>ListDomainMaintenances</code> operations, which returns results in the next page.</p>
|
|
6640
6693
|
* @public
|
|
6641
6694
|
*/
|
|
6642
6695
|
NextToken?: string | undefined;
|
|
@@ -6688,7 +6741,8 @@ export interface DomainMaintenanceDetails {
|
|
|
6688
6741
|
UpdatedAt?: Date | undefined;
|
|
6689
6742
|
}
|
|
6690
6743
|
/**
|
|
6691
|
-
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information about
|
|
6744
|
+
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information about
|
|
6745
|
+
* the requested actions. </p>
|
|
6692
6746
|
* @public
|
|
6693
6747
|
*/
|
|
6694
6748
|
export interface ListDomainMaintenancesResponse {
|
|
@@ -6699,8 +6753,8 @@ export interface ListDomainMaintenancesResponse {
|
|
|
6699
6753
|
DomainMaintenances?: DomainMaintenanceDetails[] | undefined;
|
|
6700
6754
|
/**
|
|
6701
6755
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6702
|
-
*
|
|
6703
|
-
* returned token to retrieve the next page.</p>
|
|
6756
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6757
|
+
* the returned token to retrieve the next page.</p>
|
|
6704
6758
|
* @public
|
|
6705
6759
|
*/
|
|
6706
6760
|
NextToken?: string | undefined;
|
|
@@ -6759,7 +6813,8 @@ export interface ListDomainNamesResponse {
|
|
|
6759
6813
|
DomainNames?: DomainInfo[] | undefined;
|
|
6760
6814
|
}
|
|
6761
6815
|
/**
|
|
6762
|
-
* <p>Container for the request parameters to the <code>ListDomainsForPackage</code>
|
|
6816
|
+
* <p>Container for the request parameters to the <code>ListDomainsForPackage</code>
|
|
6817
|
+
* operation.</p>
|
|
6763
6818
|
* @public
|
|
6764
6819
|
*/
|
|
6765
6820
|
export interface ListDomainsForPackageRequest {
|
|
@@ -6782,24 +6837,6 @@ export interface ListDomainsForPackageRequest {
|
|
|
6782
6837
|
*/
|
|
6783
6838
|
NextToken?: string | undefined;
|
|
6784
6839
|
}
|
|
6785
|
-
/**
|
|
6786
|
-
* <p>Container for the response parameters to the <code>ListDomainsForPackage</code> operation.</p>
|
|
6787
|
-
* @public
|
|
6788
|
-
*/
|
|
6789
|
-
export interface ListDomainsForPackageResponse {
|
|
6790
|
-
/**
|
|
6791
|
-
* <p>Information about all domains associated with a package.</p>
|
|
6792
|
-
* @public
|
|
6793
|
-
*/
|
|
6794
|
-
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
6795
|
-
/**
|
|
6796
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6797
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6798
|
-
* returned token to retrieve the next page.</p>
|
|
6799
|
-
* @public
|
|
6800
|
-
*/
|
|
6801
|
-
NextToken?: string | undefined;
|
|
6802
|
-
}
|
|
6803
6840
|
/**
|
|
6804
6841
|
* @internal
|
|
6805
6842
|
*/
|