@aws-sdk/client-opensearch 3.689.0 → 3.691.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.
|
@@ -91,12 +91,12 @@ export interface InboundConnectionStatus {
|
|
|
91
91
|
* </ul>
|
|
92
92
|
* @public
|
|
93
93
|
*/
|
|
94
|
-
StatusCode?: InboundConnectionStatusCode;
|
|
94
|
+
StatusCode?: InboundConnectionStatusCode | undefined;
|
|
95
95
|
/**
|
|
96
96
|
* <p>Information about the connection.</p>
|
|
97
97
|
* @public
|
|
98
98
|
*/
|
|
99
|
-
Message?: string;
|
|
99
|
+
Message?: string | undefined;
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
102
|
* <p>Information about an Amazon OpenSearch Service domain.</p>
|
|
@@ -107,7 +107,7 @@ export interface AWSDomainInformation {
|
|
|
107
107
|
* <p>The Amazon Web Services account ID of the domain owner.</p>
|
|
108
108
|
* @public
|
|
109
109
|
*/
|
|
110
|
-
OwnerId?: string;
|
|
110
|
+
OwnerId?: string | undefined;
|
|
111
111
|
/**
|
|
112
112
|
* <p>Name of the domain.</p>
|
|
113
113
|
* @public
|
|
@@ -117,7 +117,7 @@ export interface AWSDomainInformation {
|
|
|
117
117
|
* <p>The Amazon Web Services Region in which the domain is located.</p>
|
|
118
118
|
* @public
|
|
119
119
|
*/
|
|
120
|
-
Region?: string;
|
|
120
|
+
Region?: string | undefined;
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
123
|
* <p>Container for information about an OpenSearch Service domain.</p>
|
|
@@ -128,7 +128,7 @@ export interface DomainInformationContainer {
|
|
|
128
128
|
* <p>Information about an Amazon OpenSearch Service domain.</p>
|
|
129
129
|
* @public
|
|
130
130
|
*/
|
|
131
|
-
AWSDomainInformation?: AWSDomainInformation;
|
|
131
|
+
AWSDomainInformation?: AWSDomainInformation | undefined;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
134
|
* <p>Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more
|
|
@@ -141,27 +141,27 @@ export interface InboundConnection {
|
|
|
141
141
|
* <p>Information about the source (local) domain.</p>
|
|
142
142
|
* @public
|
|
143
143
|
*/
|
|
144
|
-
LocalDomainInfo?: DomainInformationContainer;
|
|
144
|
+
LocalDomainInfo?: DomainInformationContainer | undefined;
|
|
145
145
|
/**
|
|
146
146
|
* <p>Information about the destination (remote) domain.</p>
|
|
147
147
|
* @public
|
|
148
148
|
*/
|
|
149
|
-
RemoteDomainInfo?: DomainInformationContainer;
|
|
149
|
+
RemoteDomainInfo?: DomainInformationContainer | undefined;
|
|
150
150
|
/**
|
|
151
151
|
* <p>The unique identifier of the connection.</p>
|
|
152
152
|
* @public
|
|
153
153
|
*/
|
|
154
|
-
ConnectionId?: string;
|
|
154
|
+
ConnectionId?: string | undefined;
|
|
155
155
|
/**
|
|
156
156
|
* <p>The current status of the connection.</p>
|
|
157
157
|
* @public
|
|
158
158
|
*/
|
|
159
|
-
ConnectionStatus?: InboundConnectionStatus;
|
|
159
|
+
ConnectionStatus?: InboundConnectionStatus | undefined;
|
|
160
160
|
/**
|
|
161
161
|
* <p>The connection mode.</p>
|
|
162
162
|
* @public
|
|
163
163
|
*/
|
|
164
|
-
ConnectionMode?: ConnectionMode;
|
|
164
|
+
ConnectionMode?: ConnectionMode | undefined;
|
|
165
165
|
}
|
|
166
166
|
/**
|
|
167
167
|
* <p>Contains details about the accepted inbound connection.</p>
|
|
@@ -172,7 +172,7 @@ export interface AcceptInboundConnectionResponse {
|
|
|
172
172
|
* <p>Information about the accepted inbound connection.</p>
|
|
173
173
|
* @public
|
|
174
174
|
*/
|
|
175
|
-
Connection?: InboundConnection;
|
|
175
|
+
Connection?: InboundConnection | undefined;
|
|
176
176
|
}
|
|
177
177
|
/**
|
|
178
178
|
* <p>An error occured because the client wanted to access an unsupported operation.</p>
|
|
@@ -254,7 +254,7 @@ export interface OptionStatus {
|
|
|
254
254
|
* <p>The latest version of the entity.</p>
|
|
255
255
|
* @public
|
|
256
256
|
*/
|
|
257
|
-
UpdateVersion?: number;
|
|
257
|
+
UpdateVersion?: number | undefined;
|
|
258
258
|
/**
|
|
259
259
|
* <p>The state of the entity.</p>
|
|
260
260
|
* @public
|
|
@@ -264,7 +264,7 @@ export interface OptionStatus {
|
|
|
264
264
|
* <p>Indicates whether the entity is being deleted.</p>
|
|
265
265
|
* @public
|
|
266
266
|
*/
|
|
267
|
-
PendingDeletion?: boolean;
|
|
267
|
+
PendingDeletion?: boolean | undefined;
|
|
268
268
|
}
|
|
269
269
|
/**
|
|
270
270
|
* <p>The configured access rules for the domain's search endpoint, and the current status of
|
|
@@ -335,7 +335,7 @@ export interface S3GlueDataCatalog {
|
|
|
335
335
|
* <p>>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.</p>
|
|
336
336
|
* @public
|
|
337
337
|
*/
|
|
338
|
-
RoleArn?: string;
|
|
338
|
+
RoleArn?: string | undefined;
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
341
|
* <p>The type of data source.</p>
|
|
@@ -392,7 +392,7 @@ export interface AddDataSourceRequest {
|
|
|
392
392
|
* <p>A description of the data source.</p>
|
|
393
393
|
* @public
|
|
394
394
|
*/
|
|
395
|
-
Description?: string;
|
|
395
|
+
Description?: string | undefined;
|
|
396
396
|
}
|
|
397
397
|
/**
|
|
398
398
|
* <p>The result of an <code>AddDataSource</code> operation.</p>
|
|
@@ -403,7 +403,7 @@ export interface AddDataSourceResponse {
|
|
|
403
403
|
* <p>A message associated with creation of the data source.</p>
|
|
404
404
|
* @public
|
|
405
405
|
*/
|
|
406
|
-
Message?: string;
|
|
406
|
+
Message?: string | undefined;
|
|
407
407
|
}
|
|
408
408
|
/**
|
|
409
409
|
* <p>An error occurred while processing the request.</p>
|
|
@@ -475,12 +475,12 @@ export interface AdditionalLimit {
|
|
|
475
475
|
* </ul>
|
|
476
476
|
* @public
|
|
477
477
|
*/
|
|
478
|
-
LimitName?: string;
|
|
478
|
+
LimitName?: string | undefined;
|
|
479
479
|
/**
|
|
480
480
|
* <p> The values of the additional instance type limits.</p>
|
|
481
481
|
* @public
|
|
482
482
|
*/
|
|
483
|
-
LimitValues?: string[];
|
|
483
|
+
LimitValues?: string[] | undefined;
|
|
484
484
|
}
|
|
485
485
|
/**
|
|
486
486
|
* <p>A tag (key-value pair) for an Amazon OpenSearch Service resource.</p>
|
|
@@ -576,22 +576,22 @@ export interface JWTOptionsOutput {
|
|
|
576
576
|
* <p>True if JWT use is enabled.</p>
|
|
577
577
|
* @public
|
|
578
578
|
*/
|
|
579
|
-
Enabled?: boolean;
|
|
579
|
+
Enabled?: boolean | undefined;
|
|
580
580
|
/**
|
|
581
581
|
* <p>The key used for matching the JWT subject attribute.</p>
|
|
582
582
|
* @public
|
|
583
583
|
*/
|
|
584
|
-
SubjectKey?: string;
|
|
584
|
+
SubjectKey?: string | undefined;
|
|
585
585
|
/**
|
|
586
586
|
* <p>The key used for matching the JWT roles attribute.</p>
|
|
587
587
|
* @public
|
|
588
588
|
*/
|
|
589
|
-
RolesKey?: string;
|
|
589
|
+
RolesKey?: string | undefined;
|
|
590
590
|
/**
|
|
591
591
|
* <p>The key used to verify the signature of incoming JWT requests.</p>
|
|
592
592
|
* @public
|
|
593
593
|
*/
|
|
594
|
-
PublicKey?: string;
|
|
594
|
+
PublicKey?: string | undefined;
|
|
595
595
|
}
|
|
596
596
|
/**
|
|
597
597
|
* <p>The SAML identity povider information.</p>
|
|
@@ -618,27 +618,27 @@ export interface SAMLOptionsOutput {
|
|
|
618
618
|
* <p>True if SAML is enabled.</p>
|
|
619
619
|
* @public
|
|
620
620
|
*/
|
|
621
|
-
Enabled?: boolean;
|
|
621
|
+
Enabled?: boolean | undefined;
|
|
622
622
|
/**
|
|
623
623
|
* <p>Describes the SAML identity provider's information.</p>
|
|
624
624
|
* @public
|
|
625
625
|
*/
|
|
626
|
-
Idp?: SAMLIdp;
|
|
626
|
+
Idp?: SAMLIdp | undefined;
|
|
627
627
|
/**
|
|
628
628
|
* <p>The key used for matching the SAML subject attribute.</p>
|
|
629
629
|
* @public
|
|
630
630
|
*/
|
|
631
|
-
SubjectKey?: string;
|
|
631
|
+
SubjectKey?: string | undefined;
|
|
632
632
|
/**
|
|
633
633
|
* <p>The key used for matching the SAML roles attribute.</p>
|
|
634
634
|
* @public
|
|
635
635
|
*/
|
|
636
|
-
RolesKey?: string;
|
|
636
|
+
RolesKey?: string | undefined;
|
|
637
637
|
/**
|
|
638
638
|
* <p>The duration, in minutes, after which a user session becomes inactive.</p>
|
|
639
639
|
* @public
|
|
640
640
|
*/
|
|
641
|
-
SessionTimeoutMinutes?: number;
|
|
641
|
+
SessionTimeoutMinutes?: number | undefined;
|
|
642
642
|
}
|
|
643
643
|
/**
|
|
644
644
|
* <p>Container for fine-grained access control settings.</p>
|
|
@@ -649,35 +649,35 @@ export interface AdvancedSecurityOptions {
|
|
|
649
649
|
* <p>True if fine-grained access control is enabled.</p>
|
|
650
650
|
* @public
|
|
651
651
|
*/
|
|
652
|
-
Enabled?: boolean;
|
|
652
|
+
Enabled?: boolean | undefined;
|
|
653
653
|
/**
|
|
654
654
|
* <p>True if the internal user database is enabled.</p>
|
|
655
655
|
* @public
|
|
656
656
|
*/
|
|
657
|
-
InternalUserDatabaseEnabled?: boolean;
|
|
657
|
+
InternalUserDatabaseEnabled?: boolean | undefined;
|
|
658
658
|
/**
|
|
659
659
|
* <p>Container for information about the SAML configuration for OpenSearch Dashboards.</p>
|
|
660
660
|
* @public
|
|
661
661
|
*/
|
|
662
|
-
SAMLOptions?: SAMLOptionsOutput;
|
|
662
|
+
SAMLOptions?: SAMLOptionsOutput | undefined;
|
|
663
663
|
/**
|
|
664
664
|
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service.</p>
|
|
665
665
|
* @public
|
|
666
666
|
*/
|
|
667
|
-
JWTOptions?: JWTOptionsOutput;
|
|
667
|
+
JWTOptions?: JWTOptionsOutput | undefined;
|
|
668
668
|
/**
|
|
669
669
|
* <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
|
|
670
670
|
* fine-grained access control on an existing domain</a>.</p>
|
|
671
671
|
* @public
|
|
672
672
|
*/
|
|
673
|
-
AnonymousAuthDisableDate?: Date;
|
|
673
|
+
AnonymousAuthDisableDate?: Date | undefined;
|
|
674
674
|
/**
|
|
675
675
|
* <p>True if a 30-day migration period is enabled, during which administrators can create role
|
|
676
676
|
* mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling
|
|
677
677
|
* fine-grained access control on an existing domain</a>.</p>
|
|
678
678
|
* @public
|
|
679
679
|
*/
|
|
680
|
-
AnonymousAuthEnabled?: boolean;
|
|
680
|
+
AnonymousAuthEnabled?: boolean | undefined;
|
|
681
681
|
}
|
|
682
682
|
/**
|
|
683
683
|
* <p>The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.</p>
|
|
@@ -688,22 +688,22 @@ export interface JWTOptionsInput {
|
|
|
688
688
|
* <p>True to enable JWT authentication and authorization for a domain.</p>
|
|
689
689
|
* @public
|
|
690
690
|
*/
|
|
691
|
-
Enabled?: boolean;
|
|
691
|
+
Enabled?: boolean | undefined;
|
|
692
692
|
/**
|
|
693
693
|
* <p>Element of the JWT assertion to use for the user name.</p>
|
|
694
694
|
* @public
|
|
695
695
|
*/
|
|
696
|
-
SubjectKey?: string;
|
|
696
|
+
SubjectKey?: string | undefined;
|
|
697
697
|
/**
|
|
698
698
|
* <p>Element of the JWT assertion to use for roles.</p>
|
|
699
699
|
* @public
|
|
700
700
|
*/
|
|
701
|
-
RolesKey?: string;
|
|
701
|
+
RolesKey?: string | undefined;
|
|
702
702
|
/**
|
|
703
703
|
* <p>Element of the JWT assertion used by the cluster to verify JWT signatures.</p>
|
|
704
704
|
* @public
|
|
705
705
|
*/
|
|
706
|
-
PublicKey?: string;
|
|
706
|
+
PublicKey?: string | undefined;
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
709
|
* <p>Credentials for the master user for a domain.</p>
|
|
@@ -715,19 +715,19 @@ export interface MasterUserOptions {
|
|
|
715
715
|
* <code>InternalUserDatabaseEnabled</code> is <code>false</code>.</p>
|
|
716
716
|
* @public
|
|
717
717
|
*/
|
|
718
|
-
MasterUserARN?: string;
|
|
718
|
+
MasterUserARN?: string | undefined;
|
|
719
719
|
/**
|
|
720
720
|
* <p>User name for the master user. Only specify if <code>InternalUserDatabaseEnabled</code> is
|
|
721
721
|
* <code>true</code>.</p>
|
|
722
722
|
* @public
|
|
723
723
|
*/
|
|
724
|
-
MasterUserName?: string;
|
|
724
|
+
MasterUserName?: string | undefined;
|
|
725
725
|
/**
|
|
726
726
|
* <p>Password for the master user. Only specify if <code>InternalUserDatabaseEnabled</code> is
|
|
727
727
|
* <code>true</code>.</p>
|
|
728
728
|
* @public
|
|
729
729
|
*/
|
|
730
|
-
MasterUserPassword?: string;
|
|
730
|
+
MasterUserPassword?: string | undefined;
|
|
731
731
|
}
|
|
732
732
|
/**
|
|
733
733
|
* <p>The SAML authentication configuration for an Amazon OpenSearch Service domain.</p>
|
|
@@ -738,40 +738,40 @@ export interface SAMLOptionsInput {
|
|
|
738
738
|
* <p>True to enable SAML authentication for a domain.</p>
|
|
739
739
|
* @public
|
|
740
740
|
*/
|
|
741
|
-
Enabled?: boolean;
|
|
741
|
+
Enabled?: boolean | undefined;
|
|
742
742
|
/**
|
|
743
743
|
* <p>The SAML Identity Provider's information.</p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
Idp?: SAMLIdp;
|
|
746
|
+
Idp?: SAMLIdp | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>The SAML master user name, which is stored in the domain's internal user database.</p>
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
MasterUserName?: string;
|
|
751
|
+
MasterUserName?: string | undefined;
|
|
752
752
|
/**
|
|
753
753
|
* <p>The backend role that the SAML master user is mapped to.</p>
|
|
754
754
|
* @public
|
|
755
755
|
*/
|
|
756
|
-
MasterBackendRole?: string;
|
|
756
|
+
MasterBackendRole?: string | undefined;
|
|
757
757
|
/**
|
|
758
758
|
* <p>Element of the SAML assertion to use for the user name. Default is
|
|
759
759
|
* <code>NameID</code>.</p>
|
|
760
760
|
* @public
|
|
761
761
|
*/
|
|
762
|
-
SubjectKey?: string;
|
|
762
|
+
SubjectKey?: string | undefined;
|
|
763
763
|
/**
|
|
764
764
|
* <p>Element of the SAML assertion to use for backend roles. Default is
|
|
765
765
|
* <code>roles</code>.</p>
|
|
766
766
|
* @public
|
|
767
767
|
*/
|
|
768
|
-
RolesKey?: string;
|
|
768
|
+
RolesKey?: string | undefined;
|
|
769
769
|
/**
|
|
770
770
|
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440,
|
|
771
771
|
* and the default value is 60.</p>
|
|
772
772
|
* @public
|
|
773
773
|
*/
|
|
774
|
-
SessionTimeoutMinutes?: number;
|
|
774
|
+
SessionTimeoutMinutes?: number | undefined;
|
|
775
775
|
}
|
|
776
776
|
/**
|
|
777
777
|
* <p>Options for enabling and configuring fine-grained access control. For more information, see
|
|
@@ -783,34 +783,34 @@ export interface AdvancedSecurityOptionsInput {
|
|
|
783
783
|
* <p>True to enable fine-grained access control.</p>
|
|
784
784
|
* @public
|
|
785
785
|
*/
|
|
786
|
-
Enabled?: boolean;
|
|
786
|
+
Enabled?: boolean | undefined;
|
|
787
787
|
/**
|
|
788
788
|
* <p>True to enable the internal user database.</p>
|
|
789
789
|
* @public
|
|
790
790
|
*/
|
|
791
|
-
InternalUserDatabaseEnabled?: boolean;
|
|
791
|
+
InternalUserDatabaseEnabled?: boolean | undefined;
|
|
792
792
|
/**
|
|
793
793
|
* <p>Container for information about the master user.</p>
|
|
794
794
|
* @public
|
|
795
795
|
*/
|
|
796
|
-
MasterUserOptions?: MasterUserOptions;
|
|
796
|
+
MasterUserOptions?: MasterUserOptions | undefined;
|
|
797
797
|
/**
|
|
798
798
|
* <p>Container for information about the SAML configuration for OpenSearch Dashboards.</p>
|
|
799
799
|
* @public
|
|
800
800
|
*/
|
|
801
|
-
SAMLOptions?: SAMLOptionsInput;
|
|
801
|
+
SAMLOptions?: SAMLOptionsInput | undefined;
|
|
802
802
|
/**
|
|
803
803
|
* <p>Container for information about the JWT configuration of the Amazon OpenSearch Service. </p>
|
|
804
804
|
* @public
|
|
805
805
|
*/
|
|
806
|
-
JWTOptions?: JWTOptionsInput;
|
|
806
|
+
JWTOptions?: JWTOptionsInput | undefined;
|
|
807
807
|
/**
|
|
808
808
|
* <p>True to enable a 30-day migration period during which administrators can create role
|
|
809
809
|
* mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling
|
|
810
810
|
* fine-grained access control on an existing domain</a>.</p>
|
|
811
811
|
* @public
|
|
812
812
|
*/
|
|
813
|
-
AnonymousAuthEnabled?: boolean;
|
|
813
|
+
AnonymousAuthEnabled?: boolean | undefined;
|
|
814
814
|
}
|
|
815
815
|
/**
|
|
816
816
|
* <p>The status of fine-grained access control settings for a domain.</p>
|
|
@@ -849,7 +849,7 @@ export interface NaturalLanguageQueryGenerationOptionsInput {
|
|
|
849
849
|
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</p>
|
|
850
850
|
* @public
|
|
851
851
|
*/
|
|
852
|
-
DesiredState?: NaturalLanguageQueryGenerationDesiredState;
|
|
852
|
+
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
853
853
|
}
|
|
854
854
|
/**
|
|
855
855
|
* <p>Container for parameters required to enable all machine learning features.</p>
|
|
@@ -860,7 +860,7 @@ export interface AIMLOptionsInput {
|
|
|
860
860
|
* <p>Container for parameters required for natural language query generation on the specified domain.</p>
|
|
861
861
|
* @public
|
|
862
862
|
*/
|
|
863
|
-
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsInput;
|
|
863
|
+
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsInput | undefined;
|
|
864
864
|
}
|
|
865
865
|
/**
|
|
866
866
|
* @public
|
|
@@ -888,12 +888,12 @@ export interface NaturalLanguageQueryGenerationOptionsOutput {
|
|
|
888
888
|
* <p>The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.</p>
|
|
889
889
|
* @public
|
|
890
890
|
*/
|
|
891
|
-
DesiredState?: NaturalLanguageQueryGenerationDesiredState;
|
|
891
|
+
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
892
892
|
/**
|
|
893
893
|
* <p>The current state of the natural language query generation feature, indicating completion, in progress, or failure.</p>
|
|
894
894
|
* @public
|
|
895
895
|
*/
|
|
896
|
-
CurrentState?: NaturalLanguageQueryGenerationCurrentState;
|
|
896
|
+
CurrentState?: NaturalLanguageQueryGenerationCurrentState | undefined;
|
|
897
897
|
}
|
|
898
898
|
/**
|
|
899
899
|
* <p>Container for parameters representing the state of machine learning features on the specified domain.</p>
|
|
@@ -904,7 +904,7 @@ export interface AIMLOptionsOutput {
|
|
|
904
904
|
* <p>Container for parameters required for natural language query generation on the specified domain.</p>
|
|
905
905
|
* @public
|
|
906
906
|
*/
|
|
907
|
-
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsOutput;
|
|
907
|
+
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsOutput | undefined;
|
|
908
908
|
}
|
|
909
909
|
/**
|
|
910
910
|
* <p>The status of machine learning options on the specified domain.</p>
|
|
@@ -915,12 +915,12 @@ export interface AIMLOptionsStatus {
|
|
|
915
915
|
* <p>Machine learning options on the specified domain.</p>
|
|
916
916
|
* @public
|
|
917
917
|
*/
|
|
918
|
-
Options?: AIMLOptionsOutput;
|
|
918
|
+
Options?: AIMLOptionsOutput | undefined;
|
|
919
919
|
/**
|
|
920
920
|
* <p>Provides the current status of an entity.</p>
|
|
921
921
|
* @public
|
|
922
922
|
*/
|
|
923
|
-
Status?: OptionStatus;
|
|
923
|
+
Status?: OptionStatus | undefined;
|
|
924
924
|
}
|
|
925
925
|
/**
|
|
926
926
|
* <p>The configuration parameters to enable access to the key store required by the package.</p>
|
|
@@ -931,7 +931,7 @@ export interface KeyStoreAccessOption {
|
|
|
931
931
|
* <p>Role ARN to access the KeyStore Key</p>
|
|
932
932
|
* @public
|
|
933
933
|
*/
|
|
934
|
-
KeyAccessRoleArn?: string;
|
|
934
|
+
KeyAccessRoleArn?: string | undefined;
|
|
935
935
|
/**
|
|
936
936
|
* <p>This indicates whether Key Store access is enabled </p>
|
|
937
937
|
* @public
|
|
@@ -947,7 +947,7 @@ export interface PackageAssociationConfiguration {
|
|
|
947
947
|
* <p>The configuration parameters to enable accessing the key store required by the package.</p>
|
|
948
948
|
* @public
|
|
949
949
|
*/
|
|
950
|
-
KeyStoreAccessOption?: KeyStoreAccessOption;
|
|
950
|
+
KeyStoreAccessOption?: KeyStoreAccessOption | undefined;
|
|
951
951
|
}
|
|
952
952
|
/**
|
|
953
953
|
* <p>Container for the request parameters to the <code>AssociatePackage</code> operation.</p>
|
|
@@ -969,12 +969,12 @@ export interface AssociatePackageRequest {
|
|
|
969
969
|
* <p>A list of package IDs that must be associated with the domain before the package specified in the request can be associated.</p>
|
|
970
970
|
* @public
|
|
971
971
|
*/
|
|
972
|
-
PrerequisitePackageIDList?: string[];
|
|
972
|
+
PrerequisitePackageIDList?: string[] | undefined;
|
|
973
973
|
/**
|
|
974
974
|
* <p>The configuration for associating a package with an Amazon OpenSearch Service domain.</p>
|
|
975
975
|
* @public
|
|
976
976
|
*/
|
|
977
|
-
AssociationConfiguration?: PackageAssociationConfiguration;
|
|
977
|
+
AssociationConfiguration?: PackageAssociationConfiguration | undefined;
|
|
978
978
|
}
|
|
979
979
|
/**
|
|
980
980
|
* @public
|
|
@@ -1000,12 +1000,12 @@ export interface ErrorDetails {
|
|
|
1000
1000
|
* <p>The type of error that occurred.</p>
|
|
1001
1001
|
* @public
|
|
1002
1002
|
*/
|
|
1003
|
-
ErrorType?: string;
|
|
1003
|
+
ErrorType?: string | undefined;
|
|
1004
1004
|
/**
|
|
1005
1005
|
* <p>A message describing the error.</p>
|
|
1006
1006
|
* @public
|
|
1007
1007
|
*/
|
|
1008
|
-
ErrorMessage?: string;
|
|
1008
|
+
ErrorMessage?: string | undefined;
|
|
1009
1009
|
}
|
|
1010
1010
|
/**
|
|
1011
1011
|
* @public
|
|
@@ -1031,58 +1031,58 @@ export interface DomainPackageDetails {
|
|
|
1031
1031
|
* <p>Internal ID of the package.</p>
|
|
1032
1032
|
* @public
|
|
1033
1033
|
*/
|
|
1034
|
-
PackageID?: string;
|
|
1034
|
+
PackageID?: string | undefined;
|
|
1035
1035
|
/**
|
|
1036
1036
|
* <p>User-specified name of the package.</p>
|
|
1037
1037
|
* @public
|
|
1038
1038
|
*/
|
|
1039
|
-
PackageName?: string;
|
|
1039
|
+
PackageName?: string | undefined;
|
|
1040
1040
|
/**
|
|
1041
1041
|
* <p>The type of package.</p>
|
|
1042
1042
|
* @public
|
|
1043
1043
|
*/
|
|
1044
|
-
PackageType?: PackageType;
|
|
1044
|
+
PackageType?: PackageType | undefined;
|
|
1045
1045
|
/**
|
|
1046
1046
|
* <p>Timestamp of the most recent update to the package association status.</p>
|
|
1047
1047
|
* @public
|
|
1048
1048
|
*/
|
|
1049
|
-
LastUpdated?: Date;
|
|
1049
|
+
LastUpdated?: Date | undefined;
|
|
1050
1050
|
/**
|
|
1051
1051
|
* <p>Name of the domain that the package is associated with.</p>
|
|
1052
1052
|
* @public
|
|
1053
1053
|
*/
|
|
1054
|
-
DomainName?: string;
|
|
1054
|
+
DomainName?: string | undefined;
|
|
1055
1055
|
/**
|
|
1056
1056
|
* <p>State of the association.</p>
|
|
1057
1057
|
* @public
|
|
1058
1058
|
*/
|
|
1059
|
-
DomainPackageStatus?: DomainPackageStatus;
|
|
1059
|
+
DomainPackageStatus?: DomainPackageStatus | undefined;
|
|
1060
1060
|
/**
|
|
1061
1061
|
* <p>The current version of the package.</p>
|
|
1062
1062
|
* @public
|
|
1063
1063
|
*/
|
|
1064
|
-
PackageVersion?: string;
|
|
1064
|
+
PackageVersion?: string | undefined;
|
|
1065
1065
|
/**
|
|
1066
1066
|
* <p>A list of package IDs that must be associated with the domain before or with the package can be associated.</p>
|
|
1067
1067
|
* @public
|
|
1068
1068
|
*/
|
|
1069
|
-
PrerequisitePackageIDList?: string[];
|
|
1069
|
+
PrerequisitePackageIDList?: string[] | undefined;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is <code>synonym_path</code>
|
|
1072
1072
|
* when the package is for synonym files.</p>
|
|
1073
1073
|
* @public
|
|
1074
1074
|
*/
|
|
1075
|
-
ReferencePath?: string;
|
|
1075
|
+
ReferencePath?: string | undefined;
|
|
1076
1076
|
/**
|
|
1077
1077
|
* <p>Additional information if the package is in an error state. Null otherwise.</p>
|
|
1078
1078
|
* @public
|
|
1079
1079
|
*/
|
|
1080
|
-
ErrorDetails?: ErrorDetails;
|
|
1080
|
+
ErrorDetails?: ErrorDetails | undefined;
|
|
1081
1081
|
/**
|
|
1082
1082
|
* <p>The configuration for associating a package with an Amazon OpenSearch Service domain.</p>
|
|
1083
1083
|
* @public
|
|
1084
1084
|
*/
|
|
1085
|
-
AssociationConfiguration?: PackageAssociationConfiguration;
|
|
1085
|
+
AssociationConfiguration?: PackageAssociationConfiguration | undefined;
|
|
1086
1086
|
}
|
|
1087
1087
|
/**
|
|
1088
1088
|
* <p>Container for the response returned by the <code>AssociatePackage</code> operation.</p>
|
|
@@ -1093,7 +1093,7 @@ export interface AssociatePackageResponse {
|
|
|
1093
1093
|
* <p>Information about a package that is associated with a domain.</p>
|
|
1094
1094
|
* @public
|
|
1095
1095
|
*/
|
|
1096
|
-
DomainPackageDetails?: DomainPackageDetails;
|
|
1096
|
+
DomainPackageDetails?: DomainPackageDetails | undefined;
|
|
1097
1097
|
}
|
|
1098
1098
|
/**
|
|
1099
1099
|
* <p>An error occurred because the client attempts to remove a resource that is currently in use.</p>
|
|
@@ -1121,12 +1121,12 @@ export interface PackageDetailsForAssociation {
|
|
|
1121
1121
|
* <p>List of package IDs that must be associated with the domain with or before the package can be associated.</p>
|
|
1122
1122
|
* @public
|
|
1123
1123
|
*/
|
|
1124
|
-
PrerequisitePackageIDList?: string[];
|
|
1124
|
+
PrerequisitePackageIDList?: string[] | undefined;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* <p>The configuration parameters for associating the package with a domain.</p>
|
|
1127
1127
|
* @public
|
|
1128
1128
|
*/
|
|
1129
|
-
AssociationConfiguration?: PackageAssociationConfiguration;
|
|
1129
|
+
AssociationConfiguration?: PackageAssociationConfiguration | undefined;
|
|
1130
1130
|
}
|
|
1131
1131
|
/**
|
|
1132
1132
|
* @public
|
|
@@ -1152,7 +1152,7 @@ export interface AssociatePackagesResponse {
|
|
|
1152
1152
|
* <p>List of information about packages that are associated with a domain. </p>
|
|
1153
1153
|
* @public
|
|
1154
1154
|
*/
|
|
1155
|
-
DomainPackageDetailsList?: DomainPackageDetails[];
|
|
1155
|
+
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
1156
1156
|
}
|
|
1157
1157
|
/**
|
|
1158
1158
|
* @public
|
|
@@ -1178,12 +1178,12 @@ export interface AuthorizeVpcEndpointAccessRequest {
|
|
|
1178
1178
|
* <p>The Amazon Web Services account ID to grant access to.</p>
|
|
1179
1179
|
* @public
|
|
1180
1180
|
*/
|
|
1181
|
-
Account?: string;
|
|
1181
|
+
Account?: string | undefined;
|
|
1182
1182
|
/**
|
|
1183
1183
|
* <p>The Amazon Web Services service SP to grant access to.</p>
|
|
1184
1184
|
* @public
|
|
1185
1185
|
*/
|
|
1186
|
-
Service?: AWSServicePrincipal;
|
|
1186
|
+
Service?: AWSServicePrincipal | undefined;
|
|
1187
1187
|
}
|
|
1188
1188
|
/**
|
|
1189
1189
|
* @public
|
|
@@ -1207,12 +1207,12 @@ export interface AuthorizedPrincipal {
|
|
|
1207
1207
|
* <p>The type of principal.</p>
|
|
1208
1208
|
* @public
|
|
1209
1209
|
*/
|
|
1210
|
-
PrincipalType?: PrincipalType;
|
|
1210
|
+
PrincipalType?: PrincipalType | undefined;
|
|
1211
1211
|
/**
|
|
1212
1212
|
* <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>
|
|
1213
1213
|
* @public
|
|
1214
1214
|
*/
|
|
1215
|
-
Principal?: string;
|
|
1215
|
+
Principal?: string | undefined;
|
|
1216
1216
|
}
|
|
1217
1217
|
/**
|
|
1218
1218
|
* @public
|
|
@@ -1239,7 +1239,7 @@ export interface CancelDomainConfigChangeRequest {
|
|
|
1239
1239
|
* <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>
|
|
1240
1240
|
* @public
|
|
1241
1241
|
*/
|
|
1242
|
-
DryRun?: boolean;
|
|
1242
|
+
DryRun?: boolean | undefined;
|
|
1243
1243
|
}
|
|
1244
1244
|
/**
|
|
1245
1245
|
* <p>A property change that was cancelled for an Amazon OpenSearch Service domain.</p>
|
|
@@ -1250,17 +1250,17 @@ export interface CancelledChangeProperty {
|
|
|
1250
1250
|
* <p>The name of the property whose change was cancelled.</p>
|
|
1251
1251
|
* @public
|
|
1252
1252
|
*/
|
|
1253
|
-
PropertyName?: string;
|
|
1253
|
+
PropertyName?: string | undefined;
|
|
1254
1254
|
/**
|
|
1255
1255
|
* <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>
|
|
1256
1256
|
* @public
|
|
1257
1257
|
*/
|
|
1258
|
-
CancelledValue?: string;
|
|
1258
|
+
CancelledValue?: string | undefined;
|
|
1259
1259
|
/**
|
|
1260
1260
|
* <p>The current value of the property, after the change was cancelled.</p>
|
|
1261
1261
|
* @public
|
|
1262
1262
|
*/
|
|
1263
|
-
ActiveValue?: string;
|
|
1263
|
+
ActiveValue?: string | undefined;
|
|
1264
1264
|
}
|
|
1265
1265
|
/**
|
|
1266
1266
|
* @public
|
|
@@ -1270,17 +1270,17 @@ export interface CancelDomainConfigChangeResponse {
|
|
|
1270
1270
|
* <p>The unique identifiers of the changes that were cancelled.</p>
|
|
1271
1271
|
* @public
|
|
1272
1272
|
*/
|
|
1273
|
-
CancelledChangeIds?: string[];
|
|
1273
|
+
CancelledChangeIds?: string[] | undefined;
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>The domain change properties that were cancelled.</p>
|
|
1276
1276
|
* @public
|
|
1277
1277
|
*/
|
|
1278
|
-
CancelledChangeProperties?: CancelledChangeProperty[];
|
|
1278
|
+
CancelledChangeProperties?: CancelledChangeProperty[] | undefined;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not actually cancelled. </p>
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
DryRun?: boolean;
|
|
1283
|
+
DryRun?: boolean | undefined;
|
|
1284
1284
|
}
|
|
1285
1285
|
/**
|
|
1286
1286
|
* <p>Container for the request parameters to cancel a service software update.</p>
|
|
@@ -1320,46 +1320,46 @@ export interface ServiceSoftwareOptions {
|
|
|
1320
1320
|
* <p>The current service software version present on the domain.</p>
|
|
1321
1321
|
* @public
|
|
1322
1322
|
*/
|
|
1323
|
-
CurrentVersion?: string;
|
|
1323
|
+
CurrentVersion?: string | undefined;
|
|
1324
1324
|
/**
|
|
1325
1325
|
* <p>The new service software version, if one is available.</p>
|
|
1326
1326
|
* @public
|
|
1327
1327
|
*/
|
|
1328
|
-
NewVersion?: string;
|
|
1328
|
+
NewVersion?: string | undefined;
|
|
1329
1329
|
/**
|
|
1330
1330
|
* <p>True if you're able to update your service software version. False if you can't update your
|
|
1331
1331
|
* service software version.</p>
|
|
1332
1332
|
* @public
|
|
1333
1333
|
*/
|
|
1334
|
-
UpdateAvailable?: boolean;
|
|
1334
|
+
UpdateAvailable?: boolean | undefined;
|
|
1335
1335
|
/**
|
|
1336
1336
|
* <p> True if you're able to cancel your service software version update. False if you can't
|
|
1337
1337
|
* cancel your service software update.</p>
|
|
1338
1338
|
* @public
|
|
1339
1339
|
*/
|
|
1340
|
-
Cancellable?: boolean;
|
|
1340
|
+
Cancellable?: boolean | undefined;
|
|
1341
1341
|
/**
|
|
1342
1342
|
* <p>The status of your service software update.</p>
|
|
1343
1343
|
* @public
|
|
1344
1344
|
*/
|
|
1345
|
-
UpdateStatus?: DeploymentStatus;
|
|
1345
|
+
UpdateStatus?: DeploymentStatus | undefined;
|
|
1346
1346
|
/**
|
|
1347
1347
|
* <p>A description of the service software update status.</p>
|
|
1348
1348
|
* @public
|
|
1349
1349
|
*/
|
|
1350
|
-
Description?: string;
|
|
1350
|
+
Description?: string | undefined;
|
|
1351
1351
|
/**
|
|
1352
1352
|
* <p>The timestamp, in Epoch time, until which you can manually request a service software update. After this date,
|
|
1353
1353
|
* we automatically update your service software.</p>
|
|
1354
1354
|
* @public
|
|
1355
1355
|
*/
|
|
1356
|
-
AutomatedUpdateDate?: Date;
|
|
1356
|
+
AutomatedUpdateDate?: Date | undefined;
|
|
1357
1357
|
/**
|
|
1358
1358
|
* <p>True if a service software is never automatically updated. False if a service software is
|
|
1359
1359
|
* automatically updated after the automated update date.</p>
|
|
1360
1360
|
* @public
|
|
1361
1361
|
*/
|
|
1362
|
-
OptionalDeployment?: boolean;
|
|
1362
|
+
OptionalDeployment?: boolean | undefined;
|
|
1363
1363
|
}
|
|
1364
1364
|
/**
|
|
1365
1365
|
* <p>Container for the response to a <code>CancelServiceSoftwareUpdate</code> operation. Contains
|
|
@@ -1371,7 +1371,7 @@ export interface CancelServiceSoftwareUpdateResponse {
|
|
|
1371
1371
|
* <p>Container for the state of your domain relative to the latest service software.</p>
|
|
1372
1372
|
* @public
|
|
1373
1373
|
*/
|
|
1374
|
-
ServiceSoftwareOptions?: ServiceSoftwareOptions;
|
|
1374
|
+
ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
|
|
1375
1375
|
}
|
|
1376
1376
|
/**
|
|
1377
1377
|
* @public
|
|
@@ -1394,12 +1394,12 @@ export interface AppConfig {
|
|
|
1394
1394
|
* <p>Specify the item to configure, such as admin role for the OpenSearch Application.</p>
|
|
1395
1395
|
* @public
|
|
1396
1396
|
*/
|
|
1397
|
-
key?: AppConfigType;
|
|
1397
|
+
key?: AppConfigType | undefined;
|
|
1398
1398
|
/**
|
|
1399
1399
|
* <p>Specifies the value to configure for the key, such as an IAM user ARN.</p>
|
|
1400
1400
|
* @public
|
|
1401
1401
|
*/
|
|
1402
|
-
value?: string;
|
|
1402
|
+
value?: string | undefined;
|
|
1403
1403
|
}
|
|
1404
1404
|
/**
|
|
1405
1405
|
* <p>Data sources that are associated with an OpenSearch Application. </p>
|
|
@@ -1412,12 +1412,12 @@ export interface DataSource {
|
|
|
1412
1412
|
* </p>
|
|
1413
1413
|
* @public
|
|
1414
1414
|
*/
|
|
1415
|
-
dataSourceArn?: string;
|
|
1415
|
+
dataSourceArn?: string | undefined;
|
|
1416
1416
|
/**
|
|
1417
1417
|
* <p>Detailed description of a data source.</p>
|
|
1418
1418
|
* @public
|
|
1419
1419
|
*/
|
|
1420
|
-
dataSourceDescription?: string;
|
|
1420
|
+
dataSourceDescription?: string | undefined;
|
|
1421
1421
|
}
|
|
1422
1422
|
/**
|
|
1423
1423
|
* <p>Settings for IAM Identity Center.</p>
|
|
@@ -1428,19 +1428,19 @@ export interface IamIdentityCenterOptionsInput {
|
|
|
1428
1428
|
* <p>Enable/disable settings for IAM Identity Center.</p>
|
|
1429
1429
|
* @public
|
|
1430
1430
|
*/
|
|
1431
|
-
enabled?: boolean;
|
|
1431
|
+
enabled?: boolean | undefined;
|
|
1432
1432
|
/**
|
|
1433
1433
|
* <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
|
|
1434
1434
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1435
1435
|
* </p>
|
|
1436
1436
|
* @public
|
|
1437
1437
|
*/
|
|
1438
|
-
iamIdentityCenterInstanceArn?: string;
|
|
1438
|
+
iamIdentityCenterInstanceArn?: string | undefined;
|
|
1439
1439
|
/**
|
|
1440
1440
|
* <p>Amazon Resource Name of IAM Identity Center's application.</p>
|
|
1441
1441
|
* @public
|
|
1442
1442
|
*/
|
|
1443
|
-
iamRoleForIdentityCenterApplicationArn?: string;
|
|
1443
|
+
iamRoleForIdentityCenterApplicationArn?: string | undefined;
|
|
1444
1444
|
}
|
|
1445
1445
|
/**
|
|
1446
1446
|
* @public
|
|
@@ -1450,7 +1450,7 @@ export interface CreateApplicationRequest {
|
|
|
1450
1450
|
* <p>A unique client idempotency token. It will be auto generated if not provided.</p>
|
|
1451
1451
|
* @public
|
|
1452
1452
|
*/
|
|
1453
|
-
clientToken?: string;
|
|
1453
|
+
clientToken?: string | undefined;
|
|
1454
1454
|
/**
|
|
1455
1455
|
* <p>Name of the OpenSearch Appication to create. Application names are unique across the applications
|
|
1456
1456
|
* owned by an account within an Amazon Web Services Region.</p>
|
|
@@ -1461,22 +1461,22 @@ export interface CreateApplicationRequest {
|
|
|
1461
1461
|
* <p>Data sources to be associated with the OpenSearch Application.</p>
|
|
1462
1462
|
* @public
|
|
1463
1463
|
*/
|
|
1464
|
-
dataSources?: DataSource[];
|
|
1464
|
+
dataSources?: DataSource[] | undefined;
|
|
1465
1465
|
/**
|
|
1466
1466
|
* <p>Settings of IAM Identity Center for the OpenSearch Application.</p>
|
|
1467
1467
|
* @public
|
|
1468
1468
|
*/
|
|
1469
|
-
iamIdentityCenterOptions?: IamIdentityCenterOptionsInput;
|
|
1469
|
+
iamIdentityCenterOptions?: IamIdentityCenterOptionsInput | undefined;
|
|
1470
1470
|
/**
|
|
1471
1471
|
* <p>Configurations of the OpenSearch Application, inlcuding admin configuration.</p>
|
|
1472
1472
|
* @public
|
|
1473
1473
|
*/
|
|
1474
|
-
appConfigs?: AppConfig[];
|
|
1474
|
+
appConfigs?: AppConfig[] | undefined;
|
|
1475
1475
|
/**
|
|
1476
1476
|
* <p>A list of tags attached to a domain.</p>
|
|
1477
1477
|
* @public
|
|
1478
1478
|
*/
|
|
1479
|
-
tagList?: Tag[];
|
|
1479
|
+
tagList?: Tag[] | undefined;
|
|
1480
1480
|
}
|
|
1481
1481
|
/**
|
|
1482
1482
|
* <p>Settings for IAM Identity Center for an OpenSearch Application.</p>
|
|
@@ -1487,26 +1487,26 @@ export interface IamIdentityCenterOptions {
|
|
|
1487
1487
|
* <p>IAM Identity Center is enabled for the OpenSearch Application.</p>
|
|
1488
1488
|
* @public
|
|
1489
1489
|
*/
|
|
1490
|
-
enabled?: boolean;
|
|
1490
|
+
enabled?: boolean | undefined;
|
|
1491
1491
|
/**
|
|
1492
1492
|
* <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
|
|
1493
1493
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1494
1494
|
* </p>
|
|
1495
1495
|
* @public
|
|
1496
1496
|
*/
|
|
1497
|
-
iamIdentityCenterInstanceArn?: string;
|
|
1497
|
+
iamIdentityCenterInstanceArn?: string | undefined;
|
|
1498
1498
|
/**
|
|
1499
1499
|
* <p>Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.</p>
|
|
1500
1500
|
* @public
|
|
1501
1501
|
*/
|
|
1502
|
-
iamRoleForIdentityCenterApplicationArn?: string;
|
|
1502
|
+
iamRoleForIdentityCenterApplicationArn?: string | undefined;
|
|
1503
1503
|
/**
|
|
1504
1504
|
* <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
|
|
1505
1505
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1506
1506
|
* </p>
|
|
1507
1507
|
* @public
|
|
1508
1508
|
*/
|
|
1509
|
-
iamIdentityCenterApplicationArn?: string;
|
|
1509
|
+
iamIdentityCenterApplicationArn?: string | undefined;
|
|
1510
1510
|
}
|
|
1511
1511
|
/**
|
|
1512
1512
|
* @public
|
|
@@ -1516,44 +1516,44 @@ export interface CreateApplicationResponse {
|
|
|
1516
1516
|
* <p>Unique identifier for the created OpenSearch Application.</p>
|
|
1517
1517
|
* @public
|
|
1518
1518
|
*/
|
|
1519
|
-
id?: string;
|
|
1519
|
+
id?: string | undefined;
|
|
1520
1520
|
/**
|
|
1521
1521
|
* <p>Name of the created OpenSearch Application.</p>
|
|
1522
1522
|
* @public
|
|
1523
1523
|
*/
|
|
1524
|
-
name?: string;
|
|
1524
|
+
name?: string | undefined;
|
|
1525
1525
|
/**
|
|
1526
1526
|
* <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
|
|
1527
1527
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
1528
1528
|
* </p>
|
|
1529
1529
|
* @public
|
|
1530
1530
|
*/
|
|
1531
|
-
arn?: string;
|
|
1531
|
+
arn?: string | undefined;
|
|
1532
1532
|
/**
|
|
1533
1533
|
* <p>Data sources associated with the created OpenSearch Application.</p>
|
|
1534
1534
|
* @public
|
|
1535
1535
|
*/
|
|
1536
|
-
dataSources?: DataSource[];
|
|
1536
|
+
dataSources?: DataSource[] | undefined;
|
|
1537
1537
|
/**
|
|
1538
1538
|
* <p>Settings of IAM Identity Center for the created OpenSearch Application.</p>
|
|
1539
1539
|
* @public
|
|
1540
1540
|
*/
|
|
1541
|
-
iamIdentityCenterOptions?: IamIdentityCenterOptions;
|
|
1541
|
+
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
1542
1542
|
/**
|
|
1543
1543
|
* <p>Configurations of the OpenSearch Application, inlcuding admin configuration.</p>
|
|
1544
1544
|
* @public
|
|
1545
1545
|
*/
|
|
1546
|
-
appConfigs?: AppConfig[];
|
|
1546
|
+
appConfigs?: AppConfig[] | undefined;
|
|
1547
1547
|
/**
|
|
1548
1548
|
* <p>A list of tags attached to a domain.</p>
|
|
1549
1549
|
* @public
|
|
1550
1550
|
*/
|
|
1551
|
-
tagList?: Tag[];
|
|
1551
|
+
tagList?: Tag[] | undefined;
|
|
1552
1552
|
/**
|
|
1553
1553
|
* <p>Timestamp when the OpenSearch Application was created.</p>
|
|
1554
1554
|
* @public
|
|
1555
1555
|
*/
|
|
1556
|
-
createdAt?: Date;
|
|
1556
|
+
createdAt?: Date | undefined;
|
|
1557
1557
|
}
|
|
1558
1558
|
/**
|
|
1559
1559
|
* @public
|
|
@@ -1588,12 +1588,12 @@ export interface Duration {
|
|
|
1588
1588
|
* <p>Integer to specify the value of a maintenance schedule duration.</p>
|
|
1589
1589
|
* @public
|
|
1590
1590
|
*/
|
|
1591
|
-
Value?: number;
|
|
1591
|
+
Value?: number | undefined;
|
|
1592
1592
|
/**
|
|
1593
1593
|
* <p>The unit of measurement for the duration of a maintenance schedule.</p>
|
|
1594
1594
|
* @public
|
|
1595
1595
|
*/
|
|
1596
|
-
Unit?: TimeUnit;
|
|
1596
|
+
Unit?: TimeUnit | undefined;
|
|
1597
1597
|
}
|
|
1598
1598
|
/**
|
|
1599
1599
|
* <note>
|
|
@@ -1611,19 +1611,19 @@ export interface AutoTuneMaintenanceSchedule {
|
|
|
1611
1611
|
* <p>The Epoch timestamp at which the Auto-Tune maintenance schedule starts.</p>
|
|
1612
1612
|
* @public
|
|
1613
1613
|
*/
|
|
1614
|
-
StartAt?: Date;
|
|
1614
|
+
StartAt?: Date | undefined;
|
|
1615
1615
|
/**
|
|
1616
1616
|
* <p>The duration of the maintenance schedule. For example, <code>"Duration": \{"Value": 2,
|
|
1617
1617
|
* "Unit": "HOURS"\}</code>.</p>
|
|
1618
1618
|
* @public
|
|
1619
1619
|
*/
|
|
1620
|
-
Duration?: Duration;
|
|
1620
|
+
Duration?: Duration | undefined;
|
|
1621
1621
|
/**
|
|
1622
1622
|
* <p>A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy
|
|
1623
1623
|
* changes.</p>
|
|
1624
1624
|
* @public
|
|
1625
1625
|
*/
|
|
1626
|
-
CronExpressionForRecurrence?: string;
|
|
1626
|
+
CronExpressionForRecurrence?: string | undefined;
|
|
1627
1627
|
}
|
|
1628
1628
|
/**
|
|
1629
1629
|
* <p>Options for configuring Auto-Tune. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch
|
|
@@ -1636,17 +1636,17 @@ export interface AutoTuneOptionsInput {
|
|
|
1636
1636
|
* <p>Whether Auto-Tune is enabled or disabled.</p>
|
|
1637
1637
|
* @public
|
|
1638
1638
|
*/
|
|
1639
|
-
DesiredState?: AutoTuneDesiredState;
|
|
1639
|
+
DesiredState?: AutoTuneDesiredState | undefined;
|
|
1640
1640
|
/**
|
|
1641
1641
|
* <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>
|
|
1642
1642
|
* @public
|
|
1643
1643
|
*/
|
|
1644
|
-
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[];
|
|
1644
|
+
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[] | undefined;
|
|
1645
1645
|
/**
|
|
1646
1646
|
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.</p>
|
|
1647
1647
|
* @public
|
|
1648
1648
|
*/
|
|
1649
|
-
UseOffPeakWindow?: boolean;
|
|
1649
|
+
UseOffPeakWindow?: boolean | undefined;
|
|
1650
1650
|
}
|
|
1651
1651
|
/**
|
|
1652
1652
|
* <p>Container for the parameters required to enable cold storage for an OpenSearch Service
|
|
@@ -1783,17 +1783,17 @@ export interface NodeConfig {
|
|
|
1783
1783
|
* <p>A boolean that indicates whether a particular node type is enabled or not.</p>
|
|
1784
1784
|
* @public
|
|
1785
1785
|
*/
|
|
1786
|
-
Enabled?: boolean;
|
|
1786
|
+
Enabled?: boolean | undefined;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* <p>The instance type of a particular node type in the cluster.</p>
|
|
1789
1789
|
* @public
|
|
1790
1790
|
*/
|
|
1791
|
-
Type?: OpenSearchPartitionInstanceType;
|
|
1791
|
+
Type?: OpenSearchPartitionInstanceType | undefined;
|
|
1792
1792
|
/**
|
|
1793
1793
|
* <p>The number of nodes of a particular node type in the cluster.</p>
|
|
1794
1794
|
* @public
|
|
1795
1795
|
*/
|
|
1796
|
-
Count?: number;
|
|
1796
|
+
Count?: number | undefined;
|
|
1797
1797
|
}
|
|
1798
1798
|
/**
|
|
1799
1799
|
* @public
|
|
@@ -1815,12 +1815,12 @@ export interface NodeOption {
|
|
|
1815
1815
|
* <p>Container for node type like coordinating.</p>
|
|
1816
1816
|
* @public
|
|
1817
1817
|
*/
|
|
1818
|
-
NodeType?: NodeOptionsNodeType;
|
|
1818
|
+
NodeType?: NodeOptionsNodeType | undefined;
|
|
1819
1819
|
/**
|
|
1820
1820
|
* <p>Container for specifying configuration of any node type.</p>
|
|
1821
1821
|
* @public
|
|
1822
1822
|
*/
|
|
1823
|
-
NodeConfig?: NodeConfig;
|
|
1823
|
+
NodeConfig?: NodeConfig | undefined;
|
|
1824
1824
|
}
|
|
1825
1825
|
/**
|
|
1826
1826
|
* @public
|
|
@@ -1846,7 +1846,7 @@ export interface ZoneAwarenessConfig {
|
|
|
1846
1846
|
* provisioned within a VPC, this value be equal to number of subnets.</p>
|
|
1847
1847
|
* @public
|
|
1848
1848
|
*/
|
|
1849
|
-
AvailabilityZoneCount?: number;
|
|
1849
|
+
AvailabilityZoneCount?: number | undefined;
|
|
1850
1850
|
}
|
|
1851
1851
|
/**
|
|
1852
1852
|
* <p>Container for the cluster configuration of an OpenSearch Service domain. For more
|
|
@@ -1858,71 +1858,71 @@ export interface ClusterConfig {
|
|
|
1858
1858
|
* <p>Instance type of data nodes in the cluster.</p>
|
|
1859
1859
|
* @public
|
|
1860
1860
|
*/
|
|
1861
|
-
InstanceType?: OpenSearchPartitionInstanceType;
|
|
1861
|
+
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
1862
1862
|
/**
|
|
1863
1863
|
* <p>Number of data nodes in the cluster. This number must be greater than 1, otherwise you
|
|
1864
1864
|
* receive a validation exception.</p>
|
|
1865
1865
|
* @public
|
|
1866
1866
|
*/
|
|
1867
|
-
InstanceCount?: number;
|
|
1867
|
+
InstanceCount?: number | undefined;
|
|
1868
1868
|
/**
|
|
1869
1869
|
* <p>Indicates whether dedicated master nodes are enabled for the cluster.<code>True</code> if
|
|
1870
1870
|
* the cluster will use a dedicated master node.<code>False</code> if the cluster will not.</p>
|
|
1871
1871
|
* @public
|
|
1872
1872
|
*/
|
|
1873
|
-
DedicatedMasterEnabled?: boolean;
|
|
1873
|
+
DedicatedMasterEnabled?: boolean | undefined;
|
|
1874
1874
|
/**
|
|
1875
1875
|
* <p>Indicates whether multiple Availability Zones are enabled. 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>
|
|
1876
1876
|
* @public
|
|
1877
1877
|
*/
|
|
1878
|
-
ZoneAwarenessEnabled?: boolean;
|
|
1878
|
+
ZoneAwarenessEnabled?: boolean | undefined;
|
|
1879
1879
|
/**
|
|
1880
1880
|
* <p>Container for zone awareness configuration options. Only required if
|
|
1881
1881
|
* <code>ZoneAwarenessEnabled</code> is <code>true</code>.</p>
|
|
1882
1882
|
* @public
|
|
1883
1883
|
*/
|
|
1884
|
-
ZoneAwarenessConfig?: ZoneAwarenessConfig;
|
|
1884
|
+
ZoneAwarenessConfig?: ZoneAwarenessConfig | undefined;
|
|
1885
1885
|
/**
|
|
1886
1886
|
* <p>OpenSearch Service instance type of the dedicated master nodes in the cluster.</p>
|
|
1887
1887
|
* @public
|
|
1888
1888
|
*/
|
|
1889
|
-
DedicatedMasterType?: OpenSearchPartitionInstanceType;
|
|
1889
|
+
DedicatedMasterType?: OpenSearchPartitionInstanceType | undefined;
|
|
1890
1890
|
/**
|
|
1891
1891
|
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4,
|
|
1892
1892
|
* otherwise you receive a validation exception.</p>
|
|
1893
1893
|
* @public
|
|
1894
1894
|
*/
|
|
1895
|
-
DedicatedMasterCount?: number;
|
|
1895
|
+
DedicatedMasterCount?: number | undefined;
|
|
1896
1896
|
/**
|
|
1897
1897
|
* <p>Whether to enable warm storage for the cluster.</p>
|
|
1898
1898
|
* @public
|
|
1899
1899
|
*/
|
|
1900
|
-
WarmEnabled?: boolean;
|
|
1900
|
+
WarmEnabled?: boolean | undefined;
|
|
1901
1901
|
/**
|
|
1902
1902
|
* <p>The instance type for the cluster's warm nodes.</p>
|
|
1903
1903
|
* @public
|
|
1904
1904
|
*/
|
|
1905
|
-
WarmType?: OpenSearchWarmPartitionInstanceType;
|
|
1905
|
+
WarmType?: OpenSearchWarmPartitionInstanceType | undefined;
|
|
1906
1906
|
/**
|
|
1907
1907
|
* <p>The number of warm nodes in the cluster.</p>
|
|
1908
1908
|
* @public
|
|
1909
1909
|
*/
|
|
1910
|
-
WarmCount?: number;
|
|
1910
|
+
WarmCount?: number | undefined;
|
|
1911
1911
|
/**
|
|
1912
1912
|
* <p>Container for cold storage configuration options.</p>
|
|
1913
1913
|
* @public
|
|
1914
1914
|
*/
|
|
1915
|
-
ColdStorageOptions?: ColdStorageOptions;
|
|
1915
|
+
ColdStorageOptions?: ColdStorageOptions | undefined;
|
|
1916
1916
|
/**
|
|
1917
1917
|
* <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>
|
|
1918
1918
|
* @public
|
|
1919
1919
|
*/
|
|
1920
|
-
MultiAZWithStandbyEnabled?: boolean;
|
|
1920
|
+
MultiAZWithStandbyEnabled?: boolean | undefined;
|
|
1921
1921
|
/**
|
|
1922
1922
|
* <p>List of node options for the domain.</p>
|
|
1923
1923
|
* @public
|
|
1924
1924
|
*/
|
|
1925
|
-
NodeOptions?: NodeOption[];
|
|
1925
|
+
NodeOptions?: NodeOption[] | undefined;
|
|
1926
1926
|
}
|
|
1927
1927
|
/**
|
|
1928
1928
|
* <p>Container for the parameters required to enable Cognito authentication for an OpenSearch
|
|
@@ -1935,25 +1935,25 @@ export interface CognitoOptions {
|
|
|
1935
1935
|
* <p>Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.</p>
|
|
1936
1936
|
* @public
|
|
1937
1937
|
*/
|
|
1938
|
-
Enabled?: boolean;
|
|
1938
|
+
Enabled?: boolean | undefined;
|
|
1939
1939
|
/**
|
|
1940
1940
|
* <p>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch
|
|
1941
1941
|
* Dashboards authentication.</p>
|
|
1942
1942
|
* @public
|
|
1943
1943
|
*/
|
|
1944
|
-
UserPoolId?: string;
|
|
1944
|
+
UserPoolId?: string | undefined;
|
|
1945
1945
|
/**
|
|
1946
1946
|
* <p>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch
|
|
1947
1947
|
* Dashboards authentication.</p>
|
|
1948
1948
|
* @public
|
|
1949
1949
|
*/
|
|
1950
|
-
IdentityPoolId?: string;
|
|
1950
|
+
IdentityPoolId?: string | undefined;
|
|
1951
1951
|
/**
|
|
1952
1952
|
* <p>The <code>AmazonOpenSearchServiceCognitoAccess</code> role that allows OpenSearch Service to
|
|
1953
1953
|
* configure your user pool and identity pool.</p>
|
|
1954
1954
|
* @public
|
|
1955
1955
|
*/
|
|
1956
|
-
RoleArn?: string;
|
|
1956
|
+
RoleArn?: string | undefined;
|
|
1957
1957
|
}
|
|
1958
1958
|
/**
|
|
1959
1959
|
* @public
|
|
@@ -1977,7 +1977,7 @@ export interface DomainEndpointOptions {
|
|
|
1977
1977
|
* <p>True to require that all traffic to the domain arrive over HTTPS.</p>
|
|
1978
1978
|
* @public
|
|
1979
1979
|
*/
|
|
1980
|
-
EnforceHTTPS?: boolean;
|
|
1980
|
+
EnforceHTTPS?: boolean | undefined;
|
|
1981
1981
|
/**
|
|
1982
1982
|
* <p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can
|
|
1983
1983
|
* be one of the following values:</p>
|
|
@@ -2000,23 +2000,23 @@ export interface DomainEndpointOptions {
|
|
|
2000
2000
|
* </ul>
|
|
2001
2001
|
* @public
|
|
2002
2002
|
*/
|
|
2003
|
-
TLSSecurityPolicy?: TLSSecurityPolicy;
|
|
2003
|
+
TLSSecurityPolicy?: TLSSecurityPolicy | undefined;
|
|
2004
2004
|
/**
|
|
2005
2005
|
* <p>Whether to enable a custom endpoint for the domain.</p>
|
|
2006
2006
|
* @public
|
|
2007
2007
|
*/
|
|
2008
|
-
CustomEndpointEnabled?: boolean;
|
|
2008
|
+
CustomEndpointEnabled?: boolean | undefined;
|
|
2009
2009
|
/**
|
|
2010
2010
|
* <p>The fully qualified URL for the custom endpoint.</p>
|
|
2011
2011
|
* @public
|
|
2012
2012
|
*/
|
|
2013
|
-
CustomEndpoint?: string;
|
|
2013
|
+
CustomEndpoint?: string | undefined;
|
|
2014
2014
|
/**
|
|
2015
2015
|
* <p>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager
|
|
2016
2016
|
* (ACM).</p>
|
|
2017
2017
|
* @public
|
|
2018
2018
|
*/
|
|
2019
|
-
CustomEndpointCertificateArn?: string;
|
|
2019
|
+
CustomEndpointCertificateArn?: string | undefined;
|
|
2020
2020
|
}
|
|
2021
2021
|
/**
|
|
2022
2022
|
* @public
|
|
@@ -2043,29 +2043,29 @@ export interface EBSOptions {
|
|
|
2043
2043
|
* domain.</p>
|
|
2044
2044
|
* @public
|
|
2045
2045
|
*/
|
|
2046
|
-
EBSEnabled?: boolean;
|
|
2046
|
+
EBSEnabled?: boolean | undefined;
|
|
2047
2047
|
/**
|
|
2048
2048
|
* <p>Specifies the type of EBS volumes attached to data nodes.</p>
|
|
2049
2049
|
* @public
|
|
2050
2050
|
*/
|
|
2051
|
-
VolumeType?: VolumeType;
|
|
2051
|
+
VolumeType?: VolumeType | undefined;
|
|
2052
2052
|
/**
|
|
2053
2053
|
* <p>Specifies the size (in GiB) of EBS volumes attached to data nodes.</p>
|
|
2054
2054
|
* @public
|
|
2055
2055
|
*/
|
|
2056
|
-
VolumeSize?: number;
|
|
2056
|
+
VolumeSize?: number | undefined;
|
|
2057
2057
|
/**
|
|
2058
2058
|
* <p>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes.
|
|
2059
2059
|
* Applicable only for the <code>gp3</code> and provisioned IOPS EBS volume types.</p>
|
|
2060
2060
|
* @public
|
|
2061
2061
|
*/
|
|
2062
|
-
Iops?: number;
|
|
2062
|
+
Iops?: number | undefined;
|
|
2063
2063
|
/**
|
|
2064
2064
|
* <p>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable
|
|
2065
2065
|
* only for the <code>gp3</code> volume type.</p>
|
|
2066
2066
|
* @public
|
|
2067
2067
|
*/
|
|
2068
|
-
Throughput?: number;
|
|
2068
|
+
Throughput?: number | undefined;
|
|
2069
2069
|
}
|
|
2070
2070
|
/**
|
|
2071
2071
|
* <p>Specifies whether the domain should encrypt data at rest, and if so, the Key Management
|
|
@@ -2079,12 +2079,12 @@ export interface EncryptionAtRestOptions {
|
|
|
2079
2079
|
* <p>True to enable encryption at rest.</p>
|
|
2080
2080
|
* @public
|
|
2081
2081
|
*/
|
|
2082
|
-
Enabled?: boolean;
|
|
2082
|
+
Enabled?: boolean | undefined;
|
|
2083
2083
|
/**
|
|
2084
2084
|
* <p>The KMS key ID. Takes the form <code>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</code>.</p>
|
|
2085
2085
|
* @public
|
|
2086
2086
|
*/
|
|
2087
|
-
KmsKeyId?: string;
|
|
2087
|
+
KmsKeyId?: string | undefined;
|
|
2088
2088
|
}
|
|
2089
2089
|
/**
|
|
2090
2090
|
* @public
|
|
@@ -2120,22 +2120,22 @@ export interface IdentityCenterOptionsInput {
|
|
|
2120
2120
|
* <p>True to enable IAM Identity Center for API access in Amazon OpenSearch Service.</p>
|
|
2121
2121
|
* @public
|
|
2122
2122
|
*/
|
|
2123
|
-
EnabledAPIAccess?: boolean;
|
|
2123
|
+
EnabledAPIAccess?: boolean | undefined;
|
|
2124
2124
|
/**
|
|
2125
2125
|
* <p>The ARN for IAM Identity Center Instance which will be used for IAM Identity Center Application creation.</p>
|
|
2126
2126
|
* @public
|
|
2127
2127
|
*/
|
|
2128
|
-
IdentityCenterInstanceARN?: string;
|
|
2128
|
+
IdentityCenterInstanceARN?: string | undefined;
|
|
2129
2129
|
/**
|
|
2130
2130
|
* <p>Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.</p>
|
|
2131
2131
|
* @public
|
|
2132
2132
|
*/
|
|
2133
|
-
SubjectKey?: SubjectKeyIdCOption;
|
|
2133
|
+
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2134
2134
|
/**
|
|
2135
2135
|
* <p>Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center</p>
|
|
2136
2136
|
* @public
|
|
2137
2137
|
*/
|
|
2138
|
-
RolesKey?: RolesKeyIdCOption;
|
|
2138
|
+
RolesKey?: RolesKeyIdCOption | undefined;
|
|
2139
2139
|
}
|
|
2140
2140
|
/**
|
|
2141
2141
|
* @public
|
|
@@ -2177,12 +2177,12 @@ export interface LogPublishingOption {
|
|
|
2177
2177
|
* <p>The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.</p>
|
|
2178
2178
|
* @public
|
|
2179
2179
|
*/
|
|
2180
|
-
CloudWatchLogsLogGroupArn?: string;
|
|
2180
|
+
CloudWatchLogsLogGroupArn?: string | undefined;
|
|
2181
2181
|
/**
|
|
2182
2182
|
* <p>Whether the log should be published.</p>
|
|
2183
2183
|
* @public
|
|
2184
2184
|
*/
|
|
2185
|
-
Enabled?: boolean;
|
|
2185
|
+
Enabled?: boolean | undefined;
|
|
2186
2186
|
}
|
|
2187
2187
|
/**
|
|
2188
2188
|
* <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>
|
|
@@ -2193,7 +2193,7 @@ export interface NodeToNodeEncryptionOptions {
|
|
|
2193
2193
|
* <p>True to enable node-to-node encryption.</p>
|
|
2194
2194
|
* @public
|
|
2195
2195
|
*/
|
|
2196
|
-
Enabled?: boolean;
|
|
2196
|
+
Enabled?: boolean | undefined;
|
|
2197
2197
|
}
|
|
2198
2198
|
/**
|
|
2199
2199
|
* <p>The desired start time for an <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak maintenance
|
|
@@ -2230,7 +2230,7 @@ export interface OffPeakWindow {
|
|
|
2230
2230
|
* 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.</p>
|
|
2231
2231
|
* @public
|
|
2232
2232
|
*/
|
|
2233
|
-
WindowStartTime?: WindowStartTime;
|
|
2233
|
+
WindowStartTime?: WindowStartTime | undefined;
|
|
2234
2234
|
}
|
|
2235
2235
|
/**
|
|
2236
2236
|
* <p>Options for a domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak window</a>,
|
|
@@ -2245,12 +2245,12 @@ export interface OffPeakWindowOptions {
|
|
|
2245
2245
|
* enabled by default. You can't disable the off-peak window after it's enabled for a domain.</p>
|
|
2246
2246
|
* @public
|
|
2247
2247
|
*/
|
|
2248
|
-
Enabled?: boolean;
|
|
2248
|
+
Enabled?: boolean | undefined;
|
|
2249
2249
|
/**
|
|
2250
2250
|
* <p>Off-peak window settings for the domain.</p>
|
|
2251
2251
|
* @public
|
|
2252
2252
|
*/
|
|
2253
|
-
OffPeakWindow?: OffPeakWindow;
|
|
2253
|
+
OffPeakWindow?: OffPeakWindow | undefined;
|
|
2254
2254
|
}
|
|
2255
2255
|
/**
|
|
2256
2256
|
* <p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the
|
|
@@ -2263,7 +2263,7 @@ export interface SnapshotOptions {
|
|
|
2263
2263
|
* specified domain. Default is <code>0</code> hours.</p>
|
|
2264
2264
|
* @public
|
|
2265
2265
|
*/
|
|
2266
|
-
AutomatedSnapshotStartHour?: number;
|
|
2266
|
+
AutomatedSnapshotStartHour?: number | undefined;
|
|
2267
2267
|
}
|
|
2268
2268
|
/**
|
|
2269
2269
|
* <p>Options for configuring service software updates for a domain.</p>
|
|
@@ -2274,7 +2274,7 @@ export interface SoftwareUpdateOptions {
|
|
|
2274
2274
|
* <p>Whether automatic service software updates are enabled for the domain.</p>
|
|
2275
2275
|
* @public
|
|
2276
2276
|
*/
|
|
2277
|
-
AutoSoftwareUpdateEnabled?: boolean;
|
|
2277
|
+
AutoSoftwareUpdateEnabled?: boolean | undefined;
|
|
2278
2278
|
}
|
|
2279
2279
|
/**
|
|
2280
2280
|
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC
|
|
@@ -2289,13 +2289,13 @@ export interface VPCOptions {
|
|
|
2289
2289
|
* only one.</p>
|
|
2290
2290
|
* @public
|
|
2291
2291
|
*/
|
|
2292
|
-
SubnetIds?: string[];
|
|
2292
|
+
SubnetIds?: string[] | undefined;
|
|
2293
2293
|
/**
|
|
2294
2294
|
* <p>The list of security group IDs associated with the VPC endpoints for the domain. If you do
|
|
2295
2295
|
* not provide a security group ID, OpenSearch Service uses the default security group for the VPC.</p>
|
|
2296
2296
|
* @public
|
|
2297
2297
|
*/
|
|
2298
|
-
SecurityGroupIds?: string[];
|
|
2298
|
+
SecurityGroupIds?: string[] | undefined;
|
|
2299
2299
|
}
|
|
2300
2300
|
/**
|
|
2301
2301
|
* @public
|
|
@@ -2314,37 +2314,37 @@ export interface CreateDomainRequest {
|
|
|
2314
2314
|
* and managing Amazon OpenSearch Service domains</a>.</p>
|
|
2315
2315
|
* @public
|
|
2316
2316
|
*/
|
|
2317
|
-
EngineVersion?: string;
|
|
2317
|
+
EngineVersion?: string | undefined;
|
|
2318
2318
|
/**
|
|
2319
2319
|
* <p>Container for the cluster configuration of a domain.</p>
|
|
2320
2320
|
* @public
|
|
2321
2321
|
*/
|
|
2322
|
-
ClusterConfig?: ClusterConfig;
|
|
2322
|
+
ClusterConfig?: ClusterConfig | undefined;
|
|
2323
2323
|
/**
|
|
2324
2324
|
* <p>Container for the parameters required to enable EBS-based storage for an OpenSearch Service
|
|
2325
2325
|
* domain.</p>
|
|
2326
2326
|
* @public
|
|
2327
2327
|
*/
|
|
2328
|
-
EBSOptions?: EBSOptions;
|
|
2328
|
+
EBSOptions?: EBSOptions | undefined;
|
|
2329
2329
|
/**
|
|
2330
2330
|
* <p>Identity and Access Management (IAM) policy document specifying the access policies for the
|
|
2331
2331
|
* new domain.</p>
|
|
2332
2332
|
* @public
|
|
2333
2333
|
*/
|
|
2334
|
-
AccessPolicies?: string;
|
|
2334
|
+
AccessPolicies?: string | undefined;
|
|
2335
2335
|
/**
|
|
2336
2336
|
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share
|
|
2337
2337
|
* domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
2338
2338
|
* If you set your IP address type to dual stack, you can't change your address type later.</p>
|
|
2339
2339
|
* @public
|
|
2340
2340
|
*/
|
|
2341
|
-
IPAddressType?: IPAddressType;
|
|
2341
|
+
IPAddressType?: IPAddressType | undefined;
|
|
2342
2342
|
/**
|
|
2343
2343
|
* <p>DEPRECATED. Container for the parameters required to configure automated snapshots of domain
|
|
2344
2344
|
* indexes.</p>
|
|
2345
2345
|
* @public
|
|
2346
2346
|
*/
|
|
2347
|
-
SnapshotOptions?: SnapshotOptions;
|
|
2347
|
+
SnapshotOptions?: SnapshotOptions | undefined;
|
|
2348
2348
|
/**
|
|
2349
2349
|
* <p>Container for the values required to configure VPC access domains. If you don't specify
|
|
2350
2350
|
* these values, OpenSearch Service creates the domain with a public endpoint. For more information,
|
|
@@ -2352,22 +2352,22 @@ export interface CreateDomainRequest {
|
|
|
2352
2352
|
* your Amazon OpenSearch Service domains using a VPC</a>.</p>
|
|
2353
2353
|
* @public
|
|
2354
2354
|
*/
|
|
2355
|
-
VPCOptions?: VPCOptions;
|
|
2355
|
+
VPCOptions?: VPCOptions | undefined;
|
|
2356
2356
|
/**
|
|
2357
2357
|
* <p>Key-value pairs to configure Amazon Cognito authentication. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html">Configuring Amazon Cognito authentication for OpenSearch Dashboards</a>.</p>
|
|
2358
2358
|
* @public
|
|
2359
2359
|
*/
|
|
2360
|
-
CognitoOptions?: CognitoOptions;
|
|
2360
|
+
CognitoOptions?: CognitoOptions | undefined;
|
|
2361
2361
|
/**
|
|
2362
2362
|
* <p>Key-value pairs to enable encryption at rest.</p>
|
|
2363
2363
|
* @public
|
|
2364
2364
|
*/
|
|
2365
|
-
EncryptionAtRestOptions?: EncryptionAtRestOptions;
|
|
2365
|
+
EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
|
|
2366
2366
|
/**
|
|
2367
2367
|
* <p>Enables node-to-node encryption.</p>
|
|
2368
2368
|
* @public
|
|
2369
2369
|
*/
|
|
2370
|
-
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
|
|
2370
|
+
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
|
|
2371
2371
|
/**
|
|
2372
2372
|
* <p>Key-value pairs to specify advanced configuration options. The following key-value pairs are
|
|
2373
2373
|
* supported:</p>
|
|
@@ -2404,38 +2404,38 @@ export interface CreateDomainRequest {
|
|
|
2404
2404
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced cluster parameters</a>.</p>
|
|
2405
2405
|
* @public
|
|
2406
2406
|
*/
|
|
2407
|
-
AdvancedOptions?: Record<string, string
|
|
2407
|
+
AdvancedOptions?: Record<string, string> | undefined;
|
|
2408
2408
|
/**
|
|
2409
2409
|
* <p>Key-value pairs to configure log publishing.</p>
|
|
2410
2410
|
* @public
|
|
2411
2411
|
*/
|
|
2412
|
-
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption
|
|
2412
|
+
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
2413
2413
|
/**
|
|
2414
2414
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
2415
2415
|
* traffic.</p>
|
|
2416
2416
|
* @public
|
|
2417
2417
|
*/
|
|
2418
|
-
DomainEndpointOptions?: DomainEndpointOptions;
|
|
2418
|
+
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
2419
2419
|
/**
|
|
2420
2420
|
* <p>Options for fine-grained access control.</p>
|
|
2421
2421
|
* @public
|
|
2422
2422
|
*/
|
|
2423
|
-
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
|
|
2423
|
+
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
2424
2424
|
/**
|
|
2425
2425
|
* <p>Options for IAM Identity Center Option control for the domain.</p>
|
|
2426
2426
|
* @public
|
|
2427
2427
|
*/
|
|
2428
|
-
IdentityCenterOptions?: IdentityCenterOptionsInput;
|
|
2428
|
+
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
2429
2429
|
/**
|
|
2430
2430
|
* <p>List of tags to add to the domain upon creation.</p>
|
|
2431
2431
|
* @public
|
|
2432
2432
|
*/
|
|
2433
|
-
TagList?: Tag[];
|
|
2433
|
+
TagList?: Tag[] | undefined;
|
|
2434
2434
|
/**
|
|
2435
2435
|
* <p>Options for Auto-Tune.</p>
|
|
2436
2436
|
* @public
|
|
2437
2437
|
*/
|
|
2438
|
-
AutoTuneOptions?: AutoTuneOptionsInput;
|
|
2438
|
+
AutoTuneOptions?: AutoTuneOptionsInput | undefined;
|
|
2439
2439
|
/**
|
|
2440
2440
|
* <p>Specifies a daily 10-hour time block during which OpenSearch Service can perform
|
|
2441
2441
|
* configuration changes on the domain, including service software updates and Auto-Tune
|
|
@@ -2443,17 +2443,17 @@ export interface CreateDomainRequest {
|
|
|
2443
2443
|
* time of 10:00 P.M. local time (for the Region that the domain is created in) is used.</p>
|
|
2444
2444
|
* @public
|
|
2445
2445
|
*/
|
|
2446
|
-
OffPeakWindowOptions?: OffPeakWindowOptions;
|
|
2446
|
+
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
2447
2447
|
/**
|
|
2448
2448
|
* <p>Software update options for the domain.</p>
|
|
2449
2449
|
* @public
|
|
2450
2450
|
*/
|
|
2451
|
-
SoftwareUpdateOptions?: SoftwareUpdateOptions;
|
|
2451
|
+
SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
|
|
2452
2452
|
/**
|
|
2453
2453
|
* <p>Options for all machine learning features for the specified domain.</p>
|
|
2454
2454
|
* @public
|
|
2455
2455
|
*/
|
|
2456
|
-
AIMLOptions?: AIMLOptionsInput;
|
|
2456
|
+
AIMLOptions?: AIMLOptionsInput | undefined;
|
|
2457
2457
|
}
|
|
2458
2458
|
/**
|
|
2459
2459
|
* @public
|
|
@@ -2483,18 +2483,18 @@ export interface AutoTuneOptionsOutput {
|
|
|
2483
2483
|
* <p>The current state of Auto-Tune on the domain.</p>
|
|
2484
2484
|
* @public
|
|
2485
2485
|
*/
|
|
2486
|
-
State?: AutoTuneState;
|
|
2486
|
+
State?: AutoTuneState | undefined;
|
|
2487
2487
|
/**
|
|
2488
2488
|
* <p>Any errors that occurred while enabling or disabling Auto-Tune.</p>
|
|
2489
2489
|
* @public
|
|
2490
2490
|
*/
|
|
2491
|
-
ErrorMessage?: string;
|
|
2491
|
+
ErrorMessage?: string | undefined;
|
|
2492
2492
|
/**
|
|
2493
2493
|
* <p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather
|
|
2494
2494
|
* than a maintenance schedule.</p>
|
|
2495
2495
|
* @public
|
|
2496
2496
|
*/
|
|
2497
|
-
UseOffPeakWindow?: boolean;
|
|
2497
|
+
UseOffPeakWindow?: boolean | undefined;
|
|
2498
2498
|
}
|
|
2499
2499
|
/**
|
|
2500
2500
|
* @public
|
|
@@ -2535,32 +2535,32 @@ export interface ChangeProgressDetails {
|
|
|
2535
2535
|
* <p>The ID of the configuration change.</p>
|
|
2536
2536
|
* @public
|
|
2537
2537
|
*/
|
|
2538
|
-
ChangeId?: string;
|
|
2538
|
+
ChangeId?: string | undefined;
|
|
2539
2539
|
/**
|
|
2540
2540
|
* <p>A message corresponding to the status of the configuration change.</p>
|
|
2541
2541
|
* @public
|
|
2542
2542
|
*/
|
|
2543
|
-
Message?: string;
|
|
2543
|
+
Message?: string | undefined;
|
|
2544
2544
|
/**
|
|
2545
2545
|
* <p>The current status of the configuration change.</p>
|
|
2546
2546
|
* @public
|
|
2547
2547
|
*/
|
|
2548
|
-
ConfigChangeStatus?: ConfigChangeStatus;
|
|
2548
|
+
ConfigChangeStatus?: ConfigChangeStatus | undefined;
|
|
2549
2549
|
/**
|
|
2550
2550
|
* <p>The IAM principal who initiated the configuration change.</p>
|
|
2551
2551
|
* @public
|
|
2552
2552
|
*/
|
|
2553
|
-
InitiatedBy?: InitiatedBy;
|
|
2553
|
+
InitiatedBy?: InitiatedBy | undefined;
|
|
2554
2554
|
/**
|
|
2555
2555
|
* <p>The time that the configuration change was initiated, in Universal Coordinated Time (UTC).</p>
|
|
2556
2556
|
* @public
|
|
2557
2557
|
*/
|
|
2558
|
-
StartTime?: Date;
|
|
2558
|
+
StartTime?: Date | undefined;
|
|
2559
2559
|
/**
|
|
2560
2560
|
* <p>The last time that the configuration change was updated.</p>
|
|
2561
2561
|
* @public
|
|
2562
2562
|
*/
|
|
2563
|
-
LastUpdatedTime?: Date;
|
|
2563
|
+
LastUpdatedTime?: Date | undefined;
|
|
2564
2564
|
}
|
|
2565
2565
|
/**
|
|
2566
2566
|
* @public
|
|
@@ -2588,32 +2588,32 @@ export interface IdentityCenterOptions {
|
|
|
2588
2588
|
* <p>True to enable IAM Identity Center for API access in Amazon OpenSearch Service.</p>
|
|
2589
2589
|
* @public
|
|
2590
2590
|
*/
|
|
2591
|
-
EnabledAPIAccess?: boolean;
|
|
2591
|
+
EnabledAPIAccess?: boolean | undefined;
|
|
2592
2592
|
/**
|
|
2593
2593
|
* <p>The ARN for IAM Identity Center Instance.</p>
|
|
2594
2594
|
* @public
|
|
2595
2595
|
*/
|
|
2596
|
-
IdentityCenterInstanceARN?: string;
|
|
2596
|
+
IdentityCenterInstanceARN?: string | undefined;
|
|
2597
2597
|
/**
|
|
2598
2598
|
* <p>Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.</p>
|
|
2599
2599
|
* @public
|
|
2600
2600
|
*/
|
|
2601
|
-
SubjectKey?: SubjectKeyIdCOption;
|
|
2601
|
+
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2602
2602
|
/**
|
|
2603
2603
|
* <p>Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center</p>
|
|
2604
2604
|
* @public
|
|
2605
2605
|
*/
|
|
2606
|
-
RolesKey?: RolesKeyIdCOption;
|
|
2606
|
+
RolesKey?: RolesKeyIdCOption | undefined;
|
|
2607
2607
|
/**
|
|
2608
2608
|
* <p>The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.</p>
|
|
2609
2609
|
* @public
|
|
2610
2610
|
*/
|
|
2611
|
-
IdentityCenterApplicationARN?: string;
|
|
2611
|
+
IdentityCenterApplicationARN?: string | undefined;
|
|
2612
2612
|
/**
|
|
2613
2613
|
* <p>The ID of IAM Identity Store.</p>
|
|
2614
2614
|
* @public
|
|
2615
2615
|
*/
|
|
2616
|
-
IdentityStoreId?: string;
|
|
2616
|
+
IdentityStoreId?: string | undefined;
|
|
2617
2617
|
}
|
|
2618
2618
|
/**
|
|
2619
2619
|
* @public
|
|
@@ -2636,17 +2636,17 @@ export interface ModifyingProperties {
|
|
|
2636
2636
|
* <p>The name of the property that is currently being modified.</p>
|
|
2637
2637
|
* @public
|
|
2638
2638
|
*/
|
|
2639
|
-
Name?: string;
|
|
2639
|
+
Name?: string | undefined;
|
|
2640
2640
|
/**
|
|
2641
2641
|
* <p>The current value of the domain property that is being modified.</p>
|
|
2642
2642
|
* @public
|
|
2643
2643
|
*/
|
|
2644
|
-
ActiveValue?: string;
|
|
2644
|
+
ActiveValue?: string | undefined;
|
|
2645
2645
|
/**
|
|
2646
2646
|
* <p>The value that the property that is currently being modified will eventually have.</p>
|
|
2647
2647
|
* @public
|
|
2648
2648
|
*/
|
|
2649
|
-
PendingValue?: string;
|
|
2649
|
+
PendingValue?: string | undefined;
|
|
2650
2650
|
/**
|
|
2651
2651
|
* <p>The type of value that is currently being modified. Properties can have two types:</p>
|
|
2652
2652
|
* <ul>
|
|
@@ -2661,7 +2661,7 @@ export interface ModifyingProperties {
|
|
|
2661
2661
|
* </ul>
|
|
2662
2662
|
* @public
|
|
2663
2663
|
*/
|
|
2664
|
-
ValueType?: PropertyValueType;
|
|
2664
|
+
ValueType?: PropertyValueType | undefined;
|
|
2665
2665
|
}
|
|
2666
2666
|
/**
|
|
2667
2667
|
* <p>Information about the subnets and security groups for an Amazon OpenSearch Service domain
|
|
@@ -2675,22 +2675,22 @@ export interface VPCDerivedInfo {
|
|
|
2675
2675
|
* <p>The ID for your VPC. Amazon VPC generates this value when you create a VPC.</p>
|
|
2676
2676
|
* @public
|
|
2677
2677
|
*/
|
|
2678
|
-
VPCId?: string;
|
|
2678
|
+
VPCId?: string | undefined;
|
|
2679
2679
|
/**
|
|
2680
2680
|
* <p>A list of subnet IDs associated with the VPC endpoints for the domain.</p>
|
|
2681
2681
|
* @public
|
|
2682
2682
|
*/
|
|
2683
|
-
SubnetIds?: string[];
|
|
2683
|
+
SubnetIds?: string[] | undefined;
|
|
2684
2684
|
/**
|
|
2685
2685
|
* <p>The list of Availability Zones associated with the VPC subnets.</p>
|
|
2686
2686
|
* @public
|
|
2687
2687
|
*/
|
|
2688
|
-
AvailabilityZones?: string[];
|
|
2688
|
+
AvailabilityZones?: string[] | undefined;
|
|
2689
2689
|
/**
|
|
2690
2690
|
* <p>The list of security group IDs associated with the VPC endpoints for the domain.</p>
|
|
2691
2691
|
* @public
|
|
2692
2692
|
*/
|
|
2693
|
-
SecurityGroupIds?: string[];
|
|
2693
|
+
SecurityGroupIds?: string[] | undefined;
|
|
2694
2694
|
}
|
|
2695
2695
|
/**
|
|
2696
2696
|
* <p>The current status of an OpenSearch Service domain.</p>
|
|
@@ -2719,20 +2719,20 @@ export interface DomainStatus {
|
|
|
2719
2719
|
* if domain creation is still in progress.</p>
|
|
2720
2720
|
* @public
|
|
2721
2721
|
*/
|
|
2722
|
-
Created?: boolean;
|
|
2722
|
+
Created?: boolean | undefined;
|
|
2723
2723
|
/**
|
|
2724
2724
|
* <p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False
|
|
2725
2725
|
* if domain deletion is still in progress. Once deletion is complete, the status of the domain is
|
|
2726
2726
|
* no longer returned.</p>
|
|
2727
2727
|
* @public
|
|
2728
2728
|
*/
|
|
2729
|
-
Deleted?: boolean;
|
|
2729
|
+
Deleted?: boolean | undefined;
|
|
2730
2730
|
/**
|
|
2731
2731
|
* <p>Domain-specific endpoint used to submit index, search, and data upload requests to the
|
|
2732
2732
|
* domain.</p>
|
|
2733
2733
|
* @public
|
|
2734
2734
|
*/
|
|
2735
|
-
Endpoint?: string;
|
|
2735
|
+
Endpoint?: string | undefined;
|
|
2736
2736
|
/**
|
|
2737
2737
|
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned.
|
|
2738
2738
|
* This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses.
|
|
@@ -2740,7 +2740,7 @@ export interface DomainStatus {
|
|
|
2740
2740
|
* </p>
|
|
2741
2741
|
* @public
|
|
2742
2742
|
*/
|
|
2743
|
-
EndpointV2?: string;
|
|
2743
|
+
EndpointV2?: string | undefined;
|
|
2744
2744
|
/**
|
|
2745
2745
|
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:</p>
|
|
2746
2746
|
* <ul>
|
|
@@ -2759,31 +2759,31 @@ export interface DomainStatus {
|
|
|
2759
2759
|
* </ul>
|
|
2760
2760
|
* @public
|
|
2761
2761
|
*/
|
|
2762
|
-
Endpoints?: Record<string, string
|
|
2762
|
+
Endpoints?: Record<string, string> | undefined;
|
|
2763
2763
|
/**
|
|
2764
2764
|
* <p>The dual stack hosted zone ID for the domain. </p>
|
|
2765
2765
|
* @public
|
|
2766
2766
|
*/
|
|
2767
|
-
DomainEndpointV2HostedZoneId?: string;
|
|
2767
|
+
DomainEndpointV2HostedZoneId?: string | undefined;
|
|
2768
2768
|
/**
|
|
2769
2769
|
* <p>The status of the domain configuration. True if OpenSearch Service is processing
|
|
2770
2770
|
* configuration changes. False if the configuration is active.</p>
|
|
2771
2771
|
* @public
|
|
2772
2772
|
*/
|
|
2773
|
-
Processing?: boolean;
|
|
2773
|
+
Processing?: boolean | undefined;
|
|
2774
2774
|
/**
|
|
2775
2775
|
* <p>The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True
|
|
2776
2776
|
* if OpenSearch Service is in the process of a version upgrade. False if the configuration is
|
|
2777
2777
|
* active.</p>
|
|
2778
2778
|
* @public
|
|
2779
2779
|
*/
|
|
2780
|
-
UpgradeProcessing?: boolean;
|
|
2780
|
+
UpgradeProcessing?: boolean | undefined;
|
|
2781
2781
|
/**
|
|
2782
2782
|
* <p>Version of OpenSearch or Elasticsearch that the domain is running, in the format
|
|
2783
2783
|
* <code>Elasticsearch_X.Y</code> or <code>OpenSearch_X.Y</code>.</p>
|
|
2784
2784
|
* @public
|
|
2785
2785
|
*/
|
|
2786
|
-
EngineVersion?: string;
|
|
2786
|
+
EngineVersion?: string | undefined;
|
|
2787
2787
|
/**
|
|
2788
2788
|
* <p>Container for the cluster configuration of the domain.</p>
|
|
2789
2789
|
* @public
|
|
@@ -2793,111 +2793,111 @@ export interface DomainStatus {
|
|
|
2793
2793
|
* <p>Container for EBS-based storage settings for the domain.</p>
|
|
2794
2794
|
* @public
|
|
2795
2795
|
*/
|
|
2796
|
-
EBSOptions?: EBSOptions;
|
|
2796
|
+
EBSOptions?: EBSOptions | undefined;
|
|
2797
2797
|
/**
|
|
2798
2798
|
* <p>Identity and Access Management (IAM) policy document specifying the access policies for the
|
|
2799
2799
|
* domain.</p>
|
|
2800
2800
|
* @public
|
|
2801
2801
|
*/
|
|
2802
|
-
AccessPolicies?: string;
|
|
2802
|
+
AccessPolicies?: string | undefined;
|
|
2803
2803
|
/**
|
|
2804
2804
|
* <p>The type of IP addresses supported by the endpoint for the domain.</p>
|
|
2805
2805
|
* @public
|
|
2806
2806
|
*/
|
|
2807
|
-
IPAddressType?: IPAddressType;
|
|
2807
|
+
IPAddressType?: IPAddressType | undefined;
|
|
2808
2808
|
/**
|
|
2809
2809
|
* <p>DEPRECATED. Container for parameters required to configure automated snapshots of domain
|
|
2810
2810
|
* indexes.</p>
|
|
2811
2811
|
* @public
|
|
2812
2812
|
*/
|
|
2813
|
-
SnapshotOptions?: SnapshotOptions;
|
|
2813
|
+
SnapshotOptions?: SnapshotOptions | undefined;
|
|
2814
2814
|
/**
|
|
2815
2815
|
* <p>The VPC configuration for the domain.</p>
|
|
2816
2816
|
* @public
|
|
2817
2817
|
*/
|
|
2818
|
-
VPCOptions?: VPCDerivedInfo;
|
|
2818
|
+
VPCOptions?: VPCDerivedInfo | undefined;
|
|
2819
2819
|
/**
|
|
2820
2820
|
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>
|
|
2821
2821
|
* @public
|
|
2822
2822
|
*/
|
|
2823
|
-
CognitoOptions?: CognitoOptions;
|
|
2823
|
+
CognitoOptions?: CognitoOptions | undefined;
|
|
2824
2824
|
/**
|
|
2825
2825
|
* <p>Encryption at rest settings for the domain.</p>
|
|
2826
2826
|
* @public
|
|
2827
2827
|
*/
|
|
2828
|
-
EncryptionAtRestOptions?: EncryptionAtRestOptions;
|
|
2828
|
+
EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
|
|
2829
2829
|
/**
|
|
2830
2830
|
* <p>Whether node-to-node encryption is enabled or disabled.</p>
|
|
2831
2831
|
* @public
|
|
2832
2832
|
*/
|
|
2833
|
-
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
|
|
2833
|
+
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
|
|
2834
2834
|
/**
|
|
2835
2835
|
* <p>Key-value pairs that specify advanced configuration options.</p>
|
|
2836
2836
|
* @public
|
|
2837
2837
|
*/
|
|
2838
|
-
AdvancedOptions?: Record<string, string
|
|
2838
|
+
AdvancedOptions?: Record<string, string> | undefined;
|
|
2839
2839
|
/**
|
|
2840
2840
|
* <p>Log publishing options for the domain.</p>
|
|
2841
2841
|
* @public
|
|
2842
2842
|
*/
|
|
2843
|
-
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption
|
|
2843
|
+
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
2844
2844
|
/**
|
|
2845
2845
|
* <p>The current status of the domain's service software.</p>
|
|
2846
2846
|
* @public
|
|
2847
2847
|
*/
|
|
2848
|
-
ServiceSoftwareOptions?: ServiceSoftwareOptions;
|
|
2848
|
+
ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
|
|
2849
2849
|
/**
|
|
2850
2850
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
2851
2851
|
* traffic.</p>
|
|
2852
2852
|
* @public
|
|
2853
2853
|
*/
|
|
2854
|
-
DomainEndpointOptions?: DomainEndpointOptions;
|
|
2854
|
+
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
2855
2855
|
/**
|
|
2856
2856
|
* <p>Settings for fine-grained access control.</p>
|
|
2857
2857
|
* @public
|
|
2858
2858
|
*/
|
|
2859
|
-
AdvancedSecurityOptions?: AdvancedSecurityOptions;
|
|
2859
|
+
AdvancedSecurityOptions?: AdvancedSecurityOptions | undefined;
|
|
2860
2860
|
/**
|
|
2861
2861
|
* <p>Container for IAM Identity Center Option control for the domain.</p>
|
|
2862
2862
|
* @public
|
|
2863
2863
|
*/
|
|
2864
|
-
IdentityCenterOptions?: IdentityCenterOptions;
|
|
2864
|
+
IdentityCenterOptions?: IdentityCenterOptions | undefined;
|
|
2865
2865
|
/**
|
|
2866
2866
|
* <p>Auto-Tune settings for the domain.</p>
|
|
2867
2867
|
* @public
|
|
2868
2868
|
*/
|
|
2869
|
-
AutoTuneOptions?: AutoTuneOptionsOutput;
|
|
2869
|
+
AutoTuneOptions?: AutoTuneOptionsOutput | undefined;
|
|
2870
2870
|
/**
|
|
2871
2871
|
* <p>Information about a configuration change happening on the domain.</p>
|
|
2872
2872
|
* @public
|
|
2873
2873
|
*/
|
|
2874
|
-
ChangeProgressDetails?: ChangeProgressDetails;
|
|
2874
|
+
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
2875
2875
|
/**
|
|
2876
2876
|
* <p>Options that specify a custom 10-hour window during which OpenSearch Service can perform
|
|
2877
2877
|
* configuration changes on the domain.</p>
|
|
2878
2878
|
* @public
|
|
2879
2879
|
*/
|
|
2880
|
-
OffPeakWindowOptions?: OffPeakWindowOptions;
|
|
2880
|
+
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
2881
2881
|
/**
|
|
2882
2882
|
* <p>Service software update options for the domain.</p>
|
|
2883
2883
|
* @public
|
|
2884
2884
|
*/
|
|
2885
|
-
SoftwareUpdateOptions?: SoftwareUpdateOptions;
|
|
2885
|
+
SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
|
|
2886
2886
|
/**
|
|
2887
2887
|
* <p>The status of any changes that are currently in progress for the domain.</p>
|
|
2888
2888
|
* @public
|
|
2889
2889
|
*/
|
|
2890
|
-
DomainProcessingStatus?: DomainProcessingStatusType;
|
|
2890
|
+
DomainProcessingStatus?: DomainProcessingStatusType | undefined;
|
|
2891
2891
|
/**
|
|
2892
2892
|
* <p>Information about the domain properties that are currently being modified.</p>
|
|
2893
2893
|
* @public
|
|
2894
2894
|
*/
|
|
2895
|
-
ModifyingProperties?: ModifyingProperties[];
|
|
2895
|
+
ModifyingProperties?: ModifyingProperties[] | undefined;
|
|
2896
2896
|
/**
|
|
2897
2897
|
* <p>Container for parameters required to enable all machine learning features.</p>
|
|
2898
2898
|
* @public
|
|
2899
2899
|
*/
|
|
2900
|
-
AIMLOptions?: AIMLOptionsOutput;
|
|
2900
|
+
AIMLOptions?: AIMLOptionsOutput | undefined;
|
|
2901
2901
|
}
|
|
2902
2902
|
/**
|
|
2903
2903
|
* <p>The result of a <code>CreateDomain</code> operation. Contains the status of the newly
|
|
@@ -2909,7 +2909,7 @@ export interface CreateDomainResponse {
|
|
|
2909
2909
|
* <p>The status of the newly created domain.</p>
|
|
2910
2910
|
* @public
|
|
2911
2911
|
*/
|
|
2912
|
-
DomainStatus?: DomainStatus;
|
|
2912
|
+
DomainStatus?: DomainStatus | undefined;
|
|
2913
2913
|
}
|
|
2914
2914
|
/**
|
|
2915
2915
|
* <p>An exception for trying to create or access a sub-resource that's either invalid or not supported.</p>
|
|
@@ -2958,7 +2958,7 @@ export interface CrossClusterSearchConnectionProperties {
|
|
|
2958
2958
|
* queries return partial results despite failures on one or more remote clusters.</p>
|
|
2959
2959
|
* @public
|
|
2960
2960
|
*/
|
|
2961
|
-
SkipUnavailable?: SkipUnavailableStatus;
|
|
2961
|
+
SkipUnavailable?: SkipUnavailableStatus | undefined;
|
|
2962
2962
|
}
|
|
2963
2963
|
/**
|
|
2964
2964
|
* <p>The connection properties of an outbound connection.</p>
|
|
@@ -2972,12 +2972,12 @@ export interface ConnectionProperties {
|
|
|
2972
2972
|
* <p>The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.</p>
|
|
2973
2973
|
* @public
|
|
2974
2974
|
*/
|
|
2975
|
-
Endpoint?: string;
|
|
2975
|
+
Endpoint?: string | undefined;
|
|
2976
2976
|
/**
|
|
2977
2977
|
* <p>The connection properties for cross cluster search.</p>
|
|
2978
2978
|
* @public
|
|
2979
2979
|
*/
|
|
2980
|
-
CrossClusterSearch?: CrossClusterSearchConnectionProperties;
|
|
2980
|
+
CrossClusterSearch?: CrossClusterSearchConnectionProperties | undefined;
|
|
2981
2981
|
}
|
|
2982
2982
|
/**
|
|
2983
2983
|
* <p>Container for the parameters to the <code>CreateOutboundConnection</code> operation.</p>
|
|
@@ -3003,12 +3003,12 @@ export interface CreateOutboundConnectionRequest {
|
|
|
3003
3003
|
* <p>The connection mode.</p>
|
|
3004
3004
|
* @public
|
|
3005
3005
|
*/
|
|
3006
|
-
ConnectionMode?: ConnectionMode;
|
|
3006
|
+
ConnectionMode?: ConnectionMode | undefined;
|
|
3007
3007
|
/**
|
|
3008
3008
|
* <p>The <code>ConnectionProperties</code> for the outbound connection.</p>
|
|
3009
3009
|
* @public
|
|
3010
3010
|
*/
|
|
3011
|
-
ConnectionProperties?: ConnectionProperties;
|
|
3011
|
+
ConnectionProperties?: ConnectionProperties | undefined;
|
|
3012
3012
|
}
|
|
3013
3013
|
/**
|
|
3014
3014
|
* @public
|
|
@@ -3088,12 +3088,12 @@ export interface OutboundConnectionStatus {
|
|
|
3088
3088
|
* </ul>
|
|
3089
3089
|
* @public
|
|
3090
3090
|
*/
|
|
3091
|
-
StatusCode?: OutboundConnectionStatusCode;
|
|
3091
|
+
StatusCode?: OutboundConnectionStatusCode | undefined;
|
|
3092
3092
|
/**
|
|
3093
3093
|
* <p>Verbose information for the outbound connection.</p>
|
|
3094
3094
|
* @public
|
|
3095
3095
|
*/
|
|
3096
|
-
Message?: string;
|
|
3096
|
+
Message?: string | undefined;
|
|
3097
3097
|
}
|
|
3098
3098
|
/**
|
|
3099
3099
|
* <p>The result of a <code>CreateOutboundConnection</code> request. Contains details about the
|
|
@@ -3105,38 +3105,38 @@ export interface CreateOutboundConnectionResponse {
|
|
|
3105
3105
|
* <p>Information about the source (local) domain.</p>
|
|
3106
3106
|
* @public
|
|
3107
3107
|
*/
|
|
3108
|
-
LocalDomainInfo?: DomainInformationContainer;
|
|
3108
|
+
LocalDomainInfo?: DomainInformationContainer | undefined;
|
|
3109
3109
|
/**
|
|
3110
3110
|
* <p>Information about the destination (remote) domain.</p>
|
|
3111
3111
|
* @public
|
|
3112
3112
|
*/
|
|
3113
|
-
RemoteDomainInfo?: DomainInformationContainer;
|
|
3113
|
+
RemoteDomainInfo?: DomainInformationContainer | undefined;
|
|
3114
3114
|
/**
|
|
3115
3115
|
* <p>Name of the connection.</p>
|
|
3116
3116
|
* @public
|
|
3117
3117
|
*/
|
|
3118
|
-
ConnectionAlias?: string;
|
|
3118
|
+
ConnectionAlias?: string | undefined;
|
|
3119
3119
|
/**
|
|
3120
3120
|
* <p>The status of the connection.</p>
|
|
3121
3121
|
* @public
|
|
3122
3122
|
*/
|
|
3123
|
-
ConnectionStatus?: OutboundConnectionStatus;
|
|
3123
|
+
ConnectionStatus?: OutboundConnectionStatus | undefined;
|
|
3124
3124
|
/**
|
|
3125
3125
|
* <p>The unique identifier for the created outbound connection, which is used for subsequent
|
|
3126
3126
|
* operations on the connection.</p>
|
|
3127
3127
|
* @public
|
|
3128
3128
|
*/
|
|
3129
|
-
ConnectionId?: string;
|
|
3129
|
+
ConnectionId?: string | undefined;
|
|
3130
3130
|
/**
|
|
3131
3131
|
* <p>The connection mode.</p>
|
|
3132
3132
|
* @public
|
|
3133
3133
|
*/
|
|
3134
|
-
ConnectionMode?: ConnectionMode;
|
|
3134
|
+
ConnectionMode?: ConnectionMode | undefined;
|
|
3135
3135
|
/**
|
|
3136
3136
|
* <p>The <code>ConnectionProperties</code> for the newly created connection.</p>
|
|
3137
3137
|
* @public
|
|
3138
3138
|
*/
|
|
3139
|
-
ConnectionProperties?: ConnectionProperties;
|
|
3139
|
+
ConnectionProperties?: ConnectionProperties | undefined;
|
|
3140
3140
|
}
|
|
3141
3141
|
/**
|
|
3142
3142
|
* @public
|
|
@@ -3165,7 +3165,7 @@ export interface PackageConfiguration {
|
|
|
3165
3165
|
* <p>The relative file path for the license associated with the package.</p>
|
|
3166
3166
|
* @public
|
|
3167
3167
|
*/
|
|
3168
|
-
LicenseFilepath?: string;
|
|
3168
|
+
LicenseFilepath?: string | undefined;
|
|
3169
3169
|
/**
|
|
3170
3170
|
* <p>The configuration requirements for the package.</p>
|
|
3171
3171
|
* @public
|
|
@@ -3175,7 +3175,7 @@ export interface PackageConfiguration {
|
|
|
3175
3175
|
* <p>This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.</p>
|
|
3176
3176
|
* @public
|
|
3177
3177
|
*/
|
|
3178
|
-
RequiresRestartForConfigurationUpdate?: boolean;
|
|
3178
|
+
RequiresRestartForConfigurationUpdate?: boolean | undefined;
|
|
3179
3179
|
}
|
|
3180
3180
|
/**
|
|
3181
3181
|
* <p>Encryption options for a package.</p>
|
|
@@ -3186,7 +3186,7 @@ export interface PackageEncryptionOptions {
|
|
|
3186
3186
|
* <p> KMS key ID for encrypting the package.</p>
|
|
3187
3187
|
* @public
|
|
3188
3188
|
*/
|
|
3189
|
-
KmsKeyIdentifier?: string;
|
|
3189
|
+
KmsKeyIdentifier?: string | undefined;
|
|
3190
3190
|
/**
|
|
3191
3191
|
* <p>This indicates whether encryption is enabled for the package.</p>
|
|
3192
3192
|
* @public
|
|
@@ -3202,12 +3202,12 @@ export interface PackageSource {
|
|
|
3202
3202
|
* <p>The name of the Amazon S3 bucket containing the package.</p>
|
|
3203
3203
|
* @public
|
|
3204
3204
|
*/
|
|
3205
|
-
S3BucketName?: string;
|
|
3205
|
+
S3BucketName?: string | undefined;
|
|
3206
3206
|
/**
|
|
3207
3207
|
* <p>Key (file name) of the package.</p>
|
|
3208
3208
|
* @public
|
|
3209
3209
|
*/
|
|
3210
|
-
S3Key?: string;
|
|
3210
|
+
S3Key?: string | undefined;
|
|
3211
3211
|
}
|
|
3212
3212
|
/**
|
|
3213
3213
|
* <p>The vending options for a package to determine if the package can be used by other users.
|
|
@@ -3241,7 +3241,7 @@ export interface CreatePackageRequest {
|
|
|
3241
3241
|
* <p>Description of the package.</p>
|
|
3242
3242
|
* @public
|
|
3243
3243
|
*/
|
|
3244
|
-
PackageDescription?: string;
|
|
3244
|
+
PackageDescription?: string | undefined;
|
|
3245
3245
|
/**
|
|
3246
3246
|
* <p>The Amazon S3 location from which to import the package.</p>
|
|
3247
3247
|
* @public
|
|
@@ -3251,23 +3251,23 @@ export interface CreatePackageRequest {
|
|
|
3251
3251
|
* <p> The configuration parameters for the package being created.</p>
|
|
3252
3252
|
* @public
|
|
3253
3253
|
*/
|
|
3254
|
-
PackageConfiguration?: PackageConfiguration;
|
|
3254
|
+
PackageConfiguration?: PackageConfiguration | undefined;
|
|
3255
3255
|
/**
|
|
3256
3256
|
* <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>
|
|
3257
3257
|
* </p>
|
|
3258
3258
|
* @public
|
|
3259
3259
|
*/
|
|
3260
|
-
EngineVersion?: string;
|
|
3260
|
+
EngineVersion?: string | undefined;
|
|
3261
3261
|
/**
|
|
3262
3262
|
* <p> The vending options for the package being created. They determine if the package can be vended to other users.</p>
|
|
3263
3263
|
* @public
|
|
3264
3264
|
*/
|
|
3265
|
-
PackageVendingOptions?: PackageVendingOptions;
|
|
3265
|
+
PackageVendingOptions?: PackageVendingOptions | undefined;
|
|
3266
3266
|
/**
|
|
3267
3267
|
* <p>The encryption parameters for the package being created.</p>
|
|
3268
3268
|
* @public
|
|
3269
3269
|
*/
|
|
3270
|
-
PackageEncryptionOptions?: PackageEncryptionOptions;
|
|
3270
|
+
PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
|
|
3271
3271
|
}
|
|
3272
3272
|
/**
|
|
3273
3273
|
* <p>Basic information about the plugin.</p>
|
|
@@ -3278,27 +3278,27 @@ export interface PluginProperties {
|
|
|
3278
3278
|
* <p>The name of the plugin.</p>
|
|
3279
3279
|
* @public
|
|
3280
3280
|
*/
|
|
3281
|
-
Name?: string;
|
|
3281
|
+
Name?: string | undefined;
|
|
3282
3282
|
/**
|
|
3283
3283
|
* <p>The description of the plugin.</p>
|
|
3284
3284
|
* @public
|
|
3285
3285
|
*/
|
|
3286
|
-
Description?: string;
|
|
3286
|
+
Description?: string | undefined;
|
|
3287
3287
|
/**
|
|
3288
3288
|
* <p>The version of the plugin.</p>
|
|
3289
3289
|
* @public
|
|
3290
3290
|
*/
|
|
3291
|
-
Version?: string;
|
|
3291
|
+
Version?: string | undefined;
|
|
3292
3292
|
/**
|
|
3293
3293
|
* <p>The name of the class to load.</p>
|
|
3294
3294
|
* @public
|
|
3295
3295
|
*/
|
|
3296
|
-
ClassName?: string;
|
|
3296
|
+
ClassName?: string | undefined;
|
|
3297
3297
|
/**
|
|
3298
3298
|
* <p>The uncompressed size of the plugin.</p>
|
|
3299
3299
|
* @public
|
|
3300
3300
|
*/
|
|
3301
|
-
UncompressedSizeInBytes?: number;
|
|
3301
|
+
UncompressedSizeInBytes?: number | undefined;
|
|
3302
3302
|
}
|
|
3303
3303
|
/**
|
|
3304
3304
|
* @public
|
|
@@ -3327,83 +3327,83 @@ export interface PackageDetails {
|
|
|
3327
3327
|
* <p>The unique identifier of the package.</p>
|
|
3328
3328
|
* @public
|
|
3329
3329
|
*/
|
|
3330
|
-
PackageID?: string;
|
|
3330
|
+
PackageID?: string | undefined;
|
|
3331
3331
|
/**
|
|
3332
3332
|
* <p>The user-specified name of the package.</p>
|
|
3333
3333
|
* @public
|
|
3334
3334
|
*/
|
|
3335
|
-
PackageName?: string;
|
|
3335
|
+
PackageName?: string | undefined;
|
|
3336
3336
|
/**
|
|
3337
3337
|
* <p>The type of package.</p>
|
|
3338
3338
|
* @public
|
|
3339
3339
|
*/
|
|
3340
|
-
PackageType?: PackageType;
|
|
3340
|
+
PackageType?: PackageType | undefined;
|
|
3341
3341
|
/**
|
|
3342
3342
|
* <p>User-specified description of the package.</p>
|
|
3343
3343
|
* @public
|
|
3344
3344
|
*/
|
|
3345
|
-
PackageDescription?: string;
|
|
3345
|
+
PackageDescription?: string | undefined;
|
|
3346
3346
|
/**
|
|
3347
3347
|
* <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>
|
|
3348
3348
|
* @public
|
|
3349
3349
|
*/
|
|
3350
|
-
PackageStatus?: PackageStatus;
|
|
3350
|
+
PackageStatus?: PackageStatus | undefined;
|
|
3351
3351
|
/**
|
|
3352
3352
|
* <p>The timestamp when the package was created.</p>
|
|
3353
3353
|
* @public
|
|
3354
3354
|
*/
|
|
3355
|
-
CreatedAt?: Date;
|
|
3355
|
+
CreatedAt?: Date | undefined;
|
|
3356
3356
|
/**
|
|
3357
3357
|
* <p>Date and time when the package was last updated.</p>
|
|
3358
3358
|
* @public
|
|
3359
3359
|
*/
|
|
3360
|
-
LastUpdatedAt?: Date;
|
|
3360
|
+
LastUpdatedAt?: Date | undefined;
|
|
3361
3361
|
/**
|
|
3362
3362
|
* <p>The package version.</p>
|
|
3363
3363
|
* @public
|
|
3364
3364
|
*/
|
|
3365
|
-
AvailablePackageVersion?: string;
|
|
3365
|
+
AvailablePackageVersion?: string | undefined;
|
|
3366
3366
|
/**
|
|
3367
3367
|
* <p>Additional information if the package is in an error state. Null otherwise.</p>
|
|
3368
3368
|
* @public
|
|
3369
3369
|
*/
|
|
3370
|
-
ErrorDetails?: ErrorDetails;
|
|
3370
|
+
ErrorDetails?: ErrorDetails | undefined;
|
|
3371
3371
|
/**
|
|
3372
3372
|
* <p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
|
|
3373
3373
|
* Defaults to the latest version of OpenSearch.</p>
|
|
3374
3374
|
* @public
|
|
3375
3375
|
*/
|
|
3376
|
-
EngineVersion?: string;
|
|
3376
|
+
EngineVersion?: string | undefined;
|
|
3377
3377
|
/**
|
|
3378
3378
|
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about plugin properties.</p>
|
|
3379
3379
|
* @public
|
|
3380
3380
|
*/
|
|
3381
|
-
AvailablePluginProperties?: PluginProperties;
|
|
3381
|
+
AvailablePluginProperties?: PluginProperties | undefined;
|
|
3382
3382
|
/**
|
|
3383
3383
|
* <p>This represents the available configuration parameters for the package.</p>
|
|
3384
3384
|
* @public
|
|
3385
3385
|
*/
|
|
3386
|
-
AvailablePackageConfiguration?: PackageConfiguration;
|
|
3386
|
+
AvailablePackageConfiguration?: PackageConfiguration | undefined;
|
|
3387
3387
|
/**
|
|
3388
3388
|
* <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>
|
|
3389
3389
|
* @public
|
|
3390
3390
|
*/
|
|
3391
|
-
AllowListedUserList?: string[];
|
|
3391
|
+
AllowListedUserList?: string[] | undefined;
|
|
3392
3392
|
/**
|
|
3393
3393
|
* <p>The owner of the package who is allowed to create/update a package and add users to the package scope.</p>
|
|
3394
3394
|
* @public
|
|
3395
3395
|
*/
|
|
3396
|
-
PackageOwner?: string;
|
|
3396
|
+
PackageOwner?: string | undefined;
|
|
3397
3397
|
/**
|
|
3398
3398
|
* <p>Package Vending Options for a package.</p>
|
|
3399
3399
|
* @public
|
|
3400
3400
|
*/
|
|
3401
|
-
PackageVendingOptions?: PackageVendingOptions;
|
|
3401
|
+
PackageVendingOptions?: PackageVendingOptions | undefined;
|
|
3402
3402
|
/**
|
|
3403
3403
|
* <p>Package Encryption Options for a package.</p>
|
|
3404
3404
|
* @public
|
|
3405
3405
|
*/
|
|
3406
|
-
PackageEncryptionOptions?: PackageEncryptionOptions;
|
|
3406
|
+
PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
|
|
3407
3407
|
}
|
|
3408
3408
|
/**
|
|
3409
3409
|
* <p>Container for the response returned by the <code>CreatePackage</code> operation.</p>
|
|
@@ -3414,7 +3414,7 @@ export interface CreatePackageResponse {
|
|
|
3414
3414
|
* <p>Basic information about an OpenSearch Service package.</p>
|
|
3415
3415
|
* @public
|
|
3416
3416
|
*/
|
|
3417
|
-
PackageDetails?: PackageDetails;
|
|
3417
|
+
PackageDetails?: PackageDetails | undefined;
|
|
3418
3418
|
}
|
|
3419
3419
|
/**
|
|
3420
3420
|
* @public
|
|
@@ -3434,7 +3434,7 @@ export interface CreateVpcEndpointRequest {
|
|
|
3434
3434
|
* <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
|
|
3435
3435
|
* @public
|
|
3436
3436
|
*/
|
|
3437
|
-
ClientToken?: string;
|
|
3437
|
+
ClientToken?: string | undefined;
|
|
3438
3438
|
}
|
|
3439
3439
|
/**
|
|
3440
3440
|
* @public
|
|
@@ -3463,33 +3463,33 @@ export interface VpcEndpoint {
|
|
|
3463
3463
|
* <p>The unique identifier of the endpoint.</p>
|
|
3464
3464
|
* @public
|
|
3465
3465
|
*/
|
|
3466
|
-
VpcEndpointId?: string;
|
|
3466
|
+
VpcEndpointId?: string | undefined;
|
|
3467
3467
|
/**
|
|
3468
3468
|
* <p>The creator of the endpoint.</p>
|
|
3469
3469
|
* @public
|
|
3470
3470
|
*/
|
|
3471
|
-
VpcEndpointOwner?: string;
|
|
3471
|
+
VpcEndpointOwner?: string | undefined;
|
|
3472
3472
|
/**
|
|
3473
3473
|
* <p>The Amazon Resource Name (ARN) of the domain associated with the endpoint.</p>
|
|
3474
3474
|
* @public
|
|
3475
3475
|
*/
|
|
3476
|
-
DomainArn?: string;
|
|
3476
|
+
DomainArn?: string | undefined;
|
|
3477
3477
|
/**
|
|
3478
3478
|
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC
|
|
3479
3479
|
* endpoint.</p>
|
|
3480
3480
|
* @public
|
|
3481
3481
|
*/
|
|
3482
|
-
VpcOptions?: VPCDerivedInfo;
|
|
3482
|
+
VpcOptions?: VPCDerivedInfo | undefined;
|
|
3483
3483
|
/**
|
|
3484
3484
|
* <p>The current status of the endpoint.</p>
|
|
3485
3485
|
* @public
|
|
3486
3486
|
*/
|
|
3487
|
-
Status?: VpcEndpointStatus;
|
|
3487
|
+
Status?: VpcEndpointStatus | undefined;
|
|
3488
3488
|
/**
|
|
3489
3489
|
* <p>The connection endpoint ID for connecting to the domain.</p>
|
|
3490
3490
|
* @public
|
|
3491
3491
|
*/
|
|
3492
|
-
Endpoint?: string;
|
|
3492
|
+
Endpoint?: string | undefined;
|
|
3493
3493
|
}
|
|
3494
3494
|
/**
|
|
3495
3495
|
* @public
|
|
@@ -3542,7 +3542,7 @@ export interface DeleteDataSourceResponse {
|
|
|
3542
3542
|
* <p>A message associated with deletion of the data source.</p>
|
|
3543
3543
|
* @public
|
|
3544
3544
|
*/
|
|
3545
|
-
Message?: string;
|
|
3545
|
+
Message?: string | undefined;
|
|
3546
3546
|
}
|
|
3547
3547
|
/**
|
|
3548
3548
|
* <p>Container for the parameters to the <code>DeleteDomain</code> operation.</p>
|
|
@@ -3565,7 +3565,7 @@ export interface DeleteDomainResponse {
|
|
|
3565
3565
|
* <p>The status of the domain being deleted.</p>
|
|
3566
3566
|
* @public
|
|
3567
3567
|
*/
|
|
3568
|
-
DomainStatus?: DomainStatus;
|
|
3568
|
+
DomainStatus?: DomainStatus | undefined;
|
|
3569
3569
|
}
|
|
3570
3570
|
/**
|
|
3571
3571
|
* <p>Container for the parameters to the <code>DeleteInboundConnection</code> operation.</p>
|
|
@@ -3588,7 +3588,7 @@ export interface DeleteInboundConnectionResponse {
|
|
|
3588
3588
|
* <p>The deleted inbound connection.</p>
|
|
3589
3589
|
* @public
|
|
3590
3590
|
*/
|
|
3591
|
-
Connection?: InboundConnection;
|
|
3591
|
+
Connection?: InboundConnection | undefined;
|
|
3592
3592
|
}
|
|
3593
3593
|
/**
|
|
3594
3594
|
* <p>Container for the parameters to the <code>DeleteOutboundConnection</code> operation.</p>
|
|
@@ -3610,37 +3610,37 @@ export interface OutboundConnection {
|
|
|
3610
3610
|
* <p>Information about the source (local) domain.</p>
|
|
3611
3611
|
* @public
|
|
3612
3612
|
*/
|
|
3613
|
-
LocalDomainInfo?: DomainInformationContainer;
|
|
3613
|
+
LocalDomainInfo?: DomainInformationContainer | undefined;
|
|
3614
3614
|
/**
|
|
3615
3615
|
* <p>Information about the destination (remote) domain.</p>
|
|
3616
3616
|
* @public
|
|
3617
3617
|
*/
|
|
3618
|
-
RemoteDomainInfo?: DomainInformationContainer;
|
|
3618
|
+
RemoteDomainInfo?: DomainInformationContainer | undefined;
|
|
3619
3619
|
/**
|
|
3620
3620
|
* <p>Unique identifier of the connection.</p>
|
|
3621
3621
|
* @public
|
|
3622
3622
|
*/
|
|
3623
|
-
ConnectionId?: string;
|
|
3623
|
+
ConnectionId?: string | undefined;
|
|
3624
3624
|
/**
|
|
3625
3625
|
* <p>Name of the connection.</p>
|
|
3626
3626
|
* @public
|
|
3627
3627
|
*/
|
|
3628
|
-
ConnectionAlias?: string;
|
|
3628
|
+
ConnectionAlias?: string | undefined;
|
|
3629
3629
|
/**
|
|
3630
3630
|
* <p>Status of the connection.</p>
|
|
3631
3631
|
* @public
|
|
3632
3632
|
*/
|
|
3633
|
-
ConnectionStatus?: OutboundConnectionStatus;
|
|
3633
|
+
ConnectionStatus?: OutboundConnectionStatus | undefined;
|
|
3634
3634
|
/**
|
|
3635
3635
|
* <p>The connection mode.</p>
|
|
3636
3636
|
* @public
|
|
3637
3637
|
*/
|
|
3638
|
-
ConnectionMode?: ConnectionMode;
|
|
3638
|
+
ConnectionMode?: ConnectionMode | undefined;
|
|
3639
3639
|
/**
|
|
3640
3640
|
* <p>Properties for the outbound connection.</p>
|
|
3641
3641
|
* @public
|
|
3642
3642
|
*/
|
|
3643
|
-
ConnectionProperties?: ConnectionProperties;
|
|
3643
|
+
ConnectionProperties?: ConnectionProperties | undefined;
|
|
3644
3644
|
}
|
|
3645
3645
|
/**
|
|
3646
3646
|
* <p>Details about the deleted outbound connection.</p>
|
|
@@ -3651,7 +3651,7 @@ export interface DeleteOutboundConnectionResponse {
|
|
|
3651
3651
|
* <p>The deleted inbound connection.</p>
|
|
3652
3652
|
* @public
|
|
3653
3653
|
*/
|
|
3654
|
-
Connection?: OutboundConnection;
|
|
3654
|
+
Connection?: OutboundConnection | undefined;
|
|
3655
3655
|
}
|
|
3656
3656
|
/**
|
|
3657
3657
|
* <p>Deletes a package from OpenSearch Service. The package can't be associated with any
|
|
@@ -3674,7 +3674,7 @@ export interface DeletePackageResponse {
|
|
|
3674
3674
|
* <p> Information about the deleted package.</p>
|
|
3675
3675
|
* @public
|
|
3676
3676
|
*/
|
|
3677
|
-
PackageDetails?: PackageDetails;
|
|
3677
|
+
PackageDetails?: PackageDetails | undefined;
|
|
3678
3678
|
}
|
|
3679
3679
|
/**
|
|
3680
3680
|
* @public
|
|
@@ -3695,22 +3695,22 @@ export interface VpcEndpointSummary {
|
|
|
3695
3695
|
* <p>The unique identifier of the endpoint.</p>
|
|
3696
3696
|
* @public
|
|
3697
3697
|
*/
|
|
3698
|
-
VpcEndpointId?: string;
|
|
3698
|
+
VpcEndpointId?: string | undefined;
|
|
3699
3699
|
/**
|
|
3700
3700
|
* <p>The creator of the endpoint.</p>
|
|
3701
3701
|
* @public
|
|
3702
3702
|
*/
|
|
3703
|
-
VpcEndpointOwner?: string;
|
|
3703
|
+
VpcEndpointOwner?: string | undefined;
|
|
3704
3704
|
/**
|
|
3705
3705
|
* <p>The Amazon Resource Name (ARN) of the domain associated with the endpoint.</p>
|
|
3706
3706
|
* @public
|
|
3707
3707
|
*/
|
|
3708
|
-
DomainArn?: string;
|
|
3708
|
+
DomainArn?: string | undefined;
|
|
3709
3709
|
/**
|
|
3710
3710
|
* <p>The current status of the endpoint.</p>
|
|
3711
3711
|
* @public
|
|
3712
3712
|
*/
|
|
3713
|
-
Status?: VpcEndpointStatus;
|
|
3713
|
+
Status?: VpcEndpointStatus | undefined;
|
|
3714
3714
|
}
|
|
3715
3715
|
/**
|
|
3716
3716
|
* @public
|
|
@@ -3760,14 +3760,14 @@ export interface DescribeDomainAutoTunesRequest {
|
|
|
3760
3760
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
3761
3761
|
* @public
|
|
3762
3762
|
*/
|
|
3763
|
-
MaxResults?: number;
|
|
3763
|
+
MaxResults?: number | undefined;
|
|
3764
3764
|
/**
|
|
3765
3765
|
* <p>If your initial <code>DescribeDomainAutoTunes</code> operation returns a
|
|
3766
3766
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
3767
3767
|
* <code>DescribeDomainAutoTunes</code> operations, which returns results in the next page.</p>
|
|
3768
3768
|
* @public
|
|
3769
3769
|
*/
|
|
3770
|
-
NextToken?: string;
|
|
3770
|
+
NextToken?: string | undefined;
|
|
3771
3771
|
}
|
|
3772
3772
|
/**
|
|
3773
3773
|
* @public
|
|
@@ -3804,23 +3804,23 @@ export interface ScheduledAutoTuneDetails {
|
|
|
3804
3804
|
* <p>The date and time when the Auto-Tune action is scheduled for the domain.</p>
|
|
3805
3805
|
* @public
|
|
3806
3806
|
*/
|
|
3807
|
-
Date?: Date;
|
|
3807
|
+
Date?: Date | undefined;
|
|
3808
3808
|
/**
|
|
3809
3809
|
* <p>The type of Auto-Tune action.</p>
|
|
3810
3810
|
* @public
|
|
3811
3811
|
*/
|
|
3812
|
-
ActionType?: ScheduledAutoTuneActionType;
|
|
3812
|
+
ActionType?: ScheduledAutoTuneActionType | undefined;
|
|
3813
3813
|
/**
|
|
3814
3814
|
* <p>A description of the Auto-Tune action.</p>
|
|
3815
3815
|
* @public
|
|
3816
3816
|
*/
|
|
3817
|
-
Action?: string;
|
|
3817
|
+
Action?: string | undefined;
|
|
3818
3818
|
/**
|
|
3819
3819
|
* <p>The severity of the Auto-Tune action. Valid values are <code>LOW</code>,
|
|
3820
3820
|
* <code>MEDIUM</code>, and <code>HIGH</code>.</p>
|
|
3821
3821
|
* @public
|
|
3822
3822
|
*/
|
|
3823
|
-
Severity?: ScheduledAutoTuneSeverityType;
|
|
3823
|
+
Severity?: ScheduledAutoTuneSeverityType | undefined;
|
|
3824
3824
|
}
|
|
3825
3825
|
/**
|
|
3826
3826
|
* <p>Specifies details about a scheduled Auto-Tune action. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for
|
|
@@ -3832,7 +3832,7 @@ export interface AutoTuneDetails {
|
|
|
3832
3832
|
* <p>Container for details about a scheduled Auto-Tune action.</p>
|
|
3833
3833
|
* @public
|
|
3834
3834
|
*/
|
|
3835
|
-
ScheduledAutoTuneDetails?: ScheduledAutoTuneDetails;
|
|
3835
|
+
ScheduledAutoTuneDetails?: ScheduledAutoTuneDetails | undefined;
|
|
3836
3836
|
}
|
|
3837
3837
|
/**
|
|
3838
3838
|
* @public
|
|
@@ -3855,12 +3855,12 @@ export interface AutoTune {
|
|
|
3855
3855
|
* <p>The type of Auto-Tune action.</p>
|
|
3856
3856
|
* @public
|
|
3857
3857
|
*/
|
|
3858
|
-
AutoTuneType?: AutoTuneType;
|
|
3858
|
+
AutoTuneType?: AutoTuneType | undefined;
|
|
3859
3859
|
/**
|
|
3860
3860
|
* <p>Details about an Auto-Tune action.</p>
|
|
3861
3861
|
* @public
|
|
3862
3862
|
*/
|
|
3863
|
-
AutoTuneDetails?: AutoTuneDetails;
|
|
3863
|
+
AutoTuneDetails?: AutoTuneDetails | undefined;
|
|
3864
3864
|
}
|
|
3865
3865
|
/**
|
|
3866
3866
|
* <p>The result of a <code>DescribeDomainAutoTunes</code> request.</p>
|
|
@@ -3871,14 +3871,14 @@ export interface DescribeDomainAutoTunesResponse {
|
|
|
3871
3871
|
* <p>The list of setting adjustments that Auto-Tune has made to the domain.</p>
|
|
3872
3872
|
* @public
|
|
3873
3873
|
*/
|
|
3874
|
-
AutoTunes?: AutoTune[];
|
|
3874
|
+
AutoTunes?: AutoTune[] | undefined;
|
|
3875
3875
|
/**
|
|
3876
3876
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
3877
3877
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
3878
3878
|
* returned token to retrieve the next page.</p>
|
|
3879
3879
|
* @public
|
|
3880
3880
|
*/
|
|
3881
|
-
NextToken?: string;
|
|
3881
|
+
NextToken?: string | undefined;
|
|
3882
3882
|
}
|
|
3883
3883
|
/**
|
|
3884
3884
|
* <p>Container for the parameters to the <code>DescribeDomainChangeProgress</code>
|
|
@@ -3896,7 +3896,7 @@ export interface DescribeDomainChangeProgressRequest {
|
|
|
3896
3896
|
* request returns information about the most recent configuration change.</p>
|
|
3897
3897
|
* @public
|
|
3898
3898
|
*/
|
|
3899
|
-
ChangeId?: string;
|
|
3899
|
+
ChangeId?: string | undefined;
|
|
3900
3900
|
}
|
|
3901
3901
|
/**
|
|
3902
3902
|
* <p>Progress details for each stage of a domain update.</p>
|
|
@@ -3907,22 +3907,22 @@ export interface ChangeProgressStage {
|
|
|
3907
3907
|
* <p>The name of the stage.</p>
|
|
3908
3908
|
* @public
|
|
3909
3909
|
*/
|
|
3910
|
-
Name?: string;
|
|
3910
|
+
Name?: string | undefined;
|
|
3911
3911
|
/**
|
|
3912
3912
|
* <p>The status of the stage.</p>
|
|
3913
3913
|
* @public
|
|
3914
3914
|
*/
|
|
3915
|
-
Status?: string;
|
|
3915
|
+
Status?: string | undefined;
|
|
3916
3916
|
/**
|
|
3917
3917
|
* <p>The description of the stage.</p>
|
|
3918
3918
|
* @public
|
|
3919
3919
|
*/
|
|
3920
|
-
Description?: string;
|
|
3920
|
+
Description?: string | undefined;
|
|
3921
3921
|
/**
|
|
3922
3922
|
* <p>The most recent updated timestamp of the stage.</p>
|
|
3923
3923
|
* @public
|
|
3924
3924
|
*/
|
|
3925
|
-
LastUpdated?: Date;
|
|
3925
|
+
LastUpdated?: Date | undefined;
|
|
3926
3926
|
}
|
|
3927
3927
|
/**
|
|
3928
3928
|
* @public
|
|
@@ -3947,52 +3947,52 @@ export interface ChangeProgressStatusDetails {
|
|
|
3947
3947
|
* <p>The unique change identifier associated with a specific domain configuration change.</p>
|
|
3948
3948
|
* @public
|
|
3949
3949
|
*/
|
|
3950
|
-
ChangeId?: string;
|
|
3950
|
+
ChangeId?: string | undefined;
|
|
3951
3951
|
/**
|
|
3952
3952
|
* <p>The time at which the configuration change is made on the domain.</p>
|
|
3953
3953
|
* @public
|
|
3954
3954
|
*/
|
|
3955
|
-
StartTime?: Date;
|
|
3955
|
+
StartTime?: Date | undefined;
|
|
3956
3956
|
/**
|
|
3957
3957
|
* <p>The overall status of the domain configuration change.</p>
|
|
3958
3958
|
* @public
|
|
3959
3959
|
*/
|
|
3960
|
-
Status?: OverallChangeStatus;
|
|
3960
|
+
Status?: OverallChangeStatus | undefined;
|
|
3961
3961
|
/**
|
|
3962
3962
|
* <p>The list of properties in the domain configuration change that are still pending.</p>
|
|
3963
3963
|
* @public
|
|
3964
3964
|
*/
|
|
3965
|
-
PendingProperties?: string[];
|
|
3965
|
+
PendingProperties?: string[] | undefined;
|
|
3966
3966
|
/**
|
|
3967
3967
|
* <p>The list of properties in the domain configuration change that have completed.</p>
|
|
3968
3968
|
* @public
|
|
3969
3969
|
*/
|
|
3970
|
-
CompletedProperties?: string[];
|
|
3970
|
+
CompletedProperties?: string[] | undefined;
|
|
3971
3971
|
/**
|
|
3972
3972
|
* <p>The total number of stages required for the configuration change.</p>
|
|
3973
3973
|
* @public
|
|
3974
3974
|
*/
|
|
3975
|
-
TotalNumberOfStages?: number;
|
|
3975
|
+
TotalNumberOfStages?: number | undefined;
|
|
3976
3976
|
/**
|
|
3977
3977
|
* <p>The specific stages that the domain is going through to perform the configuration change.</p>
|
|
3978
3978
|
* @public
|
|
3979
3979
|
*/
|
|
3980
|
-
ChangeProgressStages?: ChangeProgressStage[];
|
|
3980
|
+
ChangeProgressStages?: ChangeProgressStage[] | undefined;
|
|
3981
3981
|
/**
|
|
3982
3982
|
* <p>The last time that the status of the configuration change was updated.</p>
|
|
3983
3983
|
* @public
|
|
3984
3984
|
*/
|
|
3985
|
-
LastUpdatedTime?: Date;
|
|
3985
|
+
LastUpdatedTime?: Date | undefined;
|
|
3986
3986
|
/**
|
|
3987
3987
|
* <p>The current status of the configuration change.</p>
|
|
3988
3988
|
* @public
|
|
3989
3989
|
*/
|
|
3990
|
-
ConfigChangeStatus?: ConfigChangeStatus;
|
|
3990
|
+
ConfigChangeStatus?: ConfigChangeStatus | undefined;
|
|
3991
3991
|
/**
|
|
3992
3992
|
* <p>The IAM principal who initiated the configuration change.</p>
|
|
3993
3993
|
* @public
|
|
3994
3994
|
*/
|
|
3995
|
-
InitiatedBy?: InitiatedBy;
|
|
3995
|
+
InitiatedBy?: InitiatedBy | undefined;
|
|
3996
3996
|
}
|
|
3997
3997
|
/**
|
|
3998
3998
|
* <p>The result of a <code>DescribeDomainChangeProgress</code> request. Contains progress
|
|
@@ -4004,7 +4004,7 @@ export interface DescribeDomainChangeProgressResponse {
|
|
|
4004
4004
|
* <p>Container for information about the stages of a configuration change happening on a domain.</p>
|
|
4005
4005
|
* @public
|
|
4006
4006
|
*/
|
|
4007
|
-
ChangeProgressStatus?: ChangeProgressStatusDetails;
|
|
4007
|
+
ChangeProgressStatus?: ChangeProgressStatusDetails | undefined;
|
|
4008
4008
|
}
|
|
4009
4009
|
/**
|
|
4010
4010
|
* <p>Container for the parameters to the <code>DescribeDomainConfig</code> operation.</p>
|
|
@@ -4039,7 +4039,7 @@ export interface AutoTuneOptions {
|
|
|
4039
4039
|
* <p>Whether Auto-Tune is enabled or disabled.</p>
|
|
4040
4040
|
* @public
|
|
4041
4041
|
*/
|
|
4042
|
-
DesiredState?: AutoTuneDesiredState;
|
|
4042
|
+
DesiredState?: AutoTuneDesiredState | undefined;
|
|
4043
4043
|
/**
|
|
4044
4044
|
* <p>When disabling Auto-Tune, specify <code>NO_ROLLBACK</code> to retain all prior Auto-Tune
|
|
4045
4045
|
* settings or <code>DEFAULT_ROLLBACK</code> to revert to the OpenSearch Service defaults. If you
|
|
@@ -4047,20 +4047,20 @@ export interface AutoTuneOptions {
|
|
|
4047
4047
|
* request. Otherwise, OpenSearch Service is unable to perform the rollback.</p>
|
|
4048
4048
|
* @public
|
|
4049
4049
|
*/
|
|
4050
|
-
RollbackOnDisable?: RollbackOnDisable;
|
|
4050
|
+
RollbackOnDisable?: RollbackOnDisable | undefined;
|
|
4051
4051
|
/**
|
|
4052
4052
|
* <p>DEPRECATED. Use <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak window</a>
|
|
4053
4053
|
* instead.</p>
|
|
4054
4054
|
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes.</p>
|
|
4055
4055
|
* @public
|
|
4056
4056
|
*/
|
|
4057
|
-
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[];
|
|
4057
|
+
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[] | undefined;
|
|
4058
4058
|
/**
|
|
4059
4059
|
* <p>Whether to use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak window</a> to
|
|
4060
4060
|
* deploy configuration changes on the domain rather than a maintenance schedule.</p>
|
|
4061
4061
|
* @public
|
|
4062
4062
|
*/
|
|
4063
|
-
UseOffPeakWindow?: boolean;
|
|
4063
|
+
UseOffPeakWindow?: boolean | undefined;
|
|
4064
4064
|
}
|
|
4065
4065
|
/**
|
|
4066
4066
|
* <p>The current status of Auto-Tune for the domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for
|
|
@@ -4082,7 +4082,7 @@ export interface AutoTuneStatus {
|
|
|
4082
4082
|
* <p>The latest version of the Auto-Tune options.</p>
|
|
4083
4083
|
* @public
|
|
4084
4084
|
*/
|
|
4085
|
-
UpdateVersion?: number;
|
|
4085
|
+
UpdateVersion?: number | undefined;
|
|
4086
4086
|
/**
|
|
4087
4087
|
* <p>The current state of Auto-Tune on the domain.</p>
|
|
4088
4088
|
* @public
|
|
@@ -4092,12 +4092,12 @@ export interface AutoTuneStatus {
|
|
|
4092
4092
|
* <p>Any errors that occurred while enabling or disabling Auto-Tune.</p>
|
|
4093
4093
|
* @public
|
|
4094
4094
|
*/
|
|
4095
|
-
ErrorMessage?: string;
|
|
4095
|
+
ErrorMessage?: string | undefined;
|
|
4096
4096
|
/**
|
|
4097
4097
|
* <p>Indicates whether the domain is being deleted.</p>
|
|
4098
4098
|
* @public
|
|
4099
4099
|
*/
|
|
4100
|
-
PendingDeletion?: boolean;
|
|
4100
|
+
PendingDeletion?: boolean | undefined;
|
|
4101
4101
|
}
|
|
4102
4102
|
/**
|
|
4103
4103
|
* <p>The Auto-Tune status for the domain.</p>
|
|
@@ -4108,12 +4108,12 @@ export interface AutoTuneOptionsStatus {
|
|
|
4108
4108
|
* <p>Auto-Tune settings for updating a domain.</p>
|
|
4109
4109
|
* @public
|
|
4110
4110
|
*/
|
|
4111
|
-
Options?: AutoTuneOptions;
|
|
4111
|
+
Options?: AutoTuneOptions | undefined;
|
|
4112
4112
|
/**
|
|
4113
4113
|
* <p>The current status of Auto-Tune for a domain.</p>
|
|
4114
4114
|
* @public
|
|
4115
4115
|
*/
|
|
4116
|
-
Status?: AutoTuneStatus;
|
|
4116
|
+
Status?: AutoTuneStatus | undefined;
|
|
4117
4117
|
}
|
|
4118
4118
|
/**
|
|
4119
4119
|
* <p>The cluster configuration status for a domain.</p>
|
|
@@ -4253,12 +4253,12 @@ export interface LogPublishingOptionsStatus {
|
|
|
4253
4253
|
* <p>The log publishing options configured for the domain.</p>
|
|
4254
4254
|
* @public
|
|
4255
4255
|
*/
|
|
4256
|
-
Options?: Partial<Record<LogType, LogPublishingOption
|
|
4256
|
+
Options?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
4257
4257
|
/**
|
|
4258
4258
|
* <p>The status of the log publishing options for the domain.</p>
|
|
4259
4259
|
* @public
|
|
4260
4260
|
*/
|
|
4261
|
-
Status?: OptionStatus;
|
|
4261
|
+
Status?: OptionStatus | undefined;
|
|
4262
4262
|
}
|
|
4263
4263
|
/**
|
|
4264
4264
|
* <p>Status of the node-to-node encryption options for the specified domain.</p>
|
|
@@ -4286,12 +4286,12 @@ export interface OffPeakWindowOptionsStatus {
|
|
|
4286
4286
|
* <p>The domain's off-peak window configuration.</p>
|
|
4287
4287
|
* @public
|
|
4288
4288
|
*/
|
|
4289
|
-
Options?: OffPeakWindowOptions;
|
|
4289
|
+
Options?: OffPeakWindowOptions | undefined;
|
|
4290
4290
|
/**
|
|
4291
4291
|
* <p>The current status of off-peak window options.</p>
|
|
4292
4292
|
* @public
|
|
4293
4293
|
*/
|
|
4294
|
-
Status?: OptionStatus;
|
|
4294
|
+
Status?: OptionStatus | undefined;
|
|
4295
4295
|
}
|
|
4296
4296
|
/**
|
|
4297
4297
|
* <p>Container for information about a daily automated snapshot for an OpenSearch Service
|
|
@@ -4319,12 +4319,12 @@ export interface SoftwareUpdateOptionsStatus {
|
|
|
4319
4319
|
* <p>The service software update options for a domain.</p>
|
|
4320
4320
|
* @public
|
|
4321
4321
|
*/
|
|
4322
|
-
Options?: SoftwareUpdateOptions;
|
|
4322
|
+
Options?: SoftwareUpdateOptions | undefined;
|
|
4323
4323
|
/**
|
|
4324
4324
|
* <p>The status of service software update options, including creation date and last updated date.</p>
|
|
4325
4325
|
* @public
|
|
4326
4326
|
*/
|
|
4327
|
-
Status?: OptionStatus;
|
|
4327
|
+
Status?: OptionStatus | undefined;
|
|
4328
4328
|
}
|
|
4329
4329
|
/**
|
|
4330
4330
|
* <p>Status of the VPC options for a specified domain.</p>
|
|
@@ -4351,112 +4351,112 @@ export interface DomainConfig {
|
|
|
4351
4351
|
* <p>The OpenSearch or Elasticsearch version that the domain is running.</p>
|
|
4352
4352
|
* @public
|
|
4353
4353
|
*/
|
|
4354
|
-
EngineVersion?: VersionStatus;
|
|
4354
|
+
EngineVersion?: VersionStatus | undefined;
|
|
4355
4355
|
/**
|
|
4356
4356
|
* <p>Container for the cluster configuration of a the domain.</p>
|
|
4357
4357
|
* @public
|
|
4358
4358
|
*/
|
|
4359
|
-
ClusterConfig?: ClusterConfigStatus;
|
|
4359
|
+
ClusterConfig?: ClusterConfigStatus | undefined;
|
|
4360
4360
|
/**
|
|
4361
4361
|
* <p>Container for EBS options configured for the domain.</p>
|
|
4362
4362
|
* @public
|
|
4363
4363
|
*/
|
|
4364
|
-
EBSOptions?: EBSOptionsStatus;
|
|
4364
|
+
EBSOptions?: EBSOptionsStatus | undefined;
|
|
4365
4365
|
/**
|
|
4366
4366
|
* <p>Specifies the access policies for the domain.</p>
|
|
4367
4367
|
* @public
|
|
4368
4368
|
*/
|
|
4369
|
-
AccessPolicies?: AccessPoliciesStatus;
|
|
4369
|
+
AccessPolicies?: AccessPoliciesStatus | undefined;
|
|
4370
4370
|
/**
|
|
4371
4371
|
* <p>Choose either dual stack or IPv4 as your IP address type.
|
|
4372
4372
|
* Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option.
|
|
4373
4373
|
* If you set your IP address type to dual stack, you can't change your address type later.</p>
|
|
4374
4374
|
* @public
|
|
4375
4375
|
*/
|
|
4376
|
-
IPAddressType?: IPAddressTypeStatus;
|
|
4376
|
+
IPAddressType?: IPAddressTypeStatus | undefined;
|
|
4377
4377
|
/**
|
|
4378
4378
|
* <p>DEPRECATED. Container for parameters required to configure automated snapshots of domain
|
|
4379
4379
|
* indexes.</p>
|
|
4380
4380
|
* @public
|
|
4381
4381
|
*/
|
|
4382
|
-
SnapshotOptions?: SnapshotOptionsStatus;
|
|
4382
|
+
SnapshotOptions?: SnapshotOptionsStatus | undefined;
|
|
4383
4383
|
/**
|
|
4384
4384
|
* <p>The current VPC options for the domain and the status of any updates to their
|
|
4385
4385
|
* configuration.</p>
|
|
4386
4386
|
* @public
|
|
4387
4387
|
*/
|
|
4388
|
-
VPCOptions?: VPCDerivedInfoStatus;
|
|
4388
|
+
VPCOptions?: VPCDerivedInfoStatus | undefined;
|
|
4389
4389
|
/**
|
|
4390
4390
|
* <p>Container for Amazon Cognito options for the domain.</p>
|
|
4391
4391
|
* @public
|
|
4392
4392
|
*/
|
|
4393
|
-
CognitoOptions?: CognitoOptionsStatus;
|
|
4393
|
+
CognitoOptions?: CognitoOptionsStatus | undefined;
|
|
4394
4394
|
/**
|
|
4395
4395
|
* <p>Key-value pairs to enable encryption at rest.</p>
|
|
4396
4396
|
* @public
|
|
4397
4397
|
*/
|
|
4398
|
-
EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus;
|
|
4398
|
+
EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus | undefined;
|
|
4399
4399
|
/**
|
|
4400
4400
|
* <p>Whether node-to-node encryption is enabled or disabled.</p>
|
|
4401
4401
|
* @public
|
|
4402
4402
|
*/
|
|
4403
|
-
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus;
|
|
4403
|
+
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus | undefined;
|
|
4404
4404
|
/**
|
|
4405
4405
|
* <p>Key-value pairs to specify advanced configuration options. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced options</a>.</p>
|
|
4406
4406
|
* @public
|
|
4407
4407
|
*/
|
|
4408
|
-
AdvancedOptions?: AdvancedOptionsStatus;
|
|
4408
|
+
AdvancedOptions?: AdvancedOptionsStatus | undefined;
|
|
4409
4409
|
/**
|
|
4410
4410
|
* <p>Key-value pairs to configure log publishing.</p>
|
|
4411
4411
|
* @public
|
|
4412
4412
|
*/
|
|
4413
|
-
LogPublishingOptions?: LogPublishingOptionsStatus;
|
|
4413
|
+
LogPublishingOptions?: LogPublishingOptionsStatus | undefined;
|
|
4414
4414
|
/**
|
|
4415
4415
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
4416
4416
|
* traffic.</p>
|
|
4417
4417
|
* @public
|
|
4418
4418
|
*/
|
|
4419
|
-
DomainEndpointOptions?: DomainEndpointOptionsStatus;
|
|
4419
|
+
DomainEndpointOptions?: DomainEndpointOptionsStatus | undefined;
|
|
4420
4420
|
/**
|
|
4421
4421
|
* <p>Container for fine-grained access control settings for the domain.</p>
|
|
4422
4422
|
* @public
|
|
4423
4423
|
*/
|
|
4424
|
-
AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus;
|
|
4424
|
+
AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus | undefined;
|
|
4425
4425
|
/**
|
|
4426
4426
|
* <p>Container for IAM Identity Center Option control for the domain.</p>
|
|
4427
4427
|
* @public
|
|
4428
4428
|
*/
|
|
4429
|
-
IdentityCenterOptions?: IdentityCenterOptionsStatus;
|
|
4429
|
+
IdentityCenterOptions?: IdentityCenterOptionsStatus | undefined;
|
|
4430
4430
|
/**
|
|
4431
4431
|
* <p>Container for Auto-Tune settings for the domain.</p>
|
|
4432
4432
|
* @public
|
|
4433
4433
|
*/
|
|
4434
|
-
AutoTuneOptions?: AutoTuneOptionsStatus;
|
|
4434
|
+
AutoTuneOptions?: AutoTuneOptionsStatus | undefined;
|
|
4435
4435
|
/**
|
|
4436
4436
|
* <p>Container for information about the progress of an existing configuration change.</p>
|
|
4437
4437
|
* @public
|
|
4438
4438
|
*/
|
|
4439
|
-
ChangeProgressDetails?: ChangeProgressDetails;
|
|
4439
|
+
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
4440
4440
|
/**
|
|
4441
4441
|
* <p>Container for off-peak window options for the domain.</p>
|
|
4442
4442
|
* @public
|
|
4443
4443
|
*/
|
|
4444
|
-
OffPeakWindowOptions?: OffPeakWindowOptionsStatus;
|
|
4444
|
+
OffPeakWindowOptions?: OffPeakWindowOptionsStatus | undefined;
|
|
4445
4445
|
/**
|
|
4446
4446
|
* <p>Software update options for the domain.</p>
|
|
4447
4447
|
* @public
|
|
4448
4448
|
*/
|
|
4449
|
-
SoftwareUpdateOptions?: SoftwareUpdateOptionsStatus;
|
|
4449
|
+
SoftwareUpdateOptions?: SoftwareUpdateOptionsStatus | undefined;
|
|
4450
4450
|
/**
|
|
4451
4451
|
* <p>Information about the domain properties that are currently being modified.</p>
|
|
4452
4452
|
* @public
|
|
4453
4453
|
*/
|
|
4454
|
-
ModifyingProperties?: ModifyingProperties[];
|
|
4454
|
+
ModifyingProperties?: ModifyingProperties[] | undefined;
|
|
4455
4455
|
/**
|
|
4456
4456
|
* <p>Container for parameters required to enable all machine learning features.</p>
|
|
4457
4457
|
* @public
|
|
4458
4458
|
*/
|
|
4459
|
-
AIMLOptions?: AIMLOptionsStatus;
|
|
4459
|
+
AIMLOptions?: AIMLOptionsStatus | undefined;
|
|
4460
4460
|
}
|
|
4461
4461
|
/**
|
|
4462
4462
|
* <p>Contains the configuration information of the requested domain.</p>
|
|
@@ -4529,7 +4529,7 @@ export interface AvailabilityZoneInfo {
|
|
|
4529
4529
|
* <p>The name of the Availability Zone.</p>
|
|
4530
4530
|
* @public
|
|
4531
4531
|
*/
|
|
4532
|
-
AvailabilityZoneName?: string;
|
|
4532
|
+
AvailabilityZoneName?: string | undefined;
|
|
4533
4533
|
/**
|
|
4534
4534
|
* <p>The current state of the Availability Zone. Current options are <code>Active</code> and <code>StandBy</code>.</p>
|
|
4535
4535
|
* <ul>
|
|
@@ -4548,27 +4548,27 @@ export interface AvailabilityZoneInfo {
|
|
|
4548
4548
|
* </ul>
|
|
4549
4549
|
* @public
|
|
4550
4550
|
*/
|
|
4551
|
-
ZoneStatus?: ZoneStatus;
|
|
4551
|
+
ZoneStatus?: ZoneStatus | undefined;
|
|
4552
4552
|
/**
|
|
4553
4553
|
* <p>The total number of data nodes configured in the Availability Zone.</p>
|
|
4554
4554
|
* @public
|
|
4555
4555
|
*/
|
|
4556
|
-
ConfiguredDataNodeCount?: string;
|
|
4556
|
+
ConfiguredDataNodeCount?: string | undefined;
|
|
4557
4557
|
/**
|
|
4558
4558
|
* <p>The number of data nodes active in the Availability Zone.</p>
|
|
4559
4559
|
* @public
|
|
4560
4560
|
*/
|
|
4561
|
-
AvailableDataNodeCount?: string;
|
|
4561
|
+
AvailableDataNodeCount?: string | undefined;
|
|
4562
4562
|
/**
|
|
4563
4563
|
* <p>The total number of primary and replica shards in the Availability Zone.</p>
|
|
4564
4564
|
* @public
|
|
4565
4565
|
*/
|
|
4566
|
-
TotalShards?: string;
|
|
4566
|
+
TotalShards?: string | undefined;
|
|
4567
4567
|
/**
|
|
4568
4568
|
* <p>The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.</p>
|
|
4569
4569
|
* @public
|
|
4570
4570
|
*/
|
|
4571
|
-
TotalUnAssignedShards?: string;
|
|
4571
|
+
TotalUnAssignedShards?: string | undefined;
|
|
4572
4572
|
}
|
|
4573
4573
|
/**
|
|
4574
4574
|
* <p>Information about the active domain environment.</p>
|
|
@@ -4579,7 +4579,7 @@ export interface EnvironmentInfo {
|
|
|
4579
4579
|
* <p> A list of <code>AvailabilityZoneInfo</code> for the domain.</p>
|
|
4580
4580
|
* @public
|
|
4581
4581
|
*/
|
|
4582
|
-
AvailabilityZoneInformation?: AvailabilityZoneInfo[];
|
|
4582
|
+
AvailabilityZoneInformation?: AvailabilityZoneInfo[] | undefined;
|
|
4583
4583
|
}
|
|
4584
4584
|
/**
|
|
4585
4585
|
* @public
|
|
@@ -4612,43 +4612,43 @@ export interface DescribeDomainHealthResponse {
|
|
|
4612
4612
|
* </ul>
|
|
4613
4613
|
* @public
|
|
4614
4614
|
*/
|
|
4615
|
-
DomainState?: DomainState;
|
|
4615
|
+
DomainState?: DomainState | undefined;
|
|
4616
4616
|
/**
|
|
4617
4617
|
* <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>
|
|
4618
4618
|
* @public
|
|
4619
4619
|
*/
|
|
4620
|
-
AvailabilityZoneCount?: string;
|
|
4620
|
+
AvailabilityZoneCount?: string | undefined;
|
|
4621
4621
|
/**
|
|
4622
4622
|
* <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>
|
|
4623
4623
|
* @public
|
|
4624
4624
|
*/
|
|
4625
|
-
ActiveAvailabilityZoneCount?: string;
|
|
4625
|
+
ActiveAvailabilityZoneCount?: string | undefined;
|
|
4626
4626
|
/**
|
|
4627
4627
|
* <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>
|
|
4628
4628
|
* @public
|
|
4629
4629
|
*/
|
|
4630
|
-
StandByAvailabilityZoneCount?: string;
|
|
4630
|
+
StandByAvailabilityZoneCount?: string | undefined;
|
|
4631
4631
|
/**
|
|
4632
4632
|
* <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>
|
|
4633
4633
|
* @public
|
|
4634
4634
|
*/
|
|
4635
|
-
DataNodeCount?: string;
|
|
4635
|
+
DataNodeCount?: string | undefined;
|
|
4636
4636
|
/**
|
|
4637
4637
|
* <p>A boolean that indicates if dedicated master nodes are activated for the domain.</p>
|
|
4638
4638
|
* @public
|
|
4639
4639
|
*/
|
|
4640
|
-
DedicatedMaster?: boolean;
|
|
4640
|
+
DedicatedMaster?: boolean | undefined;
|
|
4641
4641
|
/**
|
|
4642
4642
|
* <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.
|
|
4643
4643
|
* If the service is unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4644
4644
|
* @public
|
|
4645
4645
|
*/
|
|
4646
|
-
MasterEligibleNodeCount?: string;
|
|
4646
|
+
MasterEligibleNodeCount?: string | undefined;
|
|
4647
4647
|
/**
|
|
4648
4648
|
* <p>The number of warm nodes configured for the domain.</p>
|
|
4649
4649
|
* @public
|
|
4650
4650
|
*/
|
|
4651
|
-
WarmNodeCount?: string;
|
|
4651
|
+
WarmNodeCount?: string | undefined;
|
|
4652
4652
|
/**
|
|
4653
4653
|
* <p>Indicates whether the domain has an elected master node.</p>
|
|
4654
4654
|
* <ul>
|
|
@@ -4663,7 +4663,7 @@ export interface DescribeDomainHealthResponse {
|
|
|
4663
4663
|
* </ul>
|
|
4664
4664
|
* @public
|
|
4665
4665
|
*/
|
|
4666
|
-
MasterNode?: MasterNodeStatus;
|
|
4666
|
+
MasterNode?: MasterNodeStatus | undefined;
|
|
4667
4667
|
/**
|
|
4668
4668
|
* <p>The current health status of your cluster.</p>
|
|
4669
4669
|
* <ul>
|
|
@@ -4686,22 +4686,22 @@ export interface DescribeDomainHealthResponse {
|
|
|
4686
4686
|
* </ul>
|
|
4687
4687
|
* @public
|
|
4688
4688
|
*/
|
|
4689
|
-
ClusterHealth?: DomainHealth;
|
|
4689
|
+
ClusterHealth?: DomainHealth | undefined;
|
|
4690
4690
|
/**
|
|
4691
4691
|
* <p>The total number of primary and replica shards for the domain.</p>
|
|
4692
4692
|
* @public
|
|
4693
4693
|
*/
|
|
4694
|
-
TotalShards?: string;
|
|
4694
|
+
TotalShards?: string | undefined;
|
|
4695
4695
|
/**
|
|
4696
4696
|
* <p>The total number of primary and replica shards not allocated to any of the nodes for the cluster.</p>
|
|
4697
4697
|
* @public
|
|
4698
4698
|
*/
|
|
4699
|
-
TotalUnAssignedShards?: string;
|
|
4699
|
+
TotalUnAssignedShards?: string | undefined;
|
|
4700
4700
|
/**
|
|
4701
4701
|
* <p>A list of <code>EnvironmentInfo</code> for the domain. </p>
|
|
4702
4702
|
* @public
|
|
4703
4703
|
*/
|
|
4704
|
-
EnvironmentInformation?: EnvironmentInfo[];
|
|
4704
|
+
EnvironmentInformation?: EnvironmentInfo[] | undefined;
|
|
4705
4705
|
}
|
|
4706
4706
|
/**
|
|
4707
4707
|
* <p>Container for the parameters to the <code>DescribeDomainNodes</code>
|
|
@@ -4750,43 +4750,43 @@ export interface DomainNodesStatus {
|
|
|
4750
4750
|
* <p>The ID of the node.</p>
|
|
4751
4751
|
* @public
|
|
4752
4752
|
*/
|
|
4753
|
-
NodeId?: string;
|
|
4753
|
+
NodeId?: string | undefined;
|
|
4754
4754
|
/**
|
|
4755
4755
|
* <p>Indicates whether the nodes is a data, master, or ultrawarm node.</p>
|
|
4756
4756
|
* @public
|
|
4757
4757
|
*/
|
|
4758
|
-
NodeType?: NodeType;
|
|
4758
|
+
NodeType?: NodeType | undefined;
|
|
4759
4759
|
/**
|
|
4760
4760
|
* <p>The Availability Zone of the node.</p>
|
|
4761
4761
|
* @public
|
|
4762
4762
|
*/
|
|
4763
|
-
AvailabilityZone?: string;
|
|
4763
|
+
AvailabilityZone?: string | undefined;
|
|
4764
4764
|
/**
|
|
4765
4765
|
* <p>The instance type information of the node.</p>
|
|
4766
4766
|
* @public
|
|
4767
4767
|
*/
|
|
4768
|
-
InstanceType?: OpenSearchPartitionInstanceType;
|
|
4768
|
+
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
4769
4769
|
/**
|
|
4770
4770
|
* <p>Indicates if the node is active or in standby.</p>
|
|
4771
4771
|
* @public
|
|
4772
4772
|
*/
|
|
4773
|
-
NodeStatus?: NodeStatus;
|
|
4773
|
+
NodeStatus?: NodeStatus | undefined;
|
|
4774
4774
|
/**
|
|
4775
4775
|
* <p>Indicates if the node has EBS or instance storage. </p>
|
|
4776
4776
|
* @public
|
|
4777
4777
|
*/
|
|
4778
|
-
StorageType?: string;
|
|
4778
|
+
StorageType?: string | undefined;
|
|
4779
4779
|
/**
|
|
4780
4780
|
* <p>If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable
|
|
4781
4781
|
* for data nodes. </p>
|
|
4782
4782
|
* @public
|
|
4783
4783
|
*/
|
|
4784
|
-
StorageVolumeType?: VolumeType;
|
|
4784
|
+
StorageVolumeType?: VolumeType | undefined;
|
|
4785
4785
|
/**
|
|
4786
4786
|
* <p>The storage size of the node, in GiB.</p>
|
|
4787
4787
|
* @public
|
|
4788
4788
|
*/
|
|
4789
|
-
StorageSize?: string;
|
|
4789
|
+
StorageSize?: string | undefined;
|
|
4790
4790
|
}
|
|
4791
4791
|
/**
|
|
4792
4792
|
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about the nodes on the requested domain. </p>
|
|
@@ -4798,7 +4798,7 @@ export interface DescribeDomainNodesResponse {
|
|
|
4798
4798
|
* details about the all nodes on the requested domain.</p>
|
|
4799
4799
|
* @public
|
|
4800
4800
|
*/
|
|
4801
|
-
DomainNodesStatusList?: DomainNodesStatus[];
|
|
4801
|
+
DomainNodesStatusList?: DomainNodesStatus[] | undefined;
|
|
4802
4802
|
}
|
|
4803
4803
|
/**
|
|
4804
4804
|
* <p>Container for the parameters to the <code>DescribeDomains</code> operation.</p>
|
|
@@ -4836,13 +4836,13 @@ export interface DescribeDryRunProgressRequest {
|
|
|
4836
4836
|
* <p>The unique identifier of the dry run.</p>
|
|
4837
4837
|
* @public
|
|
4838
4838
|
*/
|
|
4839
|
-
DryRunId?: string;
|
|
4839
|
+
DryRunId?: string | undefined;
|
|
4840
4840
|
/**
|
|
4841
4841
|
* <p>Whether to include the configuration of the dry run in the response. The configuration
|
|
4842
4842
|
* specifies the updates that you're planning to make on the domain.</p>
|
|
4843
4843
|
* @public
|
|
4844
4844
|
*/
|
|
4845
|
-
LoadDryRunConfig?: boolean;
|
|
4845
|
+
LoadDryRunConfig?: boolean | undefined;
|
|
4846
4846
|
}
|
|
4847
4847
|
/**
|
|
4848
4848
|
* <p>A validation failure that occurred as the result of a pre-update validation check (verbose
|
|
@@ -4854,12 +4854,12 @@ export interface ValidationFailure {
|
|
|
4854
4854
|
* <p>The error code of the failure.</p>
|
|
4855
4855
|
* @public
|
|
4856
4856
|
*/
|
|
4857
|
-
Code?: string;
|
|
4857
|
+
Code?: string | undefined;
|
|
4858
4858
|
/**
|
|
4859
4859
|
* <p>A message corresponding to the failure.</p>
|
|
4860
4860
|
* @public
|
|
4861
4861
|
*/
|
|
4862
|
-
Message?: string;
|
|
4862
|
+
Message?: string | undefined;
|
|
4863
4863
|
}
|
|
4864
4864
|
/**
|
|
4865
4865
|
* <p>Information about the progress of a pre-upgrade dry run analysis.</p>
|
|
@@ -4890,7 +4890,7 @@ export interface DryRunProgressStatus {
|
|
|
4890
4890
|
* <p>Any validation failures that occurred as a result of the dry run.</p>
|
|
4891
4891
|
* @public
|
|
4892
4892
|
*/
|
|
4893
|
-
ValidationFailures?: ValidationFailure[];
|
|
4893
|
+
ValidationFailures?: ValidationFailure[] | undefined;
|
|
4894
4894
|
}
|
|
4895
4895
|
/**
|
|
4896
4896
|
* <p>Results of a dry run performed in an update domain request.</p>
|
|
@@ -4923,12 +4923,12 @@ export interface DryRunResults {
|
|
|
4923
4923
|
* </ul>
|
|
4924
4924
|
* @public
|
|
4925
4925
|
*/
|
|
4926
|
-
DeploymentType?: string;
|
|
4926
|
+
DeploymentType?: string | undefined;
|
|
4927
4927
|
/**
|
|
4928
4928
|
* <p>A message corresponding to the deployment type.</p>
|
|
4929
4929
|
* @public
|
|
4930
4930
|
*/
|
|
4931
|
-
Message?: string;
|
|
4931
|
+
Message?: string | undefined;
|
|
4932
4932
|
}
|
|
4933
4933
|
/**
|
|
4934
4934
|
* @public
|
|
@@ -4938,17 +4938,17 @@ export interface DescribeDryRunProgressResponse {
|
|
|
4938
4938
|
* <p>The current status of the dry run, including any validation errors.</p>
|
|
4939
4939
|
* @public
|
|
4940
4940
|
*/
|
|
4941
|
-
DryRunProgressStatus?: DryRunProgressStatus;
|
|
4941
|
+
DryRunProgressStatus?: DryRunProgressStatus | undefined;
|
|
4942
4942
|
/**
|
|
4943
4943
|
* <p>Details about the changes you're planning to make on the domain.</p>
|
|
4944
4944
|
* @public
|
|
4945
4945
|
*/
|
|
4946
|
-
DryRunConfig?: DomainStatus;
|
|
4946
|
+
DryRunConfig?: DomainStatus | undefined;
|
|
4947
4947
|
/**
|
|
4948
4948
|
* <p>The results of the dry run. </p>
|
|
4949
4949
|
* @public
|
|
4950
4950
|
*/
|
|
4951
|
-
DryRunResults?: DryRunResults;
|
|
4951
|
+
DryRunResults?: DryRunResults | undefined;
|
|
4952
4952
|
}
|
|
4953
4953
|
/**
|
|
4954
4954
|
* <p>A filter used to limit results when describing inbound or outbound cross-cluster
|
|
@@ -4961,12 +4961,12 @@ export interface Filter {
|
|
|
4961
4961
|
* <p>The name of the filter.</p>
|
|
4962
4962
|
* @public
|
|
4963
4963
|
*/
|
|
4964
|
-
Name?: string;
|
|
4964
|
+
Name?: string | undefined;
|
|
4965
4965
|
/**
|
|
4966
4966
|
* <p>One or more values for the filter.</p>
|
|
4967
4967
|
* @public
|
|
4968
4968
|
*/
|
|
4969
|
-
Values?: string[];
|
|
4969
|
+
Values?: string[] | undefined;
|
|
4970
4970
|
}
|
|
4971
4971
|
/**
|
|
4972
4972
|
* <p>Container for the parameters to the <code>DescribeInboundConnections</code> operation.</p>
|
|
@@ -4977,13 +4977,13 @@ export interface DescribeInboundConnectionsRequest {
|
|
|
4977
4977
|
* <p> A list of filters used to match properties for inbound cross-cluster connections.</p>
|
|
4978
4978
|
* @public
|
|
4979
4979
|
*/
|
|
4980
|
-
Filters?: Filter[];
|
|
4980
|
+
Filters?: Filter[] | undefined;
|
|
4981
4981
|
/**
|
|
4982
4982
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
4983
4983
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
4984
4984
|
* @public
|
|
4985
4985
|
*/
|
|
4986
|
-
MaxResults?: number;
|
|
4986
|
+
MaxResults?: number | undefined;
|
|
4987
4987
|
/**
|
|
4988
4988
|
* <p>If your initial <code>DescribeInboundConnections</code> operation returns a
|
|
4989
4989
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
@@ -4991,7 +4991,7 @@ export interface DescribeInboundConnectionsRequest {
|
|
|
4991
4991
|
* page.</p>
|
|
4992
4992
|
* @public
|
|
4993
4993
|
*/
|
|
4994
|
-
NextToken?: string;
|
|
4994
|
+
NextToken?: string | undefined;
|
|
4995
4995
|
}
|
|
4996
4996
|
/**
|
|
4997
4997
|
* <p>Contains a list of connections matching the filter criteria.</p>
|
|
@@ -5002,14 +5002,14 @@ export interface DescribeInboundConnectionsResponse {
|
|
|
5002
5002
|
* <p>List of inbound connections.</p>
|
|
5003
5003
|
* @public
|
|
5004
5004
|
*/
|
|
5005
|
-
Connections?: InboundConnection[];
|
|
5005
|
+
Connections?: InboundConnection[] | undefined;
|
|
5006
5006
|
/**
|
|
5007
5007
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5008
5008
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5009
5009
|
* returned token to retrieve the next page.</p>
|
|
5010
5010
|
* @public
|
|
5011
5011
|
*/
|
|
5012
|
-
NextToken?: string;
|
|
5012
|
+
NextToken?: string | undefined;
|
|
5013
5013
|
}
|
|
5014
5014
|
/**
|
|
5015
5015
|
* <p>Request processing failed because you provided an invalid pagination token.</p>
|
|
@@ -5032,7 +5032,7 @@ export interface DescribeInstanceTypeLimitsRequest {
|
|
|
5032
5032
|
* <p>The name of the domain. Only specify if you need the limits for an existing domain.</p>
|
|
5033
5033
|
* @public
|
|
5034
5034
|
*/
|
|
5035
|
-
DomainName?: string;
|
|
5035
|
+
DomainName?: string | undefined;
|
|
5036
5036
|
/**
|
|
5037
5037
|
* <p>The OpenSearch Service instance type for which you need limit information.</p>
|
|
5038
5038
|
* @public
|
|
@@ -5055,12 +5055,12 @@ export interface InstanceCountLimits {
|
|
|
5055
5055
|
* <p>The maximum allowed number of instances.</p>
|
|
5056
5056
|
* @public
|
|
5057
5057
|
*/
|
|
5058
|
-
MinimumInstanceCount?: number;
|
|
5058
|
+
MinimumInstanceCount?: number | undefined;
|
|
5059
5059
|
/**
|
|
5060
5060
|
* <p>The minimum allowed number of instances.</p>
|
|
5061
5061
|
* @public
|
|
5062
5062
|
*/
|
|
5063
|
-
MaximumInstanceCount?: number;
|
|
5063
|
+
MaximumInstanceCount?: number | undefined;
|
|
5064
5064
|
}
|
|
5065
5065
|
/**
|
|
5066
5066
|
* <p>Instance-related attributes that are available for a given instance type.</p>
|
|
@@ -5071,7 +5071,7 @@ export interface InstanceLimits {
|
|
|
5071
5071
|
* <p>Limits on the number of instances that can be created for a given instance type.</p>
|
|
5072
5072
|
* @public
|
|
5073
5073
|
*/
|
|
5074
|
-
InstanceCountLimits?: InstanceCountLimits;
|
|
5074
|
+
InstanceCountLimits?: InstanceCountLimits | undefined;
|
|
5075
5075
|
}
|
|
5076
5076
|
/**
|
|
5077
5077
|
* <p>Limits that are applicable for the given Amazon OpenSearch Service storage type.</p>
|
|
@@ -5115,12 +5115,12 @@ export interface StorageTypeLimit {
|
|
|
5115
5115
|
* </ul>
|
|
5116
5116
|
* @public
|
|
5117
5117
|
*/
|
|
5118
|
-
LimitName?: string;
|
|
5118
|
+
LimitName?: string | undefined;
|
|
5119
5119
|
/**
|
|
5120
5120
|
* <p>The limit values.</p>
|
|
5121
5121
|
* @public
|
|
5122
5122
|
*/
|
|
5123
|
-
LimitValues?: string[];
|
|
5123
|
+
LimitValues?: string[] | undefined;
|
|
5124
5124
|
}
|
|
5125
5125
|
/**
|
|
5126
5126
|
* <p>A list of storage types for an Amazon OpenSearch Service domain that are available for a
|
|
@@ -5132,17 +5132,17 @@ export interface StorageType {
|
|
|
5132
5132
|
* <p>The name of the storage type.</p>
|
|
5133
5133
|
* @public
|
|
5134
5134
|
*/
|
|
5135
|
-
StorageTypeName?: string;
|
|
5135
|
+
StorageTypeName?: string | undefined;
|
|
5136
5136
|
/**
|
|
5137
5137
|
* <p>The storage sub-type, such as <code>gp3</code> or <code>io1</code>.</p>
|
|
5138
5138
|
* @public
|
|
5139
5139
|
*/
|
|
5140
|
-
StorageSubTypeName?: string;
|
|
5140
|
+
StorageSubTypeName?: string | undefined;
|
|
5141
5141
|
/**
|
|
5142
5142
|
* <p>Limits that are applicable for the given storage type.</p>
|
|
5143
5143
|
* @public
|
|
5144
5144
|
*/
|
|
5145
|
-
StorageTypeLimits?: StorageTypeLimit[];
|
|
5145
|
+
StorageTypeLimits?: StorageTypeLimit[] | undefined;
|
|
5146
5146
|
}
|
|
5147
5147
|
/**
|
|
5148
5148
|
* <p>Limits for a given instance type and for each of its roles.</p>
|
|
@@ -5153,18 +5153,18 @@ export interface Limits {
|
|
|
5153
5153
|
* <p>Storage-related attributes that are available for a given instance type.</p>
|
|
5154
5154
|
* @public
|
|
5155
5155
|
*/
|
|
5156
|
-
StorageTypes?: StorageType[];
|
|
5156
|
+
StorageTypes?: StorageType[] | undefined;
|
|
5157
5157
|
/**
|
|
5158
5158
|
* <p>The limits for a given instance type.</p>
|
|
5159
5159
|
* @public
|
|
5160
5160
|
*/
|
|
5161
|
-
InstanceLimits?: InstanceLimits;
|
|
5161
|
+
InstanceLimits?: InstanceLimits | undefined;
|
|
5162
5162
|
/**
|
|
5163
5163
|
* <p>List of additional limits that are specific to a given instance type for each of its
|
|
5164
5164
|
* instance roles.</p>
|
|
5165
5165
|
* @public
|
|
5166
5166
|
*/
|
|
5167
|
-
AdditionalLimits?: AdditionalLimit[];
|
|
5167
|
+
AdditionalLimits?: AdditionalLimit[] | undefined;
|
|
5168
5168
|
}
|
|
5169
5169
|
/**
|
|
5170
5170
|
* <p>Container for the parameters received from the <code>DescribeInstanceTypeLimits</code>
|
|
@@ -5177,7 +5177,7 @@ export interface DescribeInstanceTypeLimitsResponse {
|
|
|
5177
5177
|
* nodes.<code>master</code> refers to dedicated master nodes.</p>
|
|
5178
5178
|
* @public
|
|
5179
5179
|
*/
|
|
5180
|
-
LimitsByRole?: Record<string, Limits
|
|
5180
|
+
LimitsByRole?: Record<string, Limits> | undefined;
|
|
5181
5181
|
}
|
|
5182
5182
|
/**
|
|
5183
5183
|
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code> operation.</p>
|
|
@@ -5188,13 +5188,13 @@ export interface DescribeOutboundConnectionsRequest {
|
|
|
5188
5188
|
* <p>List of filter names and values that you can use for requests.</p>
|
|
5189
5189
|
* @public
|
|
5190
5190
|
*/
|
|
5191
|
-
Filters?: Filter[];
|
|
5191
|
+
Filters?: Filter[] | undefined;
|
|
5192
5192
|
/**
|
|
5193
5193
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
5194
5194
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
5195
5195
|
* @public
|
|
5196
5196
|
*/
|
|
5197
|
-
MaxResults?: number;
|
|
5197
|
+
MaxResults?: number | undefined;
|
|
5198
5198
|
/**
|
|
5199
5199
|
* <p>If your initial <code>DescribeOutboundConnections</code> operation returns a
|
|
5200
5200
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
@@ -5202,7 +5202,7 @@ export interface DescribeOutboundConnectionsRequest {
|
|
|
5202
5202
|
* page.</p>
|
|
5203
5203
|
* @public
|
|
5204
5204
|
*/
|
|
5205
|
-
NextToken?: string;
|
|
5205
|
+
NextToken?: string | undefined;
|
|
5206
5206
|
}
|
|
5207
5207
|
/**
|
|
5208
5208
|
* <p>Contains a list of connections matching the filter criteria.</p>
|
|
@@ -5213,14 +5213,14 @@ export interface DescribeOutboundConnectionsResponse {
|
|
|
5213
5213
|
* <p>List of outbound connections that match the filter criteria.</p>
|
|
5214
5214
|
* @public
|
|
5215
5215
|
*/
|
|
5216
|
-
Connections?: OutboundConnection[];
|
|
5216
|
+
Connections?: OutboundConnection[] | undefined;
|
|
5217
5217
|
/**
|
|
5218
5218
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5219
5219
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5220
5220
|
* returned token to retrieve the next page.</p>
|
|
5221
5221
|
* @public
|
|
5222
5222
|
*/
|
|
5223
|
-
NextToken?: string;
|
|
5223
|
+
NextToken?: string | undefined;
|
|
5224
5224
|
}
|
|
5225
5225
|
/**
|
|
5226
5226
|
* @public
|
|
@@ -5247,12 +5247,12 @@ export interface DescribePackagesFilter {
|
|
|
5247
5247
|
* <p>Any field from <code>PackageDetails</code>.</p>
|
|
5248
5248
|
* @public
|
|
5249
5249
|
*/
|
|
5250
|
-
Name?: DescribePackagesFilterName;
|
|
5250
|
+
Name?: DescribePackagesFilterName | undefined;
|
|
5251
5251
|
/**
|
|
5252
5252
|
* <p>A non-empty list of values for the specified filter field.</p>
|
|
5253
5253
|
* @public
|
|
5254
5254
|
*/
|
|
5255
|
-
Value?: string[];
|
|
5255
|
+
Value?: string[] | undefined;
|
|
5256
5256
|
}
|
|
5257
5257
|
/**
|
|
5258
5258
|
* <p>Container for the request parameters to the <code>DescribePackage</code> operation.</p>
|
|
@@ -5263,20 +5263,20 @@ export interface DescribePackagesRequest {
|
|
|
5263
5263
|
* <p>Only returns packages that match the <code>DescribePackagesFilterList</code> values.</p>
|
|
5264
5264
|
* @public
|
|
5265
5265
|
*/
|
|
5266
|
-
Filters?: DescribePackagesFilter[];
|
|
5266
|
+
Filters?: DescribePackagesFilter[] | undefined;
|
|
5267
5267
|
/**
|
|
5268
5268
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
5269
5269
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
5270
5270
|
* @public
|
|
5271
5271
|
*/
|
|
5272
|
-
MaxResults?: number;
|
|
5272
|
+
MaxResults?: number | undefined;
|
|
5273
5273
|
/**
|
|
5274
5274
|
* <p>If your initial <code>DescribePackageFilters</code> operation returns a
|
|
5275
5275
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
5276
5276
|
* <code>DescribePackageFilters</code> operations, which returns results in the next page.</p>
|
|
5277
5277
|
* @public
|
|
5278
5278
|
*/
|
|
5279
|
-
NextToken?: string;
|
|
5279
|
+
NextToken?: string | undefined;
|
|
5280
5280
|
}
|
|
5281
5281
|
/**
|
|
5282
5282
|
* <p>Container for the response returned by the <code>DescribePackages</code> operation.</p>
|
|
@@ -5287,14 +5287,14 @@ export interface DescribePackagesResponse {
|
|
|
5287
5287
|
* <p>Basic information about a package.</p>
|
|
5288
5288
|
* @public
|
|
5289
5289
|
*/
|
|
5290
|
-
PackageDetailsList?: PackageDetails[];
|
|
5290
|
+
PackageDetailsList?: PackageDetails[] | undefined;
|
|
5291
5291
|
/**
|
|
5292
5292
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5293
5293
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5294
5294
|
* returned token to retrieve the next page.</p>
|
|
5295
5295
|
* @public
|
|
5296
5296
|
*/
|
|
5297
|
-
NextToken?: string;
|
|
5297
|
+
NextToken?: string | undefined;
|
|
5298
5298
|
}
|
|
5299
5299
|
/**
|
|
5300
5300
|
* <p>Container for the request parameters to a <code>DescribeReservedInstanceOfferings</code>
|
|
@@ -5307,13 +5307,13 @@ export interface DescribeReservedInstanceOfferingsRequest {
|
|
|
5307
5307
|
* instance types that match the specified reservation identifier.</p>
|
|
5308
5308
|
* @public
|
|
5309
5309
|
*/
|
|
5310
|
-
ReservedInstanceOfferingId?: string;
|
|
5310
|
+
ReservedInstanceOfferingId?: string | undefined;
|
|
5311
5311
|
/**
|
|
5312
5312
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
5313
5313
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
5314
5314
|
* @public
|
|
5315
5315
|
*/
|
|
5316
|
-
MaxResults?: number;
|
|
5316
|
+
MaxResults?: number | undefined;
|
|
5317
5317
|
/**
|
|
5318
5318
|
* <p>If your initial <code>DescribeReservedInstanceOfferings</code> operation returns a
|
|
5319
5319
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
@@ -5321,7 +5321,7 @@ export interface DescribeReservedInstanceOfferingsRequest {
|
|
|
5321
5321
|
* page.</p>
|
|
5322
5322
|
* @public
|
|
5323
5323
|
*/
|
|
5324
|
-
NextToken?: string;
|
|
5324
|
+
NextToken?: string | undefined;
|
|
5325
5325
|
}
|
|
5326
5326
|
/**
|
|
5327
5327
|
* @public
|
|
@@ -5346,12 +5346,12 @@ export interface RecurringCharge {
|
|
|
5346
5346
|
* <p>The monetary amount of the recurring charge.</p>
|
|
5347
5347
|
* @public
|
|
5348
5348
|
*/
|
|
5349
|
-
RecurringChargeAmount?: number;
|
|
5349
|
+
RecurringChargeAmount?: number | undefined;
|
|
5350
5350
|
/**
|
|
5351
5351
|
* <p>The frequency of the recurring charge.</p>
|
|
5352
5352
|
* @public
|
|
5353
5353
|
*/
|
|
5354
|
-
RecurringChargeFrequency?: string;
|
|
5354
|
+
RecurringChargeFrequency?: string | undefined;
|
|
5355
5355
|
}
|
|
5356
5356
|
/**
|
|
5357
5357
|
* <p>Details of an OpenSearch Reserved Instance offering.</p>
|
|
@@ -5362,44 +5362,44 @@ export interface ReservedInstanceOffering {
|
|
|
5362
5362
|
* <p>The unique identifier of the Reserved Instance offering.</p>
|
|
5363
5363
|
* @public
|
|
5364
5364
|
*/
|
|
5365
|
-
ReservedInstanceOfferingId?: string;
|
|
5365
|
+
ReservedInstanceOfferingId?: string | undefined;
|
|
5366
5366
|
/**
|
|
5367
5367
|
* <p>The OpenSearch instance type offered by the Reserved Instance offering.</p>
|
|
5368
5368
|
* @public
|
|
5369
5369
|
*/
|
|
5370
|
-
InstanceType?: OpenSearchPartitionInstanceType;
|
|
5370
|
+
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
5371
5371
|
/**
|
|
5372
5372
|
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch instance.</p>
|
|
5373
5373
|
* @public
|
|
5374
5374
|
*/
|
|
5375
|
-
Duration?: number;
|
|
5375
|
+
Duration?: number | undefined;
|
|
5376
5376
|
/**
|
|
5377
5377
|
* <p>The upfront fixed charge you will pay to purchase the specific Reserved Instance
|
|
5378
5378
|
* offering.</p>
|
|
5379
5379
|
* @public
|
|
5380
5380
|
*/
|
|
5381
|
-
FixedPrice?: number;
|
|
5381
|
+
FixedPrice?: number | undefined;
|
|
5382
5382
|
/**
|
|
5383
5383
|
* <p>The hourly rate at which you're charged for the domain using this Reserved Instance.</p>
|
|
5384
5384
|
* @public
|
|
5385
5385
|
*/
|
|
5386
|
-
UsagePrice?: number;
|
|
5386
|
+
UsagePrice?: number | undefined;
|
|
5387
5387
|
/**
|
|
5388
5388
|
* <p>The currency code for the Reserved Instance offering.</p>
|
|
5389
5389
|
* @public
|
|
5390
5390
|
*/
|
|
5391
|
-
CurrencyCode?: string;
|
|
5391
|
+
CurrencyCode?: string | undefined;
|
|
5392
5392
|
/**
|
|
5393
5393
|
* <p>Payment option for the Reserved Instance offering</p>
|
|
5394
5394
|
* @public
|
|
5395
5395
|
*/
|
|
5396
|
-
PaymentOption?: ReservedInstancePaymentOption;
|
|
5396
|
+
PaymentOption?: ReservedInstancePaymentOption | undefined;
|
|
5397
5397
|
/**
|
|
5398
5398
|
* <p>The recurring charge to your account, regardless of whether you creates any domains using
|
|
5399
5399
|
* the offering.</p>
|
|
5400
5400
|
* @public
|
|
5401
5401
|
*/
|
|
5402
|
-
RecurringCharges?: RecurringCharge[];
|
|
5402
|
+
RecurringCharges?: RecurringCharge[] | undefined;
|
|
5403
5403
|
}
|
|
5404
5404
|
/**
|
|
5405
5405
|
* <p>Container for results of a <code>DescribeReservedInstanceOfferings</code> request.</p>
|
|
@@ -5412,12 +5412,12 @@ export interface DescribeReservedInstanceOfferingsResponse {
|
|
|
5412
5412
|
* returned token to retrieve the next page.</p>
|
|
5413
5413
|
* @public
|
|
5414
5414
|
*/
|
|
5415
|
-
NextToken?: string;
|
|
5415
|
+
NextToken?: string | undefined;
|
|
5416
5416
|
/**
|
|
5417
5417
|
* <p>List of Reserved Instance offerings.</p>
|
|
5418
5418
|
* @public
|
|
5419
5419
|
*/
|
|
5420
|
-
ReservedInstanceOfferings?: ReservedInstanceOffering[];
|
|
5420
|
+
ReservedInstanceOfferings?: ReservedInstanceOffering[] | undefined;
|
|
5421
5421
|
}
|
|
5422
5422
|
/**
|
|
5423
5423
|
* <p>Container for the request parameters to the <code>DescribeReservedInstances</code>
|
|
@@ -5430,13 +5430,13 @@ export interface DescribeReservedInstancesRequest {
|
|
|
5430
5430
|
* specified reserved OpenSearch instance ID.</p>
|
|
5431
5431
|
* @public
|
|
5432
5432
|
*/
|
|
5433
|
-
ReservedInstanceId?: string;
|
|
5433
|
+
ReservedInstanceId?: string | undefined;
|
|
5434
5434
|
/**
|
|
5435
5435
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
5436
5436
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
5437
5437
|
* @public
|
|
5438
5438
|
*/
|
|
5439
|
-
MaxResults?: number;
|
|
5439
|
+
MaxResults?: number | undefined;
|
|
5440
5440
|
/**
|
|
5441
5441
|
* <p>If your initial <code>DescribeReservedInstances</code> operation returns a
|
|
5442
5442
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
@@ -5444,7 +5444,7 @@ export interface DescribeReservedInstancesRequest {
|
|
|
5444
5444
|
* page.</p>
|
|
5445
5445
|
* @public
|
|
5446
5446
|
*/
|
|
5447
|
-
NextToken?: string;
|
|
5447
|
+
NextToken?: string | undefined;
|
|
5448
5448
|
}
|
|
5449
5449
|
/**
|
|
5450
5450
|
* <p>Details of an OpenSearch Reserved Instance.</p>
|
|
@@ -5455,74 +5455,74 @@ export interface ReservedInstance {
|
|
|
5455
5455
|
* <p>The customer-specified identifier to track this reservation.</p>
|
|
5456
5456
|
* @public
|
|
5457
5457
|
*/
|
|
5458
|
-
ReservationName?: string;
|
|
5458
|
+
ReservationName?: string | undefined;
|
|
5459
5459
|
/**
|
|
5460
5460
|
* <p>The unique identifier for the reservation.</p>
|
|
5461
5461
|
* @public
|
|
5462
5462
|
*/
|
|
5463
|
-
ReservedInstanceId?: string;
|
|
5463
|
+
ReservedInstanceId?: string | undefined;
|
|
5464
5464
|
/**
|
|
5465
5465
|
* <p>The unique identifier of the billing subscription.</p>
|
|
5466
5466
|
* @public
|
|
5467
5467
|
*/
|
|
5468
|
-
BillingSubscriptionId?: number;
|
|
5468
|
+
BillingSubscriptionId?: number | undefined;
|
|
5469
5469
|
/**
|
|
5470
5470
|
* <p>The unique identifier of the Reserved Instance offering.</p>
|
|
5471
5471
|
* @public
|
|
5472
5472
|
*/
|
|
5473
|
-
ReservedInstanceOfferingId?: string;
|
|
5473
|
+
ReservedInstanceOfferingId?: string | undefined;
|
|
5474
5474
|
/**
|
|
5475
5475
|
* <p>The OpenSearch instance type offered by theReserved Instance offering.</p>
|
|
5476
5476
|
* @public
|
|
5477
5477
|
*/
|
|
5478
|
-
InstanceType?: OpenSearchPartitionInstanceType;
|
|
5478
|
+
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
5479
5479
|
/**
|
|
5480
5480
|
* <p>The date and time when the reservation was purchased.</p>
|
|
5481
5481
|
* @public
|
|
5482
5482
|
*/
|
|
5483
|
-
StartTime?: Date;
|
|
5483
|
+
StartTime?: Date | undefined;
|
|
5484
5484
|
/**
|
|
5485
5485
|
* <p>The duration, in seconds, for which the OpenSearch instance is reserved.</p>
|
|
5486
5486
|
* @public
|
|
5487
5487
|
*/
|
|
5488
|
-
Duration?: number;
|
|
5488
|
+
Duration?: number | undefined;
|
|
5489
5489
|
/**
|
|
5490
5490
|
* <p>The upfront fixed charge you will paid to purchase the specific Reserved Instance
|
|
5491
5491
|
* offering.</p>
|
|
5492
5492
|
* @public
|
|
5493
5493
|
*/
|
|
5494
|
-
FixedPrice?: number;
|
|
5494
|
+
FixedPrice?: number | undefined;
|
|
5495
5495
|
/**
|
|
5496
5496
|
* <p>The hourly rate at which you're charged for the domain using this Reserved Instance.</p>
|
|
5497
5497
|
* @public
|
|
5498
5498
|
*/
|
|
5499
|
-
UsagePrice?: number;
|
|
5499
|
+
UsagePrice?: number | undefined;
|
|
5500
5500
|
/**
|
|
5501
5501
|
* <p>The currency code for the offering.</p>
|
|
5502
5502
|
* @public
|
|
5503
5503
|
*/
|
|
5504
|
-
CurrencyCode?: string;
|
|
5504
|
+
CurrencyCode?: string | undefined;
|
|
5505
5505
|
/**
|
|
5506
5506
|
* <p>The number of OpenSearch instances that have been reserved.</p>
|
|
5507
5507
|
* @public
|
|
5508
5508
|
*/
|
|
5509
|
-
InstanceCount?: number;
|
|
5509
|
+
InstanceCount?: number | undefined;
|
|
5510
5510
|
/**
|
|
5511
5511
|
* <p>The state of the Reserved Instance.</p>
|
|
5512
5512
|
* @public
|
|
5513
5513
|
*/
|
|
5514
|
-
State?: string;
|
|
5514
|
+
State?: string | undefined;
|
|
5515
5515
|
/**
|
|
5516
5516
|
* <p>The payment option as defined in the Reserved Instance offering.</p>
|
|
5517
5517
|
* @public
|
|
5518
5518
|
*/
|
|
5519
|
-
PaymentOption?: ReservedInstancePaymentOption;
|
|
5519
|
+
PaymentOption?: ReservedInstancePaymentOption | undefined;
|
|
5520
5520
|
/**
|
|
5521
5521
|
* <p>The recurring charge to your account, regardless of whether you create any domains using the
|
|
5522
5522
|
* Reserved Instance offering.</p>
|
|
5523
5523
|
* @public
|
|
5524
5524
|
*/
|
|
5525
|
-
RecurringCharges?: RecurringCharge[];
|
|
5525
|
+
RecurringCharges?: RecurringCharge[] | undefined;
|
|
5526
5526
|
}
|
|
5527
5527
|
/**
|
|
5528
5528
|
* <p>Container for results from <code>DescribeReservedInstances</code>
|
|
@@ -5536,12 +5536,12 @@ export interface DescribeReservedInstancesResponse {
|
|
|
5536
5536
|
* returned token to retrieve the next page.</p>
|
|
5537
5537
|
* @public
|
|
5538
5538
|
*/
|
|
5539
|
-
NextToken?: string;
|
|
5539
|
+
NextToken?: string | undefined;
|
|
5540
5540
|
/**
|
|
5541
5541
|
* <p>List of Reserved Instances in the current Region.</p>
|
|
5542
5542
|
* @public
|
|
5543
5543
|
*/
|
|
5544
|
-
ReservedInstances?: ReservedInstance[];
|
|
5544
|
+
ReservedInstances?: ReservedInstance[] | undefined;
|
|
5545
5545
|
}
|
|
5546
5546
|
/**
|
|
5547
5547
|
* @public
|
|
@@ -5575,17 +5575,17 @@ export interface VpcEndpointError {
|
|
|
5575
5575
|
* <p>The unique identifier of the endpoint.</p>
|
|
5576
5576
|
* @public
|
|
5577
5577
|
*/
|
|
5578
|
-
VpcEndpointId?: string;
|
|
5578
|
+
VpcEndpointId?: string | undefined;
|
|
5579
5579
|
/**
|
|
5580
5580
|
* <p>The code associated with the error.</p>
|
|
5581
5581
|
* @public
|
|
5582
5582
|
*/
|
|
5583
|
-
ErrorCode?: VpcEndpointErrorCode;
|
|
5583
|
+
ErrorCode?: VpcEndpointErrorCode | undefined;
|
|
5584
5584
|
/**
|
|
5585
5585
|
* <p>A message describing the error.</p>
|
|
5586
5586
|
* @public
|
|
5587
5587
|
*/
|
|
5588
|
-
ErrorMessage?: string;
|
|
5588
|
+
ErrorMessage?: string | undefined;
|
|
5589
5589
|
}
|
|
5590
5590
|
/**
|
|
5591
5591
|
* @public
|
|
@@ -5628,7 +5628,7 @@ export interface DissociatePackageResponse {
|
|
|
5628
5628
|
* <p> Information about a package that has been dissociated from the domain.</p>
|
|
5629
5629
|
* @public
|
|
5630
5630
|
*/
|
|
5631
|
-
DomainPackageDetails?: DomainPackageDetails;
|
|
5631
|
+
DomainPackageDetails?: DomainPackageDetails | undefined;
|
|
5632
5632
|
}
|
|
5633
5633
|
/**
|
|
5634
5634
|
* @public
|
|
@@ -5654,7 +5654,7 @@ export interface DissociatePackagesResponse {
|
|
|
5654
5654
|
* <p>A list of package details for the packages that were dissociated from the domain.</p>
|
|
5655
5655
|
* @public
|
|
5656
5656
|
*/
|
|
5657
|
-
DomainPackageDetailsList?: DomainPackageDetails[];
|
|
5657
|
+
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
5658
5658
|
}
|
|
5659
5659
|
/**
|
|
5660
5660
|
* @public
|
|
@@ -5689,54 +5689,54 @@ export interface GetApplicationResponse {
|
|
|
5689
5689
|
* <p>Unique identifier of the checked OpenSearch Application.</p>
|
|
5690
5690
|
* @public
|
|
5691
5691
|
*/
|
|
5692
|
-
id?: string;
|
|
5692
|
+
id?: string | undefined;
|
|
5693
5693
|
/**
|
|
5694
5694
|
* <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
|
|
5695
5695
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
5696
5696
|
* </p>
|
|
5697
5697
|
* @public
|
|
5698
5698
|
*/
|
|
5699
|
-
arn?: string;
|
|
5699
|
+
arn?: string | undefined;
|
|
5700
5700
|
/**
|
|
5701
5701
|
* <p>Name of the checked OpenSearch Application.</p>
|
|
5702
5702
|
* @public
|
|
5703
5703
|
*/
|
|
5704
|
-
name?: string;
|
|
5704
|
+
name?: string | undefined;
|
|
5705
5705
|
/**
|
|
5706
5706
|
* <p>Endpoint URL of the checked OpenSearch Application.</p>
|
|
5707
5707
|
* @public
|
|
5708
5708
|
*/
|
|
5709
|
-
endpoint?: string;
|
|
5709
|
+
endpoint?: string | undefined;
|
|
5710
5710
|
/**
|
|
5711
5711
|
* <p>Current status of the checked OpenSearch Application. Possible values are <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
5712
5712
|
* @public
|
|
5713
5713
|
*/
|
|
5714
|
-
status?: ApplicationStatus;
|
|
5714
|
+
status?: ApplicationStatus | undefined;
|
|
5715
5715
|
/**
|
|
5716
5716
|
* <p>IAM Identity Center settings for the checked OpenSearch Application.</p>
|
|
5717
5717
|
* @public
|
|
5718
5718
|
*/
|
|
5719
|
-
iamIdentityCenterOptions?: IamIdentityCenterOptions;
|
|
5719
|
+
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
5720
5720
|
/**
|
|
5721
5721
|
* <p>Associated data sources to the checked OpenSearch Application.</p>
|
|
5722
5722
|
* @public
|
|
5723
5723
|
*/
|
|
5724
|
-
dataSources?: DataSource[];
|
|
5724
|
+
dataSources?: DataSource[] | undefined;
|
|
5725
5725
|
/**
|
|
5726
5726
|
* <p>App configurations of the checked OpenSearch Application.</p>
|
|
5727
5727
|
* @public
|
|
5728
5728
|
*/
|
|
5729
|
-
appConfigs?: AppConfig[];
|
|
5729
|
+
appConfigs?: AppConfig[] | undefined;
|
|
5730
5730
|
/**
|
|
5731
5731
|
* <p>Timestamp at which the checked OpenSearch Application was created.</p>
|
|
5732
5732
|
* @public
|
|
5733
5733
|
*/
|
|
5734
|
-
createdAt?: Date;
|
|
5734
|
+
createdAt?: Date | undefined;
|
|
5735
5735
|
/**
|
|
5736
5736
|
* <p>Timestamp at which the checked OpenSearch Application was last updated.</p>
|
|
5737
5737
|
* @public
|
|
5738
5738
|
*/
|
|
5739
|
-
lastUpdatedAt?: Date;
|
|
5739
|
+
lastUpdatedAt?: Date | undefined;
|
|
5740
5740
|
}
|
|
5741
5741
|
/**
|
|
5742
5742
|
* <p>Container for the request parameters to <code>GetCompatibleVersions</code> operation.</p>
|
|
@@ -5748,7 +5748,7 @@ export interface GetCompatibleVersionsRequest {
|
|
|
5748
5748
|
* domain.</p>
|
|
5749
5749
|
* @public
|
|
5750
5750
|
*/
|
|
5751
|
-
DomainName?: string;
|
|
5751
|
+
DomainName?: string | undefined;
|
|
5752
5752
|
}
|
|
5753
5753
|
/**
|
|
5754
5754
|
* <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
|
|
@@ -5760,12 +5760,12 @@ export interface CompatibleVersionsMap {
|
|
|
5760
5760
|
* <p>The current version that the OpenSearch Service domain is running.</p>
|
|
5761
5761
|
* @public
|
|
5762
5762
|
*/
|
|
5763
|
-
SourceVersion?: string;
|
|
5763
|
+
SourceVersion?: string | undefined;
|
|
5764
5764
|
/**
|
|
5765
5765
|
* <p>The possible versions that you can upgrade the domain to.</p>
|
|
5766
5766
|
* @public
|
|
5767
5767
|
*/
|
|
5768
|
-
TargetVersions?: string[];
|
|
5768
|
+
TargetVersions?: string[] | undefined;
|
|
5769
5769
|
}
|
|
5770
5770
|
/**
|
|
5771
5771
|
* <p>Container for the response returned by the <code>GetCompatibleVersions</code> operation.</p>
|
|
@@ -5777,7 +5777,7 @@ export interface GetCompatibleVersionsResponse {
|
|
|
5777
5777
|
* to.</p>
|
|
5778
5778
|
* @public
|
|
5779
5779
|
*/
|
|
5780
|
-
CompatibleVersions?: CompatibleVersionsMap[];
|
|
5780
|
+
CompatibleVersions?: CompatibleVersionsMap[] | undefined;
|
|
5781
5781
|
}
|
|
5782
5782
|
/**
|
|
5783
5783
|
* <p>Container for the parameters to the <code>GetDataSource</code>
|
|
@@ -5817,22 +5817,22 @@ export interface GetDataSourceResponse {
|
|
|
5817
5817
|
* <p>The type of data source.</p>
|
|
5818
5818
|
* @public
|
|
5819
5819
|
*/
|
|
5820
|
-
DataSourceType?: DataSourceType;
|
|
5820
|
+
DataSourceType?: DataSourceType | undefined;
|
|
5821
5821
|
/**
|
|
5822
5822
|
* <p>The name of the data source.</p>
|
|
5823
5823
|
* @public
|
|
5824
5824
|
*/
|
|
5825
|
-
Name?: string;
|
|
5825
|
+
Name?: string | undefined;
|
|
5826
5826
|
/**
|
|
5827
5827
|
* <p>A description of the data source.</p>
|
|
5828
5828
|
* @public
|
|
5829
5829
|
*/
|
|
5830
|
-
Description?: string;
|
|
5830
|
+
Description?: string | undefined;
|
|
5831
5831
|
/**
|
|
5832
5832
|
* <p>The status of the data source.</p>
|
|
5833
5833
|
* @public
|
|
5834
5834
|
*/
|
|
5835
|
-
Status?: DataSourceStatus;
|
|
5835
|
+
Status?: DataSourceStatus | undefined;
|
|
5836
5836
|
}
|
|
5837
5837
|
/**
|
|
5838
5838
|
* <p>Container for the parameters to the <code>GetDomainMaintenanceStatus</code>
|
|
@@ -5888,32 +5888,32 @@ export interface GetDomainMaintenanceStatusResponse {
|
|
|
5888
5888
|
* <p>The status of the maintenance action.</p>
|
|
5889
5889
|
* @public
|
|
5890
5890
|
*/
|
|
5891
|
-
Status?: MaintenanceStatus;
|
|
5891
|
+
Status?: MaintenanceStatus | undefined;
|
|
5892
5892
|
/**
|
|
5893
5893
|
* <p>The status message of the maintenance action.</p>
|
|
5894
5894
|
* @public
|
|
5895
5895
|
*/
|
|
5896
|
-
StatusMessage?: string;
|
|
5896
|
+
StatusMessage?: string | undefined;
|
|
5897
5897
|
/**
|
|
5898
5898
|
* <p>The node ID of the maintenance action.</p>
|
|
5899
5899
|
* @public
|
|
5900
5900
|
*/
|
|
5901
|
-
NodeId?: string;
|
|
5901
|
+
NodeId?: string | undefined;
|
|
5902
5902
|
/**
|
|
5903
5903
|
* <p>The action name.</p>
|
|
5904
5904
|
* @public
|
|
5905
5905
|
*/
|
|
5906
|
-
Action?: MaintenanceType;
|
|
5906
|
+
Action?: MaintenanceType | undefined;
|
|
5907
5907
|
/**
|
|
5908
5908
|
* <p>The time at which the action was created.</p>
|
|
5909
5909
|
* @public
|
|
5910
5910
|
*/
|
|
5911
|
-
CreatedAt?: Date;
|
|
5911
|
+
CreatedAt?: Date | undefined;
|
|
5912
5912
|
/**
|
|
5913
5913
|
* <p>The time at which the action was updated.</p>
|
|
5914
5914
|
* @public
|
|
5915
5915
|
*/
|
|
5916
|
-
UpdatedAt?: Date;
|
|
5916
|
+
UpdatedAt?: Date | undefined;
|
|
5917
5917
|
}
|
|
5918
5918
|
/**
|
|
5919
5919
|
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code> operation.</p>
|
|
@@ -5930,7 +5930,7 @@ export interface GetPackageVersionHistoryRequest {
|
|
|
5930
5930
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
5931
5931
|
* @public
|
|
5932
5932
|
*/
|
|
5933
|
-
MaxResults?: number;
|
|
5933
|
+
MaxResults?: number | undefined;
|
|
5934
5934
|
/**
|
|
5935
5935
|
* <p>If your initial <code>GetPackageVersionHistory</code> operation returns a
|
|
5936
5936
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
@@ -5938,7 +5938,7 @@ export interface GetPackageVersionHistoryRequest {
|
|
|
5938
5938
|
* </p>
|
|
5939
5939
|
* @public
|
|
5940
5940
|
*/
|
|
5941
|
-
NextToken?: string;
|
|
5941
|
+
NextToken?: string | undefined;
|
|
5942
5942
|
}
|
|
5943
5943
|
/**
|
|
5944
5944
|
* <p>Details about a package version.</p>
|
|
@@ -5949,27 +5949,27 @@ export interface PackageVersionHistory {
|
|
|
5949
5949
|
* <p>The package version.</p>
|
|
5950
5950
|
* @public
|
|
5951
5951
|
*/
|
|
5952
|
-
PackageVersion?: string;
|
|
5952
|
+
PackageVersion?: string | undefined;
|
|
5953
5953
|
/**
|
|
5954
5954
|
* <p>A message associated with the package version when it was uploaded.</p>
|
|
5955
5955
|
* @public
|
|
5956
5956
|
*/
|
|
5957
|
-
CommitMessage?: string;
|
|
5957
|
+
CommitMessage?: string | undefined;
|
|
5958
5958
|
/**
|
|
5959
5959
|
* <p>The date and time when the package was created.</p>
|
|
5960
5960
|
* @public
|
|
5961
5961
|
*/
|
|
5962
|
-
CreatedAt?: Date;
|
|
5962
|
+
CreatedAt?: Date | undefined;
|
|
5963
5963
|
/**
|
|
5964
5964
|
* <p>Additional information about plugin properties if the package is a <code>ZIP-PLUGIN</code> package.</p>
|
|
5965
5965
|
* @public
|
|
5966
5966
|
*/
|
|
5967
|
-
PluginProperties?: PluginProperties;
|
|
5967
|
+
PluginProperties?: PluginProperties | undefined;
|
|
5968
5968
|
/**
|
|
5969
5969
|
* <p>The configuration details for a specific version of a package.</p>
|
|
5970
5970
|
* @public
|
|
5971
5971
|
*/
|
|
5972
|
-
PackageConfiguration?: PackageConfiguration;
|
|
5972
|
+
PackageConfiguration?: PackageConfiguration | undefined;
|
|
5973
5973
|
}
|
|
5974
5974
|
/**
|
|
5975
5975
|
* <p>Container for response returned by <code>GetPackageVersionHistory</code> operation.</p>
|
|
@@ -5980,19 +5980,19 @@ export interface GetPackageVersionHistoryResponse {
|
|
|
5980
5980
|
* <p>The unique identifier of the package.</p>
|
|
5981
5981
|
* @public
|
|
5982
5982
|
*/
|
|
5983
|
-
PackageID?: string;
|
|
5983
|
+
PackageID?: string | undefined;
|
|
5984
5984
|
/**
|
|
5985
5985
|
* <p>A list of package versions, along with their creation time and commit message.</p>
|
|
5986
5986
|
* @public
|
|
5987
5987
|
*/
|
|
5988
|
-
PackageVersionHistoryList?: PackageVersionHistory[];
|
|
5988
|
+
PackageVersionHistoryList?: PackageVersionHistory[] | undefined;
|
|
5989
5989
|
/**
|
|
5990
5990
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
5991
5991
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
5992
5992
|
* returned token to retrieve the next page.</p>
|
|
5993
5993
|
* @public
|
|
5994
5994
|
*/
|
|
5995
|
-
NextToken?: string;
|
|
5995
|
+
NextToken?: string | undefined;
|
|
5996
5996
|
}
|
|
5997
5997
|
/**
|
|
5998
5998
|
* <p>Container for the request parameters to the <code>GetUpgradeHistory</code> operation.</p>
|
|
@@ -6009,14 +6009,14 @@ export interface GetUpgradeHistoryRequest {
|
|
|
6009
6009
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
6010
6010
|
* @public
|
|
6011
6011
|
*/
|
|
6012
|
-
MaxResults?: number;
|
|
6012
|
+
MaxResults?: number | undefined;
|
|
6013
6013
|
/**
|
|
6014
6014
|
* <p>If your initial <code>GetUpgradeHistory</code> operation returns a <code>nextToken</code>,
|
|
6015
6015
|
* you can include the returned <code>nextToken</code> in subsequent <code>GetUpgradeHistory</code>
|
|
6016
6016
|
* operations, which returns results in the next page.</p>
|
|
6017
6017
|
* @public
|
|
6018
6018
|
*/
|
|
6019
|
-
NextToken?: string;
|
|
6019
|
+
NextToken?: string | undefined;
|
|
6020
6020
|
}
|
|
6021
6021
|
/**
|
|
6022
6022
|
* @public
|
|
@@ -6065,7 +6065,7 @@ export interface UpgradeStepItem {
|
|
|
6065
6065
|
* </ul>
|
|
6066
6066
|
* @public
|
|
6067
6067
|
*/
|
|
6068
|
-
UpgradeStep?: UpgradeStep;
|
|
6068
|
+
UpgradeStep?: UpgradeStep | undefined;
|
|
6069
6069
|
/**
|
|
6070
6070
|
* <p> The current status of the upgrade. The status can take one of the following values: </p>
|
|
6071
6071
|
* <ul>
|
|
@@ -6084,17 +6084,17 @@ export interface UpgradeStepItem {
|
|
|
6084
6084
|
* </ul>
|
|
6085
6085
|
* @public
|
|
6086
6086
|
*/
|
|
6087
|
-
UpgradeStepStatus?: UpgradeStatus;
|
|
6087
|
+
UpgradeStepStatus?: UpgradeStatus | undefined;
|
|
6088
6088
|
/**
|
|
6089
6089
|
* <p>A list of strings containing detailed information about the errors encountered in a particular step.</p>
|
|
6090
6090
|
* @public
|
|
6091
6091
|
*/
|
|
6092
|
-
Issues?: string[];
|
|
6092
|
+
Issues?: string[] | undefined;
|
|
6093
6093
|
/**
|
|
6094
6094
|
* <p>The floating point value representing the progress percentage of a particular step.</p>
|
|
6095
6095
|
* @public
|
|
6096
6096
|
*/
|
|
6097
|
-
ProgressPercent?: number;
|
|
6097
|
+
ProgressPercent?: number | undefined;
|
|
6098
6098
|
}
|
|
6099
6099
|
/**
|
|
6100
6100
|
* <p>History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch
|
|
@@ -6106,13 +6106,13 @@ export interface UpgradeHistory {
|
|
|
6106
6106
|
* <p>A string that describes the upgrade.</p>
|
|
6107
6107
|
* @public
|
|
6108
6108
|
*/
|
|
6109
|
-
UpgradeName?: string;
|
|
6109
|
+
UpgradeName?: string | undefined;
|
|
6110
6110
|
/**
|
|
6111
6111
|
* <p>UTC timestamp at which the upgrade API call was made, in the format
|
|
6112
6112
|
* <code>yyyy-MM-ddTHH:mm:ssZ</code>.</p>
|
|
6113
6113
|
* @public
|
|
6114
6114
|
*/
|
|
6115
|
-
StartTimestamp?: Date;
|
|
6115
|
+
StartTimestamp?: Date | undefined;
|
|
6116
6116
|
/**
|
|
6117
6117
|
* <p> The current status of the upgrade. The status can take one of the following values: </p>
|
|
6118
6118
|
* <ul>
|
|
@@ -6131,12 +6131,12 @@ export interface UpgradeHistory {
|
|
|
6131
6131
|
* </ul>
|
|
6132
6132
|
* @public
|
|
6133
6133
|
*/
|
|
6134
|
-
UpgradeStatus?: UpgradeStatus;
|
|
6134
|
+
UpgradeStatus?: UpgradeStatus | undefined;
|
|
6135
6135
|
/**
|
|
6136
6136
|
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility check.</p>
|
|
6137
6137
|
* @public
|
|
6138
6138
|
*/
|
|
6139
|
-
StepsList?: UpgradeStepItem[];
|
|
6139
|
+
StepsList?: UpgradeStepItem[] | undefined;
|
|
6140
6140
|
}
|
|
6141
6141
|
/**
|
|
6142
6142
|
* <p>Container for the response returned by the <code>GetUpgradeHistory</code> operation.</p>
|
|
@@ -6148,14 +6148,14 @@ export interface GetUpgradeHistoryResponse {
|
|
|
6148
6148
|
* domain.</p>
|
|
6149
6149
|
* @public
|
|
6150
6150
|
*/
|
|
6151
|
-
UpgradeHistories?: UpgradeHistory[];
|
|
6151
|
+
UpgradeHistories?: UpgradeHistory[] | undefined;
|
|
6152
6152
|
/**
|
|
6153
6153
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6154
6154
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6155
6155
|
* returned token to retrieve the next page.</p>
|
|
6156
6156
|
* @public
|
|
6157
6157
|
*/
|
|
6158
|
-
NextToken?: string;
|
|
6158
|
+
NextToken?: string | undefined;
|
|
6159
6159
|
}
|
|
6160
6160
|
/**
|
|
6161
6161
|
* <p>Container for the request parameters to the <code>GetUpgradeStatus</code> operation.</p>
|
|
@@ -6177,17 +6177,17 @@ export interface GetUpgradeStatusResponse {
|
|
|
6177
6177
|
* <p>One of three steps that an upgrade or upgrade eligibility check goes through.</p>
|
|
6178
6178
|
* @public
|
|
6179
6179
|
*/
|
|
6180
|
-
UpgradeStep?: UpgradeStep;
|
|
6180
|
+
UpgradeStep?: UpgradeStep | undefined;
|
|
6181
6181
|
/**
|
|
6182
6182
|
* <p>The status of the current step that an upgrade is on.</p>
|
|
6183
6183
|
* @public
|
|
6184
6184
|
*/
|
|
6185
|
-
StepStatus?: UpgradeStatus;
|
|
6185
|
+
StepStatus?: UpgradeStatus | undefined;
|
|
6186
6186
|
/**
|
|
6187
6187
|
* <p>A string that describes the update.</p>
|
|
6188
6188
|
* @public
|
|
6189
6189
|
*/
|
|
6190
|
-
UpgradeName?: string;
|
|
6190
|
+
UpgradeName?: string | undefined;
|
|
6191
6191
|
}
|
|
6192
6192
|
/**
|
|
6193
6193
|
* @public
|
|
@@ -6199,18 +6199,18 @@ export interface ListApplicationsRequest {
|
|
|
6199
6199
|
* returned token to retrieve the next page.</p>
|
|
6200
6200
|
* @public
|
|
6201
6201
|
*/
|
|
6202
|
-
nextToken?: string;
|
|
6202
|
+
nextToken?: string | undefined;
|
|
6203
6203
|
/**
|
|
6204
6204
|
* <p>OpenSearch Application Status can be used as filters for the listing request. Possible values are <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6205
6205
|
* @public
|
|
6206
6206
|
*/
|
|
6207
|
-
statuses?: ApplicationStatus[];
|
|
6207
|
+
statuses?: ApplicationStatus[] | undefined;
|
|
6208
6208
|
/**
|
|
6209
6209
|
* <p>An optional parameter that specifies the maximum number of results to return for a given
|
|
6210
6210
|
* request.</p>
|
|
6211
6211
|
* @public
|
|
6212
6212
|
*/
|
|
6213
|
-
maxResults?: number;
|
|
6213
|
+
maxResults?: number | undefined;
|
|
6214
6214
|
}
|
|
6215
6215
|
/**
|
|
6216
6216
|
* <p>Basic information of the OpenSearch Application.</p>
|
|
@@ -6221,39 +6221,39 @@ export interface ApplicationSummary {
|
|
|
6221
6221
|
* <p>Unique identifier for an OpenSearch application.</p>
|
|
6222
6222
|
* @public
|
|
6223
6223
|
*/
|
|
6224
|
-
id?: string;
|
|
6224
|
+
id?: string | undefined;
|
|
6225
6225
|
/**
|
|
6226
6226
|
* <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
|
|
6227
6227
|
* </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.
|
|
6228
6228
|
* </p>
|
|
6229
6229
|
* @public
|
|
6230
6230
|
*/
|
|
6231
|
-
arn?: string;
|
|
6231
|
+
arn?: string | undefined;
|
|
6232
6232
|
/**
|
|
6233
6233
|
* <p>Name of an OpenSearch Application.</p>
|
|
6234
6234
|
* @public
|
|
6235
6235
|
*/
|
|
6236
|
-
name?: string;
|
|
6236
|
+
name?: string | undefined;
|
|
6237
6237
|
/**
|
|
6238
6238
|
* <p>Endpoint URL of an OpenSearch Application.</p>
|
|
6239
6239
|
* @public
|
|
6240
6240
|
*/
|
|
6241
|
-
endpoint?: string;
|
|
6241
|
+
endpoint?: string | undefined;
|
|
6242
6242
|
/**
|
|
6243
6243
|
* <p>Status of an OpenSearch Application. Possible values are <code>CREATING</code>, <code>UPDATING</code>,<code> DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6244
6244
|
* @public
|
|
6245
6245
|
*/
|
|
6246
|
-
status?: ApplicationStatus;
|
|
6246
|
+
status?: ApplicationStatus | undefined;
|
|
6247
6247
|
/**
|
|
6248
6248
|
* <p>Timestamp at which an OpenSearch Application was created.</p>
|
|
6249
6249
|
* @public
|
|
6250
6250
|
*/
|
|
6251
|
-
createdAt?: Date;
|
|
6251
|
+
createdAt?: Date | undefined;
|
|
6252
6252
|
/**
|
|
6253
6253
|
* <p>Timestamp at which an OpenSearch Application was last updated.</p>
|
|
6254
6254
|
* @public
|
|
6255
6255
|
*/
|
|
6256
|
-
lastUpdatedAt?: Date;
|
|
6256
|
+
lastUpdatedAt?: Date | undefined;
|
|
6257
6257
|
}
|
|
6258
6258
|
/**
|
|
6259
6259
|
* @public
|
|
@@ -6263,14 +6263,14 @@ export interface ListApplicationsResponse {
|
|
|
6263
6263
|
* <p>Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.</p>
|
|
6264
6264
|
* @public
|
|
6265
6265
|
*/
|
|
6266
|
-
ApplicationSummaries?: ApplicationSummary[];
|
|
6266
|
+
ApplicationSummaries?: ApplicationSummary[] | undefined;
|
|
6267
6267
|
/**
|
|
6268
6268
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6269
6269
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6270
6270
|
* returned token to retrieve the next page.</p>
|
|
6271
6271
|
* @public
|
|
6272
6272
|
*/
|
|
6273
|
-
nextToken?: string;
|
|
6273
|
+
nextToken?: string | undefined;
|
|
6274
6274
|
}
|
|
6275
6275
|
/**
|
|
6276
6276
|
* <p>Container for the parameters to the <code>ListDataSources</code>
|
|
@@ -6293,22 +6293,22 @@ export interface DataSourceDetails {
|
|
|
6293
6293
|
* <p>The type of data source.</p>
|
|
6294
6294
|
* @public
|
|
6295
6295
|
*/
|
|
6296
|
-
DataSourceType?: DataSourceType;
|
|
6296
|
+
DataSourceType?: DataSourceType | undefined;
|
|
6297
6297
|
/**
|
|
6298
6298
|
* <p>The name of the data source.</p>
|
|
6299
6299
|
* @public
|
|
6300
6300
|
*/
|
|
6301
|
-
Name?: string;
|
|
6301
|
+
Name?: string | undefined;
|
|
6302
6302
|
/**
|
|
6303
6303
|
* <p>A description of the data source.</p>
|
|
6304
6304
|
* @public
|
|
6305
6305
|
*/
|
|
6306
|
-
Description?: string;
|
|
6306
|
+
Description?: string | undefined;
|
|
6307
6307
|
/**
|
|
6308
6308
|
* <p>The status of the data source.</p>
|
|
6309
6309
|
* @public
|
|
6310
6310
|
*/
|
|
6311
|
-
Status?: DataSourceStatus;
|
|
6311
|
+
Status?: DataSourceStatus | undefined;
|
|
6312
6312
|
}
|
|
6313
6313
|
/**
|
|
6314
6314
|
* <p>The result of a <code>ListDataSources</code> operation.</p>
|
|
@@ -6319,7 +6319,7 @@ export interface ListDataSourcesResponse {
|
|
|
6319
6319
|
* <p>A list of data sources associated with specified domain.</p>
|
|
6320
6320
|
* @public
|
|
6321
6321
|
*/
|
|
6322
|
-
DataSources?: DataSourceDetails[];
|
|
6322
|
+
DataSources?: DataSourceDetails[] | undefined;
|
|
6323
6323
|
}
|
|
6324
6324
|
/**
|
|
6325
6325
|
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
@@ -6336,25 +6336,25 @@ export interface ListDomainMaintenancesRequest {
|
|
|
6336
6336
|
* <p>The name of the action.</p>
|
|
6337
6337
|
* @public
|
|
6338
6338
|
*/
|
|
6339
|
-
Action?: MaintenanceType;
|
|
6339
|
+
Action?: MaintenanceType | undefined;
|
|
6340
6340
|
/**
|
|
6341
6341
|
* <p>The status of the action.</p>
|
|
6342
6342
|
* @public
|
|
6343
6343
|
*/
|
|
6344
|
-
Status?: MaintenanceStatus;
|
|
6344
|
+
Status?: MaintenanceStatus | undefined;
|
|
6345
6345
|
/**
|
|
6346
6346
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6347
6347
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
6348
6348
|
* @public
|
|
6349
6349
|
*/
|
|
6350
|
-
MaxResults?: number;
|
|
6350
|
+
MaxResults?: number | undefined;
|
|
6351
6351
|
/**
|
|
6352
6352
|
* <p>If your initial <code>ListDomainMaintenances</code> operation returns a
|
|
6353
6353
|
* <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent
|
|
6354
6354
|
* <code>ListDomainMaintenances</code> operations, which returns results in the next page.</p>
|
|
6355
6355
|
* @public
|
|
6356
6356
|
*/
|
|
6357
|
-
NextToken?: string;
|
|
6357
|
+
NextToken?: string | undefined;
|
|
6358
6358
|
}
|
|
6359
6359
|
/**
|
|
6360
6360
|
* <p>Container for the domain maintenance details.</p>
|
|
@@ -6365,42 +6365,42 @@ export interface DomainMaintenanceDetails {
|
|
|
6365
6365
|
* <p>The ID of the requested action.</p>
|
|
6366
6366
|
* @public
|
|
6367
6367
|
*/
|
|
6368
|
-
MaintenanceId?: string;
|
|
6368
|
+
MaintenanceId?: string | undefined;
|
|
6369
6369
|
/**
|
|
6370
6370
|
* <p>The name of the domain.</p>
|
|
6371
6371
|
* @public
|
|
6372
6372
|
*/
|
|
6373
|
-
DomainName?: string;
|
|
6373
|
+
DomainName?: string | undefined;
|
|
6374
6374
|
/**
|
|
6375
6375
|
* <p>The name of the action.</p>
|
|
6376
6376
|
* @public
|
|
6377
6377
|
*/
|
|
6378
|
-
Action?: MaintenanceType;
|
|
6378
|
+
Action?: MaintenanceType | undefined;
|
|
6379
6379
|
/**
|
|
6380
6380
|
* <p>The ID of the data node.</p>
|
|
6381
6381
|
* @public
|
|
6382
6382
|
*/
|
|
6383
|
-
NodeId?: string;
|
|
6383
|
+
NodeId?: string | undefined;
|
|
6384
6384
|
/**
|
|
6385
6385
|
* <p>The status of the action.</p>
|
|
6386
6386
|
* @public
|
|
6387
6387
|
*/
|
|
6388
|
-
Status?: MaintenanceStatus;
|
|
6388
|
+
Status?: MaintenanceStatus | undefined;
|
|
6389
6389
|
/**
|
|
6390
6390
|
* <p>The status message for the action.</p>
|
|
6391
6391
|
* @public
|
|
6392
6392
|
*/
|
|
6393
|
-
StatusMessage?: string;
|
|
6393
|
+
StatusMessage?: string | undefined;
|
|
6394
6394
|
/**
|
|
6395
6395
|
* <p>The time at which the action was created.</p>
|
|
6396
6396
|
* @public
|
|
6397
6397
|
*/
|
|
6398
|
-
CreatedAt?: Date;
|
|
6398
|
+
CreatedAt?: Date | undefined;
|
|
6399
6399
|
/**
|
|
6400
6400
|
* <p>The time at which the action was updated.</p>
|
|
6401
6401
|
* @public
|
|
6402
6402
|
*/
|
|
6403
|
-
UpdatedAt?: Date;
|
|
6403
|
+
UpdatedAt?: Date | undefined;
|
|
6404
6404
|
}
|
|
6405
6405
|
/**
|
|
6406
6406
|
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information about the requested actions. </p>
|
|
@@ -6411,14 +6411,14 @@ export interface ListDomainMaintenancesResponse {
|
|
|
6411
6411
|
* <p>A list of the submitted maintenance actions.</p>
|
|
6412
6412
|
* @public
|
|
6413
6413
|
*/
|
|
6414
|
-
DomainMaintenances?: DomainMaintenanceDetails[];
|
|
6414
|
+
DomainMaintenances?: DomainMaintenanceDetails[] | undefined;
|
|
6415
6415
|
/**
|
|
6416
6416
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6417
6417
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6418
6418
|
* returned token to retrieve the next page.</p>
|
|
6419
6419
|
* @public
|
|
6420
6420
|
*/
|
|
6421
|
-
NextToken?: string;
|
|
6421
|
+
NextToken?: string | undefined;
|
|
6422
6422
|
}
|
|
6423
6423
|
/**
|
|
6424
6424
|
* @public
|
|
@@ -6441,7 +6441,7 @@ export interface ListDomainNamesRequest {
|
|
|
6441
6441
|
* <p>Filters the output by domain engine type.</p>
|
|
6442
6442
|
* @public
|
|
6443
6443
|
*/
|
|
6444
|
-
EngineType?: EngineType;
|
|
6444
|
+
EngineType?: EngineType | undefined;
|
|
6445
6445
|
}
|
|
6446
6446
|
/**
|
|
6447
6447
|
* <p>Information about an OpenSearch Service domain.</p>
|
|
@@ -6452,13 +6452,13 @@ export interface DomainInfo {
|
|
|
6452
6452
|
* <p>Name of the domain.</p>
|
|
6453
6453
|
* @public
|
|
6454
6454
|
*/
|
|
6455
|
-
DomainName?: string;
|
|
6455
|
+
DomainName?: string | undefined;
|
|
6456
6456
|
/**
|
|
6457
6457
|
* <p>The type of search engine that the domain is running.<code>OpenSearch</code> for an
|
|
6458
6458
|
* OpenSearch engine, or <code>Elasticsearch</code> for a legacy Elasticsearch OSS engine.</p>
|
|
6459
6459
|
* @public
|
|
6460
6460
|
*/
|
|
6461
|
-
EngineType?: EngineType;
|
|
6461
|
+
EngineType?: EngineType | undefined;
|
|
6462
6462
|
}
|
|
6463
6463
|
/**
|
|
6464
6464
|
* <p>The results of a <code>ListDomainNames</code> operation. Contains the names of all domains
|
|
@@ -6471,7 +6471,7 @@ export interface ListDomainNamesResponse {
|
|
|
6471
6471
|
* engine types.</p>
|
|
6472
6472
|
* @public
|
|
6473
6473
|
*/
|
|
6474
|
-
DomainNames?: DomainInfo[];
|
|
6474
|
+
DomainNames?: DomainInfo[] | undefined;
|
|
6475
6475
|
}
|
|
6476
6476
|
/**
|
|
6477
6477
|
* <p>Container for the request parameters to the <code>ListDomainsForPackage</code> operation.</p>
|
|
@@ -6488,14 +6488,14 @@ export interface ListDomainsForPackageRequest {
|
|
|
6488
6488
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
6489
6489
|
* @public
|
|
6490
6490
|
*/
|
|
6491
|
-
MaxResults?: number;
|
|
6491
|
+
MaxResults?: number | undefined;
|
|
6492
6492
|
/**
|
|
6493
6493
|
* <p>If your initial <code>ListDomainsForPackage</code> operation returns a
|
|
6494
6494
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
6495
6495
|
* <code>ListDomainsForPackage</code> operations, which returns results in the next page.</p>
|
|
6496
6496
|
* @public
|
|
6497
6497
|
*/
|
|
6498
|
-
NextToken?: string;
|
|
6498
|
+
NextToken?: string | undefined;
|
|
6499
6499
|
}
|
|
6500
6500
|
/**
|
|
6501
6501
|
* <p>Container for the response parameters to the <code>ListDomainsForPackage</code> operation.</p>
|
|
@@ -6506,14 +6506,14 @@ export interface ListDomainsForPackageResponse {
|
|
|
6506
6506
|
* <p>Information about all domains associated with a package.</p>
|
|
6507
6507
|
* @public
|
|
6508
6508
|
*/
|
|
6509
|
-
DomainPackageDetailsList?: DomainPackageDetails[];
|
|
6509
|
+
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
6510
6510
|
/**
|
|
6511
6511
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6512
6512
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6513
6513
|
* returned token to retrieve the next page.</p>
|
|
6514
6514
|
* @public
|
|
6515
6515
|
*/
|
|
6516
|
-
NextToken?: string;
|
|
6516
|
+
NextToken?: string | undefined;
|
|
6517
6517
|
}
|
|
6518
6518
|
/**
|
|
6519
6519
|
* @public
|
|
@@ -6529,30 +6529,30 @@ export interface ListInstanceTypeDetailsRequest {
|
|
|
6529
6529
|
* <p>The name of the domain.</p>
|
|
6530
6530
|
* @public
|
|
6531
6531
|
*/
|
|
6532
|
-
DomainName?: string;
|
|
6532
|
+
DomainName?: string | undefined;
|
|
6533
6533
|
/**
|
|
6534
6534
|
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6535
6535
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
6536
6536
|
* @public
|
|
6537
6537
|
*/
|
|
6538
|
-
MaxResults?: number;
|
|
6538
|
+
MaxResults?: number | undefined;
|
|
6539
6539
|
/**
|
|
6540
6540
|
* <p>If your initial <code>ListInstanceTypeDetails</code> operation returns a
|
|
6541
6541
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
6542
6542
|
* <code>ListInstanceTypeDetails</code> operations, which returns results in the next page.</p>
|
|
6543
6543
|
* @public
|
|
6544
6544
|
*/
|
|
6545
|
-
NextToken?: string;
|
|
6545
|
+
NextToken?: string | undefined;
|
|
6546
6546
|
/**
|
|
6547
6547
|
* <p>An optional parameter that specifies the Availability Zones for the domain.</p>
|
|
6548
6548
|
* @public
|
|
6549
6549
|
*/
|
|
6550
|
-
RetrieveAZs?: boolean;
|
|
6550
|
+
RetrieveAZs?: boolean | undefined;
|
|
6551
6551
|
/**
|
|
6552
6552
|
* <p>An optional parameter that lists information for a given instance type.</p>
|
|
6553
6553
|
* @public
|
|
6554
6554
|
*/
|
|
6555
|
-
InstanceType?: string;
|
|
6555
|
+
InstanceType?: string | undefined;
|
|
6556
6556
|
}
|
|
6557
6557
|
/**
|
|
6558
6558
|
* <p>Lists all instance types and available features for a given OpenSearch or Elasticsearch
|
|
@@ -6564,44 +6564,44 @@ export interface InstanceTypeDetails {
|
|
|
6564
6564
|
* <p>The instance type.</p>
|
|
6565
6565
|
* @public
|
|
6566
6566
|
*/
|
|
6567
|
-
InstanceType?: OpenSearchPartitionInstanceType;
|
|
6567
|
+
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
6568
6568
|
/**
|
|
6569
6569
|
* <p>Whether encryption at rest and node-to-node encryption are supported for the instance
|
|
6570
6570
|
* type.</p>
|
|
6571
6571
|
* @public
|
|
6572
6572
|
*/
|
|
6573
|
-
EncryptionEnabled?: boolean;
|
|
6573
|
+
EncryptionEnabled?: boolean | undefined;
|
|
6574
6574
|
/**
|
|
6575
6575
|
* <p>Whether Amazon Cognito access is supported for the instance type.</p>
|
|
6576
6576
|
* @public
|
|
6577
6577
|
*/
|
|
6578
|
-
CognitoEnabled?: boolean;
|
|
6578
|
+
CognitoEnabled?: boolean | undefined;
|
|
6579
6579
|
/**
|
|
6580
6580
|
* <p>Whether logging is supported for the instance type.</p>
|
|
6581
6581
|
* @public
|
|
6582
6582
|
*/
|
|
6583
|
-
AppLogsEnabled?: boolean;
|
|
6583
|
+
AppLogsEnabled?: boolean | undefined;
|
|
6584
6584
|
/**
|
|
6585
6585
|
* <p>Whether fine-grained access control is supported for the instance type.</p>
|
|
6586
6586
|
* @public
|
|
6587
6587
|
*/
|
|
6588
|
-
AdvancedSecurityEnabled?: boolean;
|
|
6588
|
+
AdvancedSecurityEnabled?: boolean | undefined;
|
|
6589
6589
|
/**
|
|
6590
6590
|
* <p>Whether UltraWarm is supported for the instance type.</p>
|
|
6591
6591
|
* @public
|
|
6592
6592
|
*/
|
|
6593
|
-
WarmEnabled?: boolean;
|
|
6593
|
+
WarmEnabled?: boolean | undefined;
|
|
6594
6594
|
/**
|
|
6595
6595
|
* <p>Whether the instance acts as a data node, a dedicated master node, or an UltraWarm
|
|
6596
6596
|
* node.</p>
|
|
6597
6597
|
* @public
|
|
6598
6598
|
*/
|
|
6599
|
-
InstanceRole?: string[];
|
|
6599
|
+
InstanceRole?: string[] | undefined;
|
|
6600
6600
|
/**
|
|
6601
6601
|
* <p>The supported Availability Zones for the instance type.</p>
|
|
6602
6602
|
* @public
|
|
6603
6603
|
*/
|
|
6604
|
-
AvailabilityZones?: string[];
|
|
6604
|
+
AvailabilityZones?: string[] | undefined;
|
|
6605
6605
|
}
|
|
6606
6606
|
/**
|
|
6607
6607
|
* @public
|
|
@@ -6612,14 +6612,14 @@ export interface ListInstanceTypeDetailsResponse {
|
|
|
6612
6612
|
* version.</p>
|
|
6613
6613
|
* @public
|
|
6614
6614
|
*/
|
|
6615
|
-
InstanceTypeDetails?: InstanceTypeDetails[];
|
|
6615
|
+
InstanceTypeDetails?: InstanceTypeDetails[] | undefined;
|
|
6616
6616
|
/**
|
|
6617
6617
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6618
6618
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6619
6619
|
* returned token to retrieve the next page.</p>
|
|
6620
6620
|
* @public
|
|
6621
6621
|
*/
|
|
6622
|
-
NextToken?: string;
|
|
6622
|
+
NextToken?: string | undefined;
|
|
6623
6623
|
}
|
|
6624
6624
|
/**
|
|
6625
6625
|
* <p>Container for the request parameters to the <code>ListPackagesForDomain</code> operation.</p>
|
|
@@ -6636,14 +6636,14 @@ export interface ListPackagesForDomainRequest {
|
|
|
6636
6636
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
6637
6637
|
* @public
|
|
6638
6638
|
*/
|
|
6639
|
-
MaxResults?: number;
|
|
6639
|
+
MaxResults?: number | undefined;
|
|
6640
6640
|
/**
|
|
6641
6641
|
* <p>If your initial <code>ListPackagesForDomain</code> operation returns a
|
|
6642
6642
|
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
6643
6643
|
* <code>ListPackagesForDomain</code> operations, which returns results in the next page.</p>
|
|
6644
6644
|
* @public
|
|
6645
6645
|
*/
|
|
6646
|
-
NextToken?: string;
|
|
6646
|
+
NextToken?: string | undefined;
|
|
6647
6647
|
}
|
|
6648
6648
|
/**
|
|
6649
6649
|
* <p>Container for the response parameters to the <code>ListPackagesForDomain</code> operation.</p>
|
|
@@ -6654,14 +6654,14 @@ export interface ListPackagesForDomainResponse {
|
|
|
6654
6654
|
* <p>List of all packages associated with a domain.</p>
|
|
6655
6655
|
* @public
|
|
6656
6656
|
*/
|
|
6657
|
-
DomainPackageDetailsList?: DomainPackageDetails[];
|
|
6657
|
+
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
6658
6658
|
/**
|
|
6659
6659
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6660
6660
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6661
6661
|
* returned token to retrieve the next page.</p>
|
|
6662
6662
|
* @public
|
|
6663
6663
|
*/
|
|
6664
|
-
NextToken?: string;
|
|
6664
|
+
NextToken?: string | undefined;
|
|
6665
6665
|
}
|
|
6666
6666
|
/**
|
|
6667
6667
|
* @public
|
|
@@ -6677,14 +6677,14 @@ export interface ListScheduledActionsRequest {
|
|
|
6677
6677
|
* <code>nextToken</code> to get the next page of results.</p>
|
|
6678
6678
|
* @public
|
|
6679
6679
|
*/
|
|
6680
|
-
MaxResults?: number;
|
|
6680
|
+
MaxResults?: number | undefined;
|
|
6681
6681
|
/**
|
|
6682
6682
|
* <p>If your initial <code>ListScheduledActions</code> operation returns a <code>nextToken</code>, you
|
|
6683
6683
|
* can include the returned <code>nextToken</code> in subsequent <code>ListScheduledActions</code>
|
|
6684
6684
|
* operations, which returns results in the next page.</p>
|
|
6685
6685
|
* @public
|
|
6686
6686
|
*/
|
|
6687
|
-
NextToken?: string;
|
|
6687
|
+
NextToken?: string | undefined;
|
|
6688
6688
|
}
|
|
6689
6689
|
/**
|
|
6690
6690
|
* @public
|
|
@@ -6730,27 +6730,27 @@ export interface ScheduledAction {
|
|
|
6730
6730
|
* <p>A description of the action to be taken.</p>
|
|
6731
6731
|
* @public
|
|
6732
6732
|
*/
|
|
6733
|
-
Description?: string;
|
|
6733
|
+
Description?: string | undefined;
|
|
6734
6734
|
/**
|
|
6735
6735
|
* <p>Whether the action was scheduled manually (<code>CUSTOMER</code>, or by OpenSearch Service automatically (<code>SYSTEM</code>).</p>
|
|
6736
6736
|
* @public
|
|
6737
6737
|
*/
|
|
6738
|
-
ScheduledBy?: ScheduledBy;
|
|
6738
|
+
ScheduledBy?: ScheduledBy | undefined;
|
|
6739
6739
|
/**
|
|
6740
6740
|
* <p>The current status of the scheduled action.</p>
|
|
6741
6741
|
* @public
|
|
6742
6742
|
*/
|
|
6743
|
-
Status?: ActionStatus;
|
|
6743
|
+
Status?: ActionStatus | undefined;
|
|
6744
6744
|
/**
|
|
6745
6745
|
* <p>Whether the action is required or optional.</p>
|
|
6746
6746
|
* @public
|
|
6747
6747
|
*/
|
|
6748
|
-
Mandatory?: boolean;
|
|
6748
|
+
Mandatory?: boolean | undefined;
|
|
6749
6749
|
/**
|
|
6750
6750
|
* <p>Whether or not the scheduled action is cancellable.</p>
|
|
6751
6751
|
* @public
|
|
6752
6752
|
*/
|
|
6753
|
-
Cancellable?: boolean;
|
|
6753
|
+
Cancellable?: boolean | undefined;
|
|
6754
6754
|
}
|
|
6755
6755
|
/**
|
|
6756
6756
|
* @public
|
|
@@ -6760,14 +6760,14 @@ export interface ListScheduledActionsResponse {
|
|
|
6760
6760
|
* <p>A list of actions that are scheduled for the domain.</p>
|
|
6761
6761
|
* @public
|
|
6762
6762
|
*/
|
|
6763
|
-
ScheduledActions?: ScheduledAction[];
|
|
6763
|
+
ScheduledActions?: ScheduledAction[] | undefined;
|
|
6764
6764
|
/**
|
|
6765
6765
|
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6766
6766
|
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using the
|
|
6767
6767
|
* returned token to retrieve the next page.</p>
|
|
6768
6768
|
* @public
|
|
6769
6769
|
*/
|
|
6770
|
-
NextToken?: string;
|
|
6770
|
+
NextToken?: string | undefined;
|
|
6771
6771
|
}
|
|
6772
6772
|
/**
|
|
6773
6773
|
* <p>Container for the parameters to the <code>ListTags</code> operation.</p>
|
|
@@ -6789,7 +6789,7 @@ export interface ListTagsResponse {
|
|
|
6789
6789
|
* <p>List of resource tags associated with the specified domain.</p>
|
|
6790
6790
|
* @public
|
|
6791
6791
|
*/
|
|
6792
|
-
TagList?: Tag[];
|
|
6792
|
+
TagList?: Tag[] | undefined;
|
|
6793
6793
|
}
|
|
6794
6794
|
/**
|
|
6795
6795
|
* @internal
|