@aws-sdk/client-opensearch 3.1020.0 → 3.1022.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 +21 -0
- package/dist-cjs/index.js +57 -0
- package/dist-cjs/models/errors.js +14 -1
- package/dist-cjs/schemas/schemas_0.js +107 -11
- package/dist-es/OpenSearch.js +6 -0
- package/dist-es/commands/DeregisterCapabilityCommand.js +16 -0
- package/dist-es/commands/GetCapabilityCommand.js +16 -0
- package/dist-es/commands/RegisterCapabilityCommand.js +16 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/enums.js +13 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/schemas/schemas_0.js +99 -3
- package/dist-types/OpenSearch.d.ts +21 -0
- package/dist-types/OpenSearchClient.d.ts +5 -2
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDomainCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterCapabilityCommand.d.ts +93 -0
- package/dist-types/commands/DescribeDomainCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDomainConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDomainsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDryRunProgressCommand.d.ts +1 -1
- package/dist-types/commands/GetCapabilityCommand.d.ts +101 -0
- package/dist-types/commands/RegisterCapabilityCommand.d.ts +104 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDirectQueryDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDomainConfigCommand.d.ts +3 -3
- package/dist-types/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/enums.d.ts +29 -0
- package/dist-types/models/errors.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +249 -366
- package/dist-types/models/models_1.d.ts +368 -2
- package/dist-types/schemas/schemas_0.d.ts +15 -0
- package/dist-types/ts3.4/OpenSearch.d.ts +51 -0
- package/dist-types/ts3.4/OpenSearchClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeregisterCapabilityCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCapabilityCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/RegisterCapabilityCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateDirectQueryDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDomainConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePackageCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePackageScopeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/enums.d.ts +17 -0
- package/dist-types/ts3.4/models/errors.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +87 -75
- package/dist-types/ts3.4/models/models_1.d.ts +106 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +15 -0
- package/package.json +6 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import type { ActionSeverity, ActionStatus, ActionType, AppConfigType, ApplicationStatus, AutoTuneDesiredState, AutoTuneState, AutoTuneType, AWSServicePrincipal, ConfigChangeStatus, ConnectionMode, DataSourceStatus, DeploymentStatus, DeploymentStrategy, DescribePackagesFilterName, DomainHealth, DomainPackageStatus, DomainProcessingStatusType, DomainState,
|
|
2
|
+
import type { ActionSeverity, ActionStatus, ActionType, AppConfigType, ApplicationStatus, AutoTuneDesiredState, AutoTuneState, AutoTuneType, AWSServicePrincipal, CapabilityFailureReason, CapabilityStatus, ConfigChangeStatus, ConnectionMode, DataSourceStatus, DeploymentStatus, DeploymentStrategy, DescribePackagesFilterName, DomainHealth, DomainPackageStatus, DomainProcessingStatusType, DomainState, EngineType, InboundConnectionStatusCode, IndexStatus, InitiatedBy, InsightEntityType, InsightFieldType, InsightPriorityLevel, InsightSortOrder, InsightStatus, InsightType, IPAddressType, LogType, MaintenanceStatus, MaintenanceType, MasterNodeStatus, NaturalLanguageQueryGenerationCurrentState, NaturalLanguageQueryGenerationDesiredState, NodeOptionsNodeType, NodeStatus, NodeType, OpenSearchPartitionInstanceType, OpenSearchWarmPartitionInstanceType, OptionState, OutboundConnectionStatusCode, OverallChangeStatus, PackageStatus, PackageType, PrincipalType, PropertyValueType, RequirementLevel, ReservedInstancePaymentOption, RolesKeyIdCOption, RollbackOnDisable, ScheduleAt, ScheduledAutoTuneActionType, ScheduledAutoTuneSeverityType, ScheduledBy, SkipUnavailableStatus, SubjectKeyIdCOption, TimeUnit, TLSSecurityPolicy, UpgradeStatus, UpgradeStep, VolumeType, VpcEndpointErrorCode, VpcEndpointStatus, ZoneStatus } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* <p>Container for the parameters to the <code>AcceptInboundConnection</code>
|
|
5
5
|
* operation.</p>
|
|
@@ -864,6 +864,12 @@ export interface AdvancedSecurityOptionsStatus {
|
|
|
864
864
|
*/
|
|
865
865
|
Status: OptionStatus | undefined;
|
|
866
866
|
}
|
|
867
|
+
/**
|
|
868
|
+
* <p>Configuration settings for AI-powered capabilities of an OpenSearch UI application.</p>
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
export interface AIConfig {
|
|
872
|
+
}
|
|
867
873
|
/**
|
|
868
874
|
* <p>Container for parameters required to enable the natural language query generation
|
|
869
875
|
* feature.</p>
|
|
@@ -1849,6 +1855,11 @@ export interface DomainEndpointOptions {
|
|
|
1849
1855
|
* policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward
|
|
1850
1856
|
* secrecy cipher suites</p>
|
|
1851
1857
|
* </li>
|
|
1858
|
+
* <li>
|
|
1859
|
+
* <p>
|
|
1860
|
+
* <b>Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08:</b> TLS
|
|
1861
|
+
* security policy that supports TLS version 1.3 with FIPS</p>
|
|
1862
|
+
* </li>
|
|
1852
1863
|
* </ul>
|
|
1853
1864
|
* @public
|
|
1854
1865
|
*/
|
|
@@ -3453,6 +3464,33 @@ export interface DeleteVpcEndpointResponse {
|
|
|
3453
3464
|
*/
|
|
3454
3465
|
VpcEndpointSummary: VpcEndpointSummary | undefined;
|
|
3455
3466
|
}
|
|
3467
|
+
/**
|
|
3468
|
+
* <p>Container for the parameters to the <code>DeregisterCapability</code> operation.</p>
|
|
3469
|
+
* @public
|
|
3470
|
+
*/
|
|
3471
|
+
export interface DeregisterCapabilityRequest {
|
|
3472
|
+
/**
|
|
3473
|
+
* <p>The unique identifier of the OpenSearch UI application to deregister the capability from.</p>
|
|
3474
|
+
* @public
|
|
3475
|
+
*/
|
|
3476
|
+
applicationId: string | undefined;
|
|
3477
|
+
/**
|
|
3478
|
+
* <p>The name of the capability to deregister.</p>
|
|
3479
|
+
* @public
|
|
3480
|
+
*/
|
|
3481
|
+
capabilityName: string | undefined;
|
|
3482
|
+
}
|
|
3483
|
+
/**
|
|
3484
|
+
* <p>The result of a <code>DeregisterCapability</code> request.</p>
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
export interface DeregisterCapabilityResponse {
|
|
3488
|
+
/**
|
|
3489
|
+
* <p>The status of the deregistration operation. Returns <code>deleting</code> when the capability is being removed.</p>
|
|
3490
|
+
* @public
|
|
3491
|
+
*/
|
|
3492
|
+
status?: CapabilityStatus | undefined;
|
|
3493
|
+
}
|
|
3456
3494
|
/**
|
|
3457
3495
|
* <p>Container for the parameters to the <code>DescribeDomain</code> operation.</p>
|
|
3458
3496
|
* @public
|
|
@@ -5418,6 +5456,102 @@ export interface GetApplicationResponse {
|
|
|
5418
5456
|
*/
|
|
5419
5457
|
kmsKeyArn?: string | undefined;
|
|
5420
5458
|
}
|
|
5459
|
+
/**
|
|
5460
|
+
* <p>Container for the parameters to the <code>GetCapability</code> operation.</p>
|
|
5461
|
+
* @public
|
|
5462
|
+
*/
|
|
5463
|
+
export interface GetCapabilityRequest {
|
|
5464
|
+
/**
|
|
5465
|
+
* <p>The unique identifier of the OpenSearch UI application.</p>
|
|
5466
|
+
* @public
|
|
5467
|
+
*/
|
|
5468
|
+
applicationId: string | undefined;
|
|
5469
|
+
/**
|
|
5470
|
+
* <p>The name of the capability to retrieve information about.</p>
|
|
5471
|
+
* @public
|
|
5472
|
+
*/
|
|
5473
|
+
capabilityName: string | undefined;
|
|
5474
|
+
}
|
|
5475
|
+
/**
|
|
5476
|
+
* <p>The extended configuration returned for a registered capability, including additional details beyond the base configuration.</p>
|
|
5477
|
+
* @public
|
|
5478
|
+
*/
|
|
5479
|
+
export type CapabilityExtendedResponseConfig = CapabilityExtendedResponseConfig.AiConfigMember | CapabilityExtendedResponseConfig.$UnknownMember;
|
|
5480
|
+
/**
|
|
5481
|
+
* @public
|
|
5482
|
+
*/
|
|
5483
|
+
export declare namespace CapabilityExtendedResponseConfig {
|
|
5484
|
+
/**
|
|
5485
|
+
* <p>Configuration settings for AI-powered capabilities.</p>
|
|
5486
|
+
* @public
|
|
5487
|
+
*/
|
|
5488
|
+
interface AiConfigMember {
|
|
5489
|
+
aiConfig: AIConfig;
|
|
5490
|
+
$unknown?: never;
|
|
5491
|
+
}
|
|
5492
|
+
/**
|
|
5493
|
+
* @public
|
|
5494
|
+
*/
|
|
5495
|
+
interface $UnknownMember {
|
|
5496
|
+
aiConfig?: never;
|
|
5497
|
+
$unknown: [string, any];
|
|
5498
|
+
}
|
|
5499
|
+
/**
|
|
5500
|
+
* @deprecated unused in schema-serde mode.
|
|
5501
|
+
*
|
|
5502
|
+
*/
|
|
5503
|
+
interface Visitor<T> {
|
|
5504
|
+
aiConfig: (value: AIConfig) => T;
|
|
5505
|
+
_: (name: string, value: any) => T;
|
|
5506
|
+
}
|
|
5507
|
+
}
|
|
5508
|
+
/**
|
|
5509
|
+
* <p>Information about a capability failure.</p>
|
|
5510
|
+
* @public
|
|
5511
|
+
*/
|
|
5512
|
+
export interface CapabilityFailure {
|
|
5513
|
+
/**
|
|
5514
|
+
* <p>The reason for the capability failure. Possible values: <code>KMS_KEY_INSUFFICIENT_PERMISSION</code>.</p>
|
|
5515
|
+
* @public
|
|
5516
|
+
*/
|
|
5517
|
+
reason?: CapabilityFailureReason | undefined;
|
|
5518
|
+
/**
|
|
5519
|
+
* <p>Additional details about the capability failure.</p>
|
|
5520
|
+
* @public
|
|
5521
|
+
*/
|
|
5522
|
+
details?: string | undefined;
|
|
5523
|
+
}
|
|
5524
|
+
/**
|
|
5525
|
+
* <p>The result of a <code>GetCapability</code> request. Contains details about the capability.</p>
|
|
5526
|
+
* @public
|
|
5527
|
+
*/
|
|
5528
|
+
export interface GetCapabilityResponse {
|
|
5529
|
+
/**
|
|
5530
|
+
* <p>The name of the capability.</p>
|
|
5531
|
+
* @public
|
|
5532
|
+
*/
|
|
5533
|
+
capabilityName?: string | undefined;
|
|
5534
|
+
/**
|
|
5535
|
+
* <p>The unique identifier of the OpenSearch UI application.</p>
|
|
5536
|
+
* @public
|
|
5537
|
+
*/
|
|
5538
|
+
applicationId?: string | undefined;
|
|
5539
|
+
/**
|
|
5540
|
+
* <p>The current status of the capability. Possible values: <code>creating</code>, <code>create_failed</code>, <code>active</code>, <code>updating</code>, <code>update_failed</code>, <code>deleting</code>, <code>delete_failed</code>.</p>
|
|
5541
|
+
* @public
|
|
5542
|
+
*/
|
|
5543
|
+
status?: CapabilityStatus | undefined;
|
|
5544
|
+
/**
|
|
5545
|
+
* <p>The configuration settings for the capability, including capability-specific settings such as AI configuration.</p>
|
|
5546
|
+
* @public
|
|
5547
|
+
*/
|
|
5548
|
+
capabilityConfig?: CapabilityExtendedResponseConfig | undefined;
|
|
5549
|
+
/**
|
|
5550
|
+
* <p>A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.</p>
|
|
5551
|
+
* @public
|
|
5552
|
+
*/
|
|
5553
|
+
failures?: CapabilityFailure[] | undefined;
|
|
5554
|
+
}
|
|
5421
5555
|
/**
|
|
5422
5556
|
* <p>Container for the request parameters to <code>GetCompatibleVersions</code> operation.</p>
|
|
5423
5557
|
* @public
|
|
@@ -6898,6 +7032,120 @@ export interface PutDefaultApplicationSettingResponse {
|
|
|
6898
7032
|
*/
|
|
6899
7033
|
applicationArn?: string | undefined;
|
|
6900
7034
|
}
|
|
7035
|
+
/**
|
|
7036
|
+
* <p>The base configuration for registering a capability. Contains capability-specific configuration such as AI settings.</p>
|
|
7037
|
+
* @public
|
|
7038
|
+
*/
|
|
7039
|
+
export type CapabilityBaseRequestConfig = CapabilityBaseRequestConfig.AiConfigMember | CapabilityBaseRequestConfig.$UnknownMember;
|
|
7040
|
+
/**
|
|
7041
|
+
* @public
|
|
7042
|
+
*/
|
|
7043
|
+
export declare namespace CapabilityBaseRequestConfig {
|
|
7044
|
+
/**
|
|
7045
|
+
* <p>Configuration settings for AI-powered capabilities.</p>
|
|
7046
|
+
* @public
|
|
7047
|
+
*/
|
|
7048
|
+
interface AiConfigMember {
|
|
7049
|
+
aiConfig: AIConfig;
|
|
7050
|
+
$unknown?: never;
|
|
7051
|
+
}
|
|
7052
|
+
/**
|
|
7053
|
+
* @public
|
|
7054
|
+
*/
|
|
7055
|
+
interface $UnknownMember {
|
|
7056
|
+
aiConfig?: never;
|
|
7057
|
+
$unknown: [string, any];
|
|
7058
|
+
}
|
|
7059
|
+
/**
|
|
7060
|
+
* @deprecated unused in schema-serde mode.
|
|
7061
|
+
*
|
|
7062
|
+
*/
|
|
7063
|
+
interface Visitor<T> {
|
|
7064
|
+
aiConfig: (value: AIConfig) => T;
|
|
7065
|
+
_: (name: string, value: any) => T;
|
|
7066
|
+
}
|
|
7067
|
+
}
|
|
7068
|
+
/**
|
|
7069
|
+
* <p>Container for the parameters to the <code>RegisterCapability</code> operation.</p>
|
|
7070
|
+
* @public
|
|
7071
|
+
*/
|
|
7072
|
+
export interface RegisterCapabilityRequest {
|
|
7073
|
+
/**
|
|
7074
|
+
* <p>The unique identifier of the OpenSearch UI application to register the capability for.</p>
|
|
7075
|
+
* @public
|
|
7076
|
+
*/
|
|
7077
|
+
applicationId: string | undefined;
|
|
7078
|
+
/**
|
|
7079
|
+
* <p>The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use <code>ai-capability</code>
|
|
7080
|
+
* </p>
|
|
7081
|
+
* @public
|
|
7082
|
+
*/
|
|
7083
|
+
capabilityName: string | undefined;
|
|
7084
|
+
/**
|
|
7085
|
+
* <p>The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration.</p>
|
|
7086
|
+
* @public
|
|
7087
|
+
*/
|
|
7088
|
+
capabilityConfig: CapabilityBaseRequestConfig | undefined;
|
|
7089
|
+
}
|
|
7090
|
+
/**
|
|
7091
|
+
* <p>The base configuration returned for a registered capability.</p>
|
|
7092
|
+
* @public
|
|
7093
|
+
*/
|
|
7094
|
+
export type CapabilityBaseResponseConfig = CapabilityBaseResponseConfig.AiConfigMember | CapabilityBaseResponseConfig.$UnknownMember;
|
|
7095
|
+
/**
|
|
7096
|
+
* @public
|
|
7097
|
+
*/
|
|
7098
|
+
export declare namespace CapabilityBaseResponseConfig {
|
|
7099
|
+
/**
|
|
7100
|
+
* <p>Configuration settings for AI-powered capabilities.</p>
|
|
7101
|
+
* @public
|
|
7102
|
+
*/
|
|
7103
|
+
interface AiConfigMember {
|
|
7104
|
+
aiConfig: AIConfig;
|
|
7105
|
+
$unknown?: never;
|
|
7106
|
+
}
|
|
7107
|
+
/**
|
|
7108
|
+
* @public
|
|
7109
|
+
*/
|
|
7110
|
+
interface $UnknownMember {
|
|
7111
|
+
aiConfig?: never;
|
|
7112
|
+
$unknown: [string, any];
|
|
7113
|
+
}
|
|
7114
|
+
/**
|
|
7115
|
+
* @deprecated unused in schema-serde mode.
|
|
7116
|
+
*
|
|
7117
|
+
*/
|
|
7118
|
+
interface Visitor<T> {
|
|
7119
|
+
aiConfig: (value: AIConfig) => T;
|
|
7120
|
+
_: (name: string, value: any) => T;
|
|
7121
|
+
}
|
|
7122
|
+
}
|
|
7123
|
+
/**
|
|
7124
|
+
* <p>The result of a <code>RegisterCapability</code> request. Contains details about the registered capability.</p>
|
|
7125
|
+
* @public
|
|
7126
|
+
*/
|
|
7127
|
+
export interface RegisterCapabilityResponse {
|
|
7128
|
+
/**
|
|
7129
|
+
* <p>The name of the registered capability.</p>
|
|
7130
|
+
* @public
|
|
7131
|
+
*/
|
|
7132
|
+
capabilityName?: string | undefined;
|
|
7133
|
+
/**
|
|
7134
|
+
* <p>The unique identifier of the OpenSearch UI application.</p>
|
|
7135
|
+
* @public
|
|
7136
|
+
*/
|
|
7137
|
+
applicationId?: string | undefined;
|
|
7138
|
+
/**
|
|
7139
|
+
* <p>The current status of the capability. Possible values: <code>creating</code>, <code>create_failed</code>, <code>active</code>, <code>updating</code>, <code>update_failed</code>, <code>deleting</code>, <code>delete_failed</code>.</p>
|
|
7140
|
+
* @public
|
|
7141
|
+
*/
|
|
7142
|
+
status?: CapabilityStatus | undefined;
|
|
7143
|
+
/**
|
|
7144
|
+
* <p>The configuration settings for the registered capability.</p>
|
|
7145
|
+
* @public
|
|
7146
|
+
*/
|
|
7147
|
+
capabilityConfig?: CapabilityBaseResponseConfig | undefined;
|
|
7148
|
+
}
|
|
6901
7149
|
/**
|
|
6902
7150
|
* <p>Container for the request parameters to the <code>RejectInboundConnection</code>
|
|
6903
7151
|
* operation.</p>
|
|
@@ -7153,368 +7401,3 @@ export interface UpdateDataSourceRequest {
|
|
|
7153
7401
|
*/
|
|
7154
7402
|
Status?: DataSourceStatus | undefined;
|
|
7155
7403
|
}
|
|
7156
|
-
/**
|
|
7157
|
-
* <p>The result of an <code>UpdateDataSource</code> operation.</p>
|
|
7158
|
-
* @public
|
|
7159
|
-
*/
|
|
7160
|
-
export interface UpdateDataSourceResponse {
|
|
7161
|
-
/**
|
|
7162
|
-
* <p>A message associated with the updated data source.</p>
|
|
7163
|
-
* @public
|
|
7164
|
-
*/
|
|
7165
|
-
Message?: string | undefined;
|
|
7166
|
-
}
|
|
7167
|
-
/**
|
|
7168
|
-
* @public
|
|
7169
|
-
*/
|
|
7170
|
-
export interface UpdateDirectQueryDataSourceRequest {
|
|
7171
|
-
/**
|
|
7172
|
-
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
7173
|
-
* Service environment. </p>
|
|
7174
|
-
* @public
|
|
7175
|
-
*/
|
|
7176
|
-
DataSourceName: string | undefined;
|
|
7177
|
-
/**
|
|
7178
|
-
* <p> The supported Amazon Web Services service that you want to use as the source for
|
|
7179
|
-
* direct queries in OpenSearch Service. </p>
|
|
7180
|
-
* @public
|
|
7181
|
-
*/
|
|
7182
|
-
DataSourceType: DirectQueryDataSourceType | undefined;
|
|
7183
|
-
/**
|
|
7184
|
-
* <p> An optional text field for providing additional context and details about the data
|
|
7185
|
-
* source. </p>
|
|
7186
|
-
* @public
|
|
7187
|
-
*/
|
|
7188
|
-
Description?: string | undefined;
|
|
7189
|
-
/**
|
|
7190
|
-
* <p> An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
7191
|
-
* associated with the direct query data source. This field is required for CloudWatchLogs
|
|
7192
|
-
* and SecurityLake datasource types. </p>
|
|
7193
|
-
* @public
|
|
7194
|
-
*/
|
|
7195
|
-
OpenSearchArns?: string[] | undefined;
|
|
7196
|
-
/**
|
|
7197
|
-
* <p> An optional IAM access policy document that defines the updated permissions for accessing the direct query data source.
|
|
7198
|
-
* The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged. </p>
|
|
7199
|
-
* @public
|
|
7200
|
-
*/
|
|
7201
|
-
DataSourceAccessPolicy?: string | undefined;
|
|
7202
|
-
}
|
|
7203
|
-
/**
|
|
7204
|
-
* @public
|
|
7205
|
-
*/
|
|
7206
|
-
export interface UpdateDirectQueryDataSourceResponse {
|
|
7207
|
-
/**
|
|
7208
|
-
* <p> The unique, system-generated identifier that represents the data source. </p>
|
|
7209
|
-
* @public
|
|
7210
|
-
*/
|
|
7211
|
-
DataSourceArn?: string | undefined;
|
|
7212
|
-
}
|
|
7213
|
-
/**
|
|
7214
|
-
* <p>Container for the request parameters to the <code>UpdateDomain</code>
|
|
7215
|
-
* operation.</p>
|
|
7216
|
-
* @public
|
|
7217
|
-
*/
|
|
7218
|
-
export interface UpdateDomainConfigRequest {
|
|
7219
|
-
/**
|
|
7220
|
-
* <p>The name of the domain that you're updating.</p>
|
|
7221
|
-
* @public
|
|
7222
|
-
*/
|
|
7223
|
-
DomainName: string | undefined;
|
|
7224
|
-
/**
|
|
7225
|
-
* <p>Changes that you want to make to the cluster configuration, such as the instance type
|
|
7226
|
-
* and number of EC2 instances.</p>
|
|
7227
|
-
* @public
|
|
7228
|
-
*/
|
|
7229
|
-
ClusterConfig?: ClusterConfig | undefined;
|
|
7230
|
-
/**
|
|
7231
|
-
* <p>The type and size of the EBS volume to attach to instances in the domain.</p>
|
|
7232
|
-
* @public
|
|
7233
|
-
*/
|
|
7234
|
-
EBSOptions?: EBSOptions | undefined;
|
|
7235
|
-
/**
|
|
7236
|
-
* <p>Option to set the time, in UTC format, for the daily automated snapshot. Default value
|
|
7237
|
-
* is <code>0</code> hours. </p>
|
|
7238
|
-
* @public
|
|
7239
|
-
*/
|
|
7240
|
-
SnapshotOptions?: SnapshotOptions | undefined;
|
|
7241
|
-
/**
|
|
7242
|
-
* <p>Options to specify the subnets and security groups for a VPC endpoint. For more
|
|
7243
|
-
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching your Amazon
|
|
7244
|
-
* OpenSearch Service domains using a VPC</a>.</p>
|
|
7245
|
-
* @public
|
|
7246
|
-
*/
|
|
7247
|
-
VPCOptions?: VPCOptions | undefined;
|
|
7248
|
-
/**
|
|
7249
|
-
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch
|
|
7250
|
-
* Dashboards.</p>
|
|
7251
|
-
* @public
|
|
7252
|
-
*/
|
|
7253
|
-
CognitoOptions?: CognitoOptions | undefined;
|
|
7254
|
-
/**
|
|
7255
|
-
* <p>Key-value pairs to specify advanced configuration options. The following key-value
|
|
7256
|
-
* pairs are supported:</p>
|
|
7257
|
-
* <ul>
|
|
7258
|
-
* <li>
|
|
7259
|
-
* <p>
|
|
7260
|
-
* <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note
|
|
7261
|
-
* the use of a string rather than a boolean. Specifies whether explicit references
|
|
7262
|
-
* to indexes are allowed inside the body of HTTP requests. If you want to
|
|
7263
|
-
* configure access policies for domain sub-resources, such as specific indexes and
|
|
7264
|
-
* domain APIs, you must disable this property. Default is true.</p>
|
|
7265
|
-
* </li>
|
|
7266
|
-
* <li>
|
|
7267
|
-
* <p>
|
|
7268
|
-
* <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string
|
|
7269
|
-
* rather than a boolean. Specifies the percentage of heap space allocated to field
|
|
7270
|
-
* data. Default is unbounded.</p>
|
|
7271
|
-
* </li>
|
|
7272
|
-
* <li>
|
|
7273
|
-
* <p>
|
|
7274
|
-
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a
|
|
7275
|
-
* string rather than a boolean. Specifies the maximum number of clauses allowed in
|
|
7276
|
-
* a Lucene boolean query. Default is 1,024. Queries with more than the permitted
|
|
7277
|
-
* number of clauses result in a <code>TooManyClauses</code> error.</p>
|
|
7278
|
-
* </li>
|
|
7279
|
-
* </ul>
|
|
7280
|
-
* <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>
|
|
7281
|
-
* @public
|
|
7282
|
-
*/
|
|
7283
|
-
AdvancedOptions?: Record<string, string> | undefined;
|
|
7284
|
-
/**
|
|
7285
|
-
* <p>Identity and Access Management (IAM) access policy as a JSON-formatted string.</p>
|
|
7286
|
-
* @public
|
|
7287
|
-
*/
|
|
7288
|
-
AccessPolicies?: string | undefined;
|
|
7289
|
-
/**
|
|
7290
|
-
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to
|
|
7291
|
-
* share domain resources across IPv4 and IPv6 address types, and is the recommended
|
|
7292
|
-
* option. If your IP address type is currently set to dual stack, you can't change it.
|
|
7293
|
-
* </p>
|
|
7294
|
-
* @public
|
|
7295
|
-
*/
|
|
7296
|
-
IPAddressType?: IPAddressType | undefined;
|
|
7297
|
-
/**
|
|
7298
|
-
* <p>Options to publish OpenSearch logs to Amazon CloudWatch Logs.</p>
|
|
7299
|
-
* @public
|
|
7300
|
-
*/
|
|
7301
|
-
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
7302
|
-
/**
|
|
7303
|
-
* <p>Encryption at rest options for the domain.</p>
|
|
7304
|
-
* @public
|
|
7305
|
-
*/
|
|
7306
|
-
EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
|
|
7307
|
-
/**
|
|
7308
|
-
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
7309
|
-
* traffic.</p>
|
|
7310
|
-
* @public
|
|
7311
|
-
*/
|
|
7312
|
-
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
7313
|
-
/**
|
|
7314
|
-
* <p>Node-to-node encryption options for the domain.</p>
|
|
7315
|
-
* @public
|
|
7316
|
-
*/
|
|
7317
|
-
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
|
|
7318
|
-
/**
|
|
7319
|
-
* <p>Options for fine-grained access control.</p>
|
|
7320
|
-
* @public
|
|
7321
|
-
*/
|
|
7322
|
-
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
7323
|
-
/**
|
|
7324
|
-
* <p>Configuration settings for enabling and managing IAM Identity Center.</p>
|
|
7325
|
-
* @public
|
|
7326
|
-
*/
|
|
7327
|
-
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
7328
|
-
/**
|
|
7329
|
-
* <p>Options for Auto-Tune.</p>
|
|
7330
|
-
* @public
|
|
7331
|
-
*/
|
|
7332
|
-
AutoTuneOptions?: AutoTuneOptions | undefined;
|
|
7333
|
-
/**
|
|
7334
|
-
* <p>This flag, when set to True, specifies whether the <code>UpdateDomain</code> request
|
|
7335
|
-
* should return the results of a dry run analysis without actually applying the change. A
|
|
7336
|
-
* dry run determines what type of deployment the update will cause.</p>
|
|
7337
|
-
* @public
|
|
7338
|
-
*/
|
|
7339
|
-
DryRun?: boolean | undefined;
|
|
7340
|
-
/**
|
|
7341
|
-
* <p>The type of dry run to perform.</p>
|
|
7342
|
-
* <ul>
|
|
7343
|
-
* <li>
|
|
7344
|
-
* <p>
|
|
7345
|
-
* <code>Basic</code> only returns the type of deployment (blue/green or dynamic)
|
|
7346
|
-
* that the update will cause.</p>
|
|
7347
|
-
* </li>
|
|
7348
|
-
* <li>
|
|
7349
|
-
* <p>
|
|
7350
|
-
* <code>Verbose</code> runs an additional check to validate the changes you're
|
|
7351
|
-
* making. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check">Validating a domain update</a>.</p>
|
|
7352
|
-
* </li>
|
|
7353
|
-
* </ul>
|
|
7354
|
-
* @public
|
|
7355
|
-
*/
|
|
7356
|
-
DryRunMode?: DryRunMode | undefined;
|
|
7357
|
-
/**
|
|
7358
|
-
* <p>Off-peak window options for the domain.</p>
|
|
7359
|
-
* @public
|
|
7360
|
-
*/
|
|
7361
|
-
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
7362
|
-
/**
|
|
7363
|
-
* <p>Service software update options for the domain.</p>
|
|
7364
|
-
* @public
|
|
7365
|
-
*/
|
|
7366
|
-
SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
|
|
7367
|
-
/**
|
|
7368
|
-
* <p>Options for all machine learning features for the specified domain.</p>
|
|
7369
|
-
* @public
|
|
7370
|
-
*/
|
|
7371
|
-
AIMLOptions?: AIMLOptionsInput | undefined;
|
|
7372
|
-
/**
|
|
7373
|
-
* <p>Specifies the deployment strategy options for the domain.</p>
|
|
7374
|
-
* @public
|
|
7375
|
-
*/
|
|
7376
|
-
DeploymentStrategyOptions?: DeploymentStrategyOptions | undefined;
|
|
7377
|
-
}
|
|
7378
|
-
/**
|
|
7379
|
-
* <p>The results of an <code>UpdateDomain</code> request. Contains the status of the domain
|
|
7380
|
-
* being updated.</p>
|
|
7381
|
-
* @public
|
|
7382
|
-
*/
|
|
7383
|
-
export interface UpdateDomainConfigResponse {
|
|
7384
|
-
/**
|
|
7385
|
-
* <p>The status of the updated domain.</p>
|
|
7386
|
-
* @public
|
|
7387
|
-
*/
|
|
7388
|
-
DomainConfig: DomainConfig | undefined;
|
|
7389
|
-
/**
|
|
7390
|
-
* <p>Results of the dry run performed in the update domain request.</p>
|
|
7391
|
-
* @public
|
|
7392
|
-
*/
|
|
7393
|
-
DryRunResults?: DryRunResults | undefined;
|
|
7394
|
-
/**
|
|
7395
|
-
* <p>The status of the dry run being performed on the domain, if any.</p>
|
|
7396
|
-
* @public
|
|
7397
|
-
*/
|
|
7398
|
-
DryRunProgressStatus?: DryRunProgressStatus | undefined;
|
|
7399
|
-
}
|
|
7400
|
-
/**
|
|
7401
|
-
* @public
|
|
7402
|
-
*/
|
|
7403
|
-
export interface UpdateIndexRequest {
|
|
7404
|
-
/**
|
|
7405
|
-
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
7406
|
-
* owned by an account within an Amazon Web Services Region.</p>
|
|
7407
|
-
* @public
|
|
7408
|
-
*/
|
|
7409
|
-
DomainName: string | undefined;
|
|
7410
|
-
/**
|
|
7411
|
-
* <p>The name of the index to update.</p>
|
|
7412
|
-
* @public
|
|
7413
|
-
*/
|
|
7414
|
-
IndexName: string | undefined;
|
|
7415
|
-
/**
|
|
7416
|
-
* <p>The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration.</p>
|
|
7417
|
-
* @public
|
|
7418
|
-
*/
|
|
7419
|
-
IndexSchema: __DocumentType | undefined;
|
|
7420
|
-
}
|
|
7421
|
-
/**
|
|
7422
|
-
* @public
|
|
7423
|
-
*/
|
|
7424
|
-
export interface UpdateIndexResponse {
|
|
7425
|
-
/**
|
|
7426
|
-
* <p>The status of the index update operation.</p>
|
|
7427
|
-
* @public
|
|
7428
|
-
*/
|
|
7429
|
-
Status: IndexStatus | undefined;
|
|
7430
|
-
}
|
|
7431
|
-
/**
|
|
7432
|
-
* <p>Container for request parameters to the <code>UpdatePackage</code> operation.</p>
|
|
7433
|
-
* @public
|
|
7434
|
-
*/
|
|
7435
|
-
export interface UpdatePackageRequest {
|
|
7436
|
-
/**
|
|
7437
|
-
* <p>The unique identifier for the package.</p>
|
|
7438
|
-
* @public
|
|
7439
|
-
*/
|
|
7440
|
-
PackageID: string | undefined;
|
|
7441
|
-
/**
|
|
7442
|
-
* <p>Amazon S3 bucket and key for the package.</p>
|
|
7443
|
-
* @public
|
|
7444
|
-
*/
|
|
7445
|
-
PackageSource: PackageSource | undefined;
|
|
7446
|
-
/**
|
|
7447
|
-
* <p>A new description of the package.</p>
|
|
7448
|
-
* @public
|
|
7449
|
-
*/
|
|
7450
|
-
PackageDescription?: string | undefined;
|
|
7451
|
-
/**
|
|
7452
|
-
* <p>Commit message for the updated file, which is shown as part of
|
|
7453
|
-
* <code>GetPackageVersionHistoryResponse</code>.</p>
|
|
7454
|
-
* @public
|
|
7455
|
-
*/
|
|
7456
|
-
CommitMessage?: string | undefined;
|
|
7457
|
-
/**
|
|
7458
|
-
* <p>The updated configuration details for a package.</p>
|
|
7459
|
-
* @public
|
|
7460
|
-
*/
|
|
7461
|
-
PackageConfiguration?: PackageConfiguration | undefined;
|
|
7462
|
-
/**
|
|
7463
|
-
* <p>Encryption options for a package.</p>
|
|
7464
|
-
* @public
|
|
7465
|
-
*/
|
|
7466
|
-
PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
|
|
7467
|
-
}
|
|
7468
|
-
/**
|
|
7469
|
-
* <p>Container for the response returned by the <code>UpdatePackage</code>
|
|
7470
|
-
* operation.</p>
|
|
7471
|
-
* @public
|
|
7472
|
-
*/
|
|
7473
|
-
export interface UpdatePackageResponse {
|
|
7474
|
-
/**
|
|
7475
|
-
* <p>Information about a package.</p>
|
|
7476
|
-
* @public
|
|
7477
|
-
*/
|
|
7478
|
-
PackageDetails?: PackageDetails | undefined;
|
|
7479
|
-
}
|
|
7480
|
-
/**
|
|
7481
|
-
* @public
|
|
7482
|
-
*/
|
|
7483
|
-
export interface UpdatePackageScopeRequest {
|
|
7484
|
-
/**
|
|
7485
|
-
* <p>ID of the package whose scope is being updated.</p>
|
|
7486
|
-
* @public
|
|
7487
|
-
*/
|
|
7488
|
-
PackageID: string | undefined;
|
|
7489
|
-
/**
|
|
7490
|
-
* <p> The operation to perform on the package scope (e.g., add/remove/override
|
|
7491
|
-
* users).</p>
|
|
7492
|
-
* @public
|
|
7493
|
-
*/
|
|
7494
|
-
Operation: PackageScopeOperationEnum | undefined;
|
|
7495
|
-
/**
|
|
7496
|
-
* <p> List of users to be added or removed from the package scope.</p>
|
|
7497
|
-
* @public
|
|
7498
|
-
*/
|
|
7499
|
-
PackageUserList: string[] | undefined;
|
|
7500
|
-
}
|
|
7501
|
-
/**
|
|
7502
|
-
* @public
|
|
7503
|
-
*/
|
|
7504
|
-
export interface UpdatePackageScopeResponse {
|
|
7505
|
-
/**
|
|
7506
|
-
* <p> ID of the package whose scope was updated.</p>
|
|
7507
|
-
* @public
|
|
7508
|
-
*/
|
|
7509
|
-
PackageID?: string | undefined;
|
|
7510
|
-
/**
|
|
7511
|
-
* <p>The operation that was performed on the package scope.</p>
|
|
7512
|
-
* @public
|
|
7513
|
-
*/
|
|
7514
|
-
Operation?: PackageScopeOperationEnum | undefined;
|
|
7515
|
-
/**
|
|
7516
|
-
* <p> List of users who have access to the package after the scope update.</p>
|
|
7517
|
-
* @public
|
|
7518
|
-
*/
|
|
7519
|
-
PackageUserList?: string[] | undefined;
|
|
7520
|
-
}
|