@aws-sdk/client-opensearch 3.856.0 → 3.858.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-cjs/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -0
- package/dist-types/commands/AddDataSourceCommand.d.ts +1 -2
- package/dist-types/commands/AddDirectQueryDataSourceCommand.d.ts +4 -2
- package/dist-types/commands/AssociatePackageCommand.d.ts +2 -1
- package/dist-types/commands/AssociatePackagesCommand.d.ts +1 -2
- package/dist-types/commands/CreateApplicationCommand.d.ts +1 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +10 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -2
- package/dist-types/commands/DeleteDirectQueryDataSourceCommand.d.ts +3 -1
- package/dist-types/commands/DeleteDomainCommand.d.ts +5 -0
- package/dist-types/commands/DescribeDomainChangeProgressCommand.d.ts +1 -2
- package/dist-types/commands/DescribeDomainCommand.d.ts +5 -0
- package/dist-types/commands/DescribeDomainConfigCommand.d.ts +5 -0
- package/dist-types/commands/DescribeDomainHealthCommand.d.ts +1 -2
- package/dist-types/commands/DescribeDomainsCommand.d.ts +5 -0
- package/dist-types/commands/DescribeDryRunProgressCommand.d.ts +7 -2
- package/dist-types/commands/DescribeReservedInstanceOfferingsCommand.d.ts +1 -2
- package/dist-types/commands/GetDirectQueryDataSourceCommand.d.ts +4 -2
- package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts +2 -3
- package/dist-types/commands/ListDataSourcesCommand.d.ts +3 -3
- package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts +4 -2
- package/dist-types/commands/ListDomainNamesCommand.d.ts +2 -1
- package/dist-types/commands/ListDomainsForPackageCommand.d.ts +1 -2
- 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 +4 -2
- package/dist-types/commands/UpdateDomainConfigCommand.d.ts +12 -1
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +1 -2
- package/dist-types/commands/UpdateScheduledActionCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +363 -380
- package/dist-types/models/models_1.d.ts +101 -57
- package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListDomainsForPackageCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +12 -8
- package/dist-types/ts3.4/models/models_1.d.ts +9 -0
- package/package.json +11 -11
|
@@ -368,7 +368,8 @@ 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>
|
|
371
|
+
* <p>Container for the parameters to the <code>AddDataSource</code>
|
|
372
|
+
* operation.</p>
|
|
372
373
|
* @public
|
|
373
374
|
*/
|
|
374
375
|
export interface AddDataSourceRequest {
|
|
@@ -453,33 +454,44 @@ export declare class ValidationException extends __BaseException {
|
|
|
453
454
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
454
455
|
}
|
|
455
456
|
/**
|
|
456
|
-
* <p>
|
|
457
|
-
*
|
|
457
|
+
* <p>
|
|
458
|
+
* Configuration details for a CloudWatch Logs data source
|
|
459
|
+
* that can be used for direct queries.
|
|
460
|
+
* </p>
|
|
458
461
|
* @public
|
|
459
462
|
*/
|
|
460
463
|
export interface CloudWatchDirectQueryDataSource {
|
|
461
464
|
/**
|
|
462
|
-
* <p>
|
|
463
|
-
* the
|
|
465
|
+
* <p>
|
|
466
|
+
* The unique identifier of the IAM role that grants
|
|
467
|
+
* OpenSearch Service permission to access the specified data source.
|
|
468
|
+
* </p>
|
|
464
469
|
* @public
|
|
465
470
|
*/
|
|
466
471
|
RoleArn: string | undefined;
|
|
467
472
|
}
|
|
468
473
|
/**
|
|
469
|
-
* <p>
|
|
474
|
+
* <p>
|
|
475
|
+
* Configuration details for a Security Lake data source
|
|
476
|
+
* that can be used for direct queries.
|
|
470
477
|
* </p>
|
|
471
478
|
* @public
|
|
472
479
|
*/
|
|
473
480
|
export interface SecurityLakeDirectQueryDataSource {
|
|
474
481
|
/**
|
|
475
|
-
* <p>
|
|
476
|
-
* the
|
|
482
|
+
* <p>
|
|
483
|
+
* The unique identifier of the IAM role that grants OpenSearch
|
|
484
|
+
* Service permission to access the specified data source.
|
|
485
|
+
* </p>
|
|
477
486
|
* @public
|
|
478
487
|
*/
|
|
479
488
|
RoleArn: string | undefined;
|
|
480
489
|
}
|
|
481
490
|
/**
|
|
482
|
-
* <p>
|
|
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>
|
|
483
495
|
* @public
|
|
484
496
|
*/
|
|
485
497
|
export type DirectQueryDataSourceType = DirectQueryDataSourceType.CloudWatchLogMember | DirectQueryDataSourceType.SecurityLakeMember | DirectQueryDataSourceType.$UnknownMember;
|
|
@@ -488,7 +500,9 @@ export type DirectQueryDataSourceType = DirectQueryDataSourceType.CloudWatchLogM
|
|
|
488
500
|
*/
|
|
489
501
|
export declare namespace DirectQueryDataSourceType {
|
|
490
502
|
/**
|
|
491
|
-
* <p>
|
|
503
|
+
* <p>
|
|
504
|
+
* Specifies CloudWatch Logs as a type of data source for direct queries.
|
|
505
|
+
* </p>
|
|
492
506
|
* @public
|
|
493
507
|
*/
|
|
494
508
|
interface CloudWatchLogMember {
|
|
@@ -497,7 +511,9 @@ export declare namespace DirectQueryDataSourceType {
|
|
|
497
511
|
$unknown?: never;
|
|
498
512
|
}
|
|
499
513
|
/**
|
|
500
|
-
* <p>
|
|
514
|
+
* <p>
|
|
515
|
+
* Specifies Security Lake as a type of data source for direct queries.
|
|
516
|
+
* </p>
|
|
501
517
|
* @public
|
|
502
518
|
*/
|
|
503
519
|
interface SecurityLakeMember {
|
|
@@ -544,26 +560,32 @@ export interface Tag {
|
|
|
544
560
|
*/
|
|
545
561
|
export interface AddDirectQueryDataSourceRequest {
|
|
546
562
|
/**
|
|
547
|
-
* <p>
|
|
548
|
-
*
|
|
563
|
+
* <p>
|
|
564
|
+
* A unique, user-defined label to identify the data source
|
|
565
|
+
* within your OpenSearch Service environment.
|
|
566
|
+
* </p>
|
|
549
567
|
* @public
|
|
550
568
|
*/
|
|
551
569
|
DataSourceName: string | undefined;
|
|
552
570
|
/**
|
|
553
|
-
* <p>
|
|
554
|
-
* queries in OpenSearch Service.
|
|
571
|
+
* <p>
|
|
572
|
+
* The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.
|
|
573
|
+
* </p>
|
|
555
574
|
* @public
|
|
556
575
|
*/
|
|
557
576
|
DataSourceType: DirectQueryDataSourceType | undefined;
|
|
558
577
|
/**
|
|
559
|
-
* <p>
|
|
578
|
+
* <p>
|
|
579
|
+
* An optional text field for providing additional context and details about the data source.
|
|
560
580
|
* </p>
|
|
561
581
|
* @public
|
|
562
582
|
*/
|
|
563
583
|
Description?: string | undefined;
|
|
564
584
|
/**
|
|
565
|
-
* <p>
|
|
566
|
-
*
|
|
585
|
+
* <p>
|
|
586
|
+
* A list of Amazon Resource Names (ARNs) for the OpenSearch
|
|
587
|
+
* collections that are associated with the direct query data source.
|
|
588
|
+
* </p>
|
|
567
589
|
* @public
|
|
568
590
|
*/
|
|
569
591
|
OpenSearchArns: string[] | undefined;
|
|
@@ -578,7 +600,9 @@ export interface AddDirectQueryDataSourceRequest {
|
|
|
578
600
|
*/
|
|
579
601
|
export interface AddDirectQueryDataSourceResponse {
|
|
580
602
|
/**
|
|
581
|
-
* <p>
|
|
603
|
+
* <p>
|
|
604
|
+
* The unique, system-generated identifier that represents the data source.
|
|
605
|
+
* </p>
|
|
582
606
|
* @public
|
|
583
607
|
*/
|
|
584
608
|
DataSourceArn?: string | undefined;
|
|
@@ -653,7 +677,7 @@ export interface AddTagsRequest {
|
|
|
653
677
|
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a string
|
|
654
678
|
* rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean
|
|
655
679
|
* query. Default is 1,024. Queries with more than the permitted number of clauses result in a
|
|
656
|
-
*
|
|
680
|
+
* <code>TooManyClauses</code> error.</p>
|
|
657
681
|
* </li>
|
|
658
682
|
* <li>
|
|
659
683
|
* <p>
|
|
@@ -678,6 +702,27 @@ export interface AdvancedOptionsStatus {
|
|
|
678
702
|
*/
|
|
679
703
|
Status: OptionStatus | undefined;
|
|
680
704
|
}
|
|
705
|
+
/**
|
|
706
|
+
* <p>Describes the IAM federation options configured for the domain.</p>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
export interface IAMFederationOptionsOutput {
|
|
710
|
+
/**
|
|
711
|
+
* <p>True if IAM federation is enabled.</p>
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
Enabled?: boolean | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* <p>The key used for matching the IAM federation subject attribute.</p>
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
SubjectKey?: string | undefined;
|
|
720
|
+
/**
|
|
721
|
+
* <p>The key used for matching the IAM federation roles attribute.</p>
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
RolesKey?: string | undefined;
|
|
725
|
+
}
|
|
681
726
|
/**
|
|
682
727
|
* <p>Describes the JWT options configured for the domain.</p>
|
|
683
728
|
* @public
|
|
@@ -772,11 +817,15 @@ export interface AdvancedSecurityOptions {
|
|
|
772
817
|
*/
|
|
773
818
|
SAMLOptions?: SAMLOptionsOutput | undefined;
|
|
774
819
|
/**
|
|
775
|
-
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
776
|
-
* Service.</p>
|
|
820
|
+
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service.</p>
|
|
777
821
|
* @public
|
|
778
822
|
*/
|
|
779
823
|
JWTOptions?: JWTOptionsOutput | undefined;
|
|
824
|
+
/**
|
|
825
|
+
* <p>Container for information about the IAM federation configuration for an OpenSearch UI application.</p>
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
IAMFederationOptions?: IAMFederationOptionsOutput | undefined;
|
|
780
829
|
/**
|
|
781
830
|
* <p>Date and time when the migration period will be disabled. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling
|
|
782
831
|
* fine-grained access control on an existing domain</a>.</p>
|
|
@@ -792,8 +841,30 @@ export interface AdvancedSecurityOptions {
|
|
|
792
841
|
AnonymousAuthEnabled?: boolean | undefined;
|
|
793
842
|
}
|
|
794
843
|
/**
|
|
795
|
-
* <p>The
|
|
796
|
-
*
|
|
844
|
+
* <p>The IAM federation authentication configuration for an Amazon OpenSearch Service domain.</p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
export interface IAMFederationOptionsInput {
|
|
848
|
+
/**
|
|
849
|
+
* <p>True to enable IAM federation authentication for a domain.</p>
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
Enabled?: boolean | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* <p>Element of the IAM federation assertion to use for the user name. Default is
|
|
855
|
+
* <code>sub</code>.</p>
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
SubjectKey?: string | undefined;
|
|
859
|
+
/**
|
|
860
|
+
* <p>Element of the IAM federation assertion to use for backend roles. Default is
|
|
861
|
+
* <code>roles</code>.</p>
|
|
862
|
+
* @public
|
|
863
|
+
*/
|
|
864
|
+
RolesKey?: string | undefined;
|
|
865
|
+
}
|
|
866
|
+
/**
|
|
867
|
+
* <p>The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.</p>
|
|
797
868
|
* @public
|
|
798
869
|
*/
|
|
799
870
|
export interface JWTOptionsInput {
|
|
@@ -880,8 +951,8 @@ export interface SAMLOptionsInput {
|
|
|
880
951
|
*/
|
|
881
952
|
RolesKey?: string | undefined;
|
|
882
953
|
/**
|
|
883
|
-
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are
|
|
884
|
-
*
|
|
954
|
+
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440,
|
|
955
|
+
* and the default value is 60.</p>
|
|
885
956
|
* @public
|
|
886
957
|
*/
|
|
887
958
|
SessionTimeoutMinutes?: number | undefined;
|
|
@@ -913,11 +984,15 @@ export interface AdvancedSecurityOptionsInput {
|
|
|
913
984
|
*/
|
|
914
985
|
SAMLOptions?: SAMLOptionsInput | undefined;
|
|
915
986
|
/**
|
|
916
|
-
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service.
|
|
917
|
-
* </p>
|
|
987
|
+
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service. </p>
|
|
918
988
|
* @public
|
|
919
989
|
*/
|
|
920
990
|
JWTOptions?: JWTOptionsInput | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>Container for information about the IAM federation configuration for an OpenSearch UI application.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
IAMFederationOptions?: IAMFederationOptionsInput | undefined;
|
|
921
996
|
/**
|
|
922
997
|
* <p>True to enable a 30-day migration period during which administrators can create role
|
|
923
998
|
* mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling
|
|
@@ -955,14 +1030,12 @@ export declare const NaturalLanguageQueryGenerationDesiredState: {
|
|
|
955
1030
|
*/
|
|
956
1031
|
export type NaturalLanguageQueryGenerationDesiredState = (typeof NaturalLanguageQueryGenerationDesiredState)[keyof typeof NaturalLanguageQueryGenerationDesiredState];
|
|
957
1032
|
/**
|
|
958
|
-
* <p>Container for parameters required to enable the natural language query generation
|
|
959
|
-
* feature.</p>
|
|
1033
|
+
* <p>Container for parameters required to enable the natural language query generation feature.</p>
|
|
960
1034
|
* @public
|
|
961
1035
|
*/
|
|
962
1036
|
export interface NaturalLanguageQueryGenerationOptionsInput {
|
|
963
1037
|
/**
|
|
964
|
-
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED
|
|
965
|
-
* and DISABLED.</p>
|
|
1038
|
+
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</p>
|
|
966
1039
|
* @public
|
|
967
1040
|
*/
|
|
968
1041
|
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
@@ -984,8 +1057,7 @@ export interface S3VectorsEngine {
|
|
|
984
1057
|
*/
|
|
985
1058
|
export interface AIMLOptionsInput {
|
|
986
1059
|
/**
|
|
987
|
-
* <p>Container for parameters required for natural language query generation on the specified
|
|
988
|
-
* domain.</p>
|
|
1060
|
+
* <p>Container for parameters required for natural language query generation on the specified domain.</p>
|
|
989
1061
|
* @public
|
|
990
1062
|
*/
|
|
991
1063
|
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsInput | undefined;
|
|
@@ -1013,33 +1085,28 @@ export declare const NaturalLanguageQueryGenerationCurrentState: {
|
|
|
1013
1085
|
*/
|
|
1014
1086
|
export type NaturalLanguageQueryGenerationCurrentState = (typeof NaturalLanguageQueryGenerationCurrentState)[keyof typeof NaturalLanguageQueryGenerationCurrentState];
|
|
1015
1087
|
/**
|
|
1016
|
-
* <p>Container for parameters representing the state of the natural language query generation
|
|
1017
|
-
* feature on the specified domain.</p>
|
|
1088
|
+
* <p>Container for parameters representing the state of the natural language query generation feature on the specified domain.</p>
|
|
1018
1089
|
* @public
|
|
1019
1090
|
*/
|
|
1020
1091
|
export interface NaturalLanguageQueryGenerationOptionsOutput {
|
|
1021
1092
|
/**
|
|
1022
|
-
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED
|
|
1023
|
-
* and DISABLED.</p>
|
|
1093
|
+
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</p>
|
|
1024
1094
|
* @public
|
|
1025
1095
|
*/
|
|
1026
1096
|
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
1027
1097
|
/**
|
|
1028
|
-
* <p>The current state of the natural language query generation feature, indicating completion,
|
|
1029
|
-
* in progress, or failure.</p>
|
|
1098
|
+
* <p>The current state of the natural language query generation feature, indicating completion, in progress, or failure.</p>
|
|
1030
1099
|
* @public
|
|
1031
1100
|
*/
|
|
1032
1101
|
CurrentState?: NaturalLanguageQueryGenerationCurrentState | undefined;
|
|
1033
1102
|
}
|
|
1034
1103
|
/**
|
|
1035
|
-
* <p>Container for parameters representing the state of machine learning features on the
|
|
1036
|
-
* specified domain.</p>
|
|
1104
|
+
* <p>Container for parameters representing the state of machine learning features on the specified domain.</p>
|
|
1037
1105
|
* @public
|
|
1038
1106
|
*/
|
|
1039
1107
|
export interface AIMLOptionsOutput {
|
|
1040
1108
|
/**
|
|
1041
|
-
* <p>Container for parameters required for natural language query generation on the specified
|
|
1042
|
-
* domain.</p>
|
|
1109
|
+
* <p>Container for parameters required for natural language query generation on the specified domain.</p>
|
|
1043
1110
|
* @public
|
|
1044
1111
|
*/
|
|
1045
1112
|
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsOutput | undefined;
|
|
@@ -1066,8 +1133,7 @@ export interface AIMLOptionsStatus {
|
|
|
1066
1133
|
Status?: OptionStatus | undefined;
|
|
1067
1134
|
}
|
|
1068
1135
|
/**
|
|
1069
|
-
* <p>The configuration parameters to enable access to the key store required by the
|
|
1070
|
-
* package.</p>
|
|
1136
|
+
* <p>The configuration parameters to enable access to the key store required by the package.</p>
|
|
1071
1137
|
* @public
|
|
1072
1138
|
*/
|
|
1073
1139
|
export interface KeyStoreAccessOption {
|
|
@@ -1088,8 +1154,7 @@ export interface KeyStoreAccessOption {
|
|
|
1088
1154
|
*/
|
|
1089
1155
|
export interface PackageAssociationConfiguration {
|
|
1090
1156
|
/**
|
|
1091
|
-
* <p>The configuration parameters to enable accessing the key store required by the
|
|
1092
|
-
* package.</p>
|
|
1157
|
+
* <p>The configuration parameters to enable accessing the key store required by the package.</p>
|
|
1093
1158
|
* @public
|
|
1094
1159
|
*/
|
|
1095
1160
|
KeyStoreAccessOption?: KeyStoreAccessOption | undefined;
|
|
@@ -1100,8 +1165,8 @@ export interface PackageAssociationConfiguration {
|
|
|
1100
1165
|
*/
|
|
1101
1166
|
export interface AssociatePackageRequest {
|
|
1102
1167
|
/**
|
|
1103
|
-
* <p>Internal ID of the package to associate with a domain. Use <code>DescribePackages</code> to
|
|
1104
|
-
*
|
|
1168
|
+
* <p>Internal ID of the package to associate with a domain. Use <code>DescribePackages</code> to find this value.
|
|
1169
|
+
* </p>
|
|
1105
1170
|
* @public
|
|
1106
1171
|
*/
|
|
1107
1172
|
PackageID: string | undefined;
|
|
@@ -1111,8 +1176,7 @@ export interface AssociatePackageRequest {
|
|
|
1111
1176
|
*/
|
|
1112
1177
|
DomainName: string | undefined;
|
|
1113
1178
|
/**
|
|
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>
|
|
1179
|
+
* <p>A list of package IDs that must be associated with the domain before the package specified in the request can be associated.</p>
|
|
1116
1180
|
* @public
|
|
1117
1181
|
*/
|
|
1118
1182
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
@@ -1209,14 +1273,13 @@ export interface DomainPackageDetails {
|
|
|
1209
1273
|
*/
|
|
1210
1274
|
PackageVersion?: string | undefined;
|
|
1211
1275
|
/**
|
|
1212
|
-
* <p>A list of package IDs that must be associated with the domain before or with the package can
|
|
1213
|
-
* be associated.</p>
|
|
1276
|
+
* <p>A list of package IDs that must be associated with the domain before or with the package can be associated.</p>
|
|
1214
1277
|
* @public
|
|
1215
1278
|
*/
|
|
1216
1279
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
1217
1280
|
/**
|
|
1218
|
-
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is
|
|
1219
|
-
*
|
|
1281
|
+
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is <code>synonym_path</code>
|
|
1282
|
+
* when the package is for synonym files.</p>
|
|
1220
1283
|
* @public
|
|
1221
1284
|
*/
|
|
1222
1285
|
ReferencePath?: string | undefined;
|
|
@@ -1265,8 +1328,7 @@ export interface PackageDetailsForAssociation {
|
|
|
1265
1328
|
*/
|
|
1266
1329
|
PackageID: string | undefined;
|
|
1267
1330
|
/**
|
|
1268
|
-
* <p>List of package IDs that must be linked to the domain before or simultaneously with the
|
|
1269
|
-
* package association.</p>
|
|
1331
|
+
* <p>List of package IDs that must be linked to the domain before or simultaneously with the package association.</p>
|
|
1270
1332
|
* @public
|
|
1271
1333
|
*/
|
|
1272
1334
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
@@ -1357,8 +1419,7 @@ export interface AuthorizedPrincipal {
|
|
|
1357
1419
|
*/
|
|
1358
1420
|
PrincipalType?: PrincipalType | undefined;
|
|
1359
1421
|
/**
|
|
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>
|
|
1422
|
+
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM principal</a> that is allowed access to the domain.</p>
|
|
1362
1423
|
* @public
|
|
1363
1424
|
*/
|
|
1364
1425
|
Principal?: string | undefined;
|
|
@@ -1385,8 +1446,7 @@ export interface CancelDomainConfigChangeRequest {
|
|
|
1385
1446
|
*/
|
|
1386
1447
|
DomainName: string | undefined;
|
|
1387
1448
|
/**
|
|
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>
|
|
1449
|
+
* <p>When set to <code>True</code>, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.</p>
|
|
1390
1450
|
* @public
|
|
1391
1451
|
*/
|
|
1392
1452
|
DryRun?: boolean | undefined;
|
|
@@ -1402,8 +1462,7 @@ export interface CancelledChangeProperty {
|
|
|
1402
1462
|
*/
|
|
1403
1463
|
PropertyName?: string | undefined;
|
|
1404
1464
|
/**
|
|
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>
|
|
1465
|
+
* <p>The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.</p>
|
|
1407
1466
|
* @public
|
|
1408
1467
|
*/
|
|
1409
1468
|
CancelledValue?: string | undefined;
|
|
@@ -1428,8 +1487,7 @@ export interface CancelDomainConfigChangeResponse {
|
|
|
1428
1487
|
*/
|
|
1429
1488
|
CancelledChangeProperties?: CancelledChangeProperty[] | undefined;
|
|
1430
1489
|
/**
|
|
1431
|
-
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not
|
|
1432
|
-
* actually cancelled. </p>
|
|
1490
|
+
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not actually cancelled. </p>
|
|
1433
1491
|
* @public
|
|
1434
1492
|
*/
|
|
1435
1493
|
DryRun?: boolean | undefined;
|
|
@@ -1501,8 +1559,8 @@ export interface ServiceSoftwareOptions {
|
|
|
1501
1559
|
*/
|
|
1502
1560
|
Description?: string | undefined;
|
|
1503
1561
|
/**
|
|
1504
|
-
* <p>The timestamp, in Epoch time, until which you can manually request a service software
|
|
1505
|
-
*
|
|
1562
|
+
* <p>The timestamp, in Epoch time, until which you can manually request a service software update. After this date,
|
|
1563
|
+
* we automatically update your service software.</p>
|
|
1506
1564
|
* @public
|
|
1507
1565
|
*/
|
|
1508
1566
|
AutomatedUpdateDate?: Date | undefined;
|
|
@@ -1538,8 +1596,8 @@ export declare const AppConfigType: {
|
|
|
1538
1596
|
*/
|
|
1539
1597
|
export type AppConfigType = (typeof AppConfigType)[keyof typeof AppConfigType];
|
|
1540
1598
|
/**
|
|
1541
|
-
* <p>Configuration settings for an OpenSearch application. For more information, see
|
|
1542
|
-
*
|
|
1599
|
+
* <p>Configuration settings for an OpenSearch application. For more information, see
|
|
1600
|
+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using the OpenSearch user interface in Amazon OpenSearch Service</a>.</p>
|
|
1543
1601
|
* @public
|
|
1544
1602
|
*/
|
|
1545
1603
|
export interface AppConfig {
|
|
@@ -1560,8 +1618,9 @@ export interface AppConfig {
|
|
|
1560
1618
|
*/
|
|
1561
1619
|
export interface DataSource {
|
|
1562
1620
|
/**
|
|
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
|
|
1564
|
-
*
|
|
1621
|
+
* <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
|
|
1622
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1623
|
+
* </p>
|
|
1565
1624
|
* @public
|
|
1566
1625
|
*/
|
|
1567
1626
|
dataSourceArn?: string | undefined;
|
|
@@ -1582,8 +1641,9 @@ export interface IamIdentityCenterOptionsInput {
|
|
|
1582
1641
|
*/
|
|
1583
1642
|
enabled?: boolean | undefined;
|
|
1584
1643
|
/**
|
|
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
|
|
1586
|
-
*
|
|
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
|
|
1645
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1646
|
+
* </p>
|
|
1587
1647
|
* @public
|
|
1588
1648
|
*/
|
|
1589
1649
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
@@ -1613,14 +1673,12 @@ export interface CreateApplicationRequest {
|
|
|
1613
1673
|
*/
|
|
1614
1674
|
dataSources?: DataSource[] | undefined;
|
|
1615
1675
|
/**
|
|
1616
|
-
* <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the
|
|
1617
|
-
* OpenSearch application.</p>
|
|
1676
|
+
* <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.</p>
|
|
1618
1677
|
* @public
|
|
1619
1678
|
*/
|
|
1620
1679
|
iamIdentityCenterOptions?: IamIdentityCenterOptionsInput | undefined;
|
|
1621
1680
|
/**
|
|
1622
|
-
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1623
|
-
* options.</p>
|
|
1681
|
+
* <p>Configuration settings for the OpenSearch application, including administrative options.</p>
|
|
1624
1682
|
* @public
|
|
1625
1683
|
*/
|
|
1626
1684
|
appConfigs?: AppConfig[] | undefined;
|
|
@@ -1641,20 +1699,21 @@ export interface IamIdentityCenterOptions {
|
|
|
1641
1699
|
*/
|
|
1642
1700
|
enabled?: boolean | undefined;
|
|
1643
1701
|
/**
|
|
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
|
|
1645
|
-
*
|
|
1702
|
+
* <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
|
|
1703
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1704
|
+
* </p>
|
|
1646
1705
|
* @public
|
|
1647
1706
|
*/
|
|
1648
1707
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
1649
1708
|
/**
|
|
1650
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center
|
|
1651
|
-
* application for the OpenSearch application.</p>
|
|
1709
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.</p>
|
|
1652
1710
|
* @public
|
|
1653
1711
|
*/
|
|
1654
1712
|
iamRoleForIdentityCenterApplicationArn?: string | undefined;
|
|
1655
1713
|
/**
|
|
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
|
|
1657
|
-
*
|
|
1714
|
+
* <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
|
|
1715
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1716
|
+
* </p>
|
|
1658
1717
|
* @public
|
|
1659
1718
|
*/
|
|
1660
1719
|
iamIdentityCenterApplicationArn?: string | undefined;
|
|
@@ -1674,8 +1733,9 @@ export interface CreateApplicationResponse {
|
|
|
1674
1733
|
*/
|
|
1675
1734
|
name?: string | undefined;
|
|
1676
1735
|
/**
|
|
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
|
|
1678
|
-
*
|
|
1736
|
+
* <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
|
|
1737
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1738
|
+
* </p>
|
|
1679
1739
|
* @public
|
|
1680
1740
|
*/
|
|
1681
1741
|
arn?: string | undefined;
|
|
@@ -1690,8 +1750,7 @@ export interface CreateApplicationResponse {
|
|
|
1690
1750
|
*/
|
|
1691
1751
|
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
1692
1752
|
/**
|
|
1693
|
-
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1694
|
-
* options.</p>
|
|
1753
|
+
* <p>Configuration settings for the OpenSearch application, including administrative options.</p>
|
|
1695
1754
|
* @public
|
|
1696
1755
|
*/
|
|
1697
1756
|
appConfigs?: AppConfig[] | undefined;
|
|
@@ -1749,10 +1808,11 @@ export interface Duration {
|
|
|
1749
1808
|
/**
|
|
1750
1809
|
* <note>
|
|
1751
1810
|
* <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
|
|
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
|
-
*
|
|
1811
|
+
* 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 Auto-Tune
|
|
1812
|
+
* maintenance windows</a>.</p>
|
|
1754
1813
|
* </note>
|
|
1755
|
-
* <p>The Auto-Tune maintenance schedule.
|
|
1814
|
+
* <p>The Auto-Tune maintenance schedule.
|
|
1815
|
+
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch
|
|
1756
1816
|
* Service</a>.</p>
|
|
1757
1817
|
* @public
|
|
1758
1818
|
*/
|
|
@@ -1788,14 +1848,12 @@ export interface AutoTuneOptionsInput {
|
|
|
1788
1848
|
*/
|
|
1789
1849
|
DesiredState?: AutoTuneDesiredState | undefined;
|
|
1790
1850
|
/**
|
|
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>
|
|
1851
|
+
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance 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>
|
|
1793
1852
|
* @public
|
|
1794
1853
|
*/
|
|
1795
1854
|
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[] | undefined;
|
|
1796
1855
|
/**
|
|
1797
|
-
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the
|
|
1798
|
-
* domain's configured daily off-peak window.</p>
|
|
1856
|
+
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.</p>
|
|
1799
1857
|
* @public
|
|
1800
1858
|
*/
|
|
1801
1859
|
UseOffPeakWindow?: boolean | undefined;
|
|
@@ -1808,8 +1866,7 @@ export interface AutoTuneOptionsInput {
|
|
|
1808
1866
|
*/
|
|
1809
1867
|
export interface ColdStorageOptions {
|
|
1810
1868
|
/**
|
|
1811
|
-
* <p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage
|
|
1812
|
-
* to enable cold storage.</p>
|
|
1869
|
+
* <p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.</p>
|
|
1813
1870
|
* @public
|
|
1814
1871
|
*/
|
|
1815
1872
|
Enabled: boolean | undefined;
|
|
@@ -2003,8 +2060,7 @@ export interface ZoneAwarenessConfig {
|
|
|
2003
2060
|
}
|
|
2004
2061
|
/**
|
|
2005
2062
|
* <p>Container for the cluster configuration of an OpenSearch Service domain. For more
|
|
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>
|
|
2063
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html">Creating and managing Amazon OpenSearch Service domains</a>.</p>
|
|
2008
2064
|
* @public
|
|
2009
2065
|
*/
|
|
2010
2066
|
export interface ClusterConfig {
|
|
@@ -2042,8 +2098,8 @@ export interface ClusterConfig {
|
|
|
2042
2098
|
*/
|
|
2043
2099
|
DedicatedMasterType?: OpenSearchPartitionInstanceType | undefined;
|
|
2044
2100
|
/**
|
|
2045
|
-
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not
|
|
2046
|
-
*
|
|
2101
|
+
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4,
|
|
2102
|
+
* otherwise you receive a validation exception.</p>
|
|
2047
2103
|
* @public
|
|
2048
2104
|
*/
|
|
2049
2105
|
DedicatedMasterCount?: number | undefined;
|
|
@@ -2068,9 +2124,7 @@ export interface ClusterConfig {
|
|
|
2068
2124
|
*/
|
|
2069
2125
|
ColdStorageOptions?: ColdStorageOptions | undefined;
|
|
2070
2126
|
/**
|
|
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>
|
|
2127
|
+
* <p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html">Configuring a multi-AZ domain in Amazon OpenSearch Service</a>. </p>
|
|
2074
2128
|
* @public
|
|
2075
2129
|
*/
|
|
2076
2130
|
MultiAZWithStandbyEnabled?: boolean | undefined;
|
|
@@ -2225,9 +2279,9 @@ export interface EBSOptions {
|
|
|
2225
2279
|
}
|
|
2226
2280
|
/**
|
|
2227
2281
|
* <p>Specifies whether the domain should encrypt data at rest, and if so, the Key Management
|
|
2228
|
-
* Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at
|
|
2229
|
-
*
|
|
2230
|
-
*
|
|
2282
|
+
* Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest
|
|
2283
|
+
* for the first time on an existing domain. You can't modify this parameter after it's already been
|
|
2284
|
+
* specified.</p>
|
|
2231
2285
|
* @public
|
|
2232
2286
|
*/
|
|
2233
2287
|
export interface EncryptionAtRestOptions {
|
|
@@ -2273,26 +2327,22 @@ export type SubjectKeyIdCOption = (typeof SubjectKeyIdCOption)[keyof typeof Subj
|
|
|
2273
2327
|
*/
|
|
2274
2328
|
export interface IdentityCenterOptionsInput {
|
|
2275
2329
|
/**
|
|
2276
|
-
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch
|
|
2277
|
-
* Service.</p>
|
|
2330
|
+
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.</p>
|
|
2278
2331
|
* @public
|
|
2279
2332
|
*/
|
|
2280
2333
|
EnabledAPIAccess?: boolean | undefined;
|
|
2281
2334
|
/**
|
|
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>
|
|
2335
|
+
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.</p>
|
|
2284
2336
|
* @public
|
|
2285
2337
|
*/
|
|
2286
2338
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2287
2339
|
/**
|
|
2288
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2289
|
-
* email) in IAM Identity Center.</p>
|
|
2340
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.</p>
|
|
2290
2341
|
* @public
|
|
2291
2342
|
*/
|
|
2292
2343
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2293
2344
|
/**
|
|
2294
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2295
|
-
* group ID) in IAM Identity Center.</p>
|
|
2345
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.</p>
|
|
2296
2346
|
* @public
|
|
2297
2347
|
*/
|
|
2298
2348
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
@@ -2325,8 +2375,7 @@ export declare const LogType: {
|
|
|
2325
2375
|
export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
2326
2376
|
/**
|
|
2327
2377
|
* <p>Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application
|
|
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>
|
|
2378
|
+
* 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 OpenSearch logs with Amazon CloudWatch Logs</a>.</p>
|
|
2330
2379
|
* <note>
|
|
2331
2380
|
* <p>After you enable log publishing, you still have to enable the collection of slow logs using
|
|
2332
2381
|
* the OpenSearch REST API.</p>
|
|
@@ -2346,8 +2395,7 @@ export interface LogPublishingOption {
|
|
|
2346
2395
|
Enabled?: boolean | undefined;
|
|
2347
2396
|
}
|
|
2348
2397
|
/**
|
|
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>
|
|
2398
|
+
* <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 encryption for Amazon OpenSearch Service</a>.</p>
|
|
2351
2399
|
* @public
|
|
2352
2400
|
*/
|
|
2353
2401
|
export interface NodeToNodeEncryptionOptions {
|
|
@@ -2364,8 +2412,8 @@ export interface NodeToNodeEncryptionOptions {
|
|
|
2364
2412
|
*/
|
|
2365
2413
|
export interface WindowStartTime {
|
|
2366
2414
|
/**
|
|
2367
|
-
* <p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For
|
|
2368
|
-
*
|
|
2415
|
+
* <p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, <code>17</code> refers to
|
|
2416
|
+
* 5:00 P.M. UTC.</p>
|
|
2369
2417
|
* @public
|
|
2370
2418
|
*/
|
|
2371
2419
|
Hours: number | undefined;
|
|
@@ -2378,8 +2426,8 @@ export interface WindowStartTime {
|
|
|
2378
2426
|
/**
|
|
2379
2427
|
* <p>A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory
|
|
2380
2428
|
* configuration changes on the domain. These actions can include scheduled service software updates
|
|
2381
|
-
* and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these
|
|
2382
|
-
* window that you specify.</p>
|
|
2429
|
+
* and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these
|
|
2430
|
+
* actions during the window that you specify.</p>
|
|
2383
2431
|
* <p>If you don't specify a window start time, it defaults to 10:00 P.M. local time.</p>
|
|
2384
2432
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">Defining off-peak maintenance
|
|
2385
2433
|
* windows for Amazon OpenSearch Service</a>.</p>
|
|
@@ -2454,8 +2502,7 @@ export interface VPCOptions {
|
|
|
2454
2502
|
SubnetIds?: string[] | undefined;
|
|
2455
2503
|
/**
|
|
2456
2504
|
* <p>The list of security group IDs associated with the VPC endpoints for the domain. If you do
|
|
2457
|
-
* not provide a security group ID, OpenSearch Service uses the default security group for the
|
|
2458
|
-
* VPC.</p>
|
|
2505
|
+
* not provide a security group ID, OpenSearch Service uses the default security group for the VPC.</p>
|
|
2459
2506
|
* @public
|
|
2460
2507
|
*/
|
|
2461
2508
|
SecurityGroupIds?: string[] | undefined;
|
|
@@ -2497,8 +2544,8 @@ export interface CreateDomainRequest {
|
|
|
2497
2544
|
AccessPolicies?: string | undefined;
|
|
2498
2545
|
/**
|
|
2499
2546
|
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share
|
|
2500
|
-
* domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
2501
|
-
* your IP address type to dual stack, you can't change your address type later.</p>
|
|
2547
|
+
* domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
2548
|
+
* If you set your IP address type to dual stack, you can't change your address type later.</p>
|
|
2502
2549
|
* @public
|
|
2503
2550
|
*/
|
|
2504
2551
|
IPAddressType?: IPAddressType | undefined;
|
|
@@ -2585,8 +2632,7 @@ export interface CreateDomainRequest {
|
|
|
2585
2632
|
*/
|
|
2586
2633
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
2587
2634
|
/**
|
|
2588
|
-
* <p>Configuration options for enabling and managing IAM Identity Center integration within a
|
|
2589
|
-
* domain.</p>
|
|
2635
|
+
* <p>Configuration options for enabling and managing IAM Identity Center integration within a domain.</p>
|
|
2590
2636
|
* @public
|
|
2591
2637
|
*/
|
|
2592
2638
|
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
@@ -2654,8 +2700,8 @@ export interface AutoTuneOptionsOutput {
|
|
|
2654
2700
|
*/
|
|
2655
2701
|
ErrorMessage?: string | undefined;
|
|
2656
2702
|
/**
|
|
2657
|
-
* <p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather
|
|
2658
|
-
* maintenance schedule.</p>
|
|
2703
|
+
* <p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather
|
|
2704
|
+
* than a maintenance schedule.</p>
|
|
2659
2705
|
* @public
|
|
2660
2706
|
*/
|
|
2661
2707
|
UseOffPeakWindow?: boolean | undefined;
|
|
@@ -2716,8 +2762,7 @@ export interface ChangeProgressDetails {
|
|
|
2716
2762
|
*/
|
|
2717
2763
|
InitiatedBy?: InitiatedBy | undefined;
|
|
2718
2764
|
/**
|
|
2719
|
-
* <p>The time that the configuration change was initiated, in Universal Coordinated Time
|
|
2720
|
-
* (UTC).</p>
|
|
2765
|
+
* <p>The time that the configuration change was initiated, in Universal Coordinated Time (UTC).</p>
|
|
2721
2766
|
* @public
|
|
2722
2767
|
*/
|
|
2723
2768
|
StartTime?: Date | undefined;
|
|
@@ -2746,9 +2791,8 @@ export declare const DomainProcessingStatusType: {
|
|
|
2746
2791
|
export type DomainProcessingStatusType = (typeof DomainProcessingStatusType)[keyof typeof DomainProcessingStatusType];
|
|
2747
2792
|
/**
|
|
2748
2793
|
* <p>Settings container for integrating IAM Identity Center with OpenSearch UI applications,
|
|
2749
|
-
* which enables enabling secure user authentication and access control across multiple data
|
|
2750
|
-
*
|
|
2751
|
-
* centralized user management.</p>
|
|
2794
|
+
* which enables enabling secure user authentication and access control across multiple data sources.
|
|
2795
|
+
* This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.</p>
|
|
2752
2796
|
* @public
|
|
2753
2797
|
*/
|
|
2754
2798
|
export interface IdentityCenterOptions {
|
|
@@ -2763,20 +2807,17 @@ export interface IdentityCenterOptions {
|
|
|
2763
2807
|
*/
|
|
2764
2808
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2765
2809
|
/**
|
|
2766
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2767
|
-
* email) in IAM Identity Center.</p>
|
|
2810
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.</p>
|
|
2768
2811
|
* @public
|
|
2769
2812
|
*/
|
|
2770
2813
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2771
2814
|
/**
|
|
2772
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2773
|
-
* group ID) in IAM Identity Center.</p>
|
|
2815
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.</p>
|
|
2774
2816
|
* @public
|
|
2775
2817
|
*/
|
|
2776
2818
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
2777
2819
|
/**
|
|
2778
|
-
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch
|
|
2779
|
-
* Service.</p>
|
|
2820
|
+
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.</p>
|
|
2780
2821
|
* @public
|
|
2781
2822
|
*/
|
|
2782
2823
|
IdentityCenterApplicationARN?: string | undefined;
|
|
@@ -2823,13 +2864,11 @@ export interface ModifyingProperties {
|
|
|
2823
2864
|
* <ul>
|
|
2824
2865
|
* <li>
|
|
2825
2866
|
* <p>
|
|
2826
|
-
* <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or
|
|
2827
|
-
* "c5.large.search".</p>
|
|
2867
|
+
* <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or "c5.large.search".</p>
|
|
2828
2868
|
* </li>
|
|
2829
2869
|
* <li>
|
|
2830
2870
|
* <p>
|
|
2831
|
-
* <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as
|
|
2832
|
-
* \{"Enabled":"True"\}".</p>
|
|
2871
|
+
* <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as \{"Enabled":"True"\}".</p>
|
|
2833
2872
|
* </li>
|
|
2834
2873
|
* </ul>
|
|
2835
2874
|
* @public
|
|
@@ -2907,15 +2946,15 @@ export interface DomainStatus {
|
|
|
2907
2946
|
*/
|
|
2908
2947
|
Endpoint?: string | undefined;
|
|
2909
2948
|
/**
|
|
2910
|
-
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint
|
|
2911
|
-
*
|
|
2912
|
-
*
|
|
2949
|
+
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned.
|
|
2950
|
+
* This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses.
|
|
2951
|
+
* Normal endpoints work only with IPv4 IP addresses.
|
|
2952
|
+
* </p>
|
|
2913
2953
|
* @public
|
|
2914
2954
|
*/
|
|
2915
2955
|
EndpointV2?: string | undefined;
|
|
2916
2956
|
/**
|
|
2917
|
-
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For
|
|
2918
|
-
* example:</p>
|
|
2957
|
+
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:</p>
|
|
2919
2958
|
* <ul>
|
|
2920
2959
|
* <li>
|
|
2921
2960
|
* <p>
|
|
@@ -3031,8 +3070,7 @@ export interface DomainStatus {
|
|
|
3031
3070
|
*/
|
|
3032
3071
|
AdvancedSecurityOptions?: AdvancedSecurityOptions | undefined;
|
|
3033
3072
|
/**
|
|
3034
|
-
* <p>Configuration options for controlling IAM Identity Center integration within a
|
|
3035
|
-
* domain.</p>
|
|
3073
|
+
* <p>Configuration options for controlling IAM Identity Center integration within a domain.</p>
|
|
3036
3074
|
* @public
|
|
3037
3075
|
*/
|
|
3038
3076
|
IdentityCenterOptions?: IdentityCenterOptions | undefined;
|
|
@@ -3224,43 +3262,40 @@ export interface OutboundConnectionStatus {
|
|
|
3224
3262
|
* </li>
|
|
3225
3263
|
* <li>
|
|
3226
3264
|
* <p>
|
|
3227
|
-
* <b>PENDING_ACCEPTANCE</b>: Outbound connection request is
|
|
3228
|
-
*
|
|
3265
|
+
* <b>PENDING_ACCEPTANCE</b>: Outbound connection request is validated and is
|
|
3266
|
+
* not yet accepted by the remote domain owner.</p>
|
|
3229
3267
|
* </li>
|
|
3230
3268
|
* <li>
|
|
3231
3269
|
* <p>
|
|
3232
|
-
* <b>APPROVED</b> - Outbound connection has been approved by the
|
|
3233
|
-
*
|
|
3270
|
+
* <b>APPROVED</b> - Outbound connection has been approved by the remote domain
|
|
3271
|
+
* owner for getting provisioned.</p>
|
|
3234
3272
|
* </li>
|
|
3235
3273
|
* <li>
|
|
3236
3274
|
* <p>
|
|
3237
|
-
* <b>PROVISIONING</b> - Outbound connection request is in
|
|
3238
|
-
* process.</p>
|
|
3275
|
+
* <b>PROVISIONING</b> - Outbound connection request is in process.</p>
|
|
3239
3276
|
* </li>
|
|
3240
3277
|
* <li>
|
|
3241
3278
|
* <p>
|
|
3242
|
-
* <b>ACTIVE</b> - Outbound connection is active and ready to
|
|
3243
|
-
* use.</p>
|
|
3279
|
+
* <b>ACTIVE</b> - Outbound connection is active and ready to use.</p>
|
|
3244
3280
|
* </li>
|
|
3245
3281
|
* <li>
|
|
3246
3282
|
* <p>
|
|
3247
|
-
* <b>REJECTING</b> - Outbound connection rejection by remote
|
|
3248
|
-
*
|
|
3283
|
+
* <b>REJECTING</b> - Outbound connection rejection by remote domain owner is in
|
|
3284
|
+
* progress.</p>
|
|
3249
3285
|
* </li>
|
|
3250
3286
|
* <li>
|
|
3251
3287
|
* <p>
|
|
3252
|
-
* <b>REJECTED</b> - Outbound connection request is rejected by
|
|
3253
|
-
*
|
|
3288
|
+
* <b>REJECTED</b> - Outbound connection request is rejected by remote domain
|
|
3289
|
+
* owner.</p>
|
|
3254
3290
|
* </li>
|
|
3255
3291
|
* <li>
|
|
3256
3292
|
* <p>
|
|
3257
|
-
* <b>DELETING</b> - Outbound connection deletion is in
|
|
3258
|
-
* progress.</p>
|
|
3293
|
+
* <b>DELETING</b> - Outbound connection deletion is in progress.</p>
|
|
3259
3294
|
* </li>
|
|
3260
3295
|
* <li>
|
|
3261
3296
|
* <p>
|
|
3262
|
-
* <b>DELETED</b> - Outbound connection is deleted and can no
|
|
3263
|
-
*
|
|
3297
|
+
* <b>DELETED</b> - Outbound connection is deleted and can no longer be
|
|
3298
|
+
* used.</p>
|
|
3264
3299
|
* </li>
|
|
3265
3300
|
* </ul>
|
|
3266
3301
|
* @public
|
|
@@ -3349,8 +3384,7 @@ export interface PackageConfiguration {
|
|
|
3349
3384
|
*/
|
|
3350
3385
|
ConfigurationRequirement: RequirementLevel | undefined;
|
|
3351
3386
|
/**
|
|
3352
|
-
* <p>This indicates whether a B/G deployment is required for updating the configuration that the
|
|
3353
|
-
* plugin is prerequisite for.</p>
|
|
3387
|
+
* <p>This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.</p>
|
|
3354
3388
|
* @public
|
|
3355
3389
|
*/
|
|
3356
3390
|
RequiresRestartForConfigurationUpdate?: boolean | undefined;
|
|
@@ -3388,14 +3422,12 @@ export interface PackageSource {
|
|
|
3388
3422
|
S3Key?: string | undefined;
|
|
3389
3423
|
}
|
|
3390
3424
|
/**
|
|
3391
|
-
* <p>Configuration options for determining whether a package can be made available for use by
|
|
3392
|
-
* other users.</p>
|
|
3425
|
+
* <p>Configuration options for determining whether a package can be made available for use by other users.</p>
|
|
3393
3426
|
* @public
|
|
3394
3427
|
*/
|
|
3395
3428
|
export interface PackageVendingOptions {
|
|
3396
3429
|
/**
|
|
3397
|
-
* <p>Indicates whether the package vending feature is enabled, allowing the package to be used by
|
|
3398
|
-
* other users.</p>
|
|
3430
|
+
* <p>Indicates whether the package vending feature is enabled, allowing the package to be used by other users.</p>
|
|
3399
3431
|
* @public
|
|
3400
3432
|
*/
|
|
3401
3433
|
VendingEnabled: boolean | undefined;
|
|
@@ -3431,15 +3463,13 @@ export interface CreatePackageRequest {
|
|
|
3431
3463
|
*/
|
|
3432
3464
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
3433
3465
|
/**
|
|
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>
|
|
3466
|
+
* <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code>
|
|
3436
3467
|
* </p>
|
|
3437
3468
|
* @public
|
|
3438
3469
|
*/
|
|
3439
3470
|
EngineVersion?: string | undefined;
|
|
3440
3471
|
/**
|
|
3441
|
-
* <p> The vending options for the package being created. They determine if the package can be
|
|
3442
|
-
* vended to other users.</p>
|
|
3472
|
+
* <p> The vending options for the package being created. They determine if the package can be vended to other users.</p>
|
|
3443
3473
|
* @public
|
|
3444
3474
|
*/
|
|
3445
3475
|
PackageVendingOptions?: PackageVendingOptions | undefined;
|
|
@@ -3524,9 +3554,7 @@ export interface PackageDetails {
|
|
|
3524
3554
|
*/
|
|
3525
3555
|
PackageDescription?: string | undefined;
|
|
3526
3556
|
/**
|
|
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>
|
|
3557
|
+
* <p>The current status of the package. The available options are <code>AVAILABLE</code>, <code>COPYING</code>, <code>COPY_FAILED</code>, <code>VALIDATNG</code>, <code>VALIDATION_FAILED</code>, <code>DELETING</code>, and <code>DELETE_FAILED</code>.</p>
|
|
3530
3558
|
* @public
|
|
3531
3559
|
*/
|
|
3532
3560
|
PackageStatus?: PackageStatus | undefined;
|
|
@@ -3557,8 +3585,7 @@ export interface PackageDetails {
|
|
|
3557
3585
|
*/
|
|
3558
3586
|
EngineVersion?: string | undefined;
|
|
3559
3587
|
/**
|
|
3560
|
-
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin
|
|
3561
|
-
* properties.</p>
|
|
3588
|
+
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin properties.</p>
|
|
3562
3589
|
* @public
|
|
3563
3590
|
*/
|
|
3564
3591
|
AvailablePluginProperties?: PluginProperties | undefined;
|
|
@@ -3568,14 +3595,12 @@ export interface PackageDetails {
|
|
|
3568
3595
|
*/
|
|
3569
3596
|
AvailablePackageConfiguration?: PackageConfiguration | undefined;
|
|
3570
3597
|
/**
|
|
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>
|
|
3598
|
+
* <p> A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.</p>
|
|
3573
3599
|
* @public
|
|
3574
3600
|
*/
|
|
3575
3601
|
AllowListedUserList?: string[] | undefined;
|
|
3576
3602
|
/**
|
|
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>
|
|
3603
|
+
* <p>The owner of the package who is allowed to create and update a package and add users to the package scope.</p>
|
|
3579
3604
|
* @public
|
|
3580
3605
|
*/
|
|
3581
3606
|
PackageOwner?: string | undefined;
|
|
@@ -3702,7 +3727,8 @@ export interface DeleteApplicationRequest {
|
|
|
3702
3727
|
export interface DeleteApplicationResponse {
|
|
3703
3728
|
}
|
|
3704
3729
|
/**
|
|
3705
|
-
* <p>Container for the parameters to the <code>DeleteDataSource</code>
|
|
3730
|
+
* <p>Container for the parameters to the <code>DeleteDataSource</code>
|
|
3731
|
+
* operation.</p>
|
|
3706
3732
|
* @public
|
|
3707
3733
|
*/
|
|
3708
3734
|
export interface DeleteDataSourceRequest {
|
|
@@ -3733,8 +3759,10 @@ export interface DeleteDataSourceResponse {
|
|
|
3733
3759
|
*/
|
|
3734
3760
|
export interface DeleteDirectQueryDataSourceRequest {
|
|
3735
3761
|
/**
|
|
3736
|
-
* <p>
|
|
3737
|
-
*
|
|
3762
|
+
* <p>
|
|
3763
|
+
* A unique, user-defined label to identify the data source
|
|
3764
|
+
* within your OpenSearch Service environment.
|
|
3765
|
+
* </p>
|
|
3738
3766
|
* @public
|
|
3739
3767
|
*/
|
|
3740
3768
|
DataSourceName: string | undefined;
|
|
@@ -3752,8 +3780,7 @@ export interface DeleteDomainRequest {
|
|
|
3752
3780
|
}
|
|
3753
3781
|
/**
|
|
3754
3782
|
* <p>The results of a <code>DeleteDomain</code> request. Contains the status of the pending
|
|
3755
|
-
* deletion, or a "domain not found" error if the domain and all of its resources have been
|
|
3756
|
-
* deleted.</p>
|
|
3783
|
+
* deletion, or a "domain not found" error if the domain and all of its resources have been deleted.</p>
|
|
3757
3784
|
* @public
|
|
3758
3785
|
*/
|
|
3759
3786
|
export interface DeleteDomainResponse {
|
|
@@ -3856,8 +3883,7 @@ export interface DeleteOutboundConnectionResponse {
|
|
|
3856
3883
|
*/
|
|
3857
3884
|
export interface DeletePackageRequest {
|
|
3858
3885
|
/**
|
|
3859
|
-
* <p>The internal ID of the package you want to delete. Use <code>DescribePackages</code> to find
|
|
3860
|
-
* this value.</p>
|
|
3886
|
+
* <p>The internal ID of the package you want to delete. Use <code>DescribePackages</code> to find this value.</p>
|
|
3861
3887
|
* @public
|
|
3862
3888
|
*/
|
|
3863
3889
|
PackageID: string | undefined;
|
|
@@ -4071,8 +4097,8 @@ export interface DescribeDomainAutoTunesResponse {
|
|
|
4071
4097
|
AutoTunes?: AutoTune[] | undefined;
|
|
4072
4098
|
/**
|
|
4073
4099
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
4074
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
4075
|
-
*
|
|
4100
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
4101
|
+
* returned token to retrieve the next page.</p>
|
|
4076
4102
|
* @public
|
|
4077
4103
|
*/
|
|
4078
4104
|
NextToken?: string | undefined;
|
|
@@ -4171,8 +4197,7 @@ export interface ChangeProgressStatusDetails {
|
|
|
4171
4197
|
*/
|
|
4172
4198
|
TotalNumberOfStages?: number | undefined;
|
|
4173
4199
|
/**
|
|
4174
|
-
* <p>The specific stages that the domain is going through to perform the configuration
|
|
4175
|
-
* change.</p>
|
|
4200
|
+
* <p>The specific stages that the domain is going through to perform the configuration change.</p>
|
|
4176
4201
|
* @public
|
|
4177
4202
|
*/
|
|
4178
4203
|
ChangeProgressStages?: ChangeProgressStage[] | undefined;
|
|
@@ -4199,8 +4224,7 @@ export interface ChangeProgressStatusDetails {
|
|
|
4199
4224
|
*/
|
|
4200
4225
|
export interface DescribeDomainChangeProgressResponse {
|
|
4201
4226
|
/**
|
|
4202
|
-
* <p>Container for information about the stages of a configuration change happening on a
|
|
4203
|
-
* domain.</p>
|
|
4227
|
+
* <p>Container for information about the stages of a configuration change happening on a domain.</p>
|
|
4204
4228
|
* @public
|
|
4205
4229
|
*/
|
|
4206
4230
|
ChangeProgressStatus?: ChangeProgressStatusDetails | undefined;
|
|
@@ -4520,8 +4544,7 @@ export interface SoftwareUpdateOptionsStatus {
|
|
|
4520
4544
|
*/
|
|
4521
4545
|
Options?: SoftwareUpdateOptions | undefined;
|
|
4522
4546
|
/**
|
|
4523
|
-
* <p>The status of service software update options, including creation date and last updated
|
|
4524
|
-
* date.</p>
|
|
4547
|
+
* <p>The status of service software update options, including creation date and last updated date.</p>
|
|
4525
4548
|
* @public
|
|
4526
4549
|
*/
|
|
4527
4550
|
Status?: OptionStatus | undefined;
|
|
@@ -4568,9 +4591,9 @@ export interface DomainConfig {
|
|
|
4568
4591
|
*/
|
|
4569
4592
|
AccessPolicies?: AccessPoliciesStatus | undefined;
|
|
4570
4593
|
/**
|
|
4571
|
-
* <p>Choose either dual stack or IPv4 as your IP address type.
|
|
4572
|
-
* domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
4573
|
-
* your IP address type to dual stack, you can't change your address type later.</p>
|
|
4594
|
+
* <p>Choose either dual stack or IPv4 as your IP address type.
|
|
4595
|
+
* Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
4596
|
+
* If you set your IP address type to dual stack, you can't change your address type later.</p>
|
|
4574
4597
|
* @public
|
|
4575
4598
|
*/
|
|
4576
4599
|
IPAddressType?: IPAddressTypeStatus | undefined;
|
|
@@ -4623,8 +4646,7 @@ export interface DomainConfig {
|
|
|
4623
4646
|
*/
|
|
4624
4647
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus | undefined;
|
|
4625
4648
|
/**
|
|
4626
|
-
* <p>Configuration options for enabling and managing IAM Identity Center integration within a
|
|
4627
|
-
* domain.</p>
|
|
4649
|
+
* <p>Configuration options for enabling and managing IAM Identity Center integration within a domain.</p>
|
|
4628
4650
|
* @public
|
|
4629
4651
|
*/
|
|
4630
4652
|
IdentityCenterOptions?: IdentityCenterOptionsStatus | undefined;
|
|
@@ -4732,8 +4754,7 @@ export interface AvailabilityZoneInfo {
|
|
|
4732
4754
|
*/
|
|
4733
4755
|
AvailabilityZoneName?: string | undefined;
|
|
4734
4756
|
/**
|
|
4735
|
-
* <p>The current state of the Availability Zone. Current options are <code>Active</code> and
|
|
4736
|
-
* <code>StandBy</code>.</p>
|
|
4757
|
+
* <p>The current state of the Availability Zone. Current options are <code>Active</code> and <code>StandBy</code>.</p>
|
|
4737
4758
|
* <ul>
|
|
4738
4759
|
* <li>
|
|
4739
4760
|
* <p>
|
|
@@ -4767,8 +4788,7 @@ export interface AvailabilityZoneInfo {
|
|
|
4767
4788
|
*/
|
|
4768
4789
|
TotalShards?: string | undefined;
|
|
4769
4790
|
/**
|
|
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>
|
|
4791
|
+
* <p>The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.</p>
|
|
4772
4792
|
* @public
|
|
4773
4793
|
*/
|
|
4774
4794
|
TotalUnAssignedShards?: string | undefined;
|
|
@@ -4797,8 +4817,7 @@ export declare const MasterNodeStatus: {
|
|
|
4797
4817
|
*/
|
|
4798
4818
|
export type MasterNodeStatus = (typeof MasterNodeStatus)[keyof typeof MasterNodeStatus];
|
|
4799
4819
|
/**
|
|
4800
|
-
* <p>The result of a <code>DescribeDomainHealth</code> request. Contains health information for
|
|
4801
|
-
* the requested domain.</p>
|
|
4820
|
+
* <p>The result of a <code>DescribeDomainHealth</code> request. Contains health information for the requested domain.</p>
|
|
4802
4821
|
* @public
|
|
4803
4822
|
*/
|
|
4804
4823
|
export interface DescribeDomainHealthResponse {
|
|
@@ -4811,34 +4830,29 @@ export interface DescribeDomainHealthResponse {
|
|
|
4811
4830
|
* </li>
|
|
4812
4831
|
* <li>
|
|
4813
4832
|
* <p>
|
|
4814
|
-
* <code>Active</code> - Requested changes have been processed and deployed to the
|
|
4815
|
-
* domain.</p>
|
|
4833
|
+
* <code>Active</code> - Requested changes have been processed and deployed to the domain.</p>
|
|
4816
4834
|
* </li>
|
|
4817
4835
|
* </ul>
|
|
4818
4836
|
* @public
|
|
4819
4837
|
*/
|
|
4820
4838
|
DomainState?: DomainState | undefined;
|
|
4821
4839
|
/**
|
|
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>
|
|
4840
|
+
* <p>The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4824
4841
|
* @public
|
|
4825
4842
|
*/
|
|
4826
4843
|
AvailabilityZoneCount?: string | undefined;
|
|
4827
4844
|
/**
|
|
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>
|
|
4845
|
+
* <p>The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4830
4846
|
* @public
|
|
4831
4847
|
*/
|
|
4832
4848
|
ActiveAvailabilityZoneCount?: string | undefined;
|
|
4833
4849
|
/**
|
|
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>
|
|
4850
|
+
* <p>The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4836
4851
|
* @public
|
|
4837
4852
|
*/
|
|
4838
4853
|
StandByAvailabilityZoneCount?: string | undefined;
|
|
4839
4854
|
/**
|
|
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>
|
|
4855
|
+
* <p>The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4842
4856
|
* @public
|
|
4843
4857
|
*/
|
|
4844
4858
|
DataNodeCount?: string | undefined;
|
|
@@ -4848,9 +4862,8 @@ export interface DescribeDomainHealthResponse {
|
|
|
4848
4862
|
*/
|
|
4849
4863
|
DedicatedMaster?: boolean | undefined;
|
|
4850
4864
|
/**
|
|
4851
|
-
* <p>The number of nodes that can be elected as a master node. If dedicated master nodes is
|
|
4852
|
-
*
|
|
4853
|
-
* service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4865
|
+
* <p>The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain.
|
|
4866
|
+
* If the service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4854
4867
|
* @public
|
|
4855
4868
|
*/
|
|
4856
4869
|
MasterEligibleNodeCount?: string | undefined;
|
|
@@ -4868,8 +4881,7 @@ export interface DescribeDomainHealthResponse {
|
|
|
4868
4881
|
* </li>
|
|
4869
4882
|
* <li>
|
|
4870
4883
|
* <p>
|
|
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>
|
|
4884
|
+
* <b>UnAvailable</b> - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.</p>
|
|
4873
4885
|
* </li>
|
|
4874
4886
|
* </ul>
|
|
4875
4887
|
* @public
|
|
@@ -4884,8 +4896,7 @@ export interface DescribeDomainHealthResponse {
|
|
|
4884
4896
|
* </li>
|
|
4885
4897
|
* <li>
|
|
4886
4898
|
* <p>
|
|
4887
|
-
* <code>Yellow</code> - All primary shards are allocated to nodes, but some replicas
|
|
4888
|
-
* aren’t.</p>
|
|
4899
|
+
* <code>Yellow</code> - All primary shards are allocated to nodes, but some replicas aren’t.</p>
|
|
4889
4900
|
* </li>
|
|
4890
4901
|
* <li>
|
|
4891
4902
|
* <p>
|
|
@@ -4905,8 +4916,7 @@ export interface DescribeDomainHealthResponse {
|
|
|
4905
4916
|
*/
|
|
4906
4917
|
TotalShards?: string | undefined;
|
|
4907
4918
|
/**
|
|
4908
|
-
* <p>The total number of primary and replica shards not allocated to any of the nodes for the
|
|
4909
|
-
* cluster.</p>
|
|
4919
|
+
* <p>The total number of primary and replica shards not allocated to any of the nodes for the cluster.</p>
|
|
4910
4920
|
* @public
|
|
4911
4921
|
*/
|
|
4912
4922
|
TotalUnAssignedShards?: string | undefined;
|
|
@@ -4917,7 +4927,8 @@ export interface DescribeDomainHealthResponse {
|
|
|
4917
4927
|
EnvironmentInformation?: EnvironmentInfo[] | undefined;
|
|
4918
4928
|
}
|
|
4919
4929
|
/**
|
|
4920
|
-
* <p>Container for the parameters to the <code>DescribeDomainNodes</code>
|
|
4930
|
+
* <p>Container for the parameters to the <code>DescribeDomainNodes</code>
|
|
4931
|
+
* operation.</p>
|
|
4921
4932
|
* @public
|
|
4922
4933
|
*/
|
|
4923
4934
|
export interface DescribeDomainNodesRequest {
|
|
@@ -5001,14 +5012,13 @@ export interface DomainNodesStatus {
|
|
|
5001
5012
|
StorageSize?: string | undefined;
|
|
5002
5013
|
}
|
|
5003
5014
|
/**
|
|
5004
|
-
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about the
|
|
5005
|
-
* nodes on the requested domain. </p>
|
|
5015
|
+
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about the nodes on the requested domain. </p>
|
|
5006
5016
|
* @public
|
|
5007
5017
|
*/
|
|
5008
5018
|
export interface DescribeDomainNodesResponse {
|
|
5009
5019
|
/**
|
|
5010
|
-
* <p>Contains nodes information list <code>DomainNodesStatusList</code> with
|
|
5011
|
-
* all nodes on the requested domain.</p>
|
|
5020
|
+
* <p>Contains nodes information list <code>DomainNodesStatusList</code> with
|
|
5021
|
+
* details about the all nodes on the requested domain.</p>
|
|
5012
5022
|
* @public
|
|
5013
5023
|
*/
|
|
5014
5024
|
DomainNodesStatusList?: DomainNodesStatus[] | undefined;
|
|
@@ -5182,8 +5192,7 @@ export interface Filter {
|
|
|
5182
5192
|
Values?: string[] | undefined;
|
|
5183
5193
|
}
|
|
5184
5194
|
/**
|
|
5185
|
-
* <p>Container for the parameters to the <code>DescribeInboundConnections</code>
|
|
5186
|
-
* operation.</p>
|
|
5195
|
+
* <p>Container for the parameters to the <code>DescribeInboundConnections</code> operation.</p>
|
|
5187
5196
|
* @public
|
|
5188
5197
|
*/
|
|
5189
5198
|
export interface DescribeInboundConnectionsRequest {
|
|
@@ -5219,8 +5228,8 @@ export interface DescribeInboundConnectionsResponse {
|
|
|
5219
5228
|
Connections?: InboundConnection[] | undefined;
|
|
5220
5229
|
/**
|
|
5221
5230
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5222
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5223
|
-
*
|
|
5231
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5232
|
+
* returned token to retrieve the next page.</p>
|
|
5224
5233
|
* @public
|
|
5225
5234
|
*/
|
|
5226
5235
|
NextToken?: string | undefined;
|
|
@@ -5238,8 +5247,7 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
5238
5247
|
constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
|
|
5239
5248
|
}
|
|
5240
5249
|
/**
|
|
5241
|
-
* <p>Container for the parameters to the <code>DescribeInstanceTypeLimits</code>
|
|
5242
|
-
* operation.</p>
|
|
5250
|
+
* <p>Container for the parameters to the <code>DescribeInstanceTypeLimits</code> operation.</p>
|
|
5243
5251
|
* @public
|
|
5244
5252
|
*/
|
|
5245
5253
|
export interface DescribeInstanceTypeLimitsRequest {
|
|
@@ -5299,23 +5307,23 @@ export interface StorageTypeLimit {
|
|
|
5299
5307
|
* <ul>
|
|
5300
5308
|
* <li>
|
|
5301
5309
|
* <p>
|
|
5302
|
-
* <b>MinimumVolumeSize</b> - Minimum volume size that is available
|
|
5303
|
-
*
|
|
5310
|
+
* <b>MinimumVolumeSize</b> - Minimum volume size that is available for the
|
|
5311
|
+
* given storage type. Can be empty if not applicable.</p>
|
|
5304
5312
|
* </li>
|
|
5305
5313
|
* <li>
|
|
5306
5314
|
* <p>
|
|
5307
|
-
* <b>MaximumVolumeSize</b> - Maximum volume size that is available
|
|
5308
|
-
*
|
|
5315
|
+
* <b>MaximumVolumeSize</b> - Maximum volume size that is available for the
|
|
5316
|
+
* given storage type. Can be empty if not applicable.</p>
|
|
5309
5317
|
* </li>
|
|
5310
5318
|
* <li>
|
|
5311
5319
|
* <p>
|
|
5312
|
-
* <b>MaximumIops</b> - Maximum amount of IOPS that is available
|
|
5313
|
-
*
|
|
5320
|
+
* <b>MaximumIops</b> - Maximum amount of IOPS that is available for the given
|
|
5321
|
+
* the storage type. Can be empty if not applicable.</p>
|
|
5314
5322
|
* </li>
|
|
5315
5323
|
* <li>
|
|
5316
5324
|
* <p>
|
|
5317
|
-
* <b>MinimumIops</b> - Minimum amount of IOPS that is available
|
|
5318
|
-
*
|
|
5325
|
+
* <b>MinimumIops</b> - Minimum amount of IOPS that is available for the given
|
|
5326
|
+
* the storage type. Can be empty if not applicable.</p>
|
|
5319
5327
|
* </li>
|
|
5320
5328
|
* <li>
|
|
5321
5329
|
* <p>
|
|
@@ -5389,14 +5397,13 @@ export interface Limits {
|
|
|
5389
5397
|
export interface DescribeInstanceTypeLimitsResponse {
|
|
5390
5398
|
/**
|
|
5391
5399
|
* <p>Map that contains all applicable instance type limits.<code>data</code> refers to data
|
|
5392
|
-
*
|
|
5400
|
+
* nodes.<code>master</code> refers to dedicated master nodes.</p>
|
|
5393
5401
|
* @public
|
|
5394
5402
|
*/
|
|
5395
5403
|
LimitsByRole?: Record<string, Limits> | undefined;
|
|
5396
5404
|
}
|
|
5397
5405
|
/**
|
|
5398
|
-
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code>
|
|
5399
|
-
* operation.</p>
|
|
5406
|
+
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code> operation.</p>
|
|
5400
5407
|
* @public
|
|
5401
5408
|
*/
|
|
5402
5409
|
export interface DescribeOutboundConnectionsRequest {
|
|
@@ -5432,8 +5439,8 @@ export interface DescribeOutboundConnectionsResponse {
|
|
|
5432
5439
|
Connections?: OutboundConnection[] | undefined;
|
|
5433
5440
|
/**
|
|
5434
5441
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5435
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5436
|
-
*
|
|
5442
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5443
|
+
* returned token to retrieve the next page.</p>
|
|
5437
5444
|
* @public
|
|
5438
5445
|
*/
|
|
5439
5446
|
NextToken?: string | undefined;
|
|
@@ -5482,14 +5489,14 @@ export interface DescribePackagesRequest {
|
|
|
5482
5489
|
Filters?: DescribePackagesFilter[] | undefined;
|
|
5483
5490
|
/**
|
|
5484
5491
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
5485
|
-
*
|
|
5492
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
5486
5493
|
* @public
|
|
5487
5494
|
*/
|
|
5488
5495
|
MaxResults?: number | undefined;
|
|
5489
5496
|
/**
|
|
5490
5497
|
* <p>If your initial <code>DescribePackageFilters</code> operation returns a
|
|
5491
|
-
*
|
|
5492
|
-
*
|
|
5498
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
5499
|
+
* <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>
|
|
5493
5500
|
* @public
|
|
5494
5501
|
*/
|
|
5495
5502
|
NextToken?: string | undefined;
|
|
@@ -5506,8 +5513,8 @@ export interface DescribePackagesResponse {
|
|
|
5506
5513
|
PackageDetailsList?: PackageDetails[] | undefined;
|
|
5507
5514
|
/**
|
|
5508
5515
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5509
|
-
*
|
|
5510
|
-
*
|
|
5516
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5517
|
+
* returned token to retrieve the next page.</p>
|
|
5511
5518
|
* @public
|
|
5512
5519
|
*/
|
|
5513
5520
|
NextToken?: string | undefined;
|
|
@@ -5585,8 +5592,7 @@ export interface ReservedInstanceOffering {
|
|
|
5585
5592
|
*/
|
|
5586
5593
|
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
5587
5594
|
/**
|
|
5588
|
-
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch
|
|
5589
|
-
* instance.</p>
|
|
5595
|
+
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch instance.</p>
|
|
5590
5596
|
* @public
|
|
5591
5597
|
*/
|
|
5592
5598
|
Duration?: number | undefined;
|
|
@@ -5625,8 +5631,8 @@ export interface ReservedInstanceOffering {
|
|
|
5625
5631
|
export interface DescribeReservedInstanceOfferingsResponse {
|
|
5626
5632
|
/**
|
|
5627
5633
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5628
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5629
|
-
*
|
|
5634
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5635
|
+
* returned token to retrieve the next page.</p>
|
|
5630
5636
|
* @public
|
|
5631
5637
|
*/
|
|
5632
5638
|
NextToken?: string | undefined;
|
|
@@ -5643,8 +5649,8 @@ export interface DescribeReservedInstanceOfferingsResponse {
|
|
|
5643
5649
|
*/
|
|
5644
5650
|
export interface DescribeReservedInstancesRequest {
|
|
5645
5651
|
/**
|
|
5646
|
-
* <p>The reserved instance identifier filter value. Use this parameter to show only the
|
|
5647
|
-
*
|
|
5652
|
+
* <p>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the
|
|
5653
|
+
* specified reserved OpenSearch instance ID.</p>
|
|
5648
5654
|
* @public
|
|
5649
5655
|
*/
|
|
5650
5656
|
ReservedInstanceId?: string | undefined;
|
|
@@ -5749,8 +5755,8 @@ export interface ReservedInstance {
|
|
|
5749
5755
|
export interface DescribeReservedInstancesResponse {
|
|
5750
5756
|
/**
|
|
5751
5757
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5752
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
5753
|
-
*
|
|
5758
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5759
|
+
* returned token to retrieve the next page.</p>
|
|
5754
5760
|
* @public
|
|
5755
5761
|
*/
|
|
5756
5762
|
NextToken?: string | undefined;
|
|
@@ -5908,8 +5914,9 @@ export interface GetApplicationResponse {
|
|
|
5908
5914
|
*/
|
|
5909
5915
|
id?: string | undefined;
|
|
5910
5916
|
/**
|
|
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
|
|
5912
|
-
*
|
|
5917
|
+
* <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
|
|
5918
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
5919
|
+
* </p>
|
|
5913
5920
|
* @public
|
|
5914
5921
|
*/
|
|
5915
5922
|
arn?: string | undefined;
|
|
@@ -5924,9 +5931,7 @@ export interface GetApplicationResponse {
|
|
|
5924
5931
|
*/
|
|
5925
5932
|
endpoint?: string | undefined;
|
|
5926
5933
|
/**
|
|
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>
|
|
5934
|
+
* <p>The current status of the OpenSearch application. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
5930
5935
|
* @public
|
|
5931
5936
|
*/
|
|
5932
5937
|
status?: ApplicationStatus | undefined;
|
|
@@ -5986,8 +5991,7 @@ export interface CompatibleVersionsMap {
|
|
|
5986
5991
|
TargetVersions?: string[] | undefined;
|
|
5987
5992
|
}
|
|
5988
5993
|
/**
|
|
5989
|
-
* <p>Container for the response returned by the <code>GetCompatibleVersions</code>
|
|
5990
|
-
* operation.</p>
|
|
5994
|
+
* <p>Container for the response returned by the <code>GetCompatibleVersions</code> operation.</p>
|
|
5991
5995
|
* @public
|
|
5992
5996
|
*/
|
|
5993
5997
|
export interface GetCompatibleVersionsResponse {
|
|
@@ -5999,7 +6003,8 @@ export interface GetCompatibleVersionsResponse {
|
|
|
5999
6003
|
CompatibleVersions?: CompatibleVersionsMap[] | undefined;
|
|
6000
6004
|
}
|
|
6001
6005
|
/**
|
|
6002
|
-
* <p>Container for the parameters to the <code>GetDataSource</code>
|
|
6006
|
+
* <p>Container for the parameters to the <code>GetDataSource</code>
|
|
6007
|
+
* operation.</p>
|
|
6003
6008
|
* @public
|
|
6004
6009
|
*/
|
|
6005
6010
|
export interface GetDataSourceRequest {
|
|
@@ -6057,8 +6062,10 @@ export interface GetDataSourceResponse {
|
|
|
6057
6062
|
*/
|
|
6058
6063
|
export interface GetDirectQueryDataSourceRequest {
|
|
6059
6064
|
/**
|
|
6060
|
-
* <p>
|
|
6061
|
-
*
|
|
6065
|
+
* <p>
|
|
6066
|
+
* A unique, user-defined label that identifies the data source within
|
|
6067
|
+
* your OpenSearch Service environment.
|
|
6068
|
+
* </p>
|
|
6062
6069
|
* @public
|
|
6063
6070
|
*/
|
|
6064
6071
|
DataSourceName: string | undefined;
|
|
@@ -6068,30 +6075,40 @@ export interface GetDirectQueryDataSourceRequest {
|
|
|
6068
6075
|
*/
|
|
6069
6076
|
export interface GetDirectQueryDataSourceResponse {
|
|
6070
6077
|
/**
|
|
6071
|
-
* <p>
|
|
6072
|
-
*
|
|
6078
|
+
* <p>
|
|
6079
|
+
* A unique, user-defined label to identify the data source
|
|
6080
|
+
* within your OpenSearch Service environment.
|
|
6081
|
+
* </p>
|
|
6073
6082
|
* @public
|
|
6074
6083
|
*/
|
|
6075
6084
|
DataSourceName?: string | undefined;
|
|
6076
6085
|
/**
|
|
6077
|
-
* <p>
|
|
6078
|
-
*
|
|
6086
|
+
* <p>
|
|
6087
|
+
* The supported Amazon Web Services service that is used as the source for
|
|
6088
|
+
* direct queries in OpenSearch Service.
|
|
6089
|
+
* </p>
|
|
6079
6090
|
* @public
|
|
6080
6091
|
*/
|
|
6081
6092
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6082
6093
|
/**
|
|
6083
|
-
* <p>
|
|
6094
|
+
* <p>
|
|
6095
|
+
* A description that provides additional context and details about the data source.
|
|
6096
|
+
* </p>
|
|
6084
6097
|
* @public
|
|
6085
6098
|
*/
|
|
6086
6099
|
Description?: string | undefined;
|
|
6087
6100
|
/**
|
|
6088
|
-
* <p>
|
|
6089
|
-
*
|
|
6101
|
+
* <p>
|
|
6102
|
+
* A list of Amazon Resource Names (ARNs) for the OpenSearch
|
|
6103
|
+
* collections that are associated with the direct query data source.
|
|
6104
|
+
* </p>
|
|
6090
6105
|
* @public
|
|
6091
6106
|
*/
|
|
6092
6107
|
OpenSearchArns?: string[] | undefined;
|
|
6093
6108
|
/**
|
|
6094
|
-
* <p>
|
|
6109
|
+
* <p>
|
|
6110
|
+
* The unique, system-generated identifier that represents the data source.
|
|
6111
|
+
* </p>
|
|
6095
6112
|
* @public
|
|
6096
6113
|
*/
|
|
6097
6114
|
DataSourceArn?: string | undefined;
|
|
@@ -6142,8 +6159,7 @@ export declare const MaintenanceStatus: {
|
|
|
6142
6159
|
*/
|
|
6143
6160
|
export type MaintenanceStatus = (typeof MaintenanceStatus)[keyof typeof MaintenanceStatus];
|
|
6144
6161
|
/**
|
|
6145
|
-
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about the
|
|
6146
|
-
* requested action.</p>
|
|
6162
|
+
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about the requested action.</p>
|
|
6147
6163
|
* @public
|
|
6148
6164
|
*/
|
|
6149
6165
|
export interface GetDomainMaintenanceStatusResponse {
|
|
@@ -6179,8 +6195,7 @@ export interface GetDomainMaintenanceStatusResponse {
|
|
|
6179
6195
|
UpdatedAt?: Date | undefined;
|
|
6180
6196
|
}
|
|
6181
6197
|
/**
|
|
6182
|
-
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code>
|
|
6183
|
-
* operation.</p>
|
|
6198
|
+
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code> operation.</p>
|
|
6184
6199
|
* @public
|
|
6185
6200
|
*/
|
|
6186
6201
|
export interface GetPackageVersionHistoryRequest {
|
|
@@ -6225,8 +6240,7 @@ export interface PackageVersionHistory {
|
|
|
6225
6240
|
*/
|
|
6226
6241
|
CreatedAt?: Date | undefined;
|
|
6227
6242
|
/**
|
|
6228
|
-
* <p>Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code>
|
|
6229
|
-
* package.</p>
|
|
6243
|
+
* <p>Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code> package.</p>
|
|
6230
6244
|
* @public
|
|
6231
6245
|
*/
|
|
6232
6246
|
PluginProperties?: PluginProperties | undefined;
|
|
@@ -6237,7 +6251,7 @@ export interface PackageVersionHistory {
|
|
|
6237
6251
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
6238
6252
|
}
|
|
6239
6253
|
/**
|
|
6240
|
-
* <p>Container for response returned by <code>GetPackageVersionHistory</code>
|
|
6254
|
+
* <p>Container for response returned by <code>GetPackageVersionHistory</code> operation.</p>
|
|
6241
6255
|
* @public
|
|
6242
6256
|
*/
|
|
6243
6257
|
export interface GetPackageVersionHistoryResponse {
|
|
@@ -6253,8 +6267,8 @@ export interface GetPackageVersionHistoryResponse {
|
|
|
6253
6267
|
PackageVersionHistoryList?: PackageVersionHistory[] | undefined;
|
|
6254
6268
|
/**
|
|
6255
6269
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6256
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6257
|
-
*
|
|
6270
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6271
|
+
* returned token to retrieve the next page.</p>
|
|
6258
6272
|
* @public
|
|
6259
6273
|
*/
|
|
6260
6274
|
NextToken?: string | undefined;
|
|
@@ -6351,8 +6365,7 @@ export interface UpgradeStepItem {
|
|
|
6351
6365
|
*/
|
|
6352
6366
|
UpgradeStepStatus?: UpgradeStatus | undefined;
|
|
6353
6367
|
/**
|
|
6354
|
-
* <p>A list of strings containing detailed information about the errors encountered in a
|
|
6355
|
-
* particular step.</p>
|
|
6368
|
+
* <p>A list of strings containing detailed information about the errors encountered in a particular step.</p>
|
|
6356
6369
|
* @public
|
|
6357
6370
|
*/
|
|
6358
6371
|
Issues?: string[] | undefined;
|
|
@@ -6399,8 +6412,7 @@ export interface UpgradeHistory {
|
|
|
6399
6412
|
*/
|
|
6400
6413
|
UpgradeStatus?: UpgradeStatus | undefined;
|
|
6401
6414
|
/**
|
|
6402
|
-
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility
|
|
6403
|
-
* check.</p>
|
|
6415
|
+
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility check.</p>
|
|
6404
6416
|
* @public
|
|
6405
6417
|
*/
|
|
6406
6418
|
StepsList?: UpgradeStepItem[] | undefined;
|
|
@@ -6418,8 +6430,8 @@ export interface GetUpgradeHistoryResponse {
|
|
|
6418
6430
|
UpgradeHistories?: UpgradeHistory[] | undefined;
|
|
6419
6431
|
/**
|
|
6420
6432
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6421
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6422
|
-
*
|
|
6433
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6434
|
+
* returned token to retrieve the next page.</p>
|
|
6423
6435
|
* @public
|
|
6424
6436
|
*/
|
|
6425
6437
|
NextToken?: string | undefined;
|
|
@@ -6462,15 +6474,13 @@ export interface GetUpgradeStatusResponse {
|
|
|
6462
6474
|
export interface ListApplicationsRequest {
|
|
6463
6475
|
/**
|
|
6464
6476
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6465
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6466
|
-
*
|
|
6477
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6478
|
+
* returned token to retrieve the next page.</p>
|
|
6467
6479
|
* @public
|
|
6468
6480
|
*/
|
|
6469
6481
|
nextToken?: string | undefined;
|
|
6470
6482
|
/**
|
|
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>
|
|
6483
|
+
* <p>Filters the list of OpenSearch applications by status. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6474
6484
|
* @public
|
|
6475
6485
|
*/
|
|
6476
6486
|
statuses?: ApplicationStatus[] | undefined;
|
|
@@ -6492,8 +6502,9 @@ export interface ApplicationSummary {
|
|
|
6492
6502
|
*/
|
|
6493
6503
|
id?: string | undefined;
|
|
6494
6504
|
/**
|
|
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
|
|
6496
|
-
*
|
|
6505
|
+
* <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
|
|
6506
|
+
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
6507
|
+
* </p>
|
|
6497
6508
|
* @public
|
|
6498
6509
|
*/
|
|
6499
6510
|
arn?: string | undefined;
|
|
@@ -6508,9 +6519,7 @@ export interface ApplicationSummary {
|
|
|
6508
6519
|
*/
|
|
6509
6520
|
endpoint?: string | undefined;
|
|
6510
6521
|
/**
|
|
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>
|
|
6522
|
+
* <p>The current status of an OpenSearch application. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6514
6523
|
* @public
|
|
6515
6524
|
*/
|
|
6516
6525
|
status?: ApplicationStatus | undefined;
|
|
@@ -6530,21 +6539,21 @@ export interface ApplicationSummary {
|
|
|
6530
6539
|
*/
|
|
6531
6540
|
export interface ListApplicationsResponse {
|
|
6532
6541
|
/**
|
|
6533
|
-
* <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation
|
|
6534
|
-
* time, and last update time.</p>
|
|
6542
|
+
* <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time.</p>
|
|
6535
6543
|
* @public
|
|
6536
6544
|
*/
|
|
6537
6545
|
ApplicationSummaries?: ApplicationSummary[] | undefined;
|
|
6538
6546
|
/**
|
|
6539
6547
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6540
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6541
|
-
*
|
|
6548
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6549
|
+
* returned token to retrieve the next page.</p>
|
|
6542
6550
|
* @public
|
|
6543
6551
|
*/
|
|
6544
6552
|
nextToken?: string | undefined;
|
|
6545
6553
|
}
|
|
6546
6554
|
/**
|
|
6547
|
-
* <p>Container for the parameters to the <code>ListDataSources</code>
|
|
6555
|
+
* <p>Container for the parameters to the <code>ListDataSources</code>
|
|
6556
|
+
* operation.</p>
|
|
6548
6557
|
* @public
|
|
6549
6558
|
*/
|
|
6550
6559
|
export interface ListDataSourcesRequest {
|
|
@@ -6597,47 +6606,57 @@ export interface ListDataSourcesResponse {
|
|
|
6597
6606
|
export interface ListDirectQueryDataSourcesRequest {
|
|
6598
6607
|
/**
|
|
6599
6608
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6600
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6601
|
-
*
|
|
6609
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6610
|
+
* returned token to retrieve the next page.</p>
|
|
6602
6611
|
* @public
|
|
6603
6612
|
*/
|
|
6604
6613
|
NextToken?: string | undefined;
|
|
6605
6614
|
}
|
|
6606
6615
|
/**
|
|
6607
|
-
* <p>
|
|
6616
|
+
* <p>
|
|
6617
|
+
* The configuration details for a data source that can be directly queried.
|
|
6618
|
+
* </p>
|
|
6608
6619
|
* @public
|
|
6609
6620
|
*/
|
|
6610
6621
|
export interface DirectQueryDataSource {
|
|
6611
6622
|
/**
|
|
6612
|
-
* <p>
|
|
6613
|
-
*
|
|
6623
|
+
* <p>
|
|
6624
|
+
* A unique, user-defined label to identify the data source
|
|
6625
|
+
* within your OpenSearch Service environment.
|
|
6626
|
+
* </p>
|
|
6614
6627
|
* @public
|
|
6615
6628
|
*/
|
|
6616
6629
|
DataSourceName?: string | undefined;
|
|
6617
6630
|
/**
|
|
6618
|
-
* <p>
|
|
6619
|
-
* OpenSearch Service.
|
|
6631
|
+
* <p>
|
|
6632
|
+
* The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service.
|
|
6633
|
+
* </p>
|
|
6620
6634
|
* @public
|
|
6621
6635
|
*/
|
|
6622
6636
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6623
6637
|
/**
|
|
6624
|
-
* <p>
|
|
6638
|
+
* <p>
|
|
6639
|
+
* A description that provides additional context and details about the data source.</p>
|
|
6625
6640
|
* @public
|
|
6626
6641
|
*/
|
|
6627
6642
|
Description?: string | undefined;
|
|
6628
6643
|
/**
|
|
6629
|
-
* <p>
|
|
6630
|
-
*
|
|
6644
|
+
* <p>
|
|
6645
|
+
* A list of Amazon Resource Names (ARNs) for the OpenSearch
|
|
6646
|
+
* collections that are associated with the direct query data source.
|
|
6647
|
+
* </p>
|
|
6631
6648
|
* @public
|
|
6632
6649
|
*/
|
|
6633
6650
|
OpenSearchArns?: string[] | undefined;
|
|
6634
6651
|
/**
|
|
6635
|
-
* <p>
|
|
6652
|
+
* <p>
|
|
6653
|
+
* The unique, system-generated identifier that represents the data source.</p>
|
|
6636
6654
|
* @public
|
|
6637
6655
|
*/
|
|
6638
6656
|
DataSourceArn?: string | undefined;
|
|
6639
6657
|
/**
|
|
6640
|
-
* <p>
|
|
6658
|
+
* <p>
|
|
6659
|
+
* A list of tags attached to a direct query data source.</p>
|
|
6641
6660
|
* @public
|
|
6642
6661
|
*/
|
|
6643
6662
|
TagList?: Tag[] | undefined;
|
|
@@ -6648,20 +6667,23 @@ export interface DirectQueryDataSource {
|
|
|
6648
6667
|
export interface ListDirectQueryDataSourcesResponse {
|
|
6649
6668
|
/**
|
|
6650
6669
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6651
|
-
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6652
|
-
*
|
|
6670
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6671
|
+
* returned token to retrieve the next page.</p>
|
|
6653
6672
|
* @public
|
|
6654
6673
|
*/
|
|
6655
6674
|
NextToken?: string | undefined;
|
|
6656
6675
|
/**
|
|
6657
|
-
* <p>
|
|
6658
|
-
*
|
|
6676
|
+
* <p>
|
|
6677
|
+
* A list of the direct query data sources that are returned by
|
|
6678
|
+
* the <code>ListDirectQueryDataSources</code> API operation.
|
|
6679
|
+
* </p>
|
|
6659
6680
|
* @public
|
|
6660
6681
|
*/
|
|
6661
6682
|
DirectQueryDataSources?: DirectQueryDataSource[] | undefined;
|
|
6662
6683
|
}
|
|
6663
6684
|
/**
|
|
6664
|
-
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
6685
|
+
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
6686
|
+
* operation.</p>
|
|
6665
6687
|
* @public
|
|
6666
6688
|
*/
|
|
6667
6689
|
export interface ListDomainMaintenancesRequest {
|
|
@@ -6682,14 +6704,14 @@ export interface ListDomainMaintenancesRequest {
|
|
|
6682
6704
|
Status?: MaintenanceStatus | undefined;
|
|
6683
6705
|
/**
|
|
6684
6706
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6685
|
-
*
|
|
6707
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
6686
6708
|
* @public
|
|
6687
6709
|
*/
|
|
6688
6710
|
MaxResults?: number | undefined;
|
|
6689
6711
|
/**
|
|
6690
6712
|
* <p>If your initial <code>ListDomainMaintenances</code> operation returns a
|
|
6691
|
-
*
|
|
6692
|
-
*
|
|
6713
|
+
* <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent
|
|
6714
|
+
* <code>ListDomainMaintenances</code> operations, which returns results in the next page.</p>
|
|
6693
6715
|
* @public
|
|
6694
6716
|
*/
|
|
6695
6717
|
NextToken?: string | undefined;
|
|
@@ -6741,8 +6763,7 @@ export interface DomainMaintenanceDetails {
|
|
|
6741
6763
|
UpdatedAt?: Date | undefined;
|
|
6742
6764
|
}
|
|
6743
6765
|
/**
|
|
6744
|
-
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information about
|
|
6745
|
-
* the requested actions. </p>
|
|
6766
|
+
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information about the requested actions. </p>
|
|
6746
6767
|
* @public
|
|
6747
6768
|
*/
|
|
6748
6769
|
export interface ListDomainMaintenancesResponse {
|
|
@@ -6753,8 +6774,8 @@ export interface ListDomainMaintenancesResponse {
|
|
|
6753
6774
|
DomainMaintenances?: DomainMaintenanceDetails[] | undefined;
|
|
6754
6775
|
/**
|
|
6755
6776
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6756
|
-
*
|
|
6757
|
-
*
|
|
6777
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6778
|
+
* returned token to retrieve the next page.</p>
|
|
6758
6779
|
* @public
|
|
6759
6780
|
*/
|
|
6760
6781
|
NextToken?: string | undefined;
|
|
@@ -6799,44 +6820,6 @@ export interface DomainInfo {
|
|
|
6799
6820
|
*/
|
|
6800
6821
|
EngineType?: EngineType | undefined;
|
|
6801
6822
|
}
|
|
6802
|
-
/**
|
|
6803
|
-
* <p>The results of a <code>ListDomainNames</code> operation. Contains the names of all domains
|
|
6804
|
-
* owned by this account and their respective engine types.</p>
|
|
6805
|
-
* @public
|
|
6806
|
-
*/
|
|
6807
|
-
export interface ListDomainNamesResponse {
|
|
6808
|
-
/**
|
|
6809
|
-
* <p>The names of all OpenSearch Service domains owned by the current user and their respective
|
|
6810
|
-
* engine types.</p>
|
|
6811
|
-
* @public
|
|
6812
|
-
*/
|
|
6813
|
-
DomainNames?: DomainInfo[] | undefined;
|
|
6814
|
-
}
|
|
6815
|
-
/**
|
|
6816
|
-
* <p>Container for the request parameters to the <code>ListDomainsForPackage</code>
|
|
6817
|
-
* operation.</p>
|
|
6818
|
-
* @public
|
|
6819
|
-
*/
|
|
6820
|
-
export interface ListDomainsForPackageRequest {
|
|
6821
|
-
/**
|
|
6822
|
-
* <p>The unique identifier of the package for which to list associated domains.</p>
|
|
6823
|
-
* @public
|
|
6824
|
-
*/
|
|
6825
|
-
PackageID: string | undefined;
|
|
6826
|
-
/**
|
|
6827
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6828
|
-
* <code>nextToken</code> to get the next page of results.</p>
|
|
6829
|
-
* @public
|
|
6830
|
-
*/
|
|
6831
|
-
MaxResults?: number | undefined;
|
|
6832
|
-
/**
|
|
6833
|
-
* <p>If your initial <code>ListDomainsForPackage</code> operation returns a
|
|
6834
|
-
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
6835
|
-
* <code>ListDomainsForPackage</code> operations, which returns results in the next page.</p>
|
|
6836
|
-
* @public
|
|
6837
|
-
*/
|
|
6838
|
-
NextToken?: string | undefined;
|
|
6839
|
-
}
|
|
6840
6823
|
/**
|
|
6841
6824
|
* @internal
|
|
6842
6825
|
*/
|