@aws-sdk/client-opensearch 3.931.0 → 3.933.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist-cjs/index.js +171 -1
- package/dist-es/OpenSearch.js +8 -0
- package/dist-es/commands/CreateIndexCommand.js +16 -0
- package/dist-es/commands/DeleteIndexCommand.js +16 -0
- package/dist-es/commands/GetIndexCommand.js +16 -0
- package/dist-es/commands/UpdateIndexCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +17 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/schemas/schemas_0.js +96 -1
- package/dist-types/OpenSearch.d.ts +28 -0
- package/dist-types/OpenSearchClient.d.ts +6 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +100 -0
- package/dist-types/commands/CreateOutboundConnectionCommand.d.ts +3 -2
- package/dist-types/commands/DeleteIndexCommand.d.ts +96 -0
- package/dist-types/commands/DissociatePackagesCommand.d.ts +1 -1
- package/dist-types/commands/GetDirectQueryDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/GetIndexCommand.d.ts +96 -0
- package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts +4 -4
- package/dist-types/commands/GetUpgradeHistoryCommand.d.ts +2 -2
- package/dist-types/commands/GetUpgradeStatusCommand.d.ts +2 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListDomainMaintenancesCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIndexCommand.d.ts +97 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +229 -329
- package/dist-types/models/models_1.d.ts +231 -5
- package/dist-types/schemas/schemas_0.d.ts +13 -0
- package/dist-types/ts3.4/OpenSearch.d.ts +68 -0
- package/dist-types/ts3.4/OpenSearchClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListDirectQueryDataSourcesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDomainMaintenancesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +36 -44
- package/dist-types/ts3.4/models/models_1.d.ts +56 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +13 -0
- package/package.json +6 -6
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
3
|
import { OpenSearchServiceException as __BaseException } from "./OpenSearchServiceException";
|
|
3
4
|
/**
|
|
4
5
|
* <p>Container for the parameters to the <code>AcceptInboundConnection</code>
|
|
@@ -52,43 +53,42 @@ export interface InboundConnectionStatus {
|
|
|
52
53
|
* <ul>
|
|
53
54
|
* <li>
|
|
54
55
|
* <p>
|
|
55
|
-
* <b>PENDING_ACCEPTANCE</b> - Inbound connection is
|
|
56
|
-
*
|
|
56
|
+
* <b>PENDING_ACCEPTANCE</b> - Inbound connection is not yet
|
|
57
|
+
* accepted by the remote domain owner.</p>
|
|
57
58
|
* </li>
|
|
58
59
|
* <li>
|
|
59
60
|
* <p>
|
|
60
|
-
* <b>APPROVED</b>: Inbound connection is pending
|
|
61
|
-
*
|
|
61
|
+
* <b>APPROVED</b>: Inbound connection is pending acceptance by the
|
|
62
|
+
* remote domain owner.</p>
|
|
62
63
|
* </li>
|
|
63
64
|
* <li>
|
|
64
65
|
* <p>
|
|
65
66
|
* <b>PROVISIONING</b>: Inbound connection is being
|
|
66
|
-
*
|
|
67
|
+
* provisioned.</p>
|
|
67
68
|
* </li>
|
|
68
69
|
* <li>
|
|
69
70
|
* <p>
|
|
70
|
-
* <b>ACTIVE</b>: Inbound connection is active and
|
|
71
|
-
*
|
|
71
|
+
* <b>ACTIVE</b>: Inbound connection is active and ready to
|
|
72
|
+
* use.</p>
|
|
72
73
|
* </li>
|
|
73
74
|
* <li>
|
|
74
75
|
* <p>
|
|
75
76
|
* <b>REJECTING</b>: Inbound connection rejection is in
|
|
76
|
-
*
|
|
77
|
+
* process.</p>
|
|
77
78
|
* </li>
|
|
78
79
|
* <li>
|
|
79
80
|
* <p>
|
|
80
|
-
* <b>REJECTED</b>: Inbound connection is
|
|
81
|
-
* rejected.</p>
|
|
81
|
+
* <b>REJECTED</b>: Inbound connection is rejected.</p>
|
|
82
82
|
* </li>
|
|
83
83
|
* <li>
|
|
84
84
|
* <p>
|
|
85
85
|
* <b>DELETING</b>: Inbound connection deletion is in
|
|
86
|
-
*
|
|
86
|
+
* progress.</p>
|
|
87
87
|
* </li>
|
|
88
88
|
* <li>
|
|
89
89
|
* <p>
|
|
90
|
-
* <b>DELETED</b>: Inbound connection is deleted and
|
|
91
|
-
*
|
|
90
|
+
* <b>DELETED</b>: Inbound connection is deleted and can no longer
|
|
91
|
+
* be used.</p>
|
|
92
92
|
* </li>
|
|
93
93
|
* </ul>
|
|
94
94
|
* @public
|
|
@@ -134,7 +134,8 @@ export interface DomainInformationContainer {
|
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
136
|
* <p>Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more
|
|
137
|
-
*
|
|
137
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search
|
|
138
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
138
139
|
* @public
|
|
139
140
|
*/
|
|
140
141
|
export interface InboundConnection {
|
|
@@ -1284,7 +1285,7 @@ export interface DomainPackageDetails {
|
|
|
1284
1285
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
1285
1286
|
/**
|
|
1286
1287
|
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is
|
|
1287
|
-
*
|
|
1288
|
+
* <code>synonym_path</code> when the package is for synonym files.</p>
|
|
1288
1289
|
* @public
|
|
1289
1290
|
*/
|
|
1290
1291
|
ReferencePath?: string | undefined;
|
|
@@ -1608,9 +1609,8 @@ export declare const AppConfigType: {
|
|
|
1608
1609
|
*/
|
|
1609
1610
|
export type AppConfigType = (typeof AppConfigType)[keyof typeof AppConfigType];
|
|
1610
1611
|
/**
|
|
1611
|
-
* <p>Configuration settings for an OpenSearch application. For more information, see
|
|
1612
|
-
*
|
|
1613
|
-
* user interface in Amazon OpenSearch Service</a>.</p>
|
|
1612
|
+
* <p>Configuration settings for an OpenSearch application. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using the
|
|
1613
|
+
* OpenSearch user interface in Amazon OpenSearch Service</a>.</p>
|
|
1614
1614
|
* @public
|
|
1615
1615
|
*/
|
|
1616
1616
|
export interface AppConfig {
|
|
@@ -1710,8 +1710,7 @@ export interface CreateApplicationRequest {
|
|
|
1710
1710
|
*/
|
|
1711
1711
|
export interface IamIdentityCenterOptions {
|
|
1712
1712
|
/**
|
|
1713
|
-
* <p>Indicates whether IAM Identity Center is enabled for the OpenSearch
|
|
1714
|
-
* application.</p>
|
|
1713
|
+
* <p>Indicates whether IAM Identity Center is enabled for the OpenSearch application.</p>
|
|
1715
1714
|
* @public
|
|
1716
1715
|
*/
|
|
1717
1716
|
enabled?: boolean | undefined;
|
|
@@ -1724,7 +1723,7 @@ export interface IamIdentityCenterOptions {
|
|
|
1724
1723
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
1725
1724
|
/**
|
|
1726
1725
|
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center
|
|
1727
|
-
*
|
|
1726
|
+
* application for the OpenSearch application.</p>
|
|
1728
1727
|
* @public
|
|
1729
1728
|
*/
|
|
1730
1729
|
iamRoleForIdentityCenterApplicationArn?: string | undefined;
|
|
@@ -2356,25 +2355,25 @@ export type SubjectKeyIdCOption = (typeof SubjectKeyIdCOption)[keyof typeof Subj
|
|
|
2356
2355
|
export interface IdentityCenterOptionsInput {
|
|
2357
2356
|
/**
|
|
2358
2357
|
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch
|
|
2359
|
-
*
|
|
2358
|
+
* Service.</p>
|
|
2360
2359
|
* @public
|
|
2361
2360
|
*/
|
|
2362
2361
|
EnabledAPIAccess?: boolean | undefined;
|
|
2363
2362
|
/**
|
|
2364
|
-
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI
|
|
2365
|
-
*
|
|
2363
|
+
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that
|
|
2364
|
+
* uses IAM Identity Center for authentication.</p>
|
|
2366
2365
|
* @public
|
|
2367
2366
|
*/
|
|
2368
2367
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2369
2368
|
/**
|
|
2370
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user
|
|
2371
|
-
*
|
|
2369
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2370
|
+
* email) in IAM Identity Center.</p>
|
|
2372
2371
|
* @public
|
|
2373
2372
|
*/
|
|
2374
2373
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2375
2374
|
/**
|
|
2376
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name
|
|
2377
|
-
*
|
|
2375
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2376
|
+
* group ID) in IAM Identity Center.</p>
|
|
2378
2377
|
* @public
|
|
2379
2378
|
*/
|
|
2380
2379
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
@@ -2586,16 +2585,16 @@ export interface CreateDomainRequest {
|
|
|
2586
2585
|
*/
|
|
2587
2586
|
IPAddressType?: IPAddressType | undefined;
|
|
2588
2587
|
/**
|
|
2589
|
-
* <p>DEPRECATED. Container for the parameters required to configure automated snapshots of
|
|
2590
|
-
*
|
|
2588
|
+
* <p>DEPRECATED. Container for the parameters required to configure automated snapshots of domain
|
|
2589
|
+
* indexes.</p>
|
|
2591
2590
|
* @public
|
|
2592
2591
|
*/
|
|
2593
2592
|
SnapshotOptions?: SnapshotOptions | undefined;
|
|
2594
2593
|
/**
|
|
2595
|
-
* <p>Container for the values required to configure VPC access domains. If you don't
|
|
2596
|
-
*
|
|
2597
|
-
*
|
|
2598
|
-
*
|
|
2594
|
+
* <p>Container for the values required to configure VPC access domains. If you don't specify
|
|
2595
|
+
* these values, OpenSearch Service creates the domain with a public endpoint. For more information,
|
|
2596
|
+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching
|
|
2597
|
+
* your Amazon OpenSearch Service domains using a VPC</a>.</p>
|
|
2599
2598
|
* @public
|
|
2600
2599
|
*/
|
|
2601
2600
|
VPCOptions?: VPCOptions | undefined;
|
|
@@ -2833,10 +2832,10 @@ export declare const DomainProcessingStatusType: {
|
|
|
2833
2832
|
*/
|
|
2834
2833
|
export type DomainProcessingStatusType = (typeof DomainProcessingStatusType)[keyof typeof DomainProcessingStatusType];
|
|
2835
2834
|
/**
|
|
2836
|
-
* <p>Settings container for integrating IAM Identity Center with OpenSearch UI
|
|
2837
|
-
*
|
|
2838
|
-
*
|
|
2839
|
-
*
|
|
2835
|
+
* <p>Settings container for integrating IAM Identity Center with OpenSearch UI applications,
|
|
2836
|
+
* which enables enabling secure user authentication and access control across multiple data
|
|
2837
|
+
* sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing
|
|
2838
|
+
* centralized user management.</p>
|
|
2840
2839
|
* @public
|
|
2841
2840
|
*/
|
|
2842
2841
|
export interface IdentityCenterOptions {
|
|
@@ -2851,20 +2850,20 @@ export interface IdentityCenterOptions {
|
|
|
2851
2850
|
*/
|
|
2852
2851
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2853
2852
|
/**
|
|
2854
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user
|
|
2855
|
-
*
|
|
2853
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user ID, or
|
|
2854
|
+
* email) in IAM Identity Center.</p>
|
|
2856
2855
|
* @public
|
|
2857
2856
|
*/
|
|
2858
2857
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2859
2858
|
/**
|
|
2860
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name
|
|
2861
|
-
*
|
|
2859
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name or
|
|
2860
|
+
* group ID) in IAM Identity Center.</p>
|
|
2862
2861
|
* @public
|
|
2863
2862
|
*/
|
|
2864
2863
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
2865
2864
|
/**
|
|
2866
2865
|
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch
|
|
2867
|
-
*
|
|
2866
|
+
* Service.</p>
|
|
2868
2867
|
* @public
|
|
2869
2868
|
*/
|
|
2870
2869
|
IdentityCenterApplicationARN?: string | undefined;
|
|
@@ -2967,59 +2966,57 @@ export interface DomainStatus {
|
|
|
2967
2966
|
*/
|
|
2968
2967
|
DomainId: string | undefined;
|
|
2969
2968
|
/**
|
|
2970
|
-
* <p>Name of the domain. Domain names are unique across all domains owned by the same
|
|
2971
|
-
*
|
|
2969
|
+
* <p>Name of the domain. Domain names are unique across all domains owned by the same account
|
|
2970
|
+
* within an Amazon Web Services Region.</p>
|
|
2972
2971
|
* @public
|
|
2973
2972
|
*/
|
|
2974
2973
|
DomainName: string | undefined;
|
|
2975
2974
|
/**
|
|
2976
|
-
* <p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
|
|
2977
|
-
*
|
|
2978
|
-
* Guide</i>.</p>
|
|
2975
|
+
* <p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM identifiers
|
|
2976
|
+
* </a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
2979
2977
|
* @public
|
|
2980
2978
|
*/
|
|
2981
2979
|
ARN: string | undefined;
|
|
2982
2980
|
/**
|
|
2983
|
-
* <p>Creation status of an OpenSearch Service domain. True if domain creation is complete.
|
|
2984
|
-
*
|
|
2981
|
+
* <p>Creation status of an OpenSearch Service domain. True if domain creation is complete. False
|
|
2982
|
+
* if domain creation is still in progress.</p>
|
|
2985
2983
|
* @public
|
|
2986
2984
|
*/
|
|
2987
2985
|
Created?: boolean | undefined;
|
|
2988
2986
|
/**
|
|
2989
|
-
* <p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete.
|
|
2990
|
-
*
|
|
2991
|
-
*
|
|
2987
|
+
* <p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False
|
|
2988
|
+
* if domain deletion is still in progress. Once deletion is complete, the status of the domain is
|
|
2989
|
+
* no longer returned.</p>
|
|
2992
2990
|
* @public
|
|
2993
2991
|
*/
|
|
2994
2992
|
Deleted?: boolean | undefined;
|
|
2995
2993
|
/**
|
|
2996
2994
|
* <p>Domain-specific endpoint used to submit index, search, and data upload requests to the
|
|
2997
|
-
*
|
|
2995
|
+
* domain.</p>
|
|
2998
2996
|
* @public
|
|
2999
2997
|
*/
|
|
3000
2998
|
Endpoint?: string | undefined;
|
|
3001
2999
|
/**
|
|
3002
|
-
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain
|
|
3003
|
-
*
|
|
3004
|
-
*
|
|
3005
|
-
* addresses. </p>
|
|
3000
|
+
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint
|
|
3001
|
+
* is provisioned. This endpoint functions like a normal endpoint, except that it works with both
|
|
3002
|
+
* IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. </p>
|
|
3006
3003
|
* @public
|
|
3007
3004
|
*/
|
|
3008
3005
|
EndpointV2?: string | undefined;
|
|
3009
3006
|
/**
|
|
3010
|
-
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.
|
|
3011
|
-
*
|
|
3007
|
+
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For
|
|
3008
|
+
* example:</p>
|
|
3012
3009
|
* <ul>
|
|
3013
3010
|
* <li>
|
|
3014
3011
|
* <p>
|
|
3015
3012
|
* <b>IPv4 IP addresses</b> -
|
|
3016
|
-
*
|
|
3013
|
+
* <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>
|
|
3017
3014
|
* </p>
|
|
3018
3015
|
* </li>
|
|
3019
3016
|
* <li>
|
|
3020
3017
|
* <p>
|
|
3021
3018
|
* <b>Dual stack IP addresses</b> -
|
|
3022
|
-
*
|
|
3019
|
+
* <code>'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'</code>
|
|
3023
3020
|
* </p>
|
|
3024
3021
|
* </li>
|
|
3025
3022
|
* </ul>
|
|
@@ -3033,7 +3030,7 @@ export interface DomainStatus {
|
|
|
3033
3030
|
DomainEndpointV2HostedZoneId?: string | undefined;
|
|
3034
3031
|
/**
|
|
3035
3032
|
* <p>The status of the domain configuration. True if OpenSearch Service is processing
|
|
3036
|
-
*
|
|
3033
|
+
* configuration changes. False if the configuration is active.</p>
|
|
3037
3034
|
* @public
|
|
3038
3035
|
*/
|
|
3039
3036
|
Processing?: boolean | undefined;
|
|
@@ -3046,7 +3043,7 @@ export interface DomainStatus {
|
|
|
3046
3043
|
UpgradeProcessing?: boolean | undefined;
|
|
3047
3044
|
/**
|
|
3048
3045
|
* <p>Version of OpenSearch or Elasticsearch that the domain is running, in the format
|
|
3049
|
-
*
|
|
3046
|
+
* <code>Elasticsearch_X.Y</code> or <code>OpenSearch_X.Y</code>.</p>
|
|
3050
3047
|
* @public
|
|
3051
3048
|
*/
|
|
3052
3049
|
EngineVersion?: string | undefined;
|
|
@@ -3061,8 +3058,8 @@ export interface DomainStatus {
|
|
|
3061
3058
|
*/
|
|
3062
3059
|
EBSOptions?: EBSOptions | undefined;
|
|
3063
3060
|
/**
|
|
3064
|
-
* <p>Identity and Access Management (IAM) policy document specifying the access policies
|
|
3065
|
-
*
|
|
3061
|
+
* <p>Identity and Access Management (IAM) policy document specifying the access policies for the
|
|
3062
|
+
* domain.</p>
|
|
3066
3063
|
* @public
|
|
3067
3064
|
*/
|
|
3068
3065
|
AccessPolicies?: string | undefined;
|
|
@@ -3083,8 +3080,7 @@ export interface DomainStatus {
|
|
|
3083
3080
|
*/
|
|
3084
3081
|
VPCOptions?: VPCDerivedInfo | undefined;
|
|
3085
3082
|
/**
|
|
3086
|
-
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch
|
|
3087
|
-
* Dashboards.</p>
|
|
3083
|
+
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>
|
|
3088
3084
|
* @public
|
|
3089
3085
|
*/
|
|
3090
3086
|
CognitoOptions?: CognitoOptions | undefined;
|
|
@@ -3115,7 +3111,7 @@ export interface DomainStatus {
|
|
|
3115
3111
|
ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
|
|
3116
3112
|
/**
|
|
3117
3113
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
3118
|
-
*
|
|
3114
|
+
* traffic.</p>
|
|
3119
3115
|
* @public
|
|
3120
3116
|
*/
|
|
3121
3117
|
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
@@ -3126,7 +3122,7 @@ export interface DomainStatus {
|
|
|
3126
3122
|
AdvancedSecurityOptions?: AdvancedSecurityOptions | undefined;
|
|
3127
3123
|
/**
|
|
3128
3124
|
* <p>Configuration options for controlling IAM Identity Center integration within a
|
|
3129
|
-
*
|
|
3125
|
+
* domain.</p>
|
|
3130
3126
|
* @public
|
|
3131
3127
|
*/
|
|
3132
3128
|
IdentityCenterOptions?: IdentityCenterOptions | undefined;
|
|
@@ -3141,8 +3137,8 @@ export interface DomainStatus {
|
|
|
3141
3137
|
*/
|
|
3142
3138
|
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
3143
3139
|
/**
|
|
3144
|
-
* <p>Options that specify a custom 10-hour window during which OpenSearch Service can
|
|
3145
|
-
*
|
|
3140
|
+
* <p>Options that specify a custom 10-hour window during which OpenSearch Service can perform
|
|
3141
|
+
* configuration changes on the domain.</p>
|
|
3146
3142
|
* @public
|
|
3147
3143
|
*/
|
|
3148
3144
|
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
@@ -3169,7 +3165,7 @@ export interface DomainStatus {
|
|
|
3169
3165
|
}
|
|
3170
3166
|
/**
|
|
3171
3167
|
* <p>The result of a <code>CreateDomain</code> operation. Contains the status of the newly
|
|
3172
|
-
*
|
|
3168
|
+
* created domain.</p>
|
|
3173
3169
|
* @public
|
|
3174
3170
|
*/
|
|
3175
3171
|
export interface CreateDomainResponse {
|
|
@@ -3203,6 +3199,62 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
3203
3199
|
*/
|
|
3204
3200
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
|
|
3205
3201
|
}
|
|
3202
|
+
/**
|
|
3203
|
+
* @public
|
|
3204
|
+
*/
|
|
3205
|
+
export interface CreateIndexRequest {
|
|
3206
|
+
/**
|
|
3207
|
+
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
3208
|
+
* owned by an account within an Amazon Web Services Region.</p>
|
|
3209
|
+
* @public
|
|
3210
|
+
*/
|
|
3211
|
+
DomainName: string | undefined;
|
|
3212
|
+
/**
|
|
3213
|
+
* <p>The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions.</p>
|
|
3214
|
+
* @public
|
|
3215
|
+
*/
|
|
3216
|
+
IndexName: string | undefined;
|
|
3217
|
+
/**
|
|
3218
|
+
* <p>The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters.</p>
|
|
3219
|
+
* @public
|
|
3220
|
+
*/
|
|
3221
|
+
IndexSchema: __DocumentType | undefined;
|
|
3222
|
+
}
|
|
3223
|
+
/**
|
|
3224
|
+
* @public
|
|
3225
|
+
* @enum
|
|
3226
|
+
*/
|
|
3227
|
+
export declare const IndexStatus: {
|
|
3228
|
+
readonly CREATED: "CREATED";
|
|
3229
|
+
readonly DELETED: "DELETED";
|
|
3230
|
+
readonly UPDATED: "UPDATED";
|
|
3231
|
+
};
|
|
3232
|
+
/**
|
|
3233
|
+
* @public
|
|
3234
|
+
*/
|
|
3235
|
+
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
3236
|
+
/**
|
|
3237
|
+
* @public
|
|
3238
|
+
*/
|
|
3239
|
+
export interface CreateIndexResponse {
|
|
3240
|
+
/**
|
|
3241
|
+
* <p>The status of the index creation operation.</p>
|
|
3242
|
+
* @public
|
|
3243
|
+
*/
|
|
3244
|
+
Status: IndexStatus | undefined;
|
|
3245
|
+
}
|
|
3246
|
+
/**
|
|
3247
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of your requests and try again.</p>
|
|
3248
|
+
* @public
|
|
3249
|
+
*/
|
|
3250
|
+
export declare class ThrottlingException extends __BaseException {
|
|
3251
|
+
readonly name: "ThrottlingException";
|
|
3252
|
+
readonly $fault: "client";
|
|
3253
|
+
/**
|
|
3254
|
+
* @internal
|
|
3255
|
+
*/
|
|
3256
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
3257
|
+
}
|
|
3206
3258
|
/**
|
|
3207
3259
|
* @public
|
|
3208
3260
|
* @enum
|
|
@@ -3249,8 +3301,7 @@ export interface ConnectionProperties {
|
|
|
3249
3301
|
CrossClusterSearch?: CrossClusterSearchConnectionProperties | undefined;
|
|
3250
3302
|
}
|
|
3251
3303
|
/**
|
|
3252
|
-
* <p>Container for the parameters to the <code>CreateOutboundConnection</code>
|
|
3253
|
-
* operation.</p>
|
|
3304
|
+
* <p>Container for the parameters to the <code>CreateOutboundConnection</code> operation.</p>
|
|
3254
3305
|
* @public
|
|
3255
3306
|
*/
|
|
3256
3307
|
export interface CreateOutboundConnectionRequest {
|
|
@@ -3369,8 +3420,8 @@ export interface OutboundConnectionStatus {
|
|
|
3369
3420
|
Message?: string | undefined;
|
|
3370
3421
|
}
|
|
3371
3422
|
/**
|
|
3372
|
-
* <p>The result of a <code>CreateOutboundConnection</code> request. Contains details about
|
|
3373
|
-
*
|
|
3423
|
+
* <p>The result of a <code>CreateOutboundConnection</code> request. Contains details about the
|
|
3424
|
+
* newly created cross-cluster connection.</p>
|
|
3374
3425
|
* @public
|
|
3375
3426
|
*/
|
|
3376
3427
|
export interface CreateOutboundConnectionResponse {
|
|
@@ -3395,8 +3446,8 @@ export interface CreateOutboundConnectionResponse {
|
|
|
3395
3446
|
*/
|
|
3396
3447
|
ConnectionStatus?: OutboundConnectionStatus | undefined;
|
|
3397
3448
|
/**
|
|
3398
|
-
* <p>The unique identifier for the created outbound connection, which is used for
|
|
3399
|
-
*
|
|
3449
|
+
* <p>The unique identifier for the created outbound connection, which is used for subsequent
|
|
3450
|
+
* operations on the connection.</p>
|
|
3400
3451
|
* @public
|
|
3401
3452
|
*/
|
|
3402
3453
|
ConnectionId?: string | undefined;
|
|
@@ -3885,6 +3936,32 @@ export interface DeleteInboundConnectionResponse {
|
|
|
3885
3936
|
*/
|
|
3886
3937
|
Connection?: InboundConnection | undefined;
|
|
3887
3938
|
}
|
|
3939
|
+
/**
|
|
3940
|
+
* @public
|
|
3941
|
+
*/
|
|
3942
|
+
export interface DeleteIndexRequest {
|
|
3943
|
+
/**
|
|
3944
|
+
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
3945
|
+
* owned by an account within an Amazon Web Services Region.</p>
|
|
3946
|
+
* @public
|
|
3947
|
+
*/
|
|
3948
|
+
DomainName: string | undefined;
|
|
3949
|
+
/**
|
|
3950
|
+
* <p>The name of the index to delete.</p>
|
|
3951
|
+
* @public
|
|
3952
|
+
*/
|
|
3953
|
+
IndexName: string | undefined;
|
|
3954
|
+
}
|
|
3955
|
+
/**
|
|
3956
|
+
* @public
|
|
3957
|
+
*/
|
|
3958
|
+
export interface DeleteIndexResponse {
|
|
3959
|
+
/**
|
|
3960
|
+
* <p>The status of the index deletion operation.</p>
|
|
3961
|
+
* @public
|
|
3962
|
+
*/
|
|
3963
|
+
Status: IndexStatus | undefined;
|
|
3964
|
+
}
|
|
3888
3965
|
/**
|
|
3889
3966
|
* <p>Container for the parameters to the <code>DeleteOutboundConnection</code>
|
|
3890
3967
|
* operation.</p>
|
|
@@ -5381,8 +5458,8 @@ export interface DescribeInstanceTypeLimitsRequest {
|
|
|
5381
5458
|
EngineVersion: string | undefined;
|
|
5382
5459
|
}
|
|
5383
5460
|
/**
|
|
5384
|
-
* <p>Limits on the number of instances that can be created in OpenSearch Service for a
|
|
5385
|
-
*
|
|
5461
|
+
* <p>Limits on the number of instances that can be created in OpenSearch Service for a given
|
|
5462
|
+
* instance type.</p>
|
|
5386
5463
|
* @public
|
|
5387
5464
|
*/
|
|
5388
5465
|
export interface InstanceCountLimits {
|
|
@@ -5403,8 +5480,7 @@ export interface InstanceCountLimits {
|
|
|
5403
5480
|
*/
|
|
5404
5481
|
export interface InstanceLimits {
|
|
5405
5482
|
/**
|
|
5406
|
-
* <p>Limits on the number of instances that can be created for a given instance
|
|
5407
|
-
* type.</p>
|
|
5483
|
+
* <p>Limits on the number of instances that can be created for a given instance type.</p>
|
|
5408
5484
|
* @public
|
|
5409
5485
|
*/
|
|
5410
5486
|
InstanceCountLimits?: InstanceCountLimits | undefined;
|
|
@@ -6060,9 +6136,9 @@ export interface GetApplicationResponse {
|
|
|
6060
6136
|
*/
|
|
6061
6137
|
endpoint?: string | undefined;
|
|
6062
6138
|
/**
|
|
6063
|
-
* <p>The current status of the OpenSearch application. Possible values:
|
|
6064
|
-
*
|
|
6065
|
-
*
|
|
6139
|
+
* <p>The current status of the OpenSearch application. Possible values: <code>CREATING</code>,
|
|
6140
|
+
* <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and
|
|
6141
|
+
* <code>DELETED</code>.</p>
|
|
6066
6142
|
* @public
|
|
6067
6143
|
*/
|
|
6068
6144
|
status?: ApplicationStatus | undefined;
|
|
@@ -6093,14 +6169,13 @@ export interface GetApplicationResponse {
|
|
|
6093
6169
|
lastUpdatedAt?: Date | undefined;
|
|
6094
6170
|
}
|
|
6095
6171
|
/**
|
|
6096
|
-
* <p>Container for the request parameters to <code>GetCompatibleVersions</code>
|
|
6097
|
-
* operation.</p>
|
|
6172
|
+
* <p>Container for the request parameters to <code>GetCompatibleVersions</code> operation.</p>
|
|
6098
6173
|
* @public
|
|
6099
6174
|
*/
|
|
6100
6175
|
export interface GetCompatibleVersionsRequest {
|
|
6101
6176
|
/**
|
|
6102
|
-
* <p>The name of an existing domain. Provide this parameter to limit the results to a
|
|
6103
|
-
*
|
|
6177
|
+
* <p>The name of an existing domain. Provide this parameter to limit the results to a single
|
|
6178
|
+
* domain.</p>
|
|
6104
6179
|
* @public
|
|
6105
6180
|
*/
|
|
6106
6181
|
DomainName?: string | undefined;
|
|
@@ -6124,13 +6199,13 @@ export interface CompatibleVersionsMap {
|
|
|
6124
6199
|
}
|
|
6125
6200
|
/**
|
|
6126
6201
|
* <p>Container for the response returned by the <code>GetCompatibleVersions</code>
|
|
6127
|
-
*
|
|
6202
|
+
* operation.</p>
|
|
6128
6203
|
* @public
|
|
6129
6204
|
*/
|
|
6130
6205
|
export interface GetCompatibleVersionsResponse {
|
|
6131
6206
|
/**
|
|
6132
6207
|
* <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
|
|
6133
|
-
*
|
|
6208
|
+
* to.</p>
|
|
6134
6209
|
* @public
|
|
6135
6210
|
*/
|
|
6136
6211
|
CompatibleVersions?: CompatibleVersionsMap[] | undefined;
|
|
@@ -6211,8 +6286,8 @@ export interface GetDefaultApplicationSettingResponse {
|
|
|
6211
6286
|
*/
|
|
6212
6287
|
export interface GetDirectQueryDataSourceRequest {
|
|
6213
6288
|
/**
|
|
6214
|
-
* <p> A unique, user-defined label that identifies the data source within your OpenSearch
|
|
6215
|
-
*
|
|
6289
|
+
* <p> A unique, user-defined label that identifies the data source within your OpenSearch Service
|
|
6290
|
+
* environment. </p>
|
|
6216
6291
|
* @public
|
|
6217
6292
|
*/
|
|
6218
6293
|
DataSourceName: string | undefined;
|
|
@@ -6222,26 +6297,25 @@ export interface GetDirectQueryDataSourceRequest {
|
|
|
6222
6297
|
*/
|
|
6223
6298
|
export interface GetDirectQueryDataSourceResponse {
|
|
6224
6299
|
/**
|
|
6225
|
-
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
6226
|
-
*
|
|
6300
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch Service
|
|
6301
|
+
* environment. </p>
|
|
6227
6302
|
* @public
|
|
6228
6303
|
*/
|
|
6229
6304
|
DataSourceName?: string | undefined;
|
|
6230
6305
|
/**
|
|
6231
|
-
* <p> The supported Amazon Web Services service that is used as the source for direct
|
|
6232
|
-
*
|
|
6306
|
+
* <p> The supported Amazon Web Services service that is used as the source for direct queries in
|
|
6307
|
+
* OpenSearch Service. </p>
|
|
6233
6308
|
* @public
|
|
6234
6309
|
*/
|
|
6235
6310
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6236
6311
|
/**
|
|
6237
|
-
* <p> A description that provides additional context and details about the data source.
|
|
6238
|
-
* </p>
|
|
6312
|
+
* <p> A description that provides additional context and details about the data source. </p>
|
|
6239
6313
|
* @public
|
|
6240
6314
|
*/
|
|
6241
6315
|
Description?: string | undefined;
|
|
6242
6316
|
/**
|
|
6243
|
-
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
6244
|
-
*
|
|
6317
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated
|
|
6318
|
+
* with the direct query data source. </p>
|
|
6245
6319
|
* @public
|
|
6246
6320
|
*/
|
|
6247
6321
|
OpenSearchArns?: string[] | undefined;
|
|
@@ -6253,7 +6327,7 @@ export interface GetDirectQueryDataSourceResponse {
|
|
|
6253
6327
|
}
|
|
6254
6328
|
/**
|
|
6255
6329
|
* <p>Container for the parameters to the <code>GetDomainMaintenanceStatus</code>
|
|
6256
|
-
*
|
|
6330
|
+
* operation.</p>
|
|
6257
6331
|
* @public
|
|
6258
6332
|
*/
|
|
6259
6333
|
export interface GetDomainMaintenanceStatusRequest {
|
|
@@ -6297,8 +6371,8 @@ export declare const MaintenanceStatus: {
|
|
|
6297
6371
|
*/
|
|
6298
6372
|
export type MaintenanceStatus = (typeof MaintenanceStatus)[keyof typeof MaintenanceStatus];
|
|
6299
6373
|
/**
|
|
6300
|
-
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about
|
|
6301
|
-
*
|
|
6374
|
+
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about the
|
|
6375
|
+
* requested action.</p>
|
|
6302
6376
|
* @public
|
|
6303
6377
|
*/
|
|
6304
6378
|
export interface GetDomainMaintenanceStatusResponse {
|
|
@@ -6333,9 +6407,35 @@ export interface GetDomainMaintenanceStatusResponse {
|
|
|
6333
6407
|
*/
|
|
6334
6408
|
UpdatedAt?: Date | undefined;
|
|
6335
6409
|
}
|
|
6410
|
+
/**
|
|
6411
|
+
* @public
|
|
6412
|
+
*/
|
|
6413
|
+
export interface GetIndexRequest {
|
|
6414
|
+
/**
|
|
6415
|
+
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
6416
|
+
* owned by an account within an Amazon Web Services Region.</p>
|
|
6417
|
+
* @public
|
|
6418
|
+
*/
|
|
6419
|
+
DomainName: string | undefined;
|
|
6420
|
+
/**
|
|
6421
|
+
* <p>The name of the index to retrieve information about.</p>
|
|
6422
|
+
* @public
|
|
6423
|
+
*/
|
|
6424
|
+
IndexName: string | undefined;
|
|
6425
|
+
}
|
|
6426
|
+
/**
|
|
6427
|
+
* @public
|
|
6428
|
+
*/
|
|
6429
|
+
export interface GetIndexResponse {
|
|
6430
|
+
/**
|
|
6431
|
+
* <p>The JSON schema of the index including mappings, settings, and semantic enrichment configuration.</p>
|
|
6432
|
+
* @public
|
|
6433
|
+
*/
|
|
6434
|
+
IndexSchema: __DocumentType | undefined;
|
|
6435
|
+
}
|
|
6336
6436
|
/**
|
|
6337
6437
|
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code>
|
|
6338
|
-
*
|
|
6438
|
+
* operation.</p>
|
|
6339
6439
|
* @public
|
|
6340
6440
|
*/
|
|
6341
6441
|
export interface GetPackageVersionHistoryRequest {
|
|
@@ -6345,16 +6445,16 @@ export interface GetPackageVersionHistoryRequest {
|
|
|
6345
6445
|
*/
|
|
6346
6446
|
PackageID: string | undefined;
|
|
6347
6447
|
/**
|
|
6348
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6349
|
-
*
|
|
6448
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6449
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
6350
6450
|
* @public
|
|
6351
6451
|
*/
|
|
6352
6452
|
MaxResults?: number | undefined;
|
|
6353
6453
|
/**
|
|
6354
6454
|
* <p>If your initial <code>GetPackageVersionHistory</code> operation returns a
|
|
6355
|
-
*
|
|
6356
|
-
*
|
|
6357
|
-
*
|
|
6455
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent
|
|
6456
|
+
* <code>GetPackageVersionHistory</code> operations, which returns results in the next page.
|
|
6457
|
+
* </p>
|
|
6358
6458
|
* @public
|
|
6359
6459
|
*/
|
|
6360
6460
|
NextToken?: string | undefined;
|
|
@@ -6392,8 +6492,7 @@ export interface PackageVersionHistory {
|
|
|
6392
6492
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
6393
6493
|
}
|
|
6394
6494
|
/**
|
|
6395
|
-
* <p>Container for response returned by <code>GetPackageVersionHistory</code>
|
|
6396
|
-
* operation.</p>
|
|
6495
|
+
* <p>Container for response returned by <code>GetPackageVersionHistory</code> operation.</p>
|
|
6397
6496
|
* @public
|
|
6398
6497
|
*/
|
|
6399
6498
|
export interface GetPackageVersionHistoryResponse {
|
|
@@ -6408,16 +6507,15 @@ export interface GetPackageVersionHistoryResponse {
|
|
|
6408
6507
|
*/
|
|
6409
6508
|
PackageVersionHistoryList?: PackageVersionHistory[] | undefined;
|
|
6410
6509
|
/**
|
|
6411
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6412
|
-
*
|
|
6413
|
-
*
|
|
6510
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6511
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6512
|
+
* the returned token to retrieve the next page.</p>
|
|
6414
6513
|
* @public
|
|
6415
6514
|
*/
|
|
6416
6515
|
NextToken?: string | undefined;
|
|
6417
6516
|
}
|
|
6418
6517
|
/**
|
|
6419
|
-
* <p>Container for the request parameters to the <code>GetUpgradeHistory</code>
|
|
6420
|
-
* operation.</p>
|
|
6518
|
+
* <p>Container for the request parameters to the <code>GetUpgradeHistory</code> operation.</p>
|
|
6421
6519
|
* @public
|
|
6422
6520
|
*/
|
|
6423
6521
|
export interface GetUpgradeHistoryRequest {
|
|
@@ -6427,16 +6525,15 @@ export interface GetUpgradeHistoryRequest {
|
|
|
6427
6525
|
*/
|
|
6428
6526
|
DomainName: string | undefined;
|
|
6429
6527
|
/**
|
|
6430
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6431
|
-
*
|
|
6528
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can use
|
|
6529
|
+
* <code>nextToken</code> to get the next page of results.</p>
|
|
6432
6530
|
* @public
|
|
6433
6531
|
*/
|
|
6434
6532
|
MaxResults?: number | undefined;
|
|
6435
6533
|
/**
|
|
6436
|
-
* <p>If your initial <code>GetUpgradeHistory</code> operation returns a
|
|
6437
|
-
*
|
|
6438
|
-
*
|
|
6439
|
-
* page.</p>
|
|
6534
|
+
* <p>If your initial <code>GetUpgradeHistory</code> operation returns a <code>nextToken</code>,
|
|
6535
|
+
* you can include the returned <code>nextToken</code> in subsequent <code>GetUpgradeHistory</code>
|
|
6536
|
+
* operations, which returns results in the next page.</p>
|
|
6440
6537
|
* @public
|
|
6441
6538
|
*/
|
|
6442
6539
|
NextToken?: string | undefined;
|
|
@@ -6565,28 +6662,26 @@ export interface UpgradeHistory {
|
|
|
6565
6662
|
StepsList?: UpgradeStepItem[] | undefined;
|
|
6566
6663
|
}
|
|
6567
6664
|
/**
|
|
6568
|
-
* <p>Container for the response returned by the <code>GetUpgradeHistory</code>
|
|
6569
|
-
* operation.</p>
|
|
6665
|
+
* <p>Container for the response returned by the <code>GetUpgradeHistory</code> operation.</p>
|
|
6570
6666
|
* @public
|
|
6571
6667
|
*/
|
|
6572
6668
|
export interface GetUpgradeHistoryResponse {
|
|
6573
6669
|
/**
|
|
6574
|
-
* <p>A list of objects corresponding to each upgrade or upgrade eligibility check performed
|
|
6575
|
-
*
|
|
6670
|
+
* <p>A list of objects corresponding to each upgrade or upgrade eligibility check performed on a
|
|
6671
|
+
* domain.</p>
|
|
6576
6672
|
* @public
|
|
6577
6673
|
*/
|
|
6578
6674
|
UpgradeHistories?: UpgradeHistory[] | undefined;
|
|
6579
6675
|
/**
|
|
6580
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6581
|
-
*
|
|
6582
|
-
*
|
|
6676
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value of
|
|
6677
|
+
* <code>nextToken</code> is a unique pagination token for each page. Send the request again using
|
|
6678
|
+
* the returned token to retrieve the next page.</p>
|
|
6583
6679
|
* @public
|
|
6584
6680
|
*/
|
|
6585
6681
|
NextToken?: string | undefined;
|
|
6586
6682
|
}
|
|
6587
6683
|
/**
|
|
6588
|
-
* <p>Container for the request parameters to the <code>GetUpgradeStatus</code>
|
|
6589
|
-
* operation.</p>
|
|
6684
|
+
* <p>Container for the request parameters to the <code>GetUpgradeStatus</code> operation.</p>
|
|
6590
6685
|
* @public
|
|
6591
6686
|
*/
|
|
6592
6687
|
export interface GetUpgradeStatusRequest {
|
|
@@ -6597,8 +6692,7 @@ export interface GetUpgradeStatusRequest {
|
|
|
6597
6692
|
DomainName: string | undefined;
|
|
6598
6693
|
}
|
|
6599
6694
|
/**
|
|
6600
|
-
* <p>Container for the response returned by the <code>GetUpgradeStatus</code>
|
|
6601
|
-
* operation.</p>
|
|
6695
|
+
* <p>Container for the response returned by the <code>GetUpgradeStatus</code> operation.</p>
|
|
6602
6696
|
* @public
|
|
6603
6697
|
*/
|
|
6604
6698
|
export interface GetUpgradeStatusResponse {
|
|
@@ -6743,197 +6837,3 @@ export interface DataSourceDetails {
|
|
|
6743
6837
|
*/
|
|
6744
6838
|
Status?: DataSourceStatus | undefined;
|
|
6745
6839
|
}
|
|
6746
|
-
/**
|
|
6747
|
-
* <p>The result of a <code>ListDataSources</code> operation.</p>
|
|
6748
|
-
* @public
|
|
6749
|
-
*/
|
|
6750
|
-
export interface ListDataSourcesResponse {
|
|
6751
|
-
/**
|
|
6752
|
-
* <p>A list of data sources associated with specified domain.</p>
|
|
6753
|
-
* @public
|
|
6754
|
-
*/
|
|
6755
|
-
DataSources?: DataSourceDetails[] | undefined;
|
|
6756
|
-
}
|
|
6757
|
-
/**
|
|
6758
|
-
* @public
|
|
6759
|
-
*/
|
|
6760
|
-
export interface ListDirectQueryDataSourcesRequest {
|
|
6761
|
-
/**
|
|
6762
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6763
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6764
|
-
* again using the returned token to retrieve the next page.</p>
|
|
6765
|
-
* @public
|
|
6766
|
-
*/
|
|
6767
|
-
NextToken?: string | undefined;
|
|
6768
|
-
}
|
|
6769
|
-
/**
|
|
6770
|
-
* <p> The configuration details for a data source that can be directly queried. </p>
|
|
6771
|
-
* @public
|
|
6772
|
-
*/
|
|
6773
|
-
export interface DirectQueryDataSource {
|
|
6774
|
-
/**
|
|
6775
|
-
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
6776
|
-
* Service environment. </p>
|
|
6777
|
-
* @public
|
|
6778
|
-
*/
|
|
6779
|
-
DataSourceName?: string | undefined;
|
|
6780
|
-
/**
|
|
6781
|
-
* <p> The supported Amazon Web Services service that is used as the source for direct
|
|
6782
|
-
* queries in OpenSearch Service. </p>
|
|
6783
|
-
* @public
|
|
6784
|
-
*/
|
|
6785
|
-
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6786
|
-
/**
|
|
6787
|
-
* <p> A description that provides additional context and details about the data
|
|
6788
|
-
* source.</p>
|
|
6789
|
-
* @public
|
|
6790
|
-
*/
|
|
6791
|
-
Description?: string | undefined;
|
|
6792
|
-
/**
|
|
6793
|
-
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
6794
|
-
* associated with the direct query data source. </p>
|
|
6795
|
-
* @public
|
|
6796
|
-
*/
|
|
6797
|
-
OpenSearchArns?: string[] | undefined;
|
|
6798
|
-
/**
|
|
6799
|
-
* <p> The unique, system-generated identifier that represents the data source.</p>
|
|
6800
|
-
* @public
|
|
6801
|
-
*/
|
|
6802
|
-
DataSourceArn?: string | undefined;
|
|
6803
|
-
/**
|
|
6804
|
-
* <p> A list of tags attached to a direct query data source.</p>
|
|
6805
|
-
* @public
|
|
6806
|
-
*/
|
|
6807
|
-
TagList?: Tag[] | undefined;
|
|
6808
|
-
}
|
|
6809
|
-
/**
|
|
6810
|
-
* @public
|
|
6811
|
-
*/
|
|
6812
|
-
export interface ListDirectQueryDataSourcesResponse {
|
|
6813
|
-
/**
|
|
6814
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6815
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6816
|
-
* again using the returned token to retrieve the next page.</p>
|
|
6817
|
-
* @public
|
|
6818
|
-
*/
|
|
6819
|
-
NextToken?: string | undefined;
|
|
6820
|
-
/**
|
|
6821
|
-
* <p> A list of the direct query data sources that are returned by the
|
|
6822
|
-
* <code>ListDirectQueryDataSources</code> API operation. </p>
|
|
6823
|
-
* @public
|
|
6824
|
-
*/
|
|
6825
|
-
DirectQueryDataSources?: DirectQueryDataSource[] | undefined;
|
|
6826
|
-
}
|
|
6827
|
-
/**
|
|
6828
|
-
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
6829
|
-
* operation.</p>
|
|
6830
|
-
* @public
|
|
6831
|
-
*/
|
|
6832
|
-
export interface ListDomainMaintenancesRequest {
|
|
6833
|
-
/**
|
|
6834
|
-
* <p>The name of the domain.</p>
|
|
6835
|
-
* @public
|
|
6836
|
-
*/
|
|
6837
|
-
DomainName: string | undefined;
|
|
6838
|
-
/**
|
|
6839
|
-
* <p>The name of the action.</p>
|
|
6840
|
-
* @public
|
|
6841
|
-
*/
|
|
6842
|
-
Action?: MaintenanceType | undefined;
|
|
6843
|
-
/**
|
|
6844
|
-
* <p>The status of the action.</p>
|
|
6845
|
-
* @public
|
|
6846
|
-
*/
|
|
6847
|
-
Status?: MaintenanceStatus | undefined;
|
|
6848
|
-
/**
|
|
6849
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6850
|
-
* use <code>nextToken</code> to get the next page of results.</p>
|
|
6851
|
-
* @public
|
|
6852
|
-
*/
|
|
6853
|
-
MaxResults?: number | undefined;
|
|
6854
|
-
/**
|
|
6855
|
-
* <p>If your initial <code>ListDomainMaintenances</code> operation returns a
|
|
6856
|
-
* <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent
|
|
6857
|
-
* <code>ListDomainMaintenances</code> operations, which returns results in the next
|
|
6858
|
-
* page.</p>
|
|
6859
|
-
* @public
|
|
6860
|
-
*/
|
|
6861
|
-
NextToken?: string | undefined;
|
|
6862
|
-
}
|
|
6863
|
-
/**
|
|
6864
|
-
* <p>Container for the domain maintenance details.</p>
|
|
6865
|
-
* @public
|
|
6866
|
-
*/
|
|
6867
|
-
export interface DomainMaintenanceDetails {
|
|
6868
|
-
/**
|
|
6869
|
-
* <p>The ID of the requested action.</p>
|
|
6870
|
-
* @public
|
|
6871
|
-
*/
|
|
6872
|
-
MaintenanceId?: string | undefined;
|
|
6873
|
-
/**
|
|
6874
|
-
* <p>The name of the domain.</p>
|
|
6875
|
-
* @public
|
|
6876
|
-
*/
|
|
6877
|
-
DomainName?: string | undefined;
|
|
6878
|
-
/**
|
|
6879
|
-
* <p>The name of the action.</p>
|
|
6880
|
-
* @public
|
|
6881
|
-
*/
|
|
6882
|
-
Action?: MaintenanceType | undefined;
|
|
6883
|
-
/**
|
|
6884
|
-
* <p>The ID of the data node.</p>
|
|
6885
|
-
* @public
|
|
6886
|
-
*/
|
|
6887
|
-
NodeId?: string | undefined;
|
|
6888
|
-
/**
|
|
6889
|
-
* <p>The status of the action.</p>
|
|
6890
|
-
* @public
|
|
6891
|
-
*/
|
|
6892
|
-
Status?: MaintenanceStatus | undefined;
|
|
6893
|
-
/**
|
|
6894
|
-
* <p>The status message for the action.</p>
|
|
6895
|
-
* @public
|
|
6896
|
-
*/
|
|
6897
|
-
StatusMessage?: string | undefined;
|
|
6898
|
-
/**
|
|
6899
|
-
* <p>The time at which the action was created.</p>
|
|
6900
|
-
* @public
|
|
6901
|
-
*/
|
|
6902
|
-
CreatedAt?: Date | undefined;
|
|
6903
|
-
/**
|
|
6904
|
-
* <p>The time at which the action was updated.</p>
|
|
6905
|
-
* @public
|
|
6906
|
-
*/
|
|
6907
|
-
UpdatedAt?: Date | undefined;
|
|
6908
|
-
}
|
|
6909
|
-
/**
|
|
6910
|
-
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information
|
|
6911
|
-
* about the requested actions. </p>
|
|
6912
|
-
* @public
|
|
6913
|
-
*/
|
|
6914
|
-
export interface ListDomainMaintenancesResponse {
|
|
6915
|
-
/**
|
|
6916
|
-
* <p>A list of the submitted maintenance actions.</p>
|
|
6917
|
-
* @public
|
|
6918
|
-
*/
|
|
6919
|
-
DomainMaintenances?: DomainMaintenanceDetails[] | undefined;
|
|
6920
|
-
/**
|
|
6921
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6922
|
-
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6923
|
-
* again using the returned token to retrieve the next page.</p>
|
|
6924
|
-
* @public
|
|
6925
|
-
*/
|
|
6926
|
-
NextToken?: string | undefined;
|
|
6927
|
-
}
|
|
6928
|
-
/**
|
|
6929
|
-
* @public
|
|
6930
|
-
* @enum
|
|
6931
|
-
*/
|
|
6932
|
-
export declare const EngineType: {
|
|
6933
|
-
readonly Elasticsearch: "Elasticsearch";
|
|
6934
|
-
readonly OpenSearch: "OpenSearch";
|
|
6935
|
-
};
|
|
6936
|
-
/**
|
|
6937
|
-
* @public
|
|
6938
|
-
*/
|
|
6939
|
-
export type EngineType = (typeof EngineType)[keyof typeof EngineType];
|