@aws-sdk/client-opensearch 3.926.0 → 3.927.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 +20 -4
- package/dist-cjs/index.js +88 -0
- package/dist-es/OpenSearch.js +4 -0
- package/dist-es/commands/GetDefaultApplicationSettingCommand.js +22 -0
- package/dist-es/commands/PutDefaultApplicationSettingCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +50 -0
- package/dist-types/OpenSearch.d.ts +19 -4
- package/dist-types/OpenSearchClient.d.ts +8 -6
- package/dist-types/commands/AcceptInboundConnectionCommand.d.ts +1 -2
- package/dist-types/commands/AddDataSourceCommand.d.ts +3 -2
- package/dist-types/commands/AddDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/AddTagsCommand.d.ts +4 -4
- package/dist-types/commands/AssociatePackageCommand.d.ts +3 -3
- package/dist-types/commands/AssociatePackagesCommand.d.ts +2 -1
- package/dist-types/commands/AuthorizeVpcEndpointAccessCommand.d.ts +2 -2
- package/dist-types/commands/CancelServiceSoftwareUpdateCommand.d.ts +5 -3
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -1
- package/dist-types/commands/CreateOutboundConnectionCommand.d.ts +2 -3
- package/dist-types/commands/CreatePackageCommand.d.ts +3 -2
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/DeleteDomainCommand.d.ts +2 -2
- package/dist-types/commands/DeleteInboundConnectionCommand.d.ts +2 -3
- package/dist-types/commands/DeleteOutboundConnectionCommand.d.ts +2 -3
- package/dist-types/commands/DeletePackageCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDomainAutoTunesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDomainChangeProgressCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDomainCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDomainHealthCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainNodesCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDomainsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDryRunProgressCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInboundConnectionsCommand.d.ts +2 -3
- package/dist-types/commands/DescribeInstanceTypeLimitsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeOutboundConnectionsCommand.d.ts +2 -3
- package/dist-types/commands/DescribePackagesCommand.d.ts +3 -2
- package/dist-types/commands/DescribeReservedInstanceOfferingsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeReservedInstancesCommand.d.ts +3 -3
- package/dist-types/commands/DissociatePackageCommand.d.ts +5 -4
- package/dist-types/commands/GetCompatibleVersionsCommand.d.ts +2 -2
- package/dist-types/commands/GetDefaultApplicationSettingCommand.d.ts +86 -0
- package/dist-types/commands/GetDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/GetPackageVersionHistoryCommand.d.ts +4 -3
- 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 +3 -3
- package/dist-types/commands/ListDirectQueryDataSourcesCommand.d.ts +2 -4
- package/dist-types/commands/ListDomainNamesCommand.d.ts +3 -4
- package/dist-types/commands/ListDomainsForPackageCommand.d.ts +2 -2
- package/dist-types/commands/ListInstanceTypeDetailsCommand.d.ts +2 -2
- package/dist-types/commands/ListPackagesForDomainCommand.d.ts +2 -2
- package/dist-types/commands/ListScheduledActionsCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsCommand.d.ts +1 -2
- package/dist-types/commands/ListVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListVpcEndpointAccessCommand.d.ts +3 -2
- package/dist-types/commands/ListVpcEndpointsForDomainCommand.d.ts +2 -2
- package/dist-types/commands/PutDefaultApplicationSettingCommand.d.ts +91 -0
- package/dist-types/commands/RejectInboundConnectionCommand.d.ts +2 -2
- package/dist-types/commands/RemoveTagsCommand.d.ts +2 -2
- package/dist-types/commands/RevokeVpcEndpointAccessCommand.d.ts +2 -2
- package/dist-types/commands/StartDomainMaintenanceCommand.d.ts +3 -2
- package/dist-types/commands/StartServiceSoftwareUpdateCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +3 -2
- package/dist-types/commands/UpdateDirectQueryDataSourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateDomainConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePackageCommand.d.ts +3 -2
- package/dist-types/commands/UpdatePackageScopeCommand.d.ts +2 -1
- package/dist-types/commands/UpdateScheduledActionCommand.d.ts +3 -4
- package/dist-types/commands/UpgradeDomainCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +4 -4
- package/dist-types/models/models_0.d.ts +904 -793
- package/dist-types/models/models_1.d.ts +257 -183
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/OpenSearch.d.ts +35 -0
- package/dist-types/ts3.4/OpenSearchClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetDefaultApplicationSettingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/PutDefaultApplicationSettingCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +4 -7
- package/dist-types/ts3.4/models/models_1.d.ts +15 -1
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +5 -5
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { OpenSearchServiceException as __BaseException } from "./OpenSearchServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>Container for the parameters to the <code>AcceptInboundConnection</code>
|
|
4
|
+
* <p>Container for the parameters to the <code>AcceptInboundConnection</code>
|
|
5
|
+
* operation.</p>
|
|
5
6
|
* @public
|
|
6
7
|
*/
|
|
7
8
|
export interface AcceptInboundConnectionRequest {
|
|
@@ -51,42 +52,43 @@ export interface InboundConnectionStatus {
|
|
|
51
52
|
* <ul>
|
|
52
53
|
* <li>
|
|
53
54
|
* <p>
|
|
54
|
-
* <b>PENDING_ACCEPTANCE</b> - Inbound connection is
|
|
55
|
-
*
|
|
55
|
+
* <b>PENDING_ACCEPTANCE</b> - Inbound connection is
|
|
56
|
+
* not yet accepted by the remote domain owner.</p>
|
|
56
57
|
* </li>
|
|
57
58
|
* <li>
|
|
58
59
|
* <p>
|
|
59
|
-
* <b>APPROVED</b>: Inbound connection is pending
|
|
60
|
-
*
|
|
60
|
+
* <b>APPROVED</b>: Inbound connection is pending
|
|
61
|
+
* acceptance by the remote domain owner.</p>
|
|
61
62
|
* </li>
|
|
62
63
|
* <li>
|
|
63
64
|
* <p>
|
|
64
65
|
* <b>PROVISIONING</b>: Inbound connection is being
|
|
65
|
-
*
|
|
66
|
+
* provisioned.</p>
|
|
66
67
|
* </li>
|
|
67
68
|
* <li>
|
|
68
69
|
* <p>
|
|
69
|
-
* <b>ACTIVE</b>: Inbound connection is active and
|
|
70
|
-
*
|
|
70
|
+
* <b>ACTIVE</b>: Inbound connection is active and
|
|
71
|
+
* ready to use.</p>
|
|
71
72
|
* </li>
|
|
72
73
|
* <li>
|
|
73
74
|
* <p>
|
|
74
75
|
* <b>REJECTING</b>: Inbound connection rejection is in
|
|
75
|
-
*
|
|
76
|
+
* process.</p>
|
|
76
77
|
* </li>
|
|
77
78
|
* <li>
|
|
78
79
|
* <p>
|
|
79
|
-
* <b>REJECTED</b>: Inbound connection is
|
|
80
|
+
* <b>REJECTED</b>: Inbound connection is
|
|
81
|
+
* rejected.</p>
|
|
80
82
|
* </li>
|
|
81
83
|
* <li>
|
|
82
84
|
* <p>
|
|
83
85
|
* <b>DELETING</b>: Inbound connection deletion is in
|
|
84
|
-
*
|
|
86
|
+
* progress.</p>
|
|
85
87
|
* </li>
|
|
86
88
|
* <li>
|
|
87
89
|
* <p>
|
|
88
|
-
* <b>DELETED</b>: Inbound connection is deleted and
|
|
89
|
-
*
|
|
90
|
+
* <b>DELETED</b>: Inbound connection is deleted and
|
|
91
|
+
* can no longer be used.</p>
|
|
90
92
|
* </li>
|
|
91
93
|
* </ul>
|
|
92
94
|
* @public
|
|
@@ -132,8 +134,7 @@ export interface DomainInformationContainer {
|
|
|
132
134
|
}
|
|
133
135
|
/**
|
|
134
136
|
* <p>Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more
|
|
135
|
-
*
|
|
136
|
-
* for Amazon OpenSearch Service</a>.</p>
|
|
137
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.</p>
|
|
137
138
|
* @public
|
|
138
139
|
*/
|
|
139
140
|
export interface InboundConnection {
|
|
@@ -267,14 +268,14 @@ export interface OptionStatus {
|
|
|
267
268
|
PendingDeletion?: boolean | undefined;
|
|
268
269
|
}
|
|
269
270
|
/**
|
|
270
|
-
* <p>The configured access rules for the domain's search endpoint, and the current status
|
|
271
|
-
*
|
|
271
|
+
* <p>The configured access rules for the domain's search endpoint, and the current status
|
|
272
|
+
* of those rules.</p>
|
|
272
273
|
* @public
|
|
273
274
|
*/
|
|
274
275
|
export interface AccessPoliciesStatus {
|
|
275
276
|
/**
|
|
276
277
|
* <p>The access policy configured for the domain. Access policies can be resource-based,
|
|
277
|
-
*
|
|
278
|
+
* IP-based, or IAM-based. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies">Configuring access policies</a>.</p>
|
|
278
279
|
* @public
|
|
279
280
|
*/
|
|
280
281
|
Options: string | undefined;
|
|
@@ -368,8 +369,7 @@ export declare namespace DataSourceType {
|
|
|
368
369
|
const visit: <T>(value: DataSourceType, visitor: Visitor<T>) => T;
|
|
369
370
|
}
|
|
370
371
|
/**
|
|
371
|
-
* <p>Container for the parameters to the <code>AddDataSource</code>
|
|
372
|
-
* operation.</p>
|
|
372
|
+
* <p>Container for the parameters to the <code>AddDataSource</code> operation.</p>
|
|
373
373
|
* @public
|
|
374
374
|
*/
|
|
375
375
|
export interface AddDataSourceRequest {
|
|
@@ -454,44 +454,33 @@ export declare class ValidationException extends __BaseException {
|
|
|
454
454
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
455
455
|
}
|
|
456
456
|
/**
|
|
457
|
-
* <p>
|
|
458
|
-
*
|
|
459
|
-
* that can be used for direct queries.
|
|
460
|
-
* </p>
|
|
457
|
+
* <p> Configuration details for a CloudWatch Logs data source that can be used for direct
|
|
458
|
+
* queries. </p>
|
|
461
459
|
* @public
|
|
462
460
|
*/
|
|
463
461
|
export interface CloudWatchDirectQueryDataSource {
|
|
464
462
|
/**
|
|
465
|
-
* <p>
|
|
466
|
-
*
|
|
467
|
-
* OpenSearch Service permission to access the specified data source.
|
|
468
|
-
* </p>
|
|
463
|
+
* <p> The unique identifier of the IAM role that grants OpenSearch Service permission to
|
|
464
|
+
* access the specified data source. </p>
|
|
469
465
|
* @public
|
|
470
466
|
*/
|
|
471
467
|
RoleArn: string | undefined;
|
|
472
468
|
}
|
|
473
469
|
/**
|
|
474
|
-
* <p>
|
|
475
|
-
*
|
|
476
|
-
* that can be used for direct queries.
|
|
477
|
-
* </p>
|
|
470
|
+
* <p> Configuration details for a Security Lake data source that can be used for direct
|
|
471
|
+
* queries. </p>
|
|
478
472
|
* @public
|
|
479
473
|
*/
|
|
480
474
|
export interface SecurityLakeDirectQueryDataSource {
|
|
481
475
|
/**
|
|
482
|
-
* <p>
|
|
483
|
-
*
|
|
484
|
-
* Service permission to access the specified data source.
|
|
485
|
-
* </p>
|
|
476
|
+
* <p> The unique identifier of the IAM role that grants OpenSearch Service permission to
|
|
477
|
+
* access the specified data source. </p>
|
|
486
478
|
* @public
|
|
487
479
|
*/
|
|
488
480
|
RoleArn: string | undefined;
|
|
489
481
|
}
|
|
490
482
|
/**
|
|
491
|
-
* <p>
|
|
492
|
-
* The type of data source that is used for direct queries.
|
|
493
|
-
* This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.
|
|
494
|
-
* </p>
|
|
483
|
+
* <p> The type of data source that is used for direct queries. This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake. </p>
|
|
495
484
|
* @public
|
|
496
485
|
*/
|
|
497
486
|
export type DirectQueryDataSourceType = DirectQueryDataSourceType.CloudWatchLogMember | DirectQueryDataSourceType.SecurityLakeMember | DirectQueryDataSourceType.$UnknownMember;
|
|
@@ -500,9 +489,7 @@ export type DirectQueryDataSourceType = DirectQueryDataSourceType.CloudWatchLogM
|
|
|
500
489
|
*/
|
|
501
490
|
export declare namespace DirectQueryDataSourceType {
|
|
502
491
|
/**
|
|
503
|
-
* <p>
|
|
504
|
-
* Specifies CloudWatch Logs as a type of data source for direct queries.
|
|
505
|
-
* </p>
|
|
492
|
+
* <p> Specifies CloudWatch Logs as a type of data source for direct queries. </p>
|
|
506
493
|
* @public
|
|
507
494
|
*/
|
|
508
495
|
interface CloudWatchLogMember {
|
|
@@ -511,9 +498,7 @@ export declare namespace DirectQueryDataSourceType {
|
|
|
511
498
|
$unknown?: never;
|
|
512
499
|
}
|
|
513
500
|
/**
|
|
514
|
-
* <p>
|
|
515
|
-
* Specifies Security Lake as a type of data source for direct queries.
|
|
516
|
-
* </p>
|
|
501
|
+
* <p> Specifies Security Lake as a type of data source for direct queries. </p>
|
|
517
502
|
* @public
|
|
518
503
|
*/
|
|
519
504
|
interface SecurityLakeMember {
|
|
@@ -547,9 +532,9 @@ export interface Tag {
|
|
|
547
532
|
*/
|
|
548
533
|
Key: string | undefined;
|
|
549
534
|
/**
|
|
550
|
-
* <p>The value assigned to the corresponding tag key. Tag values can be null and don't have
|
|
551
|
-
*
|
|
552
|
-
*
|
|
535
|
+
* <p>The value assigned to the corresponding tag key. Tag values can be null and don't have
|
|
536
|
+
* to be unique in a tag set. For example, you can have a key value pair in a tag set of
|
|
537
|
+
* <code>project : Trinity</code> and <code>cost-center : Trinity</code>
|
|
553
538
|
* </p>
|
|
554
539
|
* @public
|
|
555
540
|
*/
|
|
@@ -560,32 +545,26 @@ export interface Tag {
|
|
|
560
545
|
*/
|
|
561
546
|
export interface AddDirectQueryDataSourceRequest {
|
|
562
547
|
/**
|
|
563
|
-
* <p>
|
|
564
|
-
*
|
|
565
|
-
* within your OpenSearch Service environment.
|
|
566
|
-
* </p>
|
|
548
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
549
|
+
* Service environment. </p>
|
|
567
550
|
* @public
|
|
568
551
|
*/
|
|
569
552
|
DataSourceName: string | undefined;
|
|
570
553
|
/**
|
|
571
|
-
* <p>
|
|
572
|
-
*
|
|
573
|
-
* </p>
|
|
554
|
+
* <p> The supported Amazon Web Services service that you want to use as the source for
|
|
555
|
+
* direct queries in OpenSearch Service. </p>
|
|
574
556
|
* @public
|
|
575
557
|
*/
|
|
576
558
|
DataSourceType: DirectQueryDataSourceType | undefined;
|
|
577
559
|
/**
|
|
578
|
-
* <p>
|
|
579
|
-
*
|
|
580
|
-
* </p>
|
|
560
|
+
* <p> An optional text field for providing additional context and details about the data
|
|
561
|
+
* source. </p>
|
|
581
562
|
* @public
|
|
582
563
|
*/
|
|
583
564
|
Description?: string | undefined;
|
|
584
565
|
/**
|
|
585
|
-
* <p>
|
|
586
|
-
*
|
|
587
|
-
* collections that are associated with the direct query data source.
|
|
588
|
-
* </p>
|
|
566
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
567
|
+
* associated with the direct query data source. </p>
|
|
589
568
|
* @public
|
|
590
569
|
*/
|
|
591
570
|
OpenSearchArns: string[] | undefined;
|
|
@@ -600,9 +579,7 @@ export interface AddDirectQueryDataSourceRequest {
|
|
|
600
579
|
*/
|
|
601
580
|
export interface AddDirectQueryDataSourceResponse {
|
|
602
581
|
/**
|
|
603
|
-
* <p>
|
|
604
|
-
* The unique, system-generated identifier that represents the data source.
|
|
605
|
-
* </p>
|
|
582
|
+
* <p> The unique, system-generated identifier that represents the data source. </p>
|
|
606
583
|
* @public
|
|
607
584
|
*/
|
|
608
585
|
DataSourceArn?: string | undefined;
|
|
@@ -616,15 +593,15 @@ export interface AdditionalLimit {
|
|
|
616
593
|
* <ul>
|
|
617
594
|
* <li>
|
|
618
595
|
* <p>
|
|
619
|
-
* <code>MaximumNumberOfDataNodesSupported</code> - This attribute only applies
|
|
620
|
-
*
|
|
621
|
-
*
|
|
596
|
+
* <code>MaximumNumberOfDataNodesSupported</code> - This attribute only applies
|
|
597
|
+
* to master nodes and specifies the maximum number of data nodes of a given
|
|
598
|
+
* instance type a master node can support.</p>
|
|
622
599
|
* </li>
|
|
623
600
|
* <li>
|
|
624
601
|
* <p>
|
|
625
|
-
* <code>MaximumNumberOfDataNodesWithoutMasterNode</code> - This attribute only
|
|
626
|
-
*
|
|
627
|
-
*
|
|
602
|
+
* <code>MaximumNumberOfDataNodesWithoutMasterNode</code> - This attribute only
|
|
603
|
+
* applies to data nodes and specifies the maximum number of data nodes of a given
|
|
604
|
+
* instance type can exist without a master node governing them.</p>
|
|
628
605
|
* </li>
|
|
629
606
|
* </ul>
|
|
630
607
|
* @public
|
|
@@ -637,14 +614,14 @@ export interface AdditionalLimit {
|
|
|
637
614
|
LimitValues?: string[] | undefined;
|
|
638
615
|
}
|
|
639
616
|
/**
|
|
640
|
-
* <p>Container for the parameters to the <code>AddTags</code> operation. Specifies the tags
|
|
641
|
-
*
|
|
617
|
+
* <p>Container for the parameters to the <code>AddTags</code> operation. Specifies the tags
|
|
618
|
+
* to attach to the domain, data source, or application.</p>
|
|
642
619
|
* @public
|
|
643
620
|
*/
|
|
644
621
|
export interface AddTagsRequest {
|
|
645
622
|
/**
|
|
646
|
-
* <p>Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or
|
|
647
|
-
*
|
|
623
|
+
* <p>Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or
|
|
624
|
+
* application to which you want to attach resource tags.</p>
|
|
648
625
|
* @public
|
|
649
626
|
*/
|
|
650
627
|
ARN: string | undefined;
|
|
@@ -656,35 +633,36 @@ export interface AddTagsRequest {
|
|
|
656
633
|
}
|
|
657
634
|
/**
|
|
658
635
|
* <p>Status of the advanced options for the specified domain. The following options are
|
|
659
|
-
*
|
|
636
|
+
* available: </p>
|
|
660
637
|
* <ul>
|
|
661
638
|
* <li>
|
|
662
639
|
* <p>
|
|
663
|
-
* <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note
|
|
664
|
-
*
|
|
665
|
-
*
|
|
666
|
-
*
|
|
667
|
-
*
|
|
640
|
+
* <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note
|
|
641
|
+
* the use of a string rather than a boolean. Specifies whether explicit references
|
|
642
|
+
* to indexes are allowed inside the body of HTTP requests. If you want to
|
|
643
|
+
* configure access policies for domain sub-resources, such as specific indexes and
|
|
644
|
+
* domain APIs, you must disable this property. Default is true.</p>
|
|
668
645
|
* </li>
|
|
669
646
|
* <li>
|
|
670
647
|
* <p>
|
|
671
|
-
* <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string
|
|
672
|
-
*
|
|
673
|
-
*
|
|
648
|
+
* <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string
|
|
649
|
+
* rather than a boolean. Specifies the percentage of heap space allocated to field
|
|
650
|
+
* data. Default is unbounded.</p>
|
|
674
651
|
* </li>
|
|
675
652
|
* <li>
|
|
676
653
|
* <p>
|
|
677
|
-
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
654
|
+
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a
|
|
655
|
+
* string rather than a boolean. Specifies the maximum number of clauses allowed in
|
|
656
|
+
* a Lucene boolean query. Default is 1,024. Queries with more than the permitted
|
|
657
|
+
* number of clauses result in a <code>TooManyClauses</code> error.</p>
|
|
681
658
|
* </li>
|
|
682
659
|
* <li>
|
|
683
660
|
* <p>
|
|
684
|
-
* <code>"override_main_response_version": "true" | "false"</code> - Note the use
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
661
|
+
* <code>"override_main_response_version": "true" | "false"</code> - Note the use
|
|
662
|
+
* of a string rather than a boolean. Specifies whether the domain reports its
|
|
663
|
+
* version as 7.10 to allow Elasticsearch OSS clients and plugins to continue
|
|
664
|
+
* working with it. Default is false when creating a domain and true when upgrading
|
|
665
|
+
* a domain.</p>
|
|
688
666
|
* </li>
|
|
689
667
|
* </ul>
|
|
690
668
|
* <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>
|
|
@@ -703,22 +681,22 @@ export interface AdvancedOptionsStatus {
|
|
|
703
681
|
Status: OptionStatus | undefined;
|
|
704
682
|
}
|
|
705
683
|
/**
|
|
706
|
-
* <p>
|
|
684
|
+
* <p>Output parameters showing the current IAM identity federation configuration.</p>
|
|
707
685
|
* @public
|
|
708
686
|
*/
|
|
709
687
|
export interface IAMFederationOptionsOutput {
|
|
710
688
|
/**
|
|
711
|
-
* <p>
|
|
689
|
+
* <p>Indicates whether IAM identity federation is currently enabled for the domain.</p>
|
|
712
690
|
* @public
|
|
713
691
|
*/
|
|
714
692
|
Enabled?: boolean | undefined;
|
|
715
693
|
/**
|
|
716
|
-
* <p>The key
|
|
694
|
+
* <p>The configured key in the SAML assertion for the user's subject identifier.</p>
|
|
717
695
|
* @public
|
|
718
696
|
*/
|
|
719
697
|
SubjectKey?: string | undefined;
|
|
720
698
|
/**
|
|
721
|
-
* <p>The key
|
|
699
|
+
* <p>The configured key in the SAML assertion for the user's role information.</p>
|
|
722
700
|
* @public
|
|
723
701
|
*/
|
|
724
702
|
RolesKey?: string | undefined;
|
|
@@ -812,59 +790,59 @@ export interface AdvancedSecurityOptions {
|
|
|
812
790
|
*/
|
|
813
791
|
InternalUserDatabaseEnabled?: boolean | undefined;
|
|
814
792
|
/**
|
|
815
|
-
* <p>Container for information about the SAML configuration for OpenSearch
|
|
793
|
+
* <p>Container for information about the SAML configuration for OpenSearch
|
|
794
|
+
* Dashboards.</p>
|
|
816
795
|
* @public
|
|
817
796
|
*/
|
|
818
797
|
SAMLOptions?: SAMLOptionsOutput | undefined;
|
|
819
798
|
/**
|
|
820
|
-
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
799
|
+
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
800
|
+
* Service.</p>
|
|
821
801
|
* @public
|
|
822
802
|
*/
|
|
823
803
|
JWTOptions?: JWTOptionsOutput | undefined;
|
|
824
804
|
/**
|
|
825
|
-
* <p>
|
|
805
|
+
* <p>Configuration options for IAM identity federation in advanced security
|
|
806
|
+
* settings.</p>
|
|
826
807
|
* @public
|
|
827
808
|
*/
|
|
828
809
|
IAMFederationOptions?: IAMFederationOptionsOutput | undefined;
|
|
829
810
|
/**
|
|
830
|
-
* <p>Date and time when the migration period will be disabled. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling
|
|
831
|
-
* fine-grained access control on an existing domain</a>.</p>
|
|
811
|
+
* <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 fine-grained access control on an existing domain</a>.</p>
|
|
832
812
|
* @public
|
|
833
813
|
*/
|
|
834
814
|
AnonymousAuthDisableDate?: Date | undefined;
|
|
835
815
|
/**
|
|
836
|
-
* <p>True if a 30-day migration period is enabled, during which administrators can create
|
|
837
|
-
*
|
|
838
|
-
* fine-grained access control on an existing domain</a>.</p>
|
|
816
|
+
* <p>True if a 30-day migration period is enabled, during which administrators can create
|
|
817
|
+
* role mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling fine-grained access control on an existing domain</a>.</p>
|
|
839
818
|
* @public
|
|
840
819
|
*/
|
|
841
820
|
AnonymousAuthEnabled?: boolean | undefined;
|
|
842
821
|
}
|
|
843
822
|
/**
|
|
844
|
-
* <p>
|
|
823
|
+
* <p>Input parameters for configuring IAM identity federation settings.</p>
|
|
845
824
|
* @public
|
|
846
825
|
*/
|
|
847
826
|
export interface IAMFederationOptionsInput {
|
|
848
827
|
/**
|
|
849
|
-
* <p>
|
|
828
|
+
* <p>Specifies whether IAM identity federation is enabled for the OpenSearch domain.</p>
|
|
850
829
|
* @public
|
|
851
830
|
*/
|
|
852
831
|
Enabled?: boolean | undefined;
|
|
853
832
|
/**
|
|
854
|
-
* <p>
|
|
855
|
-
* <code>sub</code>.</p>
|
|
833
|
+
* <p>The key in the SAML assertion that contains the user's subject identifier.</p>
|
|
856
834
|
* @public
|
|
857
835
|
*/
|
|
858
836
|
SubjectKey?: string | undefined;
|
|
859
837
|
/**
|
|
860
|
-
* <p>
|
|
861
|
-
* <code>roles</code>.</p>
|
|
838
|
+
* <p>The key in the SAML assertion that contains the user's role information.</p>
|
|
862
839
|
* @public
|
|
863
840
|
*/
|
|
864
841
|
RolesKey?: string | undefined;
|
|
865
842
|
}
|
|
866
843
|
/**
|
|
867
|
-
* <p>The JWT authentication and authorization configuration for an Amazon OpenSearch
|
|
844
|
+
* <p>The JWT authentication and authorization configuration for an Amazon OpenSearch
|
|
845
|
+
* Service domain.</p>
|
|
868
846
|
* @public
|
|
869
847
|
*/
|
|
870
848
|
export interface JWTOptionsInput {
|
|
@@ -896,19 +874,19 @@ export interface JWTOptionsInput {
|
|
|
896
874
|
export interface MasterUserOptions {
|
|
897
875
|
/**
|
|
898
876
|
* <p>Amazon Resource Name (ARN) for the master user. Only specify if
|
|
899
|
-
*
|
|
877
|
+
* <code>InternalUserDatabaseEnabled</code> is <code>false</code>.</p>
|
|
900
878
|
* @public
|
|
901
879
|
*/
|
|
902
880
|
MasterUserARN?: string | undefined;
|
|
903
881
|
/**
|
|
904
|
-
* <p>User name for the master user. Only specify if
|
|
905
|
-
*
|
|
882
|
+
* <p>User name for the master user. Only specify if
|
|
883
|
+
* <code>InternalUserDatabaseEnabled</code> is <code>true</code>.</p>
|
|
906
884
|
* @public
|
|
907
885
|
*/
|
|
908
886
|
MasterUserName?: string | undefined;
|
|
909
887
|
/**
|
|
910
|
-
* <p>Password for the master user. Only specify if <code>InternalUserDatabaseEnabled</code>
|
|
911
|
-
*
|
|
888
|
+
* <p>Password for the master user. Only specify if <code>InternalUserDatabaseEnabled</code>
|
|
889
|
+
* is <code>true</code>.</p>
|
|
912
890
|
* @public
|
|
913
891
|
*/
|
|
914
892
|
MasterUserPassword?: string | undefined;
|
|
@@ -929,7 +907,8 @@ export interface SAMLOptionsInput {
|
|
|
929
907
|
*/
|
|
930
908
|
Idp?: SAMLIdp | undefined;
|
|
931
909
|
/**
|
|
932
|
-
* <p>The SAML master user name, which is stored in the domain's internal user
|
|
910
|
+
* <p>The SAML master user name, which is stored in the domain's internal user
|
|
911
|
+
* database.</p>
|
|
933
912
|
* @public
|
|
934
913
|
*/
|
|
935
914
|
MasterUserName?: string | undefined;
|
|
@@ -940,26 +919,27 @@ export interface SAMLOptionsInput {
|
|
|
940
919
|
MasterBackendRole?: string | undefined;
|
|
941
920
|
/**
|
|
942
921
|
* <p>Element of the SAML assertion to use for the user name. Default is
|
|
943
|
-
*
|
|
922
|
+
* <code>NameID</code>.</p>
|
|
944
923
|
* @public
|
|
945
924
|
*/
|
|
946
925
|
SubjectKey?: string | undefined;
|
|
947
926
|
/**
|
|
948
927
|
* <p>Element of the SAML assertion to use for backend roles. Default is
|
|
949
|
-
*
|
|
928
|
+
* <code>roles</code>.</p>
|
|
950
929
|
* @public
|
|
951
930
|
*/
|
|
952
931
|
RolesKey?: string | undefined;
|
|
953
932
|
/**
|
|
954
|
-
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable
|
|
955
|
-
*
|
|
933
|
+
* <p>The duration, in minutes, after which a user session becomes inactive. Acceptable
|
|
934
|
+
* values are between 1 and 1440, and the default value is 60.</p>
|
|
956
935
|
* @public
|
|
957
936
|
*/
|
|
958
937
|
SessionTimeoutMinutes?: number | undefined;
|
|
959
938
|
}
|
|
960
939
|
/**
|
|
961
|
-
* <p>Options for enabling and configuring fine-grained access control. For more
|
|
962
|
-
*
|
|
940
|
+
* <p>Options for enabling and configuring fine-grained access control. For more
|
|
941
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html">Fine-grained access control
|
|
942
|
+
* in Amazon OpenSearch Service</a>.</p>
|
|
963
943
|
* @public
|
|
964
944
|
*/
|
|
965
945
|
export interface AdvancedSecurityOptionsInput {
|
|
@@ -979,24 +959,26 @@ export interface AdvancedSecurityOptionsInput {
|
|
|
979
959
|
*/
|
|
980
960
|
MasterUserOptions?: MasterUserOptions | undefined;
|
|
981
961
|
/**
|
|
982
|
-
* <p>Container for information about the SAML configuration for OpenSearch
|
|
962
|
+
* <p>Container for information about the SAML configuration for OpenSearch
|
|
963
|
+
* Dashboards.</p>
|
|
983
964
|
* @public
|
|
984
965
|
*/
|
|
985
966
|
SAMLOptions?: SAMLOptionsInput | undefined;
|
|
986
967
|
/**
|
|
987
|
-
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
968
|
+
* <p>Container for information about the JWT configuration of the Amazon OpenSearch
|
|
969
|
+
* Service. </p>
|
|
988
970
|
* @public
|
|
989
971
|
*/
|
|
990
972
|
JWTOptions?: JWTOptionsInput | undefined;
|
|
991
973
|
/**
|
|
992
|
-
* <p>
|
|
974
|
+
* <p>Input configuration for IAM identity federation within advanced security
|
|
975
|
+
* options.</p>
|
|
993
976
|
* @public
|
|
994
977
|
*/
|
|
995
978
|
IAMFederationOptions?: IAMFederationOptionsInput | undefined;
|
|
996
979
|
/**
|
|
997
980
|
* <p>True to enable a 30-day migration period during which administrators can create role
|
|
998
|
-
*
|
|
999
|
-
* fine-grained access control on an existing domain</a>.</p>
|
|
981
|
+
* mappings. Only necessary when <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing">enabling fine-grained access control on an existing domain</a>.</p>
|
|
1000
982
|
* @public
|
|
1001
983
|
*/
|
|
1002
984
|
AnonymousAuthEnabled?: boolean | undefined;
|
|
@@ -1030,12 +1012,14 @@ export declare const NaturalLanguageQueryGenerationDesiredState: {
|
|
|
1030
1012
|
*/
|
|
1031
1013
|
export type NaturalLanguageQueryGenerationDesiredState = (typeof NaturalLanguageQueryGenerationDesiredState)[keyof typeof NaturalLanguageQueryGenerationDesiredState];
|
|
1032
1014
|
/**
|
|
1033
|
-
* <p>Container for parameters required to enable the natural language query generation
|
|
1015
|
+
* <p>Container for parameters required to enable the natural language query generation
|
|
1016
|
+
* feature.</p>
|
|
1034
1017
|
* @public
|
|
1035
1018
|
*/
|
|
1036
1019
|
export interface NaturalLanguageQueryGenerationOptionsInput {
|
|
1037
1020
|
/**
|
|
1038
|
-
* <p>The desired state of the natural language query generation feature. Valid values are
|
|
1021
|
+
* <p>The desired state of the natural language query generation feature. Valid values are
|
|
1022
|
+
* ENABLED and DISABLED.</p>
|
|
1039
1023
|
* @public
|
|
1040
1024
|
*/
|
|
1041
1025
|
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
@@ -1057,12 +1041,14 @@ export interface S3VectorsEngine {
|
|
|
1057
1041
|
*/
|
|
1058
1042
|
export interface AIMLOptionsInput {
|
|
1059
1043
|
/**
|
|
1060
|
-
* <p>Container for parameters required for natural language query generation on the
|
|
1044
|
+
* <p>Container for parameters required for natural language query generation on the
|
|
1045
|
+
* specified domain.</p>
|
|
1061
1046
|
* @public
|
|
1062
1047
|
*/
|
|
1063
1048
|
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsInput | undefined;
|
|
1064
1049
|
/**
|
|
1065
|
-
* <p>Container for parameters required to enable S3 vectors engine features on the
|
|
1050
|
+
* <p>Container for parameters required to enable S3 vectors engine features on the
|
|
1051
|
+
* specified domain.</p>
|
|
1066
1052
|
* @public
|
|
1067
1053
|
*/
|
|
1068
1054
|
S3VectorsEngine?: S3VectorsEngine | undefined;
|
|
@@ -1085,33 +1071,39 @@ export declare const NaturalLanguageQueryGenerationCurrentState: {
|
|
|
1085
1071
|
*/
|
|
1086
1072
|
export type NaturalLanguageQueryGenerationCurrentState = (typeof NaturalLanguageQueryGenerationCurrentState)[keyof typeof NaturalLanguageQueryGenerationCurrentState];
|
|
1087
1073
|
/**
|
|
1088
|
-
* <p>Container for parameters representing the state of the natural language query
|
|
1074
|
+
* <p>Container for parameters representing the state of the natural language query
|
|
1075
|
+
* generation feature on the specified domain.</p>
|
|
1089
1076
|
* @public
|
|
1090
1077
|
*/
|
|
1091
1078
|
export interface NaturalLanguageQueryGenerationOptionsOutput {
|
|
1092
1079
|
/**
|
|
1093
|
-
* <p>The desired state of the natural language query generation feature. Valid values are
|
|
1080
|
+
* <p>The desired state of the natural language query generation feature. Valid values are
|
|
1081
|
+
* ENABLED and DISABLED.</p>
|
|
1094
1082
|
* @public
|
|
1095
1083
|
*/
|
|
1096
1084
|
DesiredState?: NaturalLanguageQueryGenerationDesiredState | undefined;
|
|
1097
1085
|
/**
|
|
1098
|
-
* <p>The current state of the natural language query generation feature, indicating
|
|
1086
|
+
* <p>The current state of the natural language query generation feature, indicating
|
|
1087
|
+
* completion, in progress, or failure.</p>
|
|
1099
1088
|
* @public
|
|
1100
1089
|
*/
|
|
1101
1090
|
CurrentState?: NaturalLanguageQueryGenerationCurrentState | undefined;
|
|
1102
1091
|
}
|
|
1103
1092
|
/**
|
|
1104
|
-
* <p>Container for parameters representing the state of machine learning features on the
|
|
1093
|
+
* <p>Container for parameters representing the state of machine learning features on the
|
|
1094
|
+
* specified domain.</p>
|
|
1105
1095
|
* @public
|
|
1106
1096
|
*/
|
|
1107
1097
|
export interface AIMLOptionsOutput {
|
|
1108
1098
|
/**
|
|
1109
|
-
* <p>Container for parameters required for natural language query generation on the
|
|
1099
|
+
* <p>Container for parameters required for natural language query generation on the
|
|
1100
|
+
* specified domain.</p>
|
|
1110
1101
|
* @public
|
|
1111
1102
|
*/
|
|
1112
1103
|
NaturalLanguageQueryGenerationOptions?: NaturalLanguageQueryGenerationOptionsOutput | undefined;
|
|
1113
1104
|
/**
|
|
1114
|
-
* <p>Container for parameters representing the state of S3 vectors engine features on the
|
|
1105
|
+
* <p>Container for parameters representing the state of S3 vectors engine features on the
|
|
1106
|
+
* specified domain.</p>
|
|
1115
1107
|
* @public
|
|
1116
1108
|
*/
|
|
1117
1109
|
S3VectorsEngine?: S3VectorsEngine | undefined;
|
|
@@ -1133,7 +1125,8 @@ export interface AIMLOptionsStatus {
|
|
|
1133
1125
|
Status?: OptionStatus | undefined;
|
|
1134
1126
|
}
|
|
1135
1127
|
/**
|
|
1136
|
-
* <p>The configuration parameters to enable access to the key store required by the
|
|
1128
|
+
* <p>The configuration parameters to enable access to the key store required by the
|
|
1129
|
+
* package.</p>
|
|
1137
1130
|
* @public
|
|
1138
1131
|
*/
|
|
1139
1132
|
export interface KeyStoreAccessOption {
|
|
@@ -1154,19 +1147,21 @@ export interface KeyStoreAccessOption {
|
|
|
1154
1147
|
*/
|
|
1155
1148
|
export interface PackageAssociationConfiguration {
|
|
1156
1149
|
/**
|
|
1157
|
-
* <p>The configuration parameters to enable accessing the key store required by the
|
|
1150
|
+
* <p>The configuration parameters to enable accessing the key store required by the
|
|
1151
|
+
* package.</p>
|
|
1158
1152
|
* @public
|
|
1159
1153
|
*/
|
|
1160
1154
|
KeyStoreAccessOption?: KeyStoreAccessOption | undefined;
|
|
1161
1155
|
}
|
|
1162
1156
|
/**
|
|
1163
|
-
* <p>Container for the request parameters to the <code>AssociatePackage</code>
|
|
1157
|
+
* <p>Container for the request parameters to the <code>AssociatePackage</code>
|
|
1158
|
+
* operation.</p>
|
|
1164
1159
|
* @public
|
|
1165
1160
|
*/
|
|
1166
1161
|
export interface AssociatePackageRequest {
|
|
1167
1162
|
/**
|
|
1168
|
-
* <p>Internal ID of the package to associate with a domain. Use
|
|
1169
|
-
*
|
|
1163
|
+
* <p>Internal ID of the package to associate with a domain. Use
|
|
1164
|
+
* <code>DescribePackages</code> to find this value. </p>
|
|
1170
1165
|
* @public
|
|
1171
1166
|
*/
|
|
1172
1167
|
PackageID: string | undefined;
|
|
@@ -1176,12 +1171,14 @@ export interface AssociatePackageRequest {
|
|
|
1176
1171
|
*/
|
|
1177
1172
|
DomainName: string | undefined;
|
|
1178
1173
|
/**
|
|
1179
|
-
* <p>A list of package IDs that must be associated with the domain before the package
|
|
1174
|
+
* <p>A list of package IDs that must be associated with the domain before the package
|
|
1175
|
+
* specified in the request can be associated.</p>
|
|
1180
1176
|
* @public
|
|
1181
1177
|
*/
|
|
1182
1178
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
1183
1179
|
/**
|
|
1184
|
-
* <p>The configuration for associating a package with an Amazon OpenSearch Service
|
|
1180
|
+
* <p>The configuration for associating a package with an Amazon OpenSearch Service
|
|
1181
|
+
* domain.</p>
|
|
1185
1182
|
* @public
|
|
1186
1183
|
*/
|
|
1187
1184
|
AssociationConfiguration?: PackageAssociationConfiguration | undefined;
|
|
@@ -1232,8 +1229,9 @@ export declare const PackageType: {
|
|
|
1232
1229
|
*/
|
|
1233
1230
|
export type PackageType = (typeof PackageType)[keyof typeof PackageType];
|
|
1234
1231
|
/**
|
|
1235
|
-
* <p>Information about a package that is associated with a domain. For more information,
|
|
1236
|
-
*
|
|
1232
|
+
* <p>Information about a package that is associated with a domain. For more information,
|
|
1233
|
+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html">Custom packages
|
|
1234
|
+
* for Amazon OpenSearch Service</a>.</p>
|
|
1237
1235
|
* @public
|
|
1238
1236
|
*/
|
|
1239
1237
|
export interface DomainPackageDetails {
|
|
@@ -1273,13 +1271,14 @@ export interface DomainPackageDetails {
|
|
|
1273
1271
|
*/
|
|
1274
1272
|
PackageVersion?: string | undefined;
|
|
1275
1273
|
/**
|
|
1276
|
-
* <p>A list of package IDs that must be associated with the domain before or with the
|
|
1274
|
+
* <p>A list of package IDs that must be associated with the domain before or with the
|
|
1275
|
+
* package can be associated.</p>
|
|
1277
1276
|
* @public
|
|
1278
1277
|
*/
|
|
1279
1278
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
1280
1279
|
/**
|
|
1281
|
-
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is
|
|
1282
|
-
*
|
|
1280
|
+
* <p>The relative path of the package on the OpenSearch Service cluster nodes. This is
|
|
1281
|
+
* <code>synonym_path</code> when the package is for synonym files.</p>
|
|
1283
1282
|
* @public
|
|
1284
1283
|
*/
|
|
1285
1284
|
ReferencePath?: string | undefined;
|
|
@@ -1289,13 +1288,15 @@ export interface DomainPackageDetails {
|
|
|
1289
1288
|
*/
|
|
1290
1289
|
ErrorDetails?: ErrorDetails | undefined;
|
|
1291
1290
|
/**
|
|
1292
|
-
* <p>The configuration for associating a package with an Amazon OpenSearch Service
|
|
1291
|
+
* <p>The configuration for associating a package with an Amazon OpenSearch Service
|
|
1292
|
+
* domain.</p>
|
|
1293
1293
|
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
AssociationConfiguration?: PackageAssociationConfiguration | undefined;
|
|
1296
1296
|
}
|
|
1297
1297
|
/**
|
|
1298
|
-
* <p>Container for the response returned by the <code>AssociatePackage</code>
|
|
1298
|
+
* <p>Container for the response returned by the <code>AssociatePackage</code>
|
|
1299
|
+
* operation.</p>
|
|
1299
1300
|
* @public
|
|
1300
1301
|
*/
|
|
1301
1302
|
export interface AssociatePackageResponse {
|
|
@@ -1328,7 +1329,8 @@ export interface PackageDetailsForAssociation {
|
|
|
1328
1329
|
*/
|
|
1329
1330
|
PackageID: string | undefined;
|
|
1330
1331
|
/**
|
|
1331
|
-
* <p>List of package IDs that must be linked to the domain before or simultaneously with
|
|
1332
|
+
* <p>List of package IDs that must be linked to the domain before or simultaneously with
|
|
1333
|
+
* the package association.</p>
|
|
1332
1334
|
* @public
|
|
1333
1335
|
*/
|
|
1334
1336
|
PrerequisitePackageIDList?: string[] | undefined;
|
|
@@ -1348,8 +1350,8 @@ export interface AssociatePackagesRequest {
|
|
|
1348
1350
|
*/
|
|
1349
1351
|
PackageList: PackageDetailsForAssociation[] | undefined;
|
|
1350
1352
|
/**
|
|
1351
|
-
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
1352
|
-
*
|
|
1353
|
+
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
1354
|
+
* owned by an account within an Amazon Web Services Region.</p>
|
|
1353
1355
|
* @public
|
|
1354
1356
|
*/
|
|
1355
1357
|
DomainName: string | undefined;
|
|
@@ -1408,8 +1410,8 @@ export declare const PrincipalType: {
|
|
|
1408
1410
|
*/
|
|
1409
1411
|
export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
|
|
1410
1412
|
/**
|
|
1411
|
-
* <p>Information about an Amazon Web Services account or service that has access to an
|
|
1412
|
-
*
|
|
1413
|
+
* <p>Information about an Amazon Web Services account or service that has access to an
|
|
1414
|
+
* Amazon OpenSearch Service domain through the use of an interface VPC endpoint.</p>
|
|
1413
1415
|
* @public
|
|
1414
1416
|
*/
|
|
1415
1417
|
export interface AuthorizedPrincipal {
|
|
@@ -1419,7 +1421,8 @@ export interface AuthorizedPrincipal {
|
|
|
1419
1421
|
*/
|
|
1420
1422
|
PrincipalType?: PrincipalType | undefined;
|
|
1421
1423
|
/**
|
|
1422
|
-
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM
|
|
1424
|
+
* <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">IAM
|
|
1425
|
+
* principal</a> that is allowed access to the domain.</p>
|
|
1423
1426
|
* @public
|
|
1424
1427
|
*/
|
|
1425
1428
|
Principal?: string | undefined;
|
|
@@ -1429,8 +1432,8 @@ export interface AuthorizedPrincipal {
|
|
|
1429
1432
|
*/
|
|
1430
1433
|
export interface AuthorizeVpcEndpointAccessResponse {
|
|
1431
1434
|
/**
|
|
1432
|
-
* <p>Information about the Amazon Web Services account or service that was provided access
|
|
1433
|
-
*
|
|
1435
|
+
* <p>Information about the Amazon Web Services account or service that was provided access
|
|
1436
|
+
* to the domain.</p>
|
|
1434
1437
|
* @public
|
|
1435
1438
|
*/
|
|
1436
1439
|
AuthorizedPrincipal: AuthorizedPrincipal | undefined;
|
|
@@ -1440,13 +1443,14 @@ export interface AuthorizeVpcEndpointAccessResponse {
|
|
|
1440
1443
|
*/
|
|
1441
1444
|
export interface CancelDomainConfigChangeRequest {
|
|
1442
1445
|
/**
|
|
1443
|
-
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
1444
|
-
*
|
|
1446
|
+
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
1447
|
+
* owned by an account within an Amazon Web Services Region.</p>
|
|
1445
1448
|
* @public
|
|
1446
1449
|
*/
|
|
1447
1450
|
DomainName: string | undefined;
|
|
1448
1451
|
/**
|
|
1449
|
-
* <p>When set to <code>True</code>, returns the list of change IDs and properties that will
|
|
1452
|
+
* <p>When set to <code>True</code>, returns the list of change IDs and properties that will
|
|
1453
|
+
* be cancelled without actually cancelling the change.</p>
|
|
1450
1454
|
* @public
|
|
1451
1455
|
*/
|
|
1452
1456
|
DryRun?: boolean | undefined;
|
|
@@ -1462,7 +1466,8 @@ export interface CancelledChangeProperty {
|
|
|
1462
1466
|
*/
|
|
1463
1467
|
PropertyName?: string | undefined;
|
|
1464
1468
|
/**
|
|
1465
|
-
* <p>The pending value of the property that was cancelled. This would have been the
|
|
1469
|
+
* <p>The pending value of the property that was cancelled. This would have been the
|
|
1470
|
+
* eventual value of the property if the chance had not been cancelled.</p>
|
|
1466
1471
|
* @public
|
|
1467
1472
|
*/
|
|
1468
1473
|
CancelledValue?: string | undefined;
|
|
@@ -1487,7 +1492,8 @@ export interface CancelDomainConfigChangeResponse {
|
|
|
1487
1492
|
*/
|
|
1488
1493
|
CancelledChangeProperties?: CancelledChangeProperty[] | undefined;
|
|
1489
1494
|
/**
|
|
1490
|
-
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not
|
|
1495
|
+
* <p>Whether or not the request was a dry run. If <code>True</code>, the changes were not
|
|
1496
|
+
* actually cancelled. </p>
|
|
1491
1497
|
* @public
|
|
1492
1498
|
*/
|
|
1493
1499
|
DryRun?: boolean | undefined;
|
|
@@ -1498,8 +1504,8 @@ export interface CancelDomainConfigChangeResponse {
|
|
|
1498
1504
|
*/
|
|
1499
1505
|
export interface CancelServiceSoftwareUpdateRequest {
|
|
1500
1506
|
/**
|
|
1501
|
-
* <p>Name of the OpenSearch Service domain that you want to cancel the service software
|
|
1502
|
-
*
|
|
1507
|
+
* <p>Name of the OpenSearch Service domain that you want to cancel the service software
|
|
1508
|
+
* update on.</p>
|
|
1503
1509
|
* @public
|
|
1504
1510
|
*/
|
|
1505
1511
|
DomainName: string | undefined;
|
|
@@ -1520,9 +1526,9 @@ export declare const DeploymentStatus: {
|
|
|
1520
1526
|
*/
|
|
1521
1527
|
export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof DeploymentStatus];
|
|
1522
1528
|
/**
|
|
1523
|
-
* <p>The current status of the service software for an Amazon OpenSearch Service domain.
|
|
1524
|
-
*
|
|
1525
|
-
*
|
|
1529
|
+
* <p>The current status of the service software for an Amazon OpenSearch Service domain.
|
|
1530
|
+
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html">Service
|
|
1531
|
+
* software updates in Amazon OpenSearch Service</a>.</p>
|
|
1526
1532
|
* @public
|
|
1527
1533
|
*/
|
|
1528
1534
|
export interface ServiceSoftwareOptions {
|
|
@@ -1537,14 +1543,14 @@ export interface ServiceSoftwareOptions {
|
|
|
1537
1543
|
*/
|
|
1538
1544
|
NewVersion?: string | undefined;
|
|
1539
1545
|
/**
|
|
1540
|
-
* <p>True if you're able to update your service software version. False if you can't update
|
|
1541
|
-
*
|
|
1546
|
+
* <p>True if you're able to update your service software version. False if you can't update
|
|
1547
|
+
* your service software version.</p>
|
|
1542
1548
|
* @public
|
|
1543
1549
|
*/
|
|
1544
1550
|
UpdateAvailable?: boolean | undefined;
|
|
1545
1551
|
/**
|
|
1546
|
-
* <p> True if you're able to cancel your service software version update. False if you
|
|
1547
|
-
*
|
|
1552
|
+
* <p> True if you're able to cancel your service software version update. False if you
|
|
1553
|
+
* can't cancel your service software update.</p>
|
|
1548
1554
|
* @public
|
|
1549
1555
|
*/
|
|
1550
1556
|
Cancellable?: boolean | undefined;
|
|
@@ -1559,21 +1565,21 @@ export interface ServiceSoftwareOptions {
|
|
|
1559
1565
|
*/
|
|
1560
1566
|
Description?: string | undefined;
|
|
1561
1567
|
/**
|
|
1562
|
-
* <p>The timestamp, in Epoch time, until which you can manually request a service software
|
|
1563
|
-
*
|
|
1568
|
+
* <p>The timestamp, in Epoch time, until which you can manually request a service software
|
|
1569
|
+
* update. After this date, we automatically update your service software.</p>
|
|
1564
1570
|
* @public
|
|
1565
1571
|
*/
|
|
1566
1572
|
AutomatedUpdateDate?: Date | undefined;
|
|
1567
1573
|
/**
|
|
1568
|
-
* <p>True if a service software is never automatically updated. False if a service software
|
|
1569
|
-
*
|
|
1574
|
+
* <p>True if a service software is never automatically updated. False if a service software
|
|
1575
|
+
* is automatically updated after the automated update date.</p>
|
|
1570
1576
|
* @public
|
|
1571
1577
|
*/
|
|
1572
1578
|
OptionalDeployment?: boolean | undefined;
|
|
1573
1579
|
}
|
|
1574
1580
|
/**
|
|
1575
|
-
* <p>Container for the response to a <code>CancelServiceSoftwareUpdate</code> operation.
|
|
1576
|
-
*
|
|
1581
|
+
* <p>Container for the response to a <code>CancelServiceSoftwareUpdate</code> operation.
|
|
1582
|
+
* Contains the status of the update.</p>
|
|
1577
1583
|
* @public
|
|
1578
1584
|
*/
|
|
1579
1585
|
export interface CancelServiceSoftwareUpdateResponse {
|
|
@@ -1596,13 +1602,15 @@ export declare const AppConfigType: {
|
|
|
1596
1602
|
*/
|
|
1597
1603
|
export type AppConfigType = (typeof AppConfigType)[keyof typeof AppConfigType];
|
|
1598
1604
|
/**
|
|
1599
|
-
* <p>Configuration settings for an OpenSearch application. For more information, see
|
|
1600
|
-
*
|
|
1605
|
+
* <p>Configuration settings for an OpenSearch application. For more information, see see
|
|
1606
|
+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using the OpenSearch
|
|
1607
|
+
* user interface in Amazon OpenSearch Service</a>.</p>
|
|
1601
1608
|
* @public
|
|
1602
1609
|
*/
|
|
1603
1610
|
export interface AppConfig {
|
|
1604
1611
|
/**
|
|
1605
|
-
* <p>The configuration item to set, such as the admin role for the OpenSearch
|
|
1612
|
+
* <p>The configuration item to set, such as the admin role for the OpenSearch
|
|
1613
|
+
* application.</p>
|
|
1606
1614
|
* @public
|
|
1607
1615
|
*/
|
|
1608
1616
|
key?: AppConfigType | undefined;
|
|
@@ -1618,9 +1626,9 @@ export interface AppConfig {
|
|
|
1618
1626
|
*/
|
|
1619
1627
|
export interface DataSource {
|
|
1620
1628
|
/**
|
|
1621
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1629
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
1630
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
1631
|
+
* more information. </p>
|
|
1624
1632
|
* @public
|
|
1625
1633
|
*/
|
|
1626
1634
|
dataSourceArn?: string | undefined;
|
|
@@ -1641,9 +1649,9 @@ export interface IamIdentityCenterOptionsInput {
|
|
|
1641
1649
|
*/
|
|
1642
1650
|
enabled?: boolean | undefined;
|
|
1643
1651
|
/**
|
|
1644
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
1645
|
-
*
|
|
1646
|
-
*
|
|
1652
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
1653
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
1654
|
+
* more information. </p>
|
|
1647
1655
|
* @public
|
|
1648
1656
|
*/
|
|
1649
1657
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
@@ -1673,12 +1681,14 @@ export interface CreateApplicationRequest {
|
|
|
1673
1681
|
*/
|
|
1674
1682
|
dataSources?: DataSource[] | undefined;
|
|
1675
1683
|
/**
|
|
1676
|
-
* <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the
|
|
1684
|
+
* <p>Configuration settings for integrating Amazon Web Services IAM Identity Center with the
|
|
1685
|
+
* OpenSearch application.</p>
|
|
1677
1686
|
* @public
|
|
1678
1687
|
*/
|
|
1679
1688
|
iamIdentityCenterOptions?: IamIdentityCenterOptionsInput | undefined;
|
|
1680
1689
|
/**
|
|
1681
|
-
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1690
|
+
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1691
|
+
* options.</p>
|
|
1682
1692
|
* @public
|
|
1683
1693
|
*/
|
|
1684
1694
|
appConfigs?: AppConfig[] | undefined;
|
|
@@ -1694,26 +1704,28 @@ export interface CreateApplicationRequest {
|
|
|
1694
1704
|
*/
|
|
1695
1705
|
export interface IamIdentityCenterOptions {
|
|
1696
1706
|
/**
|
|
1697
|
-
* <p>Indicates whether IAM Identity Center is enabled for the OpenSearch
|
|
1707
|
+
* <p>Indicates whether IAM Identity Center is enabled for the OpenSearch
|
|
1708
|
+
* application.</p>
|
|
1698
1709
|
* @public
|
|
1699
1710
|
*/
|
|
1700
1711
|
enabled?: boolean | undefined;
|
|
1701
1712
|
/**
|
|
1702
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
1703
|
-
*
|
|
1704
|
-
*
|
|
1713
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
1714
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
1715
|
+
* more information. </p>
|
|
1705
1716
|
* @public
|
|
1706
1717
|
*/
|
|
1707
1718
|
iamIdentityCenterInstanceArn?: string | undefined;
|
|
1708
1719
|
/**
|
|
1709
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center
|
|
1720
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center
|
|
1721
|
+
* application for the OpenSearch application.</p>
|
|
1710
1722
|
* @public
|
|
1711
1723
|
*/
|
|
1712
1724
|
iamRoleForIdentityCenterApplicationArn?: string | undefined;
|
|
1713
1725
|
/**
|
|
1714
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
1715
|
-
*
|
|
1716
|
-
*
|
|
1726
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
1727
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
1728
|
+
* more information. </p>
|
|
1717
1729
|
* @public
|
|
1718
1730
|
*/
|
|
1719
1731
|
iamIdentityCenterApplicationArn?: string | undefined;
|
|
@@ -1733,9 +1745,9 @@ export interface CreateApplicationResponse {
|
|
|
1733
1745
|
*/
|
|
1734
1746
|
name?: string | undefined;
|
|
1735
1747
|
/**
|
|
1736
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
1737
|
-
*
|
|
1738
|
-
*
|
|
1748
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
1749
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
1750
|
+
* more information. </p>
|
|
1739
1751
|
* @public
|
|
1740
1752
|
*/
|
|
1741
1753
|
arn?: string | undefined;
|
|
@@ -1750,7 +1762,8 @@ export interface CreateApplicationResponse {
|
|
|
1750
1762
|
*/
|
|
1751
1763
|
iamIdentityCenterOptions?: IamIdentityCenterOptions | undefined;
|
|
1752
1764
|
/**
|
|
1753
|
-
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1765
|
+
* <p>Configuration settings for the OpenSearch application, including administrative
|
|
1766
|
+
* options.</p>
|
|
1754
1767
|
* @public
|
|
1755
1768
|
*/
|
|
1756
1769
|
appConfigs?: AppConfig[] | undefined;
|
|
@@ -1789,8 +1802,7 @@ export declare const TimeUnit: {
|
|
|
1789
1802
|
*/
|
|
1790
1803
|
export type TimeUnit = (typeof TimeUnit)[keyof typeof TimeUnit];
|
|
1791
1804
|
/**
|
|
1792
|
-
* <p>The duration of a maintenance schedule. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for
|
|
1793
|
-
* Amazon OpenSearch Service</a>.</p>
|
|
1805
|
+
* <p>The duration of a maintenance schedule. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch Service</a>.</p>
|
|
1794
1806
|
* @public
|
|
1795
1807
|
*/
|
|
1796
1808
|
export interface Duration {
|
|
@@ -1807,13 +1819,11 @@ export interface Duration {
|
|
|
1807
1819
|
}
|
|
1808
1820
|
/**
|
|
1809
1821
|
* <note>
|
|
1810
|
-
* <p>This object is deprecated. Use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak
|
|
1811
|
-
*
|
|
1812
|
-
*
|
|
1822
|
+
* <p>This object is deprecated. Use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak
|
|
1823
|
+
* window</a> to schedule Auto-Tune optimizations. For migration instructions,
|
|
1824
|
+
* see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate">Migrating from Auto-Tune maintenance windows</a>.</p>
|
|
1813
1825
|
* </note>
|
|
1814
|
-
* <p>The Auto-Tune maintenance schedule.
|
|
1815
|
-
* For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch
|
|
1816
|
-
* Service</a>.</p>
|
|
1826
|
+
* <p>The Auto-Tune maintenance schedule. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch Service</a>.</p>
|
|
1817
1827
|
* @public
|
|
1818
1828
|
*/
|
|
1819
1829
|
export interface AutoTuneMaintenanceSchedule {
|
|
@@ -1824,20 +1834,19 @@ export interface AutoTuneMaintenanceSchedule {
|
|
|
1824
1834
|
StartAt?: Date | undefined;
|
|
1825
1835
|
/**
|
|
1826
1836
|
* <p>The duration of the maintenance schedule. For example, <code>"Duration": \{"Value": 2,
|
|
1827
|
-
*
|
|
1837
|
+
* "Unit": "HOURS"\}</code>.</p>
|
|
1828
1838
|
* @public
|
|
1829
1839
|
*/
|
|
1830
1840
|
Duration?: Duration | undefined;
|
|
1831
1841
|
/**
|
|
1832
|
-
* <p>A cron expression for a recurring maintenance schedule during which Auto-Tune can
|
|
1833
|
-
*
|
|
1842
|
+
* <p>A cron expression for a recurring maintenance schedule during which Auto-Tune can
|
|
1843
|
+
* deploy changes.</p>
|
|
1834
1844
|
* @public
|
|
1835
1845
|
*/
|
|
1836
1846
|
CronExpressionForRecurrence?: string | undefined;
|
|
1837
1847
|
}
|
|
1838
1848
|
/**
|
|
1839
|
-
* <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
|
|
1840
|
-
* Service</a>
|
|
1849
|
+
* <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 Service</a>
|
|
1841
1850
|
* </p>
|
|
1842
1851
|
* @public
|
|
1843
1852
|
*/
|
|
@@ -1848,25 +1857,29 @@ export interface AutoTuneOptionsInput {
|
|
|
1848
1857
|
*/
|
|
1849
1858
|
DesiredState?: AutoTuneDesiredState | undefined;
|
|
1850
1859
|
/**
|
|
1851
|
-
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance
|
|
1860
|
+
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance
|
|
1861
|
+
* windows are deprecated and have been replaced with <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak
|
|
1862
|
+
* windows</a>.</p>
|
|
1852
1863
|
* @public
|
|
1853
1864
|
*/
|
|
1854
1865
|
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[] | undefined;
|
|
1855
1866
|
/**
|
|
1856
|
-
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during
|
|
1867
|
+
* <p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during
|
|
1868
|
+
* the domain's configured daily off-peak window.</p>
|
|
1857
1869
|
* @public
|
|
1858
1870
|
*/
|
|
1859
1871
|
UseOffPeakWindow?: boolean | undefined;
|
|
1860
1872
|
}
|
|
1861
1873
|
/**
|
|
1862
1874
|
* <p>Container for the parameters required to enable cold storage for an OpenSearch Service
|
|
1863
|
-
*
|
|
1864
|
-
*
|
|
1875
|
+
* domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html">Cold storage for
|
|
1876
|
+
* Amazon OpenSearch Service</a>.</p>
|
|
1865
1877
|
* @public
|
|
1866
1878
|
*/
|
|
1867
1879
|
export interface ColdStorageOptions {
|
|
1868
1880
|
/**
|
|
1869
|
-
* <p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm
|
|
1881
|
+
* <p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm
|
|
1882
|
+
* storage to enable cold storage.</p>
|
|
1870
1883
|
* @public
|
|
1871
1884
|
*/
|
|
1872
1885
|
Enabled: boolean | undefined;
|
|
@@ -1985,7 +1998,8 @@ export declare const OpenSearchPartitionInstanceType: {
|
|
|
1985
1998
|
*/
|
|
1986
1999
|
export type OpenSearchPartitionInstanceType = (typeof OpenSearchPartitionInstanceType)[keyof typeof OpenSearchPartitionInstanceType];
|
|
1987
2000
|
/**
|
|
1988
|
-
* <p>Configuration options for defining the setup of any node type within the
|
|
2001
|
+
* <p>Configuration options for defining the setup of any node type within the
|
|
2002
|
+
* cluster.</p>
|
|
1989
2003
|
* @public
|
|
1990
2004
|
*/
|
|
1991
2005
|
export interface NodeConfig {
|
|
@@ -2051,16 +2065,17 @@ export type OpenSearchWarmPartitionInstanceType = (typeof OpenSearchWarmPartitio
|
|
|
2051
2065
|
*/
|
|
2052
2066
|
export interface ZoneAwarenessConfig {
|
|
2053
2067
|
/**
|
|
2054
|
-
* <p>If you enabled multiple Availability Zones, this value is the number of zones that you
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2068
|
+
* <p>If you enabled multiple Availability Zones, this value is the number of zones that you
|
|
2069
|
+
* want the domain to use. Valid values are <code>2</code> and <code>3</code>. If your
|
|
2070
|
+
* domain is provisioned within a VPC, this value be equal to number of subnets.</p>
|
|
2057
2071
|
* @public
|
|
2058
2072
|
*/
|
|
2059
2073
|
AvailabilityZoneCount?: number | undefined;
|
|
2060
2074
|
}
|
|
2061
2075
|
/**
|
|
2062
2076
|
* <p>Container for the cluster configuration of an OpenSearch Service domain. For more
|
|
2063
|
-
*
|
|
2077
|
+
* information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html">Creating and
|
|
2078
|
+
* managing Amazon OpenSearch Service domains</a>.</p>
|
|
2064
2079
|
* @public
|
|
2065
2080
|
*/
|
|
2066
2081
|
export interface ClusterConfig {
|
|
@@ -2071,24 +2086,26 @@ export interface ClusterConfig {
|
|
|
2071
2086
|
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
2072
2087
|
/**
|
|
2073
2088
|
* <p>Number of data nodes in the cluster. This number must be greater than 1, otherwise you
|
|
2074
|
-
*
|
|
2089
|
+
* receive a validation exception.</p>
|
|
2075
2090
|
* @public
|
|
2076
2091
|
*/
|
|
2077
2092
|
InstanceCount?: number | undefined;
|
|
2078
2093
|
/**
|
|
2079
|
-
* <p>Indicates whether dedicated master nodes are enabled for the cluster.<code>True</code>
|
|
2080
|
-
*
|
|
2094
|
+
* <p>Indicates whether dedicated master nodes are enabled for the cluster.<code>True</code>
|
|
2095
|
+
* if the cluster will use a dedicated master node.<code>False</code> if the cluster will
|
|
2096
|
+
* not.</p>
|
|
2081
2097
|
* @public
|
|
2082
2098
|
*/
|
|
2083
2099
|
DedicatedMasterEnabled?: boolean | undefined;
|
|
2084
2100
|
/**
|
|
2085
|
-
* <p>Indicates whether multiple Availability Zones are enabled. For more information, see
|
|
2101
|
+
* <p>Indicates whether multiple Availability Zones are enabled. For more information, see
|
|
2102
|
+
* <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>
|
|
2086
2103
|
* @public
|
|
2087
2104
|
*/
|
|
2088
2105
|
ZoneAwarenessEnabled?: boolean | undefined;
|
|
2089
2106
|
/**
|
|
2090
2107
|
* <p>Container for zone awareness configuration options. Only required if
|
|
2091
|
-
*
|
|
2108
|
+
* <code>ZoneAwarenessEnabled</code> is <code>true</code>.</p>
|
|
2092
2109
|
* @public
|
|
2093
2110
|
*/
|
|
2094
2111
|
ZoneAwarenessConfig?: ZoneAwarenessConfig | undefined;
|
|
@@ -2098,8 +2115,8 @@ export interface ClusterConfig {
|
|
|
2098
2115
|
*/
|
|
2099
2116
|
DedicatedMasterType?: OpenSearchPartitionInstanceType | undefined;
|
|
2100
2117
|
/**
|
|
2101
|
-
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2
|
|
2102
|
-
*
|
|
2118
|
+
* <p>Number of dedicated master nodes in the cluster. This number must be greater than 2
|
|
2119
|
+
* and not 4, otherwise you receive a validation exception.</p>
|
|
2103
2120
|
* @public
|
|
2104
2121
|
*/
|
|
2105
2122
|
DedicatedMasterCount?: number | undefined;
|
|
@@ -2124,7 +2141,8 @@ export interface ClusterConfig {
|
|
|
2124
2141
|
*/
|
|
2125
2142
|
ColdStorageOptions?: ColdStorageOptions | undefined;
|
|
2126
2143
|
/**
|
|
2127
|
-
* <p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For
|
|
2144
|
+
* <p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For
|
|
2145
|
+
* 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>
|
|
2128
2146
|
* @public
|
|
2129
2147
|
*/
|
|
2130
2148
|
MultiAZWithStandbyEnabled?: boolean | undefined;
|
|
@@ -2135,32 +2153,33 @@ export interface ClusterConfig {
|
|
|
2135
2153
|
NodeOptions?: NodeOption[] | undefined;
|
|
2136
2154
|
}
|
|
2137
2155
|
/**
|
|
2138
|
-
* <p>Container for the parameters required to enable Cognito authentication for an
|
|
2139
|
-
*
|
|
2140
|
-
*
|
|
2156
|
+
* <p>Container for the parameters required to enable Cognito authentication for an
|
|
2157
|
+
* OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html">Configuring Amazon
|
|
2158
|
+
* Cognito authentication for OpenSearch Dashboards</a>.</p>
|
|
2141
2159
|
* @public
|
|
2142
2160
|
*/
|
|
2143
2161
|
export interface CognitoOptions {
|
|
2144
2162
|
/**
|
|
2145
|
-
* <p>Whether to enable or disable Amazon Cognito authentication for OpenSearch
|
|
2163
|
+
* <p>Whether to enable or disable Amazon Cognito authentication for OpenSearch
|
|
2164
|
+
* Dashboards.</p>
|
|
2146
2165
|
* @public
|
|
2147
2166
|
*/
|
|
2148
2167
|
Enabled?: boolean | undefined;
|
|
2149
2168
|
/**
|
|
2150
2169
|
* <p>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch
|
|
2151
|
-
*
|
|
2170
|
+
* Dashboards authentication.</p>
|
|
2152
2171
|
* @public
|
|
2153
2172
|
*/
|
|
2154
2173
|
UserPoolId?: string | undefined;
|
|
2155
2174
|
/**
|
|
2156
|
-
* <p>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for
|
|
2157
|
-
*
|
|
2175
|
+
* <p>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for
|
|
2176
|
+
* OpenSearch Dashboards authentication.</p>
|
|
2158
2177
|
* @public
|
|
2159
2178
|
*/
|
|
2160
2179
|
IdentityPoolId?: string | undefined;
|
|
2161
2180
|
/**
|
|
2162
|
-
* <p>The <code>AmazonOpenSearchServiceCognitoAccess</code> role that allows OpenSearch
|
|
2163
|
-
*
|
|
2181
|
+
* <p>The <code>AmazonOpenSearchServiceCognitoAccess</code> role that allows OpenSearch
|
|
2182
|
+
* Service to configure your user pool and identity pool.</p>
|
|
2164
2183
|
* @public
|
|
2165
2184
|
*/
|
|
2166
2185
|
RoleArn?: string | undefined;
|
|
@@ -2189,23 +2208,24 @@ export interface DomainEndpointOptions {
|
|
|
2189
2208
|
*/
|
|
2190
2209
|
EnforceHTTPS?: boolean | undefined;
|
|
2191
2210
|
/**
|
|
2192
|
-
* <p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The
|
|
2193
|
-
*
|
|
2211
|
+
* <p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The
|
|
2212
|
+
* policy can be one of the following values:</p>
|
|
2194
2213
|
* <ul>
|
|
2195
2214
|
* <li>
|
|
2196
2215
|
* <p>
|
|
2197
|
-
* <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security
|
|
2198
|
-
*
|
|
2216
|
+
* <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security
|
|
2217
|
+
* policy that supports TLS version 1.0 to TLS version 1.2</p>
|
|
2199
2218
|
* </li>
|
|
2200
2219
|
* <li>
|
|
2201
2220
|
* <p>
|
|
2202
|
-
* <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security
|
|
2203
|
-
*
|
|
2221
|
+
* <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security
|
|
2222
|
+
* policy that supports only TLS version 1.2</p>
|
|
2204
2223
|
* </li>
|
|
2205
2224
|
* <li>
|
|
2206
2225
|
* <p>
|
|
2207
|
-
* <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security
|
|
2208
|
-
*
|
|
2226
|
+
* <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security
|
|
2227
|
+
* policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward
|
|
2228
|
+
* secrecy cipher suites</p>
|
|
2209
2229
|
* </li>
|
|
2210
2230
|
* </ul>
|
|
2211
2231
|
* @public
|
|
@@ -2222,8 +2242,8 @@ export interface DomainEndpointOptions {
|
|
|
2222
2242
|
*/
|
|
2223
2243
|
CustomEndpoint?: string | undefined;
|
|
2224
2244
|
/**
|
|
2225
|
-
* <p>The ARN for your security certificate, managed in Amazon Web Services Certificate
|
|
2226
|
-
*
|
|
2245
|
+
* <p>The ARN for your security certificate, managed in Amazon Web Services Certificate
|
|
2246
|
+
* Manager (ACM).</p>
|
|
2227
2247
|
* @public
|
|
2228
2248
|
*/
|
|
2229
2249
|
CustomEndpointCertificateArn?: string | undefined;
|
|
@@ -2243,14 +2263,14 @@ export declare const VolumeType: {
|
|
|
2243
2263
|
*/
|
|
2244
2264
|
export type VolumeType = (typeof VolumeType)[keyof typeof VolumeType];
|
|
2245
2265
|
/**
|
|
2246
|
-
* <p>Container for the parameters required to enable EBS-based storage for an OpenSearch
|
|
2247
|
-
*
|
|
2266
|
+
* <p>Container for the parameters required to enable EBS-based storage for an OpenSearch
|
|
2267
|
+
* Service domain.</p>
|
|
2248
2268
|
* @public
|
|
2249
2269
|
*/
|
|
2250
2270
|
export interface EBSOptions {
|
|
2251
2271
|
/**
|
|
2252
2272
|
* <p>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service
|
|
2253
|
-
*
|
|
2273
|
+
* domain.</p>
|
|
2254
2274
|
* @public
|
|
2255
2275
|
*/
|
|
2256
2276
|
EBSEnabled?: boolean | undefined;
|
|
@@ -2265,23 +2285,24 @@ export interface EBSOptions {
|
|
|
2265
2285
|
*/
|
|
2266
2286
|
VolumeSize?: number | undefined;
|
|
2267
2287
|
/**
|
|
2268
|
-
* <p>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data
|
|
2269
|
-
*
|
|
2288
|
+
* <p>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data
|
|
2289
|
+
* nodes. Applicable only for the <code>gp3</code> and provisioned IOPS EBS volume
|
|
2290
|
+
* types.</p>
|
|
2270
2291
|
* @public
|
|
2271
2292
|
*/
|
|
2272
2293
|
Iops?: number | undefined;
|
|
2273
2294
|
/**
|
|
2274
|
-
* <p>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
|
|
2275
|
-
*
|
|
2295
|
+
* <p>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes.
|
|
2296
|
+
* Applicable only for the <code>gp3</code> volume type.</p>
|
|
2276
2297
|
* @public
|
|
2277
2298
|
*/
|
|
2278
2299
|
Throughput?: number | undefined;
|
|
2279
2300
|
}
|
|
2280
2301
|
/**
|
|
2281
|
-
* <p>Specifies whether the domain should encrypt data at rest, and if so, the Key
|
|
2282
|
-
*
|
|
2283
|
-
*
|
|
2284
|
-
*
|
|
2302
|
+
* <p>Specifies whether the domain should encrypt data at rest, and if so, the Key
|
|
2303
|
+
* Management Service (KMS) key to use. Can only be used when creating a new domain or
|
|
2304
|
+
* enabling encryption at rest for the first time on an existing domain. You can't modify
|
|
2305
|
+
* this parameter after it's already been specified.</p>
|
|
2285
2306
|
* @public
|
|
2286
2307
|
*/
|
|
2287
2308
|
export interface EncryptionAtRestOptions {
|
|
@@ -2291,7 +2312,8 @@ export interface EncryptionAtRestOptions {
|
|
|
2291
2312
|
*/
|
|
2292
2313
|
Enabled?: boolean | undefined;
|
|
2293
2314
|
/**
|
|
2294
|
-
* <p>The KMS key ID. Takes the form
|
|
2315
|
+
* <p>The KMS key ID. Takes the form
|
|
2316
|
+
* <code>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</code>.</p>
|
|
2295
2317
|
* @public
|
|
2296
2318
|
*/
|
|
2297
2319
|
KmsKeyId?: string | undefined;
|
|
@@ -2327,22 +2349,26 @@ export type SubjectKeyIdCOption = (typeof SubjectKeyIdCOption)[keyof typeof Subj
|
|
|
2327
2349
|
*/
|
|
2328
2350
|
export interface IdentityCenterOptionsInput {
|
|
2329
2351
|
/**
|
|
2330
|
-
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch
|
|
2352
|
+
* <p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch
|
|
2353
|
+
* Service.</p>
|
|
2331
2354
|
* @public
|
|
2332
2355
|
*/
|
|
2333
2356
|
EnabledAPIAccess?: boolean | undefined;
|
|
2334
2357
|
/**
|
|
2335
|
-
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI
|
|
2358
|
+
* <p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI
|
|
2359
|
+
* application that uses IAM Identity Center for authentication.</p>
|
|
2336
2360
|
* @public
|
|
2337
2361
|
*/
|
|
2338
2362
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2339
2363
|
/**
|
|
2340
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user
|
|
2364
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user
|
|
2365
|
+
* ID, or email) in IAM Identity Center.</p>
|
|
2341
2366
|
* @public
|
|
2342
2367
|
*/
|
|
2343
2368
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2344
2369
|
/**
|
|
2345
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name
|
|
2370
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name
|
|
2371
|
+
* or group ID) in IAM Identity Center.</p>
|
|
2346
2372
|
* @public
|
|
2347
2373
|
*/
|
|
2348
2374
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
@@ -2374,11 +2400,11 @@ export declare const LogType: {
|
|
|
2374
2400
|
*/
|
|
2375
2401
|
export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
2376
2402
|
/**
|
|
2377
|
-
* <p>Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch
|
|
2378
|
-
*
|
|
2403
|
+
* <p>Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch
|
|
2404
|
+
* application and slow logs to Amazon CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html">Monitoring OpenSearch logs with Amazon CloudWatch Logs</a>.</p>
|
|
2379
2405
|
* <note>
|
|
2380
|
-
* <p>After you enable log publishing, you still have to enable the collection of slow
|
|
2381
|
-
*
|
|
2406
|
+
* <p>After you enable log publishing, you still have to enable the collection of slow
|
|
2407
|
+
* logs using the OpenSearch REST API.</p>
|
|
2382
2408
|
* </note>
|
|
2383
2409
|
* @public
|
|
2384
2410
|
*/
|
|
@@ -2406,14 +2432,14 @@ export interface NodeToNodeEncryptionOptions {
|
|
|
2406
2432
|
Enabled?: boolean | undefined;
|
|
2407
2433
|
}
|
|
2408
2434
|
/**
|
|
2409
|
-
* <p>The desired start time for an <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
2410
|
-
*
|
|
2435
|
+
* <p>The desired start time for an <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
2436
|
+
* maintenance window</a>.</p>
|
|
2411
2437
|
* @public
|
|
2412
2438
|
*/
|
|
2413
2439
|
export interface WindowStartTime {
|
|
2414
2440
|
/**
|
|
2415
|
-
* <p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time.
|
|
2416
|
-
*
|
|
2441
|
+
* <p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time.
|
|
2442
|
+
* For example, <code>17</code> refers to 5:00 P.M. UTC.</p>
|
|
2417
2443
|
* @public
|
|
2418
2444
|
*/
|
|
2419
2445
|
Hours: number | undefined;
|
|
@@ -2424,35 +2450,38 @@ export interface WindowStartTime {
|
|
|
2424
2450
|
Minutes: number | undefined;
|
|
2425
2451
|
}
|
|
2426
2452
|
/**
|
|
2427
|
-
* <p>A custom 10-hour, low-traffic window during which OpenSearch Service can perform
|
|
2428
|
-
*
|
|
2429
|
-
*
|
|
2430
|
-
*
|
|
2453
|
+
* <p>A custom 10-hour, low-traffic window during which OpenSearch Service can perform
|
|
2454
|
+
* mandatory configuration changes on the domain. These actions can include scheduled
|
|
2455
|
+
* service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will
|
|
2456
|
+
* schedule these actions during the window that you specify.</p>
|
|
2431
2457
|
* <p>If you don't specify a window start time, it defaults to 10:00 P.M. local time.</p>
|
|
2432
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">Defining off-peak
|
|
2433
|
-
*
|
|
2458
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">Defining off-peak
|
|
2459
|
+
* maintenance windows for Amazon OpenSearch Service</a>.</p>
|
|
2434
2460
|
* @public
|
|
2435
2461
|
*/
|
|
2436
2462
|
export interface OffPeakWindow {
|
|
2437
2463
|
/**
|
|
2438
|
-
* <p>A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The
|
|
2439
|
-
*
|
|
2440
|
-
*
|
|
2464
|
+
* <p>A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The
|
|
2465
|
+
* window length will always be 10 hours, so you can't specify an end time. For example, if
|
|
2466
|
+
* you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to
|
|
2467
|
+
* 9:00 A.M.</p>
|
|
2441
2468
|
* @public
|
|
2442
2469
|
*/
|
|
2443
2470
|
WindowStartTime?: WindowStartTime | undefined;
|
|
2444
2471
|
}
|
|
2445
2472
|
/**
|
|
2446
|
-
* <p>Options for a domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
2447
|
-
*
|
|
2473
|
+
* <p>Options for a domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
2474
|
+
* window</a>, during which OpenSearch Service can perform mandatory configuration
|
|
2475
|
+
* changes on the domain.</p>
|
|
2448
2476
|
* @public
|
|
2449
2477
|
*/
|
|
2450
2478
|
export interface OffPeakWindowOptions {
|
|
2451
2479
|
/**
|
|
2452
2480
|
* <p>Whether to enable an off-peak window.</p>
|
|
2453
|
-
* <p>This option is only available when modifying a domain created prior to February 16,
|
|
2454
|
-
*
|
|
2455
|
-
*
|
|
2481
|
+
* <p>This option is only available when modifying a domain created prior to February 16,
|
|
2482
|
+
* 2023, not when creating a new domain. All domains created after this date have the
|
|
2483
|
+
* off-peak window enabled by default. You can't disable the off-peak window after it's
|
|
2484
|
+
* enabled for a domain.</p>
|
|
2456
2485
|
* @public
|
|
2457
2486
|
*/
|
|
2458
2487
|
Enabled?: boolean | undefined;
|
|
@@ -2463,14 +2492,14 @@ export interface OffPeakWindowOptions {
|
|
|
2463
2492
|
OffPeakWindow?: OffPeakWindow | undefined;
|
|
2464
2493
|
}
|
|
2465
2494
|
/**
|
|
2466
|
-
* <p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of
|
|
2467
|
-
*
|
|
2495
|
+
* <p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of
|
|
2496
|
+
* the specified domain. Default is <code>0</code> hours.</p>
|
|
2468
2497
|
* @public
|
|
2469
2498
|
*/
|
|
2470
2499
|
export interface SnapshotOptions {
|
|
2471
2500
|
/**
|
|
2472
|
-
* <p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of
|
|
2473
|
-
*
|
|
2501
|
+
* <p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of
|
|
2502
|
+
* the specified domain. Default is <code>0</code> hours.</p>
|
|
2474
2503
|
* @public
|
|
2475
2504
|
*/
|
|
2476
2505
|
AutomatedSnapshotStartHour?: number | undefined;
|
|
@@ -2487,22 +2516,23 @@ export interface SoftwareUpdateOptions {
|
|
|
2487
2516
|
AutoSoftwareUpdateEnabled?: boolean | undefined;
|
|
2488
2517
|
}
|
|
2489
2518
|
/**
|
|
2490
|
-
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service
|
|
2491
|
-
*
|
|
2492
|
-
*
|
|
2519
|
+
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service
|
|
2520
|
+
* VPC endpoint. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching your Amazon
|
|
2521
|
+
* OpenSearch Service domains using a VPC</a>.</p>
|
|
2493
2522
|
* @public
|
|
2494
2523
|
*/
|
|
2495
2524
|
export interface VPCOptions {
|
|
2496
2525
|
/**
|
|
2497
|
-
* <p>A list of subnet IDs associated with the VPC endpoints for the domain. If your domain
|
|
2498
|
-
*
|
|
2499
|
-
*
|
|
2526
|
+
* <p>A list of subnet IDs associated with the VPC endpoints for the domain. If your domain
|
|
2527
|
+
* uses multiple Availability Zones, you need to provide two subnet IDs, one per zone.
|
|
2528
|
+
* Otherwise, provide only one.</p>
|
|
2500
2529
|
* @public
|
|
2501
2530
|
*/
|
|
2502
2531
|
SubnetIds?: string[] | undefined;
|
|
2503
2532
|
/**
|
|
2504
|
-
* <p>The list of security group IDs associated with the VPC endpoints for the domain. If
|
|
2505
|
-
*
|
|
2533
|
+
* <p>The list of security group IDs associated with the VPC endpoints for the domain. If
|
|
2534
|
+
* you do not provide a security group ID, OpenSearch Service uses the default security
|
|
2535
|
+
* group for the VPC.</p>
|
|
2506
2536
|
* @public
|
|
2507
2537
|
*/
|
|
2508
2538
|
SecurityGroupIds?: string[] | undefined;
|
|
@@ -2512,16 +2542,15 @@ export interface VPCOptions {
|
|
|
2512
2542
|
*/
|
|
2513
2543
|
export interface CreateDomainRequest {
|
|
2514
2544
|
/**
|
|
2515
|
-
* <p>Name of the OpenSearch Service domain to create. Domain names are unique across the
|
|
2516
|
-
*
|
|
2545
|
+
* <p>Name of the OpenSearch Service domain to create. Domain names are unique across the
|
|
2546
|
+
* domains owned by an account within an Amazon Web Services Region.</p>
|
|
2517
2547
|
* @public
|
|
2518
2548
|
*/
|
|
2519
2549
|
DomainName: string | undefined;
|
|
2520
2550
|
/**
|
|
2521
|
-
* <p>String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for
|
|
2522
|
-
*
|
|
2523
|
-
*
|
|
2524
|
-
* and managing Amazon OpenSearch Service domains</a>.</p>
|
|
2551
|
+
* <p>String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for
|
|
2552
|
+
* the OpenSearch Service domain. For example, <code>OpenSearch_1.0</code> or
|
|
2553
|
+
* <code>Elasticsearch_7.9</code>. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains">Creating and managing Amazon OpenSearch Service domains</a>.</p>
|
|
2525
2554
|
* @public
|
|
2526
2555
|
*/
|
|
2527
2556
|
EngineVersion?: string | undefined;
|
|
@@ -2531,40 +2560,43 @@ export interface CreateDomainRequest {
|
|
|
2531
2560
|
*/
|
|
2532
2561
|
ClusterConfig?: ClusterConfig | undefined;
|
|
2533
2562
|
/**
|
|
2534
|
-
* <p>Container for the parameters required to enable EBS-based storage for an OpenSearch
|
|
2535
|
-
*
|
|
2563
|
+
* <p>Container for the parameters required to enable EBS-based storage for an OpenSearch
|
|
2564
|
+
* Service domain.</p>
|
|
2536
2565
|
* @public
|
|
2537
2566
|
*/
|
|
2538
2567
|
EBSOptions?: EBSOptions | undefined;
|
|
2539
2568
|
/**
|
|
2540
|
-
* <p>Identity and Access Management (IAM) policy document specifying the access policies
|
|
2541
|
-
*
|
|
2569
|
+
* <p>Identity and Access Management (IAM) policy document specifying the access policies
|
|
2570
|
+
* for the new domain.</p>
|
|
2542
2571
|
* @public
|
|
2543
2572
|
*/
|
|
2544
2573
|
AccessPolicies?: string | undefined;
|
|
2545
2574
|
/**
|
|
2546
|
-
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2575
|
+
* <p>Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to
|
|
2576
|
+
* share domain resources across IPv4 and IPv6 address types, and is the recommended
|
|
2577
|
+
* option. If you set your IP address type to dual stack, you can't change your address
|
|
2578
|
+
* type later.</p>
|
|
2549
2579
|
* @public
|
|
2550
2580
|
*/
|
|
2551
2581
|
IPAddressType?: IPAddressType | undefined;
|
|
2552
2582
|
/**
|
|
2553
|
-
* <p>DEPRECATED. Container for the parameters required to configure automated snapshots of
|
|
2554
|
-
*
|
|
2583
|
+
* <p>DEPRECATED. Container for the parameters required to configure automated snapshots of
|
|
2584
|
+
* domain indexes.</p>
|
|
2555
2585
|
* @public
|
|
2556
2586
|
*/
|
|
2557
2587
|
SnapshotOptions?: SnapshotOptions | undefined;
|
|
2558
2588
|
/**
|
|
2559
|
-
* <p>Container for the values required to configure VPC access domains. If you don't
|
|
2560
|
-
*
|
|
2561
|
-
*
|
|
2562
|
-
*
|
|
2589
|
+
* <p>Container for the values required to configure VPC access domains. If you don't
|
|
2590
|
+
* specify these values, OpenSearch Service creates the domain with a public endpoint. For
|
|
2591
|
+
* more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching your Amazon
|
|
2592
|
+
* OpenSearch Service domains using a VPC</a>.</p>
|
|
2563
2593
|
* @public
|
|
2564
2594
|
*/
|
|
2565
2595
|
VPCOptions?: VPCOptions | undefined;
|
|
2566
2596
|
/**
|
|
2567
|
-
* <p>Key-value pairs to configure Amazon Cognito authentication. For more information, see
|
|
2597
|
+
* <p>Key-value pairs to configure Amazon Cognito authentication. For more information, see
|
|
2598
|
+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html">Configuring Amazon
|
|
2599
|
+
* Cognito authentication for OpenSearch Dashboards</a>.</p>
|
|
2568
2600
|
* @public
|
|
2569
2601
|
*/
|
|
2570
2602
|
CognitoOptions?: CognitoOptions | undefined;
|
|
@@ -2579,36 +2611,37 @@ export interface CreateDomainRequest {
|
|
|
2579
2611
|
*/
|
|
2580
2612
|
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
|
|
2581
2613
|
/**
|
|
2582
|
-
* <p>Key-value pairs to specify advanced configuration options. The following key-value
|
|
2583
|
-
*
|
|
2614
|
+
* <p>Key-value pairs to specify advanced configuration options. The following key-value
|
|
2615
|
+
* pairs are supported:</p>
|
|
2584
2616
|
* <ul>
|
|
2585
2617
|
* <li>
|
|
2586
2618
|
* <p>
|
|
2587
|
-
* <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note
|
|
2588
|
-
*
|
|
2589
|
-
*
|
|
2590
|
-
*
|
|
2591
|
-
*
|
|
2619
|
+
* <code>"rest.action.multi.allow_explicit_index": "true" | "false"</code> - Note
|
|
2620
|
+
* the use of a string rather than a boolean. Specifies whether explicit references
|
|
2621
|
+
* to indexes are allowed inside the body of HTTP requests. If you want to
|
|
2622
|
+
* configure access policies for domain sub-resources, such as specific indexes and
|
|
2623
|
+
* domain APIs, you must disable this property. Default is true.</p>
|
|
2592
2624
|
* </li>
|
|
2593
2625
|
* <li>
|
|
2594
2626
|
* <p>
|
|
2595
|
-
* <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string
|
|
2596
|
-
*
|
|
2597
|
-
*
|
|
2627
|
+
* <code>"indices.fielddata.cache.size": "80" </code> - Note the use of a string
|
|
2628
|
+
* rather than a boolean. Specifies the percentage of heap space allocated to field
|
|
2629
|
+
* data. Default is unbounded.</p>
|
|
2598
2630
|
* </li>
|
|
2599
2631
|
* <li>
|
|
2600
2632
|
* <p>
|
|
2601
|
-
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a
|
|
2602
|
-
*
|
|
2603
|
-
*
|
|
2604
|
-
*
|
|
2633
|
+
* <code>"indices.query.bool.max_clause_count": "1024"</code> - Note the use of a
|
|
2634
|
+
* string rather than a boolean. Specifies the maximum number of clauses allowed in
|
|
2635
|
+
* a Lucene boolean query. Default is 1,024. Queries with more than the permitted
|
|
2636
|
+
* number of clauses result in a <code>TooManyClauses</code> error.</p>
|
|
2605
2637
|
* </li>
|
|
2606
2638
|
* <li>
|
|
2607
2639
|
* <p>
|
|
2608
|
-
* <code>"override_main_response_version": "true" | "false"</code> - Note the use
|
|
2609
|
-
*
|
|
2610
|
-
*
|
|
2611
|
-
*
|
|
2640
|
+
* <code>"override_main_response_version": "true" | "false"</code> - Note the use
|
|
2641
|
+
* of a string rather than a boolean. Specifies whether the domain reports its
|
|
2642
|
+
* version as 7.10 to allow Elasticsearch OSS clients and plugins to continue
|
|
2643
|
+
* working with it. Default is false when creating a domain and true when upgrading
|
|
2644
|
+
* a domain.</p>
|
|
2612
2645
|
* </li>
|
|
2613
2646
|
* </ul>
|
|
2614
2647
|
* <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>
|
|
@@ -2622,7 +2655,7 @@ export interface CreateDomainRequest {
|
|
|
2622
2655
|
LogPublishingOptions?: Partial<Record<LogType, LogPublishingOption>> | undefined;
|
|
2623
2656
|
/**
|
|
2624
2657
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
2625
|
-
*
|
|
2658
|
+
* traffic.</p>
|
|
2626
2659
|
* @public
|
|
2627
2660
|
*/
|
|
2628
2661
|
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
@@ -2632,7 +2665,8 @@ export interface CreateDomainRequest {
|
|
|
2632
2665
|
*/
|
|
2633
2666
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
|
|
2634
2667
|
/**
|
|
2635
|
-
* <p>Configuration options for enabling and managing IAM Identity Center integration within
|
|
2668
|
+
* <p>Configuration options for enabling and managing IAM Identity Center integration within
|
|
2669
|
+
* a domain.</p>
|
|
2636
2670
|
* @public
|
|
2637
2671
|
*/
|
|
2638
2672
|
IdentityCenterOptions?: IdentityCenterOptionsInput | undefined;
|
|
@@ -2648,9 +2682,10 @@ export interface CreateDomainRequest {
|
|
|
2648
2682
|
AutoTuneOptions?: AutoTuneOptionsInput | undefined;
|
|
2649
2683
|
/**
|
|
2650
2684
|
* <p>Specifies a daily 10-hour time block during which OpenSearch Service can perform
|
|
2651
|
-
*
|
|
2652
|
-
*
|
|
2653
|
-
*
|
|
2685
|
+
* configuration changes on the domain, including service software updates and Auto-Tune
|
|
2686
|
+
* enhancements that require a blue/green deployment. If no options are specified, the
|
|
2687
|
+
* default start time of 10:00 P.M. local time (for the Region that the domain is created
|
|
2688
|
+
* in) is used.</p>
|
|
2654
2689
|
* @public
|
|
2655
2690
|
*/
|
|
2656
2691
|
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
@@ -2685,7 +2720,8 @@ export declare const AutoTuneState: {
|
|
|
2685
2720
|
*/
|
|
2686
2721
|
export type AutoTuneState = (typeof AutoTuneState)[keyof typeof AutoTuneState];
|
|
2687
2722
|
/**
|
|
2688
|
-
* <p>The Auto-Tune settings for a domain, displayed when enabling or disabling
|
|
2723
|
+
* <p>The Auto-Tune settings for a domain, displayed when enabling or disabling
|
|
2724
|
+
* Auto-Tune.</p>
|
|
2689
2725
|
* @public
|
|
2690
2726
|
*/
|
|
2691
2727
|
export interface AutoTuneOptionsOutput {
|
|
@@ -2701,7 +2737,7 @@ export interface AutoTuneOptionsOutput {
|
|
|
2701
2737
|
ErrorMessage?: string | undefined;
|
|
2702
2738
|
/**
|
|
2703
2739
|
* <p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather
|
|
2704
|
-
*
|
|
2740
|
+
* than a maintenance schedule.</p>
|
|
2705
2741
|
* @public
|
|
2706
2742
|
*/
|
|
2707
2743
|
UseOffPeakWindow?: boolean | undefined;
|
|
@@ -2762,7 +2798,8 @@ export interface ChangeProgressDetails {
|
|
|
2762
2798
|
*/
|
|
2763
2799
|
InitiatedBy?: InitiatedBy | undefined;
|
|
2764
2800
|
/**
|
|
2765
|
-
* <p>The time that the configuration change was initiated, in Universal Coordinated Time
|
|
2801
|
+
* <p>The time that the configuration change was initiated, in Universal Coordinated Time
|
|
2802
|
+
* (UTC).</p>
|
|
2766
2803
|
* @public
|
|
2767
2804
|
*/
|
|
2768
2805
|
StartTime?: Date | undefined;
|
|
@@ -2790,9 +2827,10 @@ export declare const DomainProcessingStatusType: {
|
|
|
2790
2827
|
*/
|
|
2791
2828
|
export type DomainProcessingStatusType = (typeof DomainProcessingStatusType)[keyof typeof DomainProcessingStatusType];
|
|
2792
2829
|
/**
|
|
2793
|
-
* <p>Settings container for integrating IAM Identity Center with OpenSearch UI
|
|
2794
|
-
*
|
|
2795
|
-
*
|
|
2830
|
+
* <p>Settings container for integrating IAM Identity Center with OpenSearch UI
|
|
2831
|
+
* applications, which enables enabling secure user authentication and access control
|
|
2832
|
+
* across multiple data sources. This setup supports single sign-on (SSO) through IAM
|
|
2833
|
+
* Identity Center, allowing centralized user management.</p>
|
|
2796
2834
|
* @public
|
|
2797
2835
|
*/
|
|
2798
2836
|
export interface IdentityCenterOptions {
|
|
@@ -2807,17 +2845,20 @@ export interface IdentityCenterOptions {
|
|
|
2807
2845
|
*/
|
|
2808
2846
|
IdentityCenterInstanceARN?: string | undefined;
|
|
2809
2847
|
/**
|
|
2810
|
-
* <p>Specifies the attribute that contains the subject identifier (such as username, user
|
|
2848
|
+
* <p>Specifies the attribute that contains the subject identifier (such as username, user
|
|
2849
|
+
* ID, or email) in IAM Identity Center.</p>
|
|
2811
2850
|
* @public
|
|
2812
2851
|
*/
|
|
2813
2852
|
SubjectKey?: SubjectKeyIdCOption | undefined;
|
|
2814
2853
|
/**
|
|
2815
|
-
* <p>Specifies the attribute that contains the backend role identifier (such as group name
|
|
2854
|
+
* <p>Specifies the attribute that contains the backend role identifier (such as group name
|
|
2855
|
+
* or group ID) in IAM Identity Center.</p>
|
|
2816
2856
|
* @public
|
|
2817
2857
|
*/
|
|
2818
2858
|
RolesKey?: RolesKeyIdCOption | undefined;
|
|
2819
2859
|
/**
|
|
2820
|
-
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch
|
|
2860
|
+
* <p>The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch
|
|
2861
|
+
* Service.</p>
|
|
2821
2862
|
* @public
|
|
2822
2863
|
*/
|
|
2823
2864
|
IdentityCenterApplicationARN?: string | undefined;
|
|
@@ -2855,20 +2896,24 @@ export interface ModifyingProperties {
|
|
|
2855
2896
|
*/
|
|
2856
2897
|
ActiveValue?: string | undefined;
|
|
2857
2898
|
/**
|
|
2858
|
-
* <p>The value that the property that is currently being modified will eventually
|
|
2899
|
+
* <p>The value that the property that is currently being modified will eventually
|
|
2900
|
+
* have.</p>
|
|
2859
2901
|
* @public
|
|
2860
2902
|
*/
|
|
2861
2903
|
PendingValue?: string | undefined;
|
|
2862
2904
|
/**
|
|
2863
|
-
* <p>The type of value that is currently being modified. Properties can have two
|
|
2905
|
+
* <p>The type of value that is currently being modified. Properties can have two
|
|
2906
|
+
* types:</p>
|
|
2864
2907
|
* <ul>
|
|
2865
2908
|
* <li>
|
|
2866
2909
|
* <p>
|
|
2867
|
-
* <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or
|
|
2910
|
+
* <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or
|
|
2911
|
+
* "c5.large.search".</p>
|
|
2868
2912
|
* </li>
|
|
2869
2913
|
* <li>
|
|
2870
2914
|
* <p>
|
|
2871
|
-
* <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as
|
|
2915
|
+
* <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as
|
|
2916
|
+
* \{"Enabled":"True"\}".</p>
|
|
2872
2917
|
* </li>
|
|
2873
2918
|
* </ul>
|
|
2874
2919
|
* @public
|
|
@@ -2876,10 +2921,10 @@ export interface ModifyingProperties {
|
|
|
2876
2921
|
ValueType?: PropertyValueType | undefined;
|
|
2877
2922
|
}
|
|
2878
2923
|
/**
|
|
2879
|
-
* <p>Information about the subnets and security groups for an Amazon OpenSearch Service
|
|
2880
|
-
*
|
|
2881
|
-
*
|
|
2882
|
-
*
|
|
2924
|
+
* <p>Information about the subnets and security groups for an Amazon OpenSearch Service
|
|
2925
|
+
* domain provisioned within a virtual private cloud (VPC). For more information, see
|
|
2926
|
+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html">Launching your Amazon OpenSearch Service domains using a VPC</a>. This
|
|
2927
|
+
* information only exists if the domain was created with <code>VPCOptions</code>.</p>
|
|
2883
2928
|
* @public
|
|
2884
2929
|
*/
|
|
2885
2930
|
export interface VPCDerivedInfo {
|
|
@@ -2899,7 +2944,8 @@ export interface VPCDerivedInfo {
|
|
|
2899
2944
|
*/
|
|
2900
2945
|
AvailabilityZones?: string[] | undefined;
|
|
2901
2946
|
/**
|
|
2902
|
-
* <p>The list of security group IDs associated with the VPC endpoints for the
|
|
2947
|
+
* <p>The list of security group IDs associated with the VPC endpoints for the
|
|
2948
|
+
* domain.</p>
|
|
2903
2949
|
* @public
|
|
2904
2950
|
*/
|
|
2905
2951
|
SecurityGroupIds?: string[] | undefined;
|
|
@@ -2915,57 +2961,59 @@ export interface DomainStatus {
|
|
|
2915
2961
|
*/
|
|
2916
2962
|
DomainId: string | undefined;
|
|
2917
2963
|
/**
|
|
2918
|
-
* <p>Name of the domain. Domain names are unique across all domains owned by the same
|
|
2919
|
-
*
|
|
2964
|
+
* <p>Name of the domain. Domain names are unique across all domains owned by the same
|
|
2965
|
+
* account within an Amazon Web Services Region.</p>
|
|
2920
2966
|
* @public
|
|
2921
2967
|
*/
|
|
2922
2968
|
DomainName: string | undefined;
|
|
2923
2969
|
/**
|
|
2924
|
-
* <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
|
|
2925
|
-
*
|
|
2970
|
+
* <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
|
|
2971
|
+
* identifiers </a> in the <i>AWS Identity and Access Management User
|
|
2972
|
+
* Guide</i>.</p>
|
|
2926
2973
|
* @public
|
|
2927
2974
|
*/
|
|
2928
2975
|
ARN: string | undefined;
|
|
2929
2976
|
/**
|
|
2930
|
-
* <p>Creation status of an OpenSearch Service domain. True if domain creation is complete.
|
|
2931
|
-
*
|
|
2977
|
+
* <p>Creation status of an OpenSearch Service domain. True if domain creation is complete.
|
|
2978
|
+
* False if domain creation is still in progress.</p>
|
|
2932
2979
|
* @public
|
|
2933
2980
|
*/
|
|
2934
2981
|
Created?: boolean | undefined;
|
|
2935
2982
|
/**
|
|
2936
|
-
* <p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete.
|
|
2937
|
-
*
|
|
2938
|
-
*
|
|
2983
|
+
* <p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete.
|
|
2984
|
+
* False if domain deletion is still in progress. Once deletion is complete, the status of
|
|
2985
|
+
* the domain is no longer returned.</p>
|
|
2939
2986
|
* @public
|
|
2940
2987
|
*/
|
|
2941
2988
|
Deleted?: boolean | undefined;
|
|
2942
2989
|
/**
|
|
2943
2990
|
* <p>Domain-specific endpoint used to submit index, search, and data upload requests to the
|
|
2944
|
-
*
|
|
2991
|
+
* domain.</p>
|
|
2945
2992
|
* @public
|
|
2946
2993
|
*/
|
|
2947
2994
|
Endpoint?: string | undefined;
|
|
2948
2995
|
/**
|
|
2949
|
-
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain
|
|
2950
|
-
*
|
|
2951
|
-
*
|
|
2952
|
-
*
|
|
2996
|
+
* <p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain
|
|
2997
|
+
* endpoint is provisioned. This endpoint functions like a normal endpoint, except that it
|
|
2998
|
+
* works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP
|
|
2999
|
+
* addresses. </p>
|
|
2953
3000
|
* @public
|
|
2954
3001
|
*/
|
|
2955
3002
|
EndpointV2?: string | undefined;
|
|
2956
3003
|
/**
|
|
2957
|
-
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.
|
|
3004
|
+
* <p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.
|
|
3005
|
+
* For example:</p>
|
|
2958
3006
|
* <ul>
|
|
2959
3007
|
* <li>
|
|
2960
3008
|
* <p>
|
|
2961
3009
|
* <b>IPv4 IP addresses</b> -
|
|
2962
|
-
*
|
|
3010
|
+
* <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>
|
|
2963
3011
|
* </p>
|
|
2964
3012
|
* </li>
|
|
2965
3013
|
* <li>
|
|
2966
3014
|
* <p>
|
|
2967
3015
|
* <b>Dual stack IP addresses</b> -
|
|
2968
|
-
*
|
|
3016
|
+
* <code>'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'</code>
|
|
2969
3017
|
* </p>
|
|
2970
3018
|
* </li>
|
|
2971
3019
|
* </ul>
|
|
@@ -2979,20 +3027,20 @@ export interface DomainStatus {
|
|
|
2979
3027
|
DomainEndpointV2HostedZoneId?: string | undefined;
|
|
2980
3028
|
/**
|
|
2981
3029
|
* <p>The status of the domain configuration. True if OpenSearch Service is processing
|
|
2982
|
-
*
|
|
3030
|
+
* configuration changes. False if the configuration is active.</p>
|
|
2983
3031
|
* @public
|
|
2984
3032
|
*/
|
|
2985
3033
|
Processing?: boolean | undefined;
|
|
2986
3034
|
/**
|
|
2987
|
-
* <p>The status of a domain version upgrade to a new version of OpenSearch or
|
|
2988
|
-
*
|
|
2989
|
-
*
|
|
3035
|
+
* <p>The status of a domain version upgrade to a new version of OpenSearch or
|
|
3036
|
+
* Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False
|
|
3037
|
+
* if the configuration is active.</p>
|
|
2990
3038
|
* @public
|
|
2991
3039
|
*/
|
|
2992
3040
|
UpgradeProcessing?: boolean | undefined;
|
|
2993
3041
|
/**
|
|
2994
3042
|
* <p>Version of OpenSearch or Elasticsearch that the domain is running, in the format
|
|
2995
|
-
*
|
|
3043
|
+
* <code>Elasticsearch_X.Y</code> or <code>OpenSearch_X.Y</code>.</p>
|
|
2996
3044
|
* @public
|
|
2997
3045
|
*/
|
|
2998
3046
|
EngineVersion?: string | undefined;
|
|
@@ -3007,8 +3055,8 @@ export interface DomainStatus {
|
|
|
3007
3055
|
*/
|
|
3008
3056
|
EBSOptions?: EBSOptions | undefined;
|
|
3009
3057
|
/**
|
|
3010
|
-
* <p>Identity and Access Management (IAM) policy document specifying the access policies
|
|
3011
|
-
*
|
|
3058
|
+
* <p>Identity and Access Management (IAM) policy document specifying the access policies
|
|
3059
|
+
* for the domain.</p>
|
|
3012
3060
|
* @public
|
|
3013
3061
|
*/
|
|
3014
3062
|
AccessPolicies?: string | undefined;
|
|
@@ -3018,8 +3066,8 @@ export interface DomainStatus {
|
|
|
3018
3066
|
*/
|
|
3019
3067
|
IPAddressType?: IPAddressType | undefined;
|
|
3020
3068
|
/**
|
|
3021
|
-
* <p>DEPRECATED. Container for parameters required to configure automated snapshots of
|
|
3022
|
-
*
|
|
3069
|
+
* <p>DEPRECATED. Container for parameters required to configure automated snapshots of
|
|
3070
|
+
* domain indexes.</p>
|
|
3023
3071
|
* @public
|
|
3024
3072
|
*/
|
|
3025
3073
|
SnapshotOptions?: SnapshotOptions | undefined;
|
|
@@ -3029,7 +3077,8 @@ export interface DomainStatus {
|
|
|
3029
3077
|
*/
|
|
3030
3078
|
VPCOptions?: VPCDerivedInfo | undefined;
|
|
3031
3079
|
/**
|
|
3032
|
-
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch
|
|
3080
|
+
* <p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch
|
|
3081
|
+
* Dashboards.</p>
|
|
3033
3082
|
* @public
|
|
3034
3083
|
*/
|
|
3035
3084
|
CognitoOptions?: CognitoOptions | undefined;
|
|
@@ -3060,7 +3109,7 @@ export interface DomainStatus {
|
|
|
3060
3109
|
ServiceSoftwareOptions?: ServiceSoftwareOptions | undefined;
|
|
3061
3110
|
/**
|
|
3062
3111
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
3063
|
-
*
|
|
3112
|
+
* traffic.</p>
|
|
3064
3113
|
* @public
|
|
3065
3114
|
*/
|
|
3066
3115
|
DomainEndpointOptions?: DomainEndpointOptions | undefined;
|
|
@@ -3070,7 +3119,8 @@ export interface DomainStatus {
|
|
|
3070
3119
|
*/
|
|
3071
3120
|
AdvancedSecurityOptions?: AdvancedSecurityOptions | undefined;
|
|
3072
3121
|
/**
|
|
3073
|
-
* <p>Configuration options for controlling IAM Identity Center integration within a
|
|
3122
|
+
* <p>Configuration options for controlling IAM Identity Center integration within a
|
|
3123
|
+
* domain.</p>
|
|
3074
3124
|
* @public
|
|
3075
3125
|
*/
|
|
3076
3126
|
IdentityCenterOptions?: IdentityCenterOptions | undefined;
|
|
@@ -3085,8 +3135,8 @@ export interface DomainStatus {
|
|
|
3085
3135
|
*/
|
|
3086
3136
|
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
3087
3137
|
/**
|
|
3088
|
-
* <p>Options that specify a custom 10-hour window during which OpenSearch Service can
|
|
3089
|
-
*
|
|
3138
|
+
* <p>Options that specify a custom 10-hour window during which OpenSearch Service can
|
|
3139
|
+
* perform configuration changes on the domain.</p>
|
|
3090
3140
|
* @public
|
|
3091
3141
|
*/
|
|
3092
3142
|
OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
|
|
@@ -3113,7 +3163,7 @@ export interface DomainStatus {
|
|
|
3113
3163
|
}
|
|
3114
3164
|
/**
|
|
3115
3165
|
* <p>The result of a <code>CreateDomain</code> operation. Contains the status of the newly
|
|
3116
|
-
*
|
|
3166
|
+
* created domain.</p>
|
|
3117
3167
|
* @public
|
|
3118
3168
|
*/
|
|
3119
3169
|
export interface CreateDomainResponse {
|
|
@@ -3165,9 +3215,10 @@ export type SkipUnavailableStatus = (typeof SkipUnavailableStatus)[keyof typeof
|
|
|
3165
3215
|
*/
|
|
3166
3216
|
export interface CrossClusterSearchConnectionProperties {
|
|
3167
3217
|
/**
|
|
3168
|
-
* <p>The status of the <code>SkipUnavailable</code> setting for the outbound connection.
|
|
3169
|
-
*
|
|
3170
|
-
*
|
|
3218
|
+
* <p>The status of the <code>SkipUnavailable</code> setting for the outbound connection.
|
|
3219
|
+
* This feature allows you to specify some clusters as optional and ensure that your
|
|
3220
|
+
* cross-cluster queries return partial results despite failures on one or more remote
|
|
3221
|
+
* clusters.</p>
|
|
3171
3222
|
* @public
|
|
3172
3223
|
*/
|
|
3173
3224
|
SkipUnavailable?: SkipUnavailableStatus | undefined;
|
|
@@ -3192,7 +3243,8 @@ export interface ConnectionProperties {
|
|
|
3192
3243
|
CrossClusterSearch?: CrossClusterSearchConnectionProperties | undefined;
|
|
3193
3244
|
}
|
|
3194
3245
|
/**
|
|
3195
|
-
* <p>Container for the parameters to the <code>CreateOutboundConnection</code>
|
|
3246
|
+
* <p>Container for the parameters to the <code>CreateOutboundConnection</code>
|
|
3247
|
+
* operation.</p>
|
|
3196
3248
|
* @public
|
|
3197
3249
|
*/
|
|
3198
3250
|
export interface CreateOutboundConnectionRequest {
|
|
@@ -3252,50 +3304,53 @@ export interface OutboundConnectionStatus {
|
|
|
3252
3304
|
* <ul>
|
|
3253
3305
|
* <li>
|
|
3254
3306
|
* <p>
|
|
3255
|
-
* <b>VALIDATING</b> - The outbound connection request
|
|
3256
|
-
*
|
|
3307
|
+
* <b>VALIDATING</b> - The outbound connection request
|
|
3308
|
+
* is being validated.</p>
|
|
3257
3309
|
* </li>
|
|
3258
3310
|
* <li>
|
|
3259
3311
|
* <p>
|
|
3260
|
-
* <b>VALIDATION_FAILED</b> - Validation failed for the
|
|
3261
|
-
*
|
|
3312
|
+
* <b>VALIDATION_FAILED</b> - Validation failed for the
|
|
3313
|
+
* connection request.</p>
|
|
3262
3314
|
* </li>
|
|
3263
3315
|
* <li>
|
|
3264
3316
|
* <p>
|
|
3265
|
-
* <b>PENDING_ACCEPTANCE</b>: Outbound connection
|
|
3266
|
-
*
|
|
3317
|
+
* <b>PENDING_ACCEPTANCE</b>: Outbound connection
|
|
3318
|
+
* request is validated and is not yet accepted by the remote domain owner.</p>
|
|
3267
3319
|
* </li>
|
|
3268
3320
|
* <li>
|
|
3269
3321
|
* <p>
|
|
3270
|
-
* <b>APPROVED</b> - Outbound connection has been
|
|
3271
|
-
*
|
|
3322
|
+
* <b>APPROVED</b> - Outbound connection has been
|
|
3323
|
+
* approved by the remote domain owner for getting provisioned.</p>
|
|
3272
3324
|
* </li>
|
|
3273
3325
|
* <li>
|
|
3274
3326
|
* <p>
|
|
3275
|
-
* <b>PROVISIONING</b> - Outbound connection request is
|
|
3327
|
+
* <b>PROVISIONING</b> - Outbound connection request is
|
|
3328
|
+
* in process.</p>
|
|
3276
3329
|
* </li>
|
|
3277
3330
|
* <li>
|
|
3278
3331
|
* <p>
|
|
3279
|
-
* <b>ACTIVE</b> - Outbound connection is active and
|
|
3332
|
+
* <b>ACTIVE</b> - Outbound connection is active and
|
|
3333
|
+
* ready to use.</p>
|
|
3280
3334
|
* </li>
|
|
3281
3335
|
* <li>
|
|
3282
3336
|
* <p>
|
|
3283
|
-
* <b>REJECTING</b> - Outbound connection rejection by
|
|
3284
|
-
*
|
|
3337
|
+
* <b>REJECTING</b> - Outbound connection rejection by
|
|
3338
|
+
* remote domain owner is in progress.</p>
|
|
3285
3339
|
* </li>
|
|
3286
3340
|
* <li>
|
|
3287
3341
|
* <p>
|
|
3288
|
-
* <b>REJECTED</b> - Outbound connection request is
|
|
3289
|
-
*
|
|
3342
|
+
* <b>REJECTED</b> - Outbound connection request is
|
|
3343
|
+
* rejected by remote domain owner.</p>
|
|
3290
3344
|
* </li>
|
|
3291
3345
|
* <li>
|
|
3292
3346
|
* <p>
|
|
3293
|
-
* <b>DELETING</b> - Outbound connection deletion is in
|
|
3347
|
+
* <b>DELETING</b> - Outbound connection deletion is in
|
|
3348
|
+
* progress.</p>
|
|
3294
3349
|
* </li>
|
|
3295
3350
|
* <li>
|
|
3296
3351
|
* <p>
|
|
3297
|
-
* <b>DELETED</b> - Outbound connection is deleted and
|
|
3298
|
-
*
|
|
3352
|
+
* <b>DELETED</b> - Outbound connection is deleted and
|
|
3353
|
+
* can no longer be used.</p>
|
|
3299
3354
|
* </li>
|
|
3300
3355
|
* </ul>
|
|
3301
3356
|
* @public
|
|
@@ -3308,8 +3363,8 @@ export interface OutboundConnectionStatus {
|
|
|
3308
3363
|
Message?: string | undefined;
|
|
3309
3364
|
}
|
|
3310
3365
|
/**
|
|
3311
|
-
* <p>The result of a <code>CreateOutboundConnection</code> request. Contains details about
|
|
3312
|
-
*
|
|
3366
|
+
* <p>The result of a <code>CreateOutboundConnection</code> request. Contains details about
|
|
3367
|
+
* the newly created cross-cluster connection.</p>
|
|
3313
3368
|
* @public
|
|
3314
3369
|
*/
|
|
3315
3370
|
export interface CreateOutboundConnectionResponse {
|
|
@@ -3334,8 +3389,8 @@ export interface CreateOutboundConnectionResponse {
|
|
|
3334
3389
|
*/
|
|
3335
3390
|
ConnectionStatus?: OutboundConnectionStatus | undefined;
|
|
3336
3391
|
/**
|
|
3337
|
-
* <p>The unique identifier for the created outbound connection, which is used for
|
|
3338
|
-
*
|
|
3392
|
+
* <p>The unique identifier for the created outbound connection, which is used for
|
|
3393
|
+
* subsequent operations on the connection.</p>
|
|
3339
3394
|
* @public
|
|
3340
3395
|
*/
|
|
3341
3396
|
ConnectionId?: string | undefined;
|
|
@@ -3384,7 +3439,8 @@ export interface PackageConfiguration {
|
|
|
3384
3439
|
*/
|
|
3385
3440
|
ConfigurationRequirement: RequirementLevel | undefined;
|
|
3386
3441
|
/**
|
|
3387
|
-
* <p>This indicates whether a B/G deployment is required for updating the configuration
|
|
3442
|
+
* <p>This indicates whether a B/G deployment is required for updating the configuration
|
|
3443
|
+
* that the plugin is prerequisite for.</p>
|
|
3388
3444
|
* @public
|
|
3389
3445
|
*/
|
|
3390
3446
|
RequiresRestartForConfigurationUpdate?: boolean | undefined;
|
|
@@ -3422,12 +3478,14 @@ export interface PackageSource {
|
|
|
3422
3478
|
S3Key?: string | undefined;
|
|
3423
3479
|
}
|
|
3424
3480
|
/**
|
|
3425
|
-
* <p>Configuration options for determining whether a package can be made available for use
|
|
3481
|
+
* <p>Configuration options for determining whether a package can be made available for use
|
|
3482
|
+
* by other users.</p>
|
|
3426
3483
|
* @public
|
|
3427
3484
|
*/
|
|
3428
3485
|
export interface PackageVendingOptions {
|
|
3429
3486
|
/**
|
|
3430
|
-
* <p>Indicates whether the package vending feature is enabled, allowing the package to be
|
|
3487
|
+
* <p>Indicates whether the package vending feature is enabled, allowing the package to be
|
|
3488
|
+
* used by other users.</p>
|
|
3431
3489
|
* @public
|
|
3432
3490
|
*/
|
|
3433
3491
|
VendingEnabled: boolean | undefined;
|
|
@@ -3463,13 +3521,15 @@ export interface CreatePackageRequest {
|
|
|
3463
3521
|
*/
|
|
3464
3522
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
3465
3523
|
/**
|
|
3466
|
-
* <p>The version of the Amazon OpenSearch Service engine for which is compatible with the
|
|
3524
|
+
* <p>The version of the Amazon OpenSearch Service engine for which is compatible with the
|
|
3525
|
+
* package. This can only be specified for package type <code>ZIP-PLUGIN</code>
|
|
3467
3526
|
* </p>
|
|
3468
3527
|
* @public
|
|
3469
3528
|
*/
|
|
3470
3529
|
EngineVersion?: string | undefined;
|
|
3471
3530
|
/**
|
|
3472
|
-
* <p> The vending options for the package being created. They determine if the package can
|
|
3531
|
+
* <p> The vending options for the package being created. They determine if the package can
|
|
3532
|
+
* be vended to other users.</p>
|
|
3473
3533
|
* @public
|
|
3474
3534
|
*/
|
|
3475
3535
|
PackageVendingOptions?: PackageVendingOptions | undefined;
|
|
@@ -3554,7 +3614,10 @@ export interface PackageDetails {
|
|
|
3554
3614
|
*/
|
|
3555
3615
|
PackageDescription?: string | undefined;
|
|
3556
3616
|
/**
|
|
3557
|
-
* <p>The current status of the package. The available options are <code>AVAILABLE</code>,
|
|
3617
|
+
* <p>The current status of the package. The available options are <code>AVAILABLE</code>,
|
|
3618
|
+
* <code>COPYING</code>, <code>COPY_FAILED</code>, <code>VALIDATNG</code>,
|
|
3619
|
+
* <code>VALIDATION_FAILED</code>, <code>DELETING</code>, and
|
|
3620
|
+
* <code>DELETE_FAILED</code>.</p>
|
|
3558
3621
|
* @public
|
|
3559
3622
|
*/
|
|
3560
3623
|
PackageStatus?: PackageStatus | undefined;
|
|
@@ -3579,13 +3642,14 @@ export interface PackageDetails {
|
|
|
3579
3642
|
*/
|
|
3580
3643
|
ErrorDetails?: ErrorDetails | undefined;
|
|
3581
3644
|
/**
|
|
3582
|
-
* <p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
|
|
3583
|
-
*
|
|
3645
|
+
* <p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
|
|
3646
|
+
* OpenSearch_X.Y. Defaults to the latest version of OpenSearch.</p>
|
|
3584
3647
|
* @public
|
|
3585
3648
|
*/
|
|
3586
3649
|
EngineVersion?: string | undefined;
|
|
3587
3650
|
/**
|
|
3588
|
-
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about
|
|
3651
|
+
* <p>If the package is a <code>ZIP-PLUGIN</code> package, additional information about
|
|
3652
|
+
* plugin properties.</p>
|
|
3589
3653
|
* @public
|
|
3590
3654
|
*/
|
|
3591
3655
|
AvailablePluginProperties?: PluginProperties | undefined;
|
|
@@ -3595,12 +3659,14 @@ export interface PackageDetails {
|
|
|
3595
3659
|
*/
|
|
3596
3660
|
AvailablePackageConfiguration?: PackageConfiguration | undefined;
|
|
3597
3661
|
/**
|
|
3598
|
-
* <p> A list of users who are allowed to view and associate the package. This field is only
|
|
3662
|
+
* <p> A list of users who are allowed to view and associate the package. This field is only
|
|
3663
|
+
* visible to the owner of a package.</p>
|
|
3599
3664
|
* @public
|
|
3600
3665
|
*/
|
|
3601
3666
|
AllowListedUserList?: string[] | undefined;
|
|
3602
3667
|
/**
|
|
3603
|
-
* <p>The owner of the package who is allowed to create and update a package and add users
|
|
3668
|
+
* <p>The owner of the package who is allowed to create and update a package and add users
|
|
3669
|
+
* to the package scope.</p>
|
|
3604
3670
|
* @public
|
|
3605
3671
|
*/
|
|
3606
3672
|
PackageOwner?: string | undefined;
|
|
@@ -3616,7 +3682,8 @@ export interface PackageDetails {
|
|
|
3616
3682
|
PackageEncryptionOptions?: PackageEncryptionOptions | undefined;
|
|
3617
3683
|
}
|
|
3618
3684
|
/**
|
|
3619
|
-
* <p>Container for the response returned by the <code>CreatePackage</code>
|
|
3685
|
+
* <p>Container for the response returned by the <code>CreatePackage</code>
|
|
3686
|
+
* operation.</p>
|
|
3620
3687
|
* @public
|
|
3621
3688
|
*/
|
|
3622
3689
|
export interface CreatePackageResponse {
|
|
@@ -3664,8 +3731,8 @@ export declare const VpcEndpointStatus: {
|
|
|
3664
3731
|
*/
|
|
3665
3732
|
export type VpcEndpointStatus = (typeof VpcEndpointStatus)[keyof typeof VpcEndpointStatus];
|
|
3666
3733
|
/**
|
|
3667
|
-
* <p>The connection endpoint for connecting to an Amazon OpenSearch Service domain through
|
|
3668
|
-
*
|
|
3734
|
+
* <p>The connection endpoint for connecting to an Amazon OpenSearch Service domain through
|
|
3735
|
+
* a proxy.</p>
|
|
3669
3736
|
* @public
|
|
3670
3737
|
*/
|
|
3671
3738
|
export interface VpcEndpoint {
|
|
@@ -3685,8 +3752,8 @@ export interface VpcEndpoint {
|
|
|
3685
3752
|
*/
|
|
3686
3753
|
DomainArn?: string | undefined;
|
|
3687
3754
|
/**
|
|
3688
|
-
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service
|
|
3689
|
-
*
|
|
3755
|
+
* <p>Options to specify the subnets and security groups for an Amazon OpenSearch Service
|
|
3756
|
+
* VPC endpoint.</p>
|
|
3690
3757
|
* @public
|
|
3691
3758
|
*/
|
|
3692
3759
|
VpcOptions?: VPCDerivedInfo | undefined;
|
|
@@ -3727,8 +3794,7 @@ export interface DeleteApplicationRequest {
|
|
|
3727
3794
|
export interface DeleteApplicationResponse {
|
|
3728
3795
|
}
|
|
3729
3796
|
/**
|
|
3730
|
-
* <p>Container for the parameters to the <code>DeleteDataSource</code>
|
|
3731
|
-
* operation.</p>
|
|
3797
|
+
* <p>Container for the parameters to the <code>DeleteDataSource</code> operation.</p>
|
|
3732
3798
|
* @public
|
|
3733
3799
|
*/
|
|
3734
3800
|
export interface DeleteDataSourceRequest {
|
|
@@ -3759,10 +3825,8 @@ export interface DeleteDataSourceResponse {
|
|
|
3759
3825
|
*/
|
|
3760
3826
|
export interface DeleteDirectQueryDataSourceRequest {
|
|
3761
3827
|
/**
|
|
3762
|
-
* <p>
|
|
3763
|
-
*
|
|
3764
|
-
* within your OpenSearch Service environment.
|
|
3765
|
-
* </p>
|
|
3828
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
3829
|
+
* Service environment. </p>
|
|
3766
3830
|
* @public
|
|
3767
3831
|
*/
|
|
3768
3832
|
DataSourceName: string | undefined;
|
|
@@ -3780,7 +3844,8 @@ export interface DeleteDomainRequest {
|
|
|
3780
3844
|
}
|
|
3781
3845
|
/**
|
|
3782
3846
|
* <p>The results of a <code>DeleteDomain</code> request. Contains the status of the pending
|
|
3783
|
-
*
|
|
3847
|
+
* deletion, or a "domain not found" error if the domain and all of its resources have been
|
|
3848
|
+
* deleted.</p>
|
|
3784
3849
|
* @public
|
|
3785
3850
|
*/
|
|
3786
3851
|
export interface DeleteDomainResponse {
|
|
@@ -3791,7 +3856,8 @@ export interface DeleteDomainResponse {
|
|
|
3791
3856
|
DomainStatus?: DomainStatus | undefined;
|
|
3792
3857
|
}
|
|
3793
3858
|
/**
|
|
3794
|
-
* <p>Container for the parameters to the <code>DeleteInboundConnection</code>
|
|
3859
|
+
* <p>Container for the parameters to the <code>DeleteInboundConnection</code>
|
|
3860
|
+
* operation.</p>
|
|
3795
3861
|
* @public
|
|
3796
3862
|
*/
|
|
3797
3863
|
export interface DeleteInboundConnectionRequest {
|
|
@@ -3802,8 +3868,8 @@ export interface DeleteInboundConnectionRequest {
|
|
|
3802
3868
|
ConnectionId: string | undefined;
|
|
3803
3869
|
}
|
|
3804
3870
|
/**
|
|
3805
|
-
* <p>The results of a <code>DeleteInboundConnection</code> operation. Contains details
|
|
3806
|
-
*
|
|
3871
|
+
* <p>The results of a <code>DeleteInboundConnection</code> operation. Contains details
|
|
3872
|
+
* about the deleted inbound connection.</p>
|
|
3807
3873
|
* @public
|
|
3808
3874
|
*/
|
|
3809
3875
|
export interface DeleteInboundConnectionResponse {
|
|
@@ -3814,7 +3880,8 @@ export interface DeleteInboundConnectionResponse {
|
|
|
3814
3880
|
Connection?: InboundConnection | undefined;
|
|
3815
3881
|
}
|
|
3816
3882
|
/**
|
|
3817
|
-
* <p>Container for the parameters to the <code>DeleteOutboundConnection</code>
|
|
3883
|
+
* <p>Container for the parameters to the <code>DeleteOutboundConnection</code>
|
|
3884
|
+
* operation.</p>
|
|
3818
3885
|
* @public
|
|
3819
3886
|
*/
|
|
3820
3887
|
export interface DeleteOutboundConnectionRequest {
|
|
@@ -3878,18 +3945,20 @@ export interface DeleteOutboundConnectionResponse {
|
|
|
3878
3945
|
}
|
|
3879
3946
|
/**
|
|
3880
3947
|
* <p>Deletes a package from OpenSearch Service. The package can't be associated with any
|
|
3881
|
-
*
|
|
3948
|
+
* OpenSearch Service domain.</p>
|
|
3882
3949
|
* @public
|
|
3883
3950
|
*/
|
|
3884
3951
|
export interface DeletePackageRequest {
|
|
3885
3952
|
/**
|
|
3886
|
-
* <p>The internal ID of the package you want to delete. Use <code>DescribePackages</code>
|
|
3953
|
+
* <p>The internal ID of the package you want to delete. Use <code>DescribePackages</code>
|
|
3954
|
+
* to find this value.</p>
|
|
3887
3955
|
* @public
|
|
3888
3956
|
*/
|
|
3889
3957
|
PackageID: string | undefined;
|
|
3890
3958
|
}
|
|
3891
3959
|
/**
|
|
3892
|
-
* <p>Container for the response parameters to the <code>DeletePackage</code>
|
|
3960
|
+
* <p>Container for the response parameters to the <code>DeletePackage</code>
|
|
3961
|
+
* operation.</p>
|
|
3893
3962
|
* @public
|
|
3894
3963
|
*/
|
|
3895
3964
|
export interface DeletePackageResponse {
|
|
@@ -3940,8 +4009,8 @@ export interface VpcEndpointSummary {
|
|
|
3940
4009
|
*/
|
|
3941
4010
|
export interface DeleteVpcEndpointResponse {
|
|
3942
4011
|
/**
|
|
3943
|
-
* <p>Information about the deleted endpoint, including its current status
|
|
3944
|
-
*
|
|
4012
|
+
* <p>Information about the deleted endpoint, including its current status
|
|
4013
|
+
* (<code>DELETING</code> or <code>DELETE_FAILED</code>).</p>
|
|
3945
4014
|
* @public
|
|
3946
4015
|
*/
|
|
3947
4016
|
VpcEndpointSummary: VpcEndpointSummary | undefined;
|
|
@@ -3969,7 +4038,8 @@ export interface DescribeDomainResponse {
|
|
|
3969
4038
|
DomainStatus: DomainStatus | undefined;
|
|
3970
4039
|
}
|
|
3971
4040
|
/**
|
|
3972
|
-
* <p>Container for the parameters to the <code>DescribeDomainAutoTunes</code>
|
|
4041
|
+
* <p>Container for the parameters to the <code>DescribeDomainAutoTunes</code>
|
|
4042
|
+
* operation.</p>
|
|
3973
4043
|
* @public
|
|
3974
4044
|
*/
|
|
3975
4045
|
export interface DescribeDomainAutoTunesRequest {
|
|
@@ -3979,15 +4049,16 @@ export interface DescribeDomainAutoTunesRequest {
|
|
|
3979
4049
|
*/
|
|
3980
4050
|
DomainName: string | undefined;
|
|
3981
4051
|
/**
|
|
3982
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
3983
|
-
*
|
|
4052
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
4053
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
3984
4054
|
* @public
|
|
3985
4055
|
*/
|
|
3986
4056
|
MaxResults?: number | undefined;
|
|
3987
4057
|
/**
|
|
3988
4058
|
* <p>If your initial <code>DescribeDomainAutoTunes</code> operation returns a
|
|
3989
|
-
*
|
|
3990
|
-
*
|
|
4059
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
4060
|
+
* subsequent <code>DescribeDomainAutoTunes</code> operations, which returns results in the
|
|
4061
|
+
* next page.</p>
|
|
3991
4062
|
* @public
|
|
3992
4063
|
*/
|
|
3993
4064
|
NextToken?: string | undefined;
|
|
@@ -4018,8 +4089,7 @@ export declare const ScheduledAutoTuneSeverityType: {
|
|
|
4018
4089
|
*/
|
|
4019
4090
|
export type ScheduledAutoTuneSeverityType = (typeof ScheduledAutoTuneSeverityType)[keyof typeof ScheduledAutoTuneSeverityType];
|
|
4020
4091
|
/**
|
|
4021
|
-
* <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
|
|
4022
|
-
* Amazon OpenSearch Service</a>.</p>
|
|
4092
|
+
* <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 Amazon OpenSearch Service</a>.</p>
|
|
4023
4093
|
* @public
|
|
4024
4094
|
*/
|
|
4025
4095
|
export interface ScheduledAutoTuneDetails {
|
|
@@ -4040,14 +4110,13 @@ export interface ScheduledAutoTuneDetails {
|
|
|
4040
4110
|
Action?: string | undefined;
|
|
4041
4111
|
/**
|
|
4042
4112
|
* <p>The severity of the Auto-Tune action. Valid values are <code>LOW</code>,
|
|
4043
|
-
*
|
|
4113
|
+
* <code>MEDIUM</code>, and <code>HIGH</code>.</p>
|
|
4044
4114
|
* @public
|
|
4045
4115
|
*/
|
|
4046
4116
|
Severity?: ScheduledAutoTuneSeverityType | undefined;
|
|
4047
4117
|
}
|
|
4048
4118
|
/**
|
|
4049
|
-
* <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
|
|
4050
|
-
* Amazon OpenSearch Service</a>.</p>
|
|
4119
|
+
* <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 Amazon OpenSearch Service</a>.</p>
|
|
4051
4120
|
* @public
|
|
4052
4121
|
*/
|
|
4053
4122
|
export interface AutoTuneDetails {
|
|
@@ -4069,8 +4138,7 @@ export declare const AutoTuneType: {
|
|
|
4069
4138
|
*/
|
|
4070
4139
|
export type AutoTuneType = (typeof AutoTuneType)[keyof typeof AutoTuneType];
|
|
4071
4140
|
/**
|
|
4072
|
-
* <p>Information about an Auto-Tune action. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch
|
|
4073
|
-
* Service</a>.</p>
|
|
4141
|
+
* <p>Information about an Auto-Tune action. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch Service</a>.</p>
|
|
4074
4142
|
* @public
|
|
4075
4143
|
*/
|
|
4076
4144
|
export interface AutoTune {
|
|
@@ -4096,16 +4164,16 @@ export interface DescribeDomainAutoTunesResponse {
|
|
|
4096
4164
|
*/
|
|
4097
4165
|
AutoTunes?: AutoTune[] | undefined;
|
|
4098
4166
|
/**
|
|
4099
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
4100
|
-
*
|
|
4101
|
-
*
|
|
4167
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
4168
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
4169
|
+
* again using the returned token to retrieve the next page.</p>
|
|
4102
4170
|
* @public
|
|
4103
4171
|
*/
|
|
4104
4172
|
NextToken?: string | undefined;
|
|
4105
4173
|
}
|
|
4106
4174
|
/**
|
|
4107
4175
|
* <p>Container for the parameters to the <code>DescribeDomainChangeProgress</code>
|
|
4108
|
-
*
|
|
4176
|
+
* operation.</p>
|
|
4109
4177
|
* @public
|
|
4110
4178
|
*/
|
|
4111
4179
|
export interface DescribeDomainChangeProgressRequest {
|
|
@@ -4116,7 +4184,7 @@ export interface DescribeDomainChangeProgressRequest {
|
|
|
4116
4184
|
DomainName: string | undefined;
|
|
4117
4185
|
/**
|
|
4118
4186
|
* <p>The specific change ID for which you want to get progress information. If omitted, the
|
|
4119
|
-
*
|
|
4187
|
+
* request returns information about the most recent configuration change.</p>
|
|
4120
4188
|
* @public
|
|
4121
4189
|
*/
|
|
4122
4190
|
ChangeId?: string | undefined;
|
|
@@ -4167,7 +4235,8 @@ export type OverallChangeStatus = (typeof OverallChangeStatus)[keyof typeof Over
|
|
|
4167
4235
|
*/
|
|
4168
4236
|
export interface ChangeProgressStatusDetails {
|
|
4169
4237
|
/**
|
|
4170
|
-
* <p>The unique change identifier associated with a specific domain configuration
|
|
4238
|
+
* <p>The unique change identifier associated with a specific domain configuration
|
|
4239
|
+
* change.</p>
|
|
4171
4240
|
* @public
|
|
4172
4241
|
*/
|
|
4173
4242
|
ChangeId?: string | undefined;
|
|
@@ -4182,7 +4251,8 @@ export interface ChangeProgressStatusDetails {
|
|
|
4182
4251
|
*/
|
|
4183
4252
|
Status?: OverallChangeStatus | undefined;
|
|
4184
4253
|
/**
|
|
4185
|
-
* <p>The list of properties in the domain configuration change that are still
|
|
4254
|
+
* <p>The list of properties in the domain configuration change that are still
|
|
4255
|
+
* pending.</p>
|
|
4186
4256
|
* @public
|
|
4187
4257
|
*/
|
|
4188
4258
|
PendingProperties?: string[] | undefined;
|
|
@@ -4197,7 +4267,8 @@ export interface ChangeProgressStatusDetails {
|
|
|
4197
4267
|
*/
|
|
4198
4268
|
TotalNumberOfStages?: number | undefined;
|
|
4199
4269
|
/**
|
|
4200
|
-
* <p>The specific stages that the domain is going through to perform the configuration
|
|
4270
|
+
* <p>The specific stages that the domain is going through to perform the configuration
|
|
4271
|
+
* change.</p>
|
|
4201
4272
|
* @public
|
|
4202
4273
|
*/
|
|
4203
4274
|
ChangeProgressStages?: ChangeProgressStage[] | undefined;
|
|
@@ -4219,18 +4290,20 @@ export interface ChangeProgressStatusDetails {
|
|
|
4219
4290
|
}
|
|
4220
4291
|
/**
|
|
4221
4292
|
* <p>The result of a <code>DescribeDomainChangeProgress</code> request. Contains progress
|
|
4222
|
-
*
|
|
4293
|
+
* information for the requested domain change.</p>
|
|
4223
4294
|
* @public
|
|
4224
4295
|
*/
|
|
4225
4296
|
export interface DescribeDomainChangeProgressResponse {
|
|
4226
4297
|
/**
|
|
4227
|
-
* <p>Container for information about the stages of a configuration change happening on a
|
|
4298
|
+
* <p>Container for information about the stages of a configuration change happening on a
|
|
4299
|
+
* domain.</p>
|
|
4228
4300
|
* @public
|
|
4229
4301
|
*/
|
|
4230
4302
|
ChangeProgressStatus?: ChangeProgressStatusDetails | undefined;
|
|
4231
4303
|
}
|
|
4232
4304
|
/**
|
|
4233
|
-
* <p>Container for the parameters to the <code>DescribeDomainConfig</code>
|
|
4305
|
+
* <p>Container for the parameters to the <code>DescribeDomainConfig</code>
|
|
4306
|
+
* operation.</p>
|
|
4234
4307
|
* @public
|
|
4235
4308
|
*/
|
|
4236
4309
|
export interface DescribeDomainConfigRequest {
|
|
@@ -4253,8 +4326,7 @@ export declare const RollbackOnDisable: {
|
|
|
4253
4326
|
*/
|
|
4254
4327
|
export type RollbackOnDisable = (typeof RollbackOnDisable)[keyof typeof RollbackOnDisable];
|
|
4255
4328
|
/**
|
|
4256
|
-
* <p>Auto-Tune settings when updating a domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for
|
|
4257
|
-
* Amazon OpenSearch Service</a>.</p>
|
|
4329
|
+
* <p>Auto-Tune settings when updating a domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html">Auto-Tune for Amazon OpenSearch Service</a>.</p>
|
|
4258
4330
|
* @public
|
|
4259
4331
|
*/
|
|
4260
4332
|
export interface AutoTuneOptions {
|
|
@@ -4264,30 +4336,31 @@ export interface AutoTuneOptions {
|
|
|
4264
4336
|
*/
|
|
4265
4337
|
DesiredState?: AutoTuneDesiredState | undefined;
|
|
4266
4338
|
/**
|
|
4267
|
-
* <p>When disabling Auto-Tune, specify <code>NO_ROLLBACK</code> to retain all prior
|
|
4268
|
-
*
|
|
4269
|
-
*
|
|
4270
|
-
*
|
|
4339
|
+
* <p>When disabling Auto-Tune, specify <code>NO_ROLLBACK</code> to retain all prior
|
|
4340
|
+
* Auto-Tune settings or <code>DEFAULT_ROLLBACK</code> to revert to the OpenSearch Service
|
|
4341
|
+
* defaults. If you specify <code>DEFAULT_ROLLBACK</code>, you must include a
|
|
4342
|
+
* <code>MaintenanceSchedule</code> in the request. Otherwise, OpenSearch Service is
|
|
4343
|
+
* unable to perform the rollback.</p>
|
|
4271
4344
|
* @public
|
|
4272
4345
|
*/
|
|
4273
4346
|
RollbackOnDisable?: RollbackOnDisable | undefined;
|
|
4274
4347
|
/**
|
|
4275
4348
|
* <p>DEPRECATED. Use <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak window</a>
|
|
4276
|
-
*
|
|
4349
|
+
* instead.</p>
|
|
4277
4350
|
* <p>A list of maintenance schedules during which Auto-Tune can deploy changes.</p>
|
|
4278
4351
|
* @public
|
|
4279
4352
|
*/
|
|
4280
4353
|
MaintenanceSchedules?: AutoTuneMaintenanceSchedule[] | undefined;
|
|
4281
4354
|
/**
|
|
4282
|
-
* <p>Whether to use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
4283
|
-
*
|
|
4355
|
+
* <p>Whether to use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
4356
|
+
* window</a> to deploy configuration changes on the domain rather than a
|
|
4357
|
+
* maintenance schedule.</p>
|
|
4284
4358
|
* @public
|
|
4285
4359
|
*/
|
|
4286
4360
|
UseOffPeakWindow?: boolean | undefined;
|
|
4287
4361
|
}
|
|
4288
4362
|
/**
|
|
4289
|
-
* <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
|
|
4290
|
-
* Amazon OpenSearch Service</a>.</p>
|
|
4363
|
+
* <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 Amazon OpenSearch Service</a>.</p>
|
|
4291
4364
|
* @public
|
|
4292
4365
|
*/
|
|
4293
4366
|
export interface AutoTuneStatus {
|
|
@@ -4403,7 +4476,8 @@ export interface EBSOptionsStatus {
|
|
|
4403
4476
|
Status: OptionStatus | undefined;
|
|
4404
4477
|
}
|
|
4405
4478
|
/**
|
|
4406
|
-
* <p>Status of the encryption at rest options for the specified OpenSearch Service
|
|
4479
|
+
* <p>Status of the encryption at rest options for the specified OpenSearch Service
|
|
4480
|
+
* domain.</p>
|
|
4407
4481
|
* @public
|
|
4408
4482
|
*/
|
|
4409
4483
|
export interface EncryptionAtRestOptionsStatus {
|
|
@@ -4419,8 +4493,8 @@ export interface EncryptionAtRestOptionsStatus {
|
|
|
4419
4493
|
Status: OptionStatus | undefined;
|
|
4420
4494
|
}
|
|
4421
4495
|
/**
|
|
4422
|
-
* <p>The status of the the OpenSearch or Elasticsearch version options for the specified
|
|
4423
|
-
*
|
|
4496
|
+
* <p>The status of the the OpenSearch or Elasticsearch version options for the specified
|
|
4497
|
+
* Amazon OpenSearch Service domain.</p>
|
|
4424
4498
|
* @public
|
|
4425
4499
|
*/
|
|
4426
4500
|
export interface VersionStatus {
|
|
@@ -4500,8 +4574,8 @@ export interface NodeToNodeEncryptionOptionsStatus {
|
|
|
4500
4574
|
Status: OptionStatus | undefined;
|
|
4501
4575
|
}
|
|
4502
4576
|
/**
|
|
4503
|
-
* <p>The status of <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
4504
|
-
*
|
|
4577
|
+
* <p>The status of <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak
|
|
4578
|
+
* window</a> options for a domain.</p>
|
|
4505
4579
|
* @public
|
|
4506
4580
|
*/
|
|
4507
4581
|
export interface OffPeakWindowOptionsStatus {
|
|
@@ -4518,7 +4592,7 @@ export interface OffPeakWindowOptionsStatus {
|
|
|
4518
4592
|
}
|
|
4519
4593
|
/**
|
|
4520
4594
|
* <p>Container for information about a daily automated snapshot for an OpenSearch Service
|
|
4521
|
-
*
|
|
4595
|
+
* domain.</p>
|
|
4522
4596
|
* @public
|
|
4523
4597
|
*/
|
|
4524
4598
|
export interface SnapshotOptionsStatus {
|
|
@@ -4544,7 +4618,8 @@ export interface SoftwareUpdateOptionsStatus {
|
|
|
4544
4618
|
*/
|
|
4545
4619
|
Options?: SoftwareUpdateOptions | undefined;
|
|
4546
4620
|
/**
|
|
4547
|
-
* <p>The status of service software update options, including creation date and last
|
|
4621
|
+
* <p>The status of service software update options, including creation date and last
|
|
4622
|
+
* updated date.</p>
|
|
4548
4623
|
* @public
|
|
4549
4624
|
*/
|
|
4550
4625
|
Status?: OptionStatus | undefined;
|
|
@@ -4591,21 +4666,22 @@ export interface DomainConfig {
|
|
|
4591
4666
|
*/
|
|
4592
4667
|
AccessPolicies?: AccessPoliciesStatus | undefined;
|
|
4593
4668
|
/**
|
|
4594
|
-
* <p>Choose either dual stack or IPv4 as your IP address type.
|
|
4595
|
-
*
|
|
4596
|
-
*
|
|
4669
|
+
* <p>Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to
|
|
4670
|
+
* share domain resources across IPv4 and IPv6 address types, and is the recommended
|
|
4671
|
+
* option. If you set your IP address type to dual stack, you can't change your address
|
|
4672
|
+
* type later.</p>
|
|
4597
4673
|
* @public
|
|
4598
4674
|
*/
|
|
4599
4675
|
IPAddressType?: IPAddressTypeStatus | undefined;
|
|
4600
4676
|
/**
|
|
4601
|
-
* <p>DEPRECATED. Container for parameters required to configure automated snapshots of
|
|
4602
|
-
*
|
|
4677
|
+
* <p>DEPRECATED. Container for parameters required to configure automated snapshots of
|
|
4678
|
+
* domain indexes.</p>
|
|
4603
4679
|
* @public
|
|
4604
4680
|
*/
|
|
4605
4681
|
SnapshotOptions?: SnapshotOptionsStatus | undefined;
|
|
4606
4682
|
/**
|
|
4607
4683
|
* <p>The current VPC options for the domain and the status of any updates to their
|
|
4608
|
-
*
|
|
4684
|
+
* configuration.</p>
|
|
4609
4685
|
* @public
|
|
4610
4686
|
*/
|
|
4611
4687
|
VPCOptions?: VPCDerivedInfoStatus | undefined;
|
|
@@ -4625,7 +4701,8 @@ export interface DomainConfig {
|
|
|
4625
4701
|
*/
|
|
4626
4702
|
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus | undefined;
|
|
4627
4703
|
/**
|
|
4628
|
-
* <p>Key-value pairs to specify advanced configuration options. For more information, see
|
|
4704
|
+
* <p>Key-value pairs to specify advanced configuration options. For more information, see
|
|
4705
|
+
* <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options">Advanced options</a>.</p>
|
|
4629
4706
|
* @public
|
|
4630
4707
|
*/
|
|
4631
4708
|
AdvancedOptions?: AdvancedOptionsStatus | undefined;
|
|
@@ -4636,7 +4713,7 @@ export interface DomainConfig {
|
|
|
4636
4713
|
LogPublishingOptions?: LogPublishingOptionsStatus | undefined;
|
|
4637
4714
|
/**
|
|
4638
4715
|
* <p>Additional options for the domain endpoint, such as whether to require HTTPS for all
|
|
4639
|
-
*
|
|
4716
|
+
* traffic.</p>
|
|
4640
4717
|
* @public
|
|
4641
4718
|
*/
|
|
4642
4719
|
DomainEndpointOptions?: DomainEndpointOptionsStatus | undefined;
|
|
@@ -4646,7 +4723,8 @@ export interface DomainConfig {
|
|
|
4646
4723
|
*/
|
|
4647
4724
|
AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus | undefined;
|
|
4648
4725
|
/**
|
|
4649
|
-
* <p>Configuration options for enabling and managing IAM Identity Center integration within
|
|
4726
|
+
* <p>Configuration options for enabling and managing IAM Identity Center integration within
|
|
4727
|
+
* a domain.</p>
|
|
4650
4728
|
* @public
|
|
4651
4729
|
*/
|
|
4652
4730
|
IdentityCenterOptions?: IdentityCenterOptionsStatus | undefined;
|
|
@@ -4656,7 +4734,8 @@ export interface DomainConfig {
|
|
|
4656
4734
|
*/
|
|
4657
4735
|
AutoTuneOptions?: AutoTuneOptionsStatus | undefined;
|
|
4658
4736
|
/**
|
|
4659
|
-
* <p>Container for information about the progress of an existing configuration
|
|
4737
|
+
* <p>Container for information about the progress of an existing configuration
|
|
4738
|
+
* change.</p>
|
|
4660
4739
|
* @public
|
|
4661
4740
|
*/
|
|
4662
4741
|
ChangeProgressDetails?: ChangeProgressDetails | undefined;
|
|
@@ -4693,7 +4772,8 @@ export interface DescribeDomainConfigResponse {
|
|
|
4693
4772
|
DomainConfig: DomainConfig | undefined;
|
|
4694
4773
|
}
|
|
4695
4774
|
/**
|
|
4696
|
-
* <p>Container for the parameters to the <code>DescribeDomainHealth</code>
|
|
4775
|
+
* <p>Container for the parameters to the <code>DescribeDomainHealth</code>
|
|
4776
|
+
* operation.</p>
|
|
4697
4777
|
* @public
|
|
4698
4778
|
*/
|
|
4699
4779
|
export interface DescribeDomainHealthRequest {
|
|
@@ -4754,7 +4834,8 @@ export interface AvailabilityZoneInfo {
|
|
|
4754
4834
|
*/
|
|
4755
4835
|
AvailabilityZoneName?: string | undefined;
|
|
4756
4836
|
/**
|
|
4757
|
-
* <p>The current state of the Availability Zone. Current options are <code>Active</code>
|
|
4837
|
+
* <p>The current state of the Availability Zone. Current options are <code>Active</code>
|
|
4838
|
+
* and <code>StandBy</code>.</p>
|
|
4758
4839
|
* <ul>
|
|
4759
4840
|
* <li>
|
|
4760
4841
|
* <p>
|
|
@@ -4762,7 +4843,8 @@ export interface AvailabilityZoneInfo {
|
|
|
4762
4843
|
* </li>
|
|
4763
4844
|
* <li>
|
|
4764
4845
|
* <p>
|
|
4765
|
-
* <code>StandBy</code> - Data nodes in the Availability Zone are in a standby
|
|
4846
|
+
* <code>StandBy</code> - Data nodes in the Availability Zone are in a standby
|
|
4847
|
+
* state.</p>
|
|
4766
4848
|
* </li>
|
|
4767
4849
|
* <li>
|
|
4768
4850
|
* <p>
|
|
@@ -4788,7 +4870,8 @@ export interface AvailabilityZoneInfo {
|
|
|
4788
4870
|
*/
|
|
4789
4871
|
TotalShards?: string | undefined;
|
|
4790
4872
|
/**
|
|
4791
|
-
* <p>The total number of primary and replica shards that aren't allocated to any of the
|
|
4873
|
+
* <p>The total number of primary and replica shards that aren't allocated to any of the
|
|
4874
|
+
* nodes in the Availability Zone.</p>
|
|
4792
4875
|
* @public
|
|
4793
4876
|
*/
|
|
4794
4877
|
TotalUnAssignedShards?: string | undefined;
|
|
@@ -4817,7 +4900,8 @@ export declare const MasterNodeStatus: {
|
|
|
4817
4900
|
*/
|
|
4818
4901
|
export type MasterNodeStatus = (typeof MasterNodeStatus)[keyof typeof MasterNodeStatus];
|
|
4819
4902
|
/**
|
|
4820
|
-
* <p>The result of a <code>DescribeDomainHealth</code> request. Contains health information
|
|
4903
|
+
* <p>The result of a <code>DescribeDomainHealth</code> request. Contains health information
|
|
4904
|
+
* for the requested domain.</p>
|
|
4821
4905
|
* @public
|
|
4822
4906
|
*/
|
|
4823
4907
|
export interface DescribeDomainHealthResponse {
|
|
@@ -4830,40 +4914,48 @@ export interface DescribeDomainHealthResponse {
|
|
|
4830
4914
|
* </li>
|
|
4831
4915
|
* <li>
|
|
4832
4916
|
* <p>
|
|
4833
|
-
* <code>Active</code> - Requested changes have been processed and deployed to
|
|
4917
|
+
* <code>Active</code> - Requested changes have been processed and deployed to
|
|
4918
|
+
* the domain.</p>
|
|
4834
4919
|
* </li>
|
|
4835
4920
|
* </ul>
|
|
4836
4921
|
* @public
|
|
4837
4922
|
*/
|
|
4838
4923
|
DomainState?: DomainState | undefined;
|
|
4839
4924
|
/**
|
|
4840
|
-
* <p>The number of Availability Zones configured for the domain. If the service is unable
|
|
4925
|
+
* <p>The number of Availability Zones configured for the domain. If the service is unable
|
|
4926
|
+
* to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4841
4927
|
* @public
|
|
4842
4928
|
*/
|
|
4843
4929
|
AvailabilityZoneCount?: string | undefined;
|
|
4844
4930
|
/**
|
|
4845
|
-
* <p>The number of active Availability Zones configured for the domain. If the service is
|
|
4931
|
+
* <p>The number of active Availability Zones configured for the domain. If the service is
|
|
4932
|
+
* unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4846
4933
|
* @public
|
|
4847
4934
|
*/
|
|
4848
4935
|
ActiveAvailabilityZoneCount?: string | undefined;
|
|
4849
4936
|
/**
|
|
4850
|
-
* <p>The number of standby Availability Zones configured for the domain. If the service is
|
|
4937
|
+
* <p>The number of standby Availability Zones configured for the domain. If the service is
|
|
4938
|
+
* unable to fetch this information, it will return <code>NotAvailable</code>.</p>
|
|
4851
4939
|
* @public
|
|
4852
4940
|
*/
|
|
4853
4941
|
StandByAvailabilityZoneCount?: string | undefined;
|
|
4854
4942
|
/**
|
|
4855
|
-
* <p>The number of data nodes configured for the domain. If the service is unable to fetch
|
|
4943
|
+
* <p>The number of data nodes configured for the domain. If the service is unable to fetch
|
|
4944
|
+
* this information, it will return <code>NotAvailable</code>.</p>
|
|
4856
4945
|
* @public
|
|
4857
4946
|
*/
|
|
4858
4947
|
DataNodeCount?: string | undefined;
|
|
4859
4948
|
/**
|
|
4860
|
-
* <p>A boolean that indicates if dedicated master nodes are activated for the
|
|
4949
|
+
* <p>A boolean that indicates if dedicated master nodes are activated for the
|
|
4950
|
+
* domain.</p>
|
|
4861
4951
|
* @public
|
|
4862
4952
|
*/
|
|
4863
4953
|
DedicatedMaster?: boolean | undefined;
|
|
4864
4954
|
/**
|
|
4865
|
-
* <p>The number of nodes that can be elected as a master node. If dedicated master nodes is
|
|
4866
|
-
*
|
|
4955
|
+
* <p>The number of nodes that can be elected as a master node. If dedicated master nodes is
|
|
4956
|
+
* turned on, this value is the number of dedicated master nodes configured for the domain.
|
|
4957
|
+
* If the service is unable to fetch this information, it will return
|
|
4958
|
+
* <code>NotAvailable</code>.</p>
|
|
4867
4959
|
* @public
|
|
4868
4960
|
*/
|
|
4869
4961
|
MasterEligibleNodeCount?: string | undefined;
|
|
@@ -4877,11 +4969,13 @@ export interface DescribeDomainHealthResponse {
|
|
|
4877
4969
|
* <ul>
|
|
4878
4970
|
* <li>
|
|
4879
4971
|
* <p>
|
|
4880
|
-
* <b>Available</b> - The domain has an elected master
|
|
4972
|
+
* <b>Available</b> - The domain has an elected master
|
|
4973
|
+
* node.</p>
|
|
4881
4974
|
* </li>
|
|
4882
4975
|
* <li>
|
|
4883
4976
|
* <p>
|
|
4884
|
-
* <b>UnAvailable</b> - The master node hasn't yet been
|
|
4977
|
+
* <b>UnAvailable</b> - The master node hasn't yet been
|
|
4978
|
+
* elected, and a quorum to elect a new master node hasn't been reached.</p>
|
|
4885
4979
|
* </li>
|
|
4886
4980
|
* </ul>
|
|
4887
4981
|
* @public
|
|
@@ -4892,15 +4986,18 @@ export interface DescribeDomainHealthResponse {
|
|
|
4892
4986
|
* <ul>
|
|
4893
4987
|
* <li>
|
|
4894
4988
|
* <p>
|
|
4895
|
-
* <code>Red</code> - At least one primary shard is not allocated to any
|
|
4989
|
+
* <code>Red</code> - At least one primary shard is not allocated to any
|
|
4990
|
+
* node.</p>
|
|
4896
4991
|
* </li>
|
|
4897
4992
|
* <li>
|
|
4898
4993
|
* <p>
|
|
4899
|
-
* <code>Yellow</code> - All primary shards are allocated to nodes, but some
|
|
4994
|
+
* <code>Yellow</code> - All primary shards are allocated to nodes, but some
|
|
4995
|
+
* replicas aren’t.</p>
|
|
4900
4996
|
* </li>
|
|
4901
4997
|
* <li>
|
|
4902
4998
|
* <p>
|
|
4903
|
-
* <code>Green</code> - All primary shards and their replicas are allocated to
|
|
4999
|
+
* <code>Green</code> - All primary shards and their replicas are allocated to
|
|
5000
|
+
* nodes.</p>
|
|
4904
5001
|
* </li>
|
|
4905
5002
|
* <li>
|
|
4906
5003
|
* <p>
|
|
@@ -4916,7 +5013,8 @@ export interface DescribeDomainHealthResponse {
|
|
|
4916
5013
|
*/
|
|
4917
5014
|
TotalShards?: string | undefined;
|
|
4918
5015
|
/**
|
|
4919
|
-
* <p>The total number of primary and replica shards not allocated to any of the nodes for
|
|
5016
|
+
* <p>The total number of primary and replica shards not allocated to any of the nodes for
|
|
5017
|
+
* the cluster.</p>
|
|
4920
5018
|
* @public
|
|
4921
5019
|
*/
|
|
4922
5020
|
TotalUnAssignedShards?: string | undefined;
|
|
@@ -4927,8 +5025,7 @@ export interface DescribeDomainHealthResponse {
|
|
|
4927
5025
|
EnvironmentInformation?: EnvironmentInfo[] | undefined;
|
|
4928
5026
|
}
|
|
4929
5027
|
/**
|
|
4930
|
-
* <p>Container for the parameters to the <code>DescribeDomainNodes</code>
|
|
4931
|
-
* operation.</p>
|
|
5028
|
+
* <p>Container for the parameters to the <code>DescribeDomainNodes</code> operation.</p>
|
|
4932
5029
|
* @public
|
|
4933
5030
|
*/
|
|
4934
5031
|
export interface DescribeDomainNodesRequest {
|
|
@@ -5000,8 +5097,8 @@ export interface DomainNodesStatus {
|
|
|
5000
5097
|
*/
|
|
5001
5098
|
StorageType?: string | undefined;
|
|
5002
5099
|
/**
|
|
5003
|
-
* <p>If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only
|
|
5004
|
-
*
|
|
5100
|
+
* <p>If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only
|
|
5101
|
+
* applicable for data nodes. </p>
|
|
5005
5102
|
* @public
|
|
5006
5103
|
*/
|
|
5007
5104
|
StorageVolumeType?: VolumeType | undefined;
|
|
@@ -5012,13 +5109,14 @@ export interface DomainNodesStatus {
|
|
|
5012
5109
|
StorageSize?: string | undefined;
|
|
5013
5110
|
}
|
|
5014
5111
|
/**
|
|
5015
|
-
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about
|
|
5112
|
+
* <p>The result of a <code>DescribeDomainNodes</code> request. Contains information about
|
|
5113
|
+
* the nodes on the requested domain. </p>
|
|
5016
5114
|
* @public
|
|
5017
5115
|
*/
|
|
5018
5116
|
export interface DescribeDomainNodesResponse {
|
|
5019
5117
|
/**
|
|
5020
|
-
* <p>Contains nodes information list <code>DomainNodesStatusList</code> with
|
|
5021
|
-
*
|
|
5118
|
+
* <p>Contains nodes information list <code>DomainNodesStatusList</code> with details about
|
|
5119
|
+
* the all nodes on the requested domain.</p>
|
|
5022
5120
|
* @public
|
|
5023
5121
|
*/
|
|
5024
5122
|
DomainNodesStatusList?: DomainNodesStatus[] | undefined;
|
|
@@ -5029,14 +5127,15 @@ export interface DescribeDomainNodesResponse {
|
|
|
5029
5127
|
*/
|
|
5030
5128
|
export interface DescribeDomainsRequest {
|
|
5031
5129
|
/**
|
|
5032
|
-
* <p>Array of OpenSearch Service domain names that you want information about. You must
|
|
5033
|
-
*
|
|
5130
|
+
* <p>Array of OpenSearch Service domain names that you want information about. You must
|
|
5131
|
+
* specify at least one domain name.</p>
|
|
5034
5132
|
* @public
|
|
5035
5133
|
*/
|
|
5036
5134
|
DomainNames: string[] | undefined;
|
|
5037
5135
|
}
|
|
5038
5136
|
/**
|
|
5039
|
-
* <p>Contains the status of the specified domains or all domains owned by the
|
|
5137
|
+
* <p>Contains the status of the specified domains or all domains owned by the
|
|
5138
|
+
* account.</p>
|
|
5040
5139
|
* @public
|
|
5041
5140
|
*/
|
|
5042
5141
|
export interface DescribeDomainsResponse {
|
|
@@ -5062,14 +5161,14 @@ export interface DescribeDryRunProgressRequest {
|
|
|
5062
5161
|
DryRunId?: string | undefined;
|
|
5063
5162
|
/**
|
|
5064
5163
|
* <p>Whether to include the configuration of the dry run in the response. The configuration
|
|
5065
|
-
*
|
|
5164
|
+
* specifies the updates that you're planning to make on the domain.</p>
|
|
5066
5165
|
* @public
|
|
5067
5166
|
*/
|
|
5068
5167
|
LoadDryRunConfig?: boolean | undefined;
|
|
5069
5168
|
}
|
|
5070
5169
|
/**
|
|
5071
|
-
* <p>A validation failure that occurred as the result of a pre-update validation check
|
|
5072
|
-
*
|
|
5170
|
+
* <p>A validation failure that occurred as the result of a pre-update validation check
|
|
5171
|
+
* (verbose dry run) on a domain.</p>
|
|
5073
5172
|
* @public
|
|
5074
5173
|
*/
|
|
5075
5174
|
export interface ValidationFailure {
|
|
@@ -5122,26 +5221,28 @@ export interface DryRunProgressStatus {
|
|
|
5122
5221
|
export interface DryRunResults {
|
|
5123
5222
|
/**
|
|
5124
5223
|
* <p> Specifies the way in which OpenSearch Service will apply an update. Possible values
|
|
5125
|
-
*
|
|
5224
|
+
* are:</p>
|
|
5126
5225
|
* <ul>
|
|
5127
5226
|
* <li>
|
|
5128
5227
|
* <p>
|
|
5129
5228
|
* <b>Blue/Green</b> - The update requires a blue/green
|
|
5130
|
-
*
|
|
5229
|
+
* deployment.</p>
|
|
5131
5230
|
* </li>
|
|
5132
5231
|
* <li>
|
|
5133
5232
|
* <p>
|
|
5134
|
-
* <b>DynamicUpdate</b> - No blue/green deployment
|
|
5233
|
+
* <b>DynamicUpdate</b> - No blue/green deployment
|
|
5234
|
+
* required</p>
|
|
5135
5235
|
* </li>
|
|
5136
5236
|
* <li>
|
|
5137
5237
|
* <p>
|
|
5138
|
-
* <b>Undetermined</b> - The domain is in the middle of
|
|
5139
|
-
*
|
|
5238
|
+
* <b>Undetermined</b> - The domain is in the middle of
|
|
5239
|
+
* an update and can't predict the deployment type. Try again after the update is
|
|
5240
|
+
* complete.</p>
|
|
5140
5241
|
* </li>
|
|
5141
5242
|
* <li>
|
|
5142
5243
|
* <p>
|
|
5143
|
-
* <b>None</b> - The request doesn't include any
|
|
5144
|
-
*
|
|
5244
|
+
* <b>None</b> - The request doesn't include any
|
|
5245
|
+
* configuration changes.</p>
|
|
5145
5246
|
* </li>
|
|
5146
5247
|
* </ul>
|
|
5147
5248
|
* @public
|
|
@@ -5175,8 +5276,9 @@ export interface DescribeDryRunProgressResponse {
|
|
|
5175
5276
|
}
|
|
5176
5277
|
/**
|
|
5177
5278
|
* <p>A filter used to limit results when describing inbound or outbound cross-cluster
|
|
5178
|
-
*
|
|
5179
|
-
*
|
|
5279
|
+
* connections. You can specify multiple values per filter. A cross-cluster connection must
|
|
5280
|
+
* match at least one of the specified values for it to be returned from an
|
|
5281
|
+
* operation.</p>
|
|
5180
5282
|
* @public
|
|
5181
5283
|
*/
|
|
5182
5284
|
export interface Filter {
|
|
@@ -5192,26 +5294,28 @@ export interface Filter {
|
|
|
5192
5294
|
Values?: string[] | undefined;
|
|
5193
5295
|
}
|
|
5194
5296
|
/**
|
|
5195
|
-
* <p>Container for the parameters to the <code>DescribeInboundConnections</code>
|
|
5297
|
+
* <p>Container for the parameters to the <code>DescribeInboundConnections</code>
|
|
5298
|
+
* operation.</p>
|
|
5196
5299
|
* @public
|
|
5197
5300
|
*/
|
|
5198
5301
|
export interface DescribeInboundConnectionsRequest {
|
|
5199
5302
|
/**
|
|
5200
|
-
* <p> A list of filters used to match properties for inbound cross-cluster
|
|
5303
|
+
* <p> A list of filters used to match properties for inbound cross-cluster
|
|
5304
|
+
* connections.</p>
|
|
5201
5305
|
* @public
|
|
5202
5306
|
*/
|
|
5203
5307
|
Filters?: Filter[] | undefined;
|
|
5204
5308
|
/**
|
|
5205
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5206
|
-
*
|
|
5309
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5310
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
5207
5311
|
* @public
|
|
5208
5312
|
*/
|
|
5209
5313
|
MaxResults?: number | undefined;
|
|
5210
5314
|
/**
|
|
5211
5315
|
* <p>If your initial <code>DescribeInboundConnections</code> operation returns a
|
|
5212
|
-
*
|
|
5213
|
-
*
|
|
5214
|
-
*
|
|
5316
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
5317
|
+
* subsequent <code>DescribeInboundConnections</code> operations, which returns results in
|
|
5318
|
+
* the next page.</p>
|
|
5215
5319
|
* @public
|
|
5216
5320
|
*/
|
|
5217
5321
|
NextToken?: string | undefined;
|
|
@@ -5227,9 +5331,9 @@ export interface DescribeInboundConnectionsResponse {
|
|
|
5227
5331
|
*/
|
|
5228
5332
|
Connections?: InboundConnection[] | undefined;
|
|
5229
5333
|
/**
|
|
5230
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5231
|
-
*
|
|
5232
|
-
*
|
|
5334
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5335
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
5336
|
+
* again using the returned token to retrieve the next page.</p>
|
|
5233
5337
|
* @public
|
|
5234
5338
|
*/
|
|
5235
5339
|
NextToken?: string | undefined;
|
|
@@ -5247,12 +5351,14 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
5247
5351
|
constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
|
|
5248
5352
|
}
|
|
5249
5353
|
/**
|
|
5250
|
-
* <p>Container for the parameters to the <code>DescribeInstanceTypeLimits</code>
|
|
5354
|
+
* <p>Container for the parameters to the <code>DescribeInstanceTypeLimits</code>
|
|
5355
|
+
* operation.</p>
|
|
5251
5356
|
* @public
|
|
5252
5357
|
*/
|
|
5253
5358
|
export interface DescribeInstanceTypeLimitsRequest {
|
|
5254
5359
|
/**
|
|
5255
|
-
* <p>The name of the domain. Only specify if you need the limits for an existing
|
|
5360
|
+
* <p>The name of the domain. Only specify if you need the limits for an existing
|
|
5361
|
+
* domain.</p>
|
|
5256
5362
|
* @public
|
|
5257
5363
|
*/
|
|
5258
5364
|
DomainName?: string | undefined;
|
|
@@ -5262,15 +5368,15 @@ export interface DescribeInstanceTypeLimitsRequest {
|
|
|
5262
5368
|
*/
|
|
5263
5369
|
InstanceType: OpenSearchPartitionInstanceType | undefined;
|
|
5264
5370
|
/**
|
|
5265
|
-
* <p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
|
|
5266
|
-
*
|
|
5371
|
+
* <p>Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or
|
|
5372
|
+
* OpenSearch_X.Y. Defaults to the latest version of OpenSearch.</p>
|
|
5267
5373
|
* @public
|
|
5268
5374
|
*/
|
|
5269
5375
|
EngineVersion: string | undefined;
|
|
5270
5376
|
}
|
|
5271
5377
|
/**
|
|
5272
|
-
* <p>Limits on the number of instances that can be created in OpenSearch Service for a
|
|
5273
|
-
*
|
|
5378
|
+
* <p>Limits on the number of instances that can be created in OpenSearch Service for a
|
|
5379
|
+
* given instance type.</p>
|
|
5274
5380
|
* @public
|
|
5275
5381
|
*/
|
|
5276
5382
|
export interface InstanceCountLimits {
|
|
@@ -5291,49 +5397,54 @@ export interface InstanceCountLimits {
|
|
|
5291
5397
|
*/
|
|
5292
5398
|
export interface InstanceLimits {
|
|
5293
5399
|
/**
|
|
5294
|
-
* <p>Limits on the number of instances that can be created for a given instance
|
|
5400
|
+
* <p>Limits on the number of instances that can be created for a given instance
|
|
5401
|
+
* type.</p>
|
|
5295
5402
|
* @public
|
|
5296
5403
|
*/
|
|
5297
5404
|
InstanceCountLimits?: InstanceCountLimits | undefined;
|
|
5298
5405
|
}
|
|
5299
5406
|
/**
|
|
5300
|
-
* <p>Limits that are applicable for the given Amazon OpenSearch Service storage
|
|
5407
|
+
* <p>Limits that are applicable for the given Amazon OpenSearch Service storage
|
|
5408
|
+
* type.</p>
|
|
5301
5409
|
* @public
|
|
5302
5410
|
*/
|
|
5303
5411
|
export interface StorageTypeLimit {
|
|
5304
5412
|
/**
|
|
5305
5413
|
* <p> Name of storage limits that are applicable for the given storage type. If
|
|
5306
|
-
*
|
|
5414
|
+
* <code>StorageType</code> is <code>ebs</code>, the following options are
|
|
5415
|
+
* available:</p>
|
|
5307
5416
|
* <ul>
|
|
5308
5417
|
* <li>
|
|
5309
5418
|
* <p>
|
|
5310
|
-
* <b>MinimumVolumeSize</b> - Minimum volume size that
|
|
5311
|
-
*
|
|
5419
|
+
* <b>MinimumVolumeSize</b> - Minimum volume size that
|
|
5420
|
+
* is available for the given storage type. Can be empty if not applicable.</p>
|
|
5312
5421
|
* </li>
|
|
5313
5422
|
* <li>
|
|
5314
5423
|
* <p>
|
|
5315
|
-
* <b>MaximumVolumeSize</b> - Maximum volume size that
|
|
5316
|
-
*
|
|
5424
|
+
* <b>MaximumVolumeSize</b> - Maximum volume size that
|
|
5425
|
+
* is available for the given storage type. Can be empty if not applicable.</p>
|
|
5317
5426
|
* </li>
|
|
5318
5427
|
* <li>
|
|
5319
5428
|
* <p>
|
|
5320
|
-
* <b>MaximumIops</b> - Maximum amount of IOPS that is
|
|
5321
|
-
*
|
|
5429
|
+
* <b>MaximumIops</b> - Maximum amount of IOPS that is
|
|
5430
|
+
* available for the given the storage type. Can be empty if not applicable.</p>
|
|
5322
5431
|
* </li>
|
|
5323
5432
|
* <li>
|
|
5324
5433
|
* <p>
|
|
5325
|
-
* <b>MinimumIops</b> - Minimum amount of IOPS that is
|
|
5326
|
-
*
|
|
5434
|
+
* <b>MinimumIops</b> - Minimum amount of IOPS that is
|
|
5435
|
+
* available for the given the storage type. Can be empty if not applicable.</p>
|
|
5327
5436
|
* </li>
|
|
5328
5437
|
* <li>
|
|
5329
5438
|
* <p>
|
|
5330
|
-
* <b>MaximumThroughput</b> - Maximum amount of
|
|
5331
|
-
*
|
|
5439
|
+
* <b>MaximumThroughput</b> - Maximum amount of
|
|
5440
|
+
* throughput that is available for the given the storage type. Can be empty if not
|
|
5441
|
+
* applicable.</p>
|
|
5332
5442
|
* </li>
|
|
5333
5443
|
* <li>
|
|
5334
5444
|
* <p>
|
|
5335
|
-
* <b>MinimumThroughput</b> - Minimum amount of
|
|
5336
|
-
*
|
|
5445
|
+
* <b>MinimumThroughput</b> - Minimum amount of
|
|
5446
|
+
* throughput that is available for the given the storage type. Can be empty if not
|
|
5447
|
+
* applicable.</p>
|
|
5337
5448
|
* </li>
|
|
5338
5449
|
* </ul>
|
|
5339
5450
|
* @public
|
|
@@ -5346,8 +5457,8 @@ export interface StorageTypeLimit {
|
|
|
5346
5457
|
LimitValues?: string[] | undefined;
|
|
5347
5458
|
}
|
|
5348
5459
|
/**
|
|
5349
|
-
* <p>A list of storage types for an Amazon OpenSearch Service domain that are available for
|
|
5350
|
-
*
|
|
5460
|
+
* <p>A list of storage types for an Amazon OpenSearch Service domain that are available for
|
|
5461
|
+
* a given intance type.</p>
|
|
5351
5462
|
* @public
|
|
5352
5463
|
*/
|
|
5353
5464
|
export interface StorageType {
|
|
@@ -5384,26 +5495,27 @@ export interface Limits {
|
|
|
5384
5495
|
InstanceLimits?: InstanceLimits | undefined;
|
|
5385
5496
|
/**
|
|
5386
5497
|
* <p>List of additional limits that are specific to a given instance type for each of its
|
|
5387
|
-
*
|
|
5498
|
+
* instance roles.</p>
|
|
5388
5499
|
* @public
|
|
5389
5500
|
*/
|
|
5390
5501
|
AdditionalLimits?: AdditionalLimit[] | undefined;
|
|
5391
5502
|
}
|
|
5392
5503
|
/**
|
|
5393
5504
|
* <p>Container for the parameters received from the <code>DescribeInstanceTypeLimits</code>
|
|
5394
|
-
*
|
|
5505
|
+
* operation.</p>
|
|
5395
5506
|
* @public
|
|
5396
5507
|
*/
|
|
5397
5508
|
export interface DescribeInstanceTypeLimitsResponse {
|
|
5398
5509
|
/**
|
|
5399
5510
|
* <p>Map that contains all applicable instance type limits.<code>data</code> refers to data
|
|
5400
|
-
*
|
|
5511
|
+
* nodes.<code>master</code> refers to dedicated master nodes.</p>
|
|
5401
5512
|
* @public
|
|
5402
5513
|
*/
|
|
5403
5514
|
LimitsByRole?: Record<string, Limits> | undefined;
|
|
5404
5515
|
}
|
|
5405
5516
|
/**
|
|
5406
|
-
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code>
|
|
5517
|
+
* <p>Container for the parameters to the <code>DescribeOutboundConnections</code>
|
|
5518
|
+
* operation.</p>
|
|
5407
5519
|
* @public
|
|
5408
5520
|
*/
|
|
5409
5521
|
export interface DescribeOutboundConnectionsRequest {
|
|
@@ -5413,16 +5525,16 @@ export interface DescribeOutboundConnectionsRequest {
|
|
|
5413
5525
|
*/
|
|
5414
5526
|
Filters?: Filter[] | undefined;
|
|
5415
5527
|
/**
|
|
5416
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5417
|
-
*
|
|
5528
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5529
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
5418
5530
|
* @public
|
|
5419
5531
|
*/
|
|
5420
5532
|
MaxResults?: number | undefined;
|
|
5421
5533
|
/**
|
|
5422
5534
|
* <p>If your initial <code>DescribeOutboundConnections</code> operation returns a
|
|
5423
|
-
*
|
|
5424
|
-
*
|
|
5425
|
-
*
|
|
5535
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
5536
|
+
* subsequent <code>DescribeOutboundConnections</code> operations, which returns results in
|
|
5537
|
+
* the next page.</p>
|
|
5426
5538
|
* @public
|
|
5427
5539
|
*/
|
|
5428
5540
|
NextToken?: string | undefined;
|
|
@@ -5438,9 +5550,9 @@ export interface DescribeOutboundConnectionsResponse {
|
|
|
5438
5550
|
*/
|
|
5439
5551
|
Connections?: OutboundConnection[] | undefined;
|
|
5440
5552
|
/**
|
|
5441
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5442
|
-
*
|
|
5443
|
-
*
|
|
5553
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5554
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
5555
|
+
* again using the returned token to retrieve the next page.</p>
|
|
5444
5556
|
* @public
|
|
5445
5557
|
*/
|
|
5446
5558
|
NextToken?: string | undefined;
|
|
@@ -5478,31 +5590,35 @@ export interface DescribePackagesFilter {
|
|
|
5478
5590
|
Value?: string[] | undefined;
|
|
5479
5591
|
}
|
|
5480
5592
|
/**
|
|
5481
|
-
* <p>Container for the request parameters to the <code>DescribePackage</code>
|
|
5593
|
+
* <p>Container for the request parameters to the <code>DescribePackage</code>
|
|
5594
|
+
* operation.</p>
|
|
5482
5595
|
* @public
|
|
5483
5596
|
*/
|
|
5484
5597
|
export interface DescribePackagesRequest {
|
|
5485
5598
|
/**
|
|
5486
|
-
* <p>Only returns packages that match the <code>DescribePackagesFilterList</code>
|
|
5599
|
+
* <p>Only returns packages that match the <code>DescribePackagesFilterList</code>
|
|
5600
|
+
* values.</p>
|
|
5487
5601
|
* @public
|
|
5488
5602
|
*/
|
|
5489
5603
|
Filters?: DescribePackagesFilter[] | undefined;
|
|
5490
5604
|
/**
|
|
5491
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5492
|
-
*
|
|
5605
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5606
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
5493
5607
|
* @public
|
|
5494
5608
|
*/
|
|
5495
5609
|
MaxResults?: number | undefined;
|
|
5496
5610
|
/**
|
|
5497
5611
|
* <p>If your initial <code>DescribePackageFilters</code> operation returns a
|
|
5498
|
-
*
|
|
5499
|
-
*
|
|
5612
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
5613
|
+
* subsequent <code>DescribePackageFilters</code> operations, which returns results in the
|
|
5614
|
+
* next page.</p>
|
|
5500
5615
|
* @public
|
|
5501
5616
|
*/
|
|
5502
5617
|
NextToken?: string | undefined;
|
|
5503
5618
|
}
|
|
5504
5619
|
/**
|
|
5505
|
-
* <p>Container for the response returned by the <code>DescribePackages</code>
|
|
5620
|
+
* <p>Container for the response returned by the <code>DescribePackages</code>
|
|
5621
|
+
* operation.</p>
|
|
5506
5622
|
* @public
|
|
5507
5623
|
*/
|
|
5508
5624
|
export interface DescribePackagesResponse {
|
|
@@ -5512,36 +5628,36 @@ export interface DescribePackagesResponse {
|
|
|
5512
5628
|
*/
|
|
5513
5629
|
PackageDetailsList?: PackageDetails[] | undefined;
|
|
5514
5630
|
/**
|
|
5515
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5516
|
-
*
|
|
5517
|
-
*
|
|
5631
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5632
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
5633
|
+
* again using the returned token to retrieve the next page.</p>
|
|
5518
5634
|
* @public
|
|
5519
5635
|
*/
|
|
5520
5636
|
NextToken?: string | undefined;
|
|
5521
5637
|
}
|
|
5522
5638
|
/**
|
|
5523
|
-
* <p>Container for the request parameters to a
|
|
5524
|
-
*
|
|
5639
|
+
* <p>Container for the request parameters to a
|
|
5640
|
+
* <code>DescribeReservedInstanceOfferings</code> operation.</p>
|
|
5525
5641
|
* @public
|
|
5526
5642
|
*/
|
|
5527
5643
|
export interface DescribeReservedInstanceOfferingsRequest {
|
|
5528
5644
|
/**
|
|
5529
|
-
* <p>The Reserved Instance identifier filter value. Use this parameter to show only the
|
|
5530
|
-
*
|
|
5645
|
+
* <p>The Reserved Instance identifier filter value. Use this parameter to show only the
|
|
5646
|
+
* available instance types that match the specified reservation identifier.</p>
|
|
5531
5647
|
* @public
|
|
5532
5648
|
*/
|
|
5533
5649
|
ReservedInstanceOfferingId?: string | undefined;
|
|
5534
5650
|
/**
|
|
5535
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5536
|
-
*
|
|
5651
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5652
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
5537
5653
|
* @public
|
|
5538
5654
|
*/
|
|
5539
5655
|
MaxResults?: number | undefined;
|
|
5540
5656
|
/**
|
|
5541
5657
|
* <p>If your initial <code>DescribeReservedInstanceOfferings</code> operation returns a
|
|
5542
|
-
*
|
|
5543
|
-
*
|
|
5544
|
-
*
|
|
5658
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
5659
|
+
* subsequent <code>DescribeReservedInstanceOfferings</code> operations, which returns
|
|
5660
|
+
* results in the next page.</p>
|
|
5545
5661
|
* @public
|
|
5546
5662
|
*/
|
|
5547
5663
|
NextToken?: string | undefined;
|
|
@@ -5560,8 +5676,8 @@ export declare const ReservedInstancePaymentOption: {
|
|
|
5560
5676
|
*/
|
|
5561
5677
|
export type ReservedInstancePaymentOption = (typeof ReservedInstancePaymentOption)[keyof typeof ReservedInstancePaymentOption];
|
|
5562
5678
|
/**
|
|
5563
|
-
* <p>Contains the specific price and frequency of a recurring charges for an OpenSearch
|
|
5564
|
-
*
|
|
5679
|
+
* <p>Contains the specific price and frequency of a recurring charges for an OpenSearch
|
|
5680
|
+
* Reserved Instance, or for a Reserved Instance offering.</p>
|
|
5565
5681
|
* @public
|
|
5566
5682
|
*/
|
|
5567
5683
|
export interface RecurringCharge {
|
|
@@ -5592,18 +5708,20 @@ export interface ReservedInstanceOffering {
|
|
|
5592
5708
|
*/
|
|
5593
5709
|
InstanceType?: OpenSearchPartitionInstanceType | undefined;
|
|
5594
5710
|
/**
|
|
5595
|
-
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch
|
|
5711
|
+
* <p>The duration, in seconds, for which the offering will reserve the OpenSearch
|
|
5712
|
+
* instance.</p>
|
|
5596
5713
|
* @public
|
|
5597
5714
|
*/
|
|
5598
5715
|
Duration?: number | undefined;
|
|
5599
5716
|
/**
|
|
5600
5717
|
* <p>The upfront fixed charge you will pay to purchase the specific Reserved Instance
|
|
5601
|
-
*
|
|
5718
|
+
* offering.</p>
|
|
5602
5719
|
* @public
|
|
5603
5720
|
*/
|
|
5604
5721
|
FixedPrice?: number | undefined;
|
|
5605
5722
|
/**
|
|
5606
|
-
* <p>The hourly rate at which you're charged for the domain using this Reserved
|
|
5723
|
+
* <p>The hourly rate at which you're charged for the domain using this Reserved
|
|
5724
|
+
* Instance.</p>
|
|
5607
5725
|
* @public
|
|
5608
5726
|
*/
|
|
5609
5727
|
UsagePrice?: number | undefined;
|
|
@@ -5618,21 +5736,22 @@ export interface ReservedInstanceOffering {
|
|
|
5618
5736
|
*/
|
|
5619
5737
|
PaymentOption?: ReservedInstancePaymentOption | undefined;
|
|
5620
5738
|
/**
|
|
5621
|
-
* <p>The recurring charge to your account, regardless of whether you creates any domains
|
|
5622
|
-
*
|
|
5739
|
+
* <p>The recurring charge to your account, regardless of whether you creates any domains
|
|
5740
|
+
* using the offering.</p>
|
|
5623
5741
|
* @public
|
|
5624
5742
|
*/
|
|
5625
5743
|
RecurringCharges?: RecurringCharge[] | undefined;
|
|
5626
5744
|
}
|
|
5627
5745
|
/**
|
|
5628
|
-
* <p>Container for results of a <code>DescribeReservedInstanceOfferings</code>
|
|
5746
|
+
* <p>Container for results of a <code>DescribeReservedInstanceOfferings</code>
|
|
5747
|
+
* request.</p>
|
|
5629
5748
|
* @public
|
|
5630
5749
|
*/
|
|
5631
5750
|
export interface DescribeReservedInstanceOfferingsResponse {
|
|
5632
5751
|
/**
|
|
5633
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5634
|
-
*
|
|
5635
|
-
*
|
|
5752
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5753
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
5754
|
+
* again using the returned token to retrieve the next page.</p>
|
|
5636
5755
|
* @public
|
|
5637
5756
|
*/
|
|
5638
5757
|
NextToken?: string | undefined;
|
|
@@ -5644,27 +5763,27 @@ export interface DescribeReservedInstanceOfferingsResponse {
|
|
|
5644
5763
|
}
|
|
5645
5764
|
/**
|
|
5646
5765
|
* <p>Container for the request parameters to the <code>DescribeReservedInstances</code>
|
|
5647
|
-
*
|
|
5766
|
+
* operation.</p>
|
|
5648
5767
|
* @public
|
|
5649
5768
|
*/
|
|
5650
5769
|
export interface DescribeReservedInstancesRequest {
|
|
5651
5770
|
/**
|
|
5652
|
-
* <p>The reserved instance identifier filter value. Use this parameter to show only the
|
|
5653
|
-
*
|
|
5771
|
+
* <p>The reserved instance identifier filter value. Use this parameter to show only the
|
|
5772
|
+
* reservation that matches the specified reserved OpenSearch instance ID.</p>
|
|
5654
5773
|
* @public
|
|
5655
5774
|
*/
|
|
5656
5775
|
ReservedInstanceId?: string | undefined;
|
|
5657
5776
|
/**
|
|
5658
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5659
|
-
*
|
|
5777
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
5778
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
5660
5779
|
* @public
|
|
5661
5780
|
*/
|
|
5662
5781
|
MaxResults?: number | undefined;
|
|
5663
5782
|
/**
|
|
5664
5783
|
* <p>If your initial <code>DescribeReservedInstances</code> operation returns a
|
|
5665
|
-
*
|
|
5666
|
-
*
|
|
5667
|
-
*
|
|
5784
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
5785
|
+
* subsequent <code>DescribeReservedInstances</code> operations, which returns results in
|
|
5786
|
+
* the next page.</p>
|
|
5668
5787
|
* @public
|
|
5669
5788
|
*/
|
|
5670
5789
|
NextToken?: string | undefined;
|
|
@@ -5711,12 +5830,13 @@ export interface ReservedInstance {
|
|
|
5711
5830
|
Duration?: number | undefined;
|
|
5712
5831
|
/**
|
|
5713
5832
|
* <p>The upfront fixed charge you will paid to purchase the specific Reserved Instance
|
|
5714
|
-
*
|
|
5833
|
+
* offering.</p>
|
|
5715
5834
|
* @public
|
|
5716
5835
|
*/
|
|
5717
5836
|
FixedPrice?: number | undefined;
|
|
5718
5837
|
/**
|
|
5719
|
-
* <p>The hourly rate at which you're charged for the domain using this Reserved
|
|
5838
|
+
* <p>The hourly rate at which you're charged for the domain using this Reserved
|
|
5839
|
+
* Instance.</p>
|
|
5720
5840
|
* @public
|
|
5721
5841
|
*/
|
|
5722
5842
|
UsagePrice?: number | undefined;
|
|
@@ -5741,8 +5861,8 @@ export interface ReservedInstance {
|
|
|
5741
5861
|
*/
|
|
5742
5862
|
PaymentOption?: ReservedInstancePaymentOption | undefined;
|
|
5743
5863
|
/**
|
|
5744
|
-
* <p>The recurring charge to your account, regardless of whether you create any domains
|
|
5745
|
-
*
|
|
5864
|
+
* <p>The recurring charge to your account, regardless of whether you create any domains
|
|
5865
|
+
* using the Reserved Instance offering.</p>
|
|
5746
5866
|
* @public
|
|
5747
5867
|
*/
|
|
5748
5868
|
RecurringCharges?: RecurringCharge[] | undefined;
|
|
@@ -5754,9 +5874,9 @@ export interface ReservedInstance {
|
|
|
5754
5874
|
*/
|
|
5755
5875
|
export interface DescribeReservedInstancesResponse {
|
|
5756
5876
|
/**
|
|
5757
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5758
|
-
*
|
|
5759
|
-
*
|
|
5877
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
5878
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
5879
|
+
* again using the returned token to retrieve the next page.</p>
|
|
5760
5880
|
* @public
|
|
5761
5881
|
*/
|
|
5762
5882
|
NextToken?: string | undefined;
|
|
@@ -5790,7 +5910,7 @@ export declare const VpcEndpointErrorCode: {
|
|
|
5790
5910
|
export type VpcEndpointErrorCode = (typeof VpcEndpointErrorCode)[keyof typeof VpcEndpointErrorCode];
|
|
5791
5911
|
/**
|
|
5792
5912
|
* <p>Error information when attempting to describe an Amazon OpenSearch Service-managed VPC
|
|
5793
|
-
*
|
|
5913
|
+
* endpoint.</p>
|
|
5794
5914
|
* @public
|
|
5795
5915
|
*/
|
|
5796
5916
|
export interface VpcEndpointError {
|
|
@@ -5826,13 +5946,14 @@ export interface DescribeVpcEndpointsResponse {
|
|
|
5826
5946
|
VpcEndpointErrors: VpcEndpointError[] | undefined;
|
|
5827
5947
|
}
|
|
5828
5948
|
/**
|
|
5829
|
-
* <p>Container for the request parameters to the <code>DissociatePackage</code>
|
|
5949
|
+
* <p>Container for the request parameters to the <code>DissociatePackage</code>
|
|
5950
|
+
* operation.</p>
|
|
5830
5951
|
* @public
|
|
5831
5952
|
*/
|
|
5832
5953
|
export interface DissociatePackageRequest {
|
|
5833
5954
|
/**
|
|
5834
5955
|
* <p>Internal ID of the package to dissociate from the domain. Use
|
|
5835
|
-
*
|
|
5956
|
+
* <code>ListPackagesForDomain</code> to find this value.</p>
|
|
5836
5957
|
* @public
|
|
5837
5958
|
*/
|
|
5838
5959
|
PackageID: string | undefined;
|
|
@@ -5843,7 +5964,8 @@ export interface DissociatePackageRequest {
|
|
|
5843
5964
|
DomainName: string | undefined;
|
|
5844
5965
|
}
|
|
5845
5966
|
/**
|
|
5846
|
-
* <p>Container for the response returned by an <code>DissociatePackage</code>
|
|
5967
|
+
* <p>Container for the response returned by an <code>DissociatePackage</code>
|
|
5968
|
+
* operation.</p>
|
|
5847
5969
|
* @public
|
|
5848
5970
|
*/
|
|
5849
5971
|
export interface DissociatePackageResponse {
|
|
@@ -5863,8 +5985,8 @@ export interface DissociatePackagesRequest {
|
|
|
5863
5985
|
*/
|
|
5864
5986
|
PackageList: string[] | undefined;
|
|
5865
5987
|
/**
|
|
5866
|
-
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
5867
|
-
*
|
|
5988
|
+
* <p>The name of an OpenSearch Service domain. Domain names are unique across the domains
|
|
5989
|
+
* owned by an account within an Amazon Web Services Region.</p>
|
|
5868
5990
|
* @public
|
|
5869
5991
|
*/
|
|
5870
5992
|
DomainName: string | undefined;
|
|
@@ -5874,7 +5996,8 @@ export interface DissociatePackagesRequest {
|
|
|
5874
5996
|
*/
|
|
5875
5997
|
export interface DissociatePackagesResponse {
|
|
5876
5998
|
/**
|
|
5877
|
-
* <p>A list of package details for the packages that were dissociated from the
|
|
5999
|
+
* <p>A list of package details for the packages that were dissociated from the
|
|
6000
|
+
* domain.</p>
|
|
5878
6001
|
* @public
|
|
5879
6002
|
*/
|
|
5880
6003
|
DomainPackageDetailsList?: DomainPackageDetails[] | undefined;
|
|
@@ -5914,9 +6037,9 @@ export interface GetApplicationResponse {
|
|
|
5914
6037
|
*/
|
|
5915
6038
|
id?: string | undefined;
|
|
5916
6039
|
/**
|
|
5917
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
5918
|
-
*
|
|
5919
|
-
*
|
|
6040
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
6041
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
6042
|
+
* more information. </p>
|
|
5920
6043
|
* @public
|
|
5921
6044
|
*/
|
|
5922
6045
|
arn?: string | undefined;
|
|
@@ -5931,7 +6054,9 @@ export interface GetApplicationResponse {
|
|
|
5931
6054
|
*/
|
|
5932
6055
|
endpoint?: string | undefined;
|
|
5933
6056
|
/**
|
|
5934
|
-
* <p>The current status of the OpenSearch application. Possible values:
|
|
6057
|
+
* <p>The current status of the OpenSearch application. Possible values:
|
|
6058
|
+
* <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>,
|
|
6059
|
+
* <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
5935
6060
|
* @public
|
|
5936
6061
|
*/
|
|
5937
6062
|
status?: ApplicationStatus | undefined;
|
|
@@ -5962,20 +6087,21 @@ export interface GetApplicationResponse {
|
|
|
5962
6087
|
lastUpdatedAt?: Date | undefined;
|
|
5963
6088
|
}
|
|
5964
6089
|
/**
|
|
5965
|
-
* <p>Container for the request parameters to <code>GetCompatibleVersions</code>
|
|
6090
|
+
* <p>Container for the request parameters to <code>GetCompatibleVersions</code>
|
|
6091
|
+
* operation.</p>
|
|
5966
6092
|
* @public
|
|
5967
6093
|
*/
|
|
5968
6094
|
export interface GetCompatibleVersionsRequest {
|
|
5969
6095
|
/**
|
|
5970
|
-
* <p>The name of an existing domain. Provide this parameter to limit the results to a
|
|
5971
|
-
*
|
|
6096
|
+
* <p>The name of an existing domain. Provide this parameter to limit the results to a
|
|
6097
|
+
* single domain.</p>
|
|
5972
6098
|
* @public
|
|
5973
6099
|
*/
|
|
5974
6100
|
DomainName?: string | undefined;
|
|
5975
6101
|
}
|
|
5976
6102
|
/**
|
|
5977
6103
|
* <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
|
|
5978
|
-
*
|
|
6104
|
+
* to.</p>
|
|
5979
6105
|
* @public
|
|
5980
6106
|
*/
|
|
5981
6107
|
export interface CompatibleVersionsMap {
|
|
@@ -5991,20 +6117,20 @@ export interface CompatibleVersionsMap {
|
|
|
5991
6117
|
TargetVersions?: string[] | undefined;
|
|
5992
6118
|
}
|
|
5993
6119
|
/**
|
|
5994
|
-
* <p>Container for the response returned by the <code>GetCompatibleVersions</code>
|
|
6120
|
+
* <p>Container for the response returned by the <code>GetCompatibleVersions</code>
|
|
6121
|
+
* operation.</p>
|
|
5995
6122
|
* @public
|
|
5996
6123
|
*/
|
|
5997
6124
|
export interface GetCompatibleVersionsResponse {
|
|
5998
6125
|
/**
|
|
5999
6126
|
* <p>A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them
|
|
6000
|
-
*
|
|
6127
|
+
* to.</p>
|
|
6001
6128
|
* @public
|
|
6002
6129
|
*/
|
|
6003
6130
|
CompatibleVersions?: CompatibleVersionsMap[] | undefined;
|
|
6004
6131
|
}
|
|
6005
6132
|
/**
|
|
6006
|
-
* <p>Container for the parameters to the <code>GetDataSource</code>
|
|
6007
|
-
* operation.</p>
|
|
6133
|
+
* <p>Container for the parameters to the <code>GetDataSource</code> operation.</p>
|
|
6008
6134
|
* @public
|
|
6009
6135
|
*/
|
|
6010
6136
|
export interface GetDataSourceRequest {
|
|
@@ -6057,15 +6183,30 @@ export interface GetDataSourceResponse {
|
|
|
6057
6183
|
*/
|
|
6058
6184
|
Status?: DataSourceStatus | undefined;
|
|
6059
6185
|
}
|
|
6186
|
+
/**
|
|
6187
|
+
* @public
|
|
6188
|
+
*/
|
|
6189
|
+
export interface GetDefaultApplicationSettingRequest {
|
|
6190
|
+
}
|
|
6191
|
+
/**
|
|
6192
|
+
* @public
|
|
6193
|
+
*/
|
|
6194
|
+
export interface GetDefaultApplicationSettingResponse {
|
|
6195
|
+
/**
|
|
6196
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
6197
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
6198
|
+
* more information. </p>
|
|
6199
|
+
* @public
|
|
6200
|
+
*/
|
|
6201
|
+
applicationArn?: string | undefined;
|
|
6202
|
+
}
|
|
6060
6203
|
/**
|
|
6061
6204
|
* @public
|
|
6062
6205
|
*/
|
|
6063
6206
|
export interface GetDirectQueryDataSourceRequest {
|
|
6064
6207
|
/**
|
|
6065
|
-
* <p>
|
|
6066
|
-
*
|
|
6067
|
-
* your OpenSearch Service environment.
|
|
6068
|
-
* </p>
|
|
6208
|
+
* <p> A unique, user-defined label that identifies the data source within your OpenSearch
|
|
6209
|
+
* Service environment. </p>
|
|
6069
6210
|
* @public
|
|
6070
6211
|
*/
|
|
6071
6212
|
DataSourceName: string | undefined;
|
|
@@ -6075,47 +6216,38 @@ export interface GetDirectQueryDataSourceRequest {
|
|
|
6075
6216
|
*/
|
|
6076
6217
|
export interface GetDirectQueryDataSourceResponse {
|
|
6077
6218
|
/**
|
|
6078
|
-
* <p>
|
|
6079
|
-
*
|
|
6080
|
-
* within your OpenSearch Service environment.
|
|
6081
|
-
* </p>
|
|
6219
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
6220
|
+
* Service environment. </p>
|
|
6082
6221
|
* @public
|
|
6083
6222
|
*/
|
|
6084
6223
|
DataSourceName?: string | undefined;
|
|
6085
6224
|
/**
|
|
6086
|
-
* <p>
|
|
6087
|
-
*
|
|
6088
|
-
* direct queries in OpenSearch Service.
|
|
6089
|
-
* </p>
|
|
6225
|
+
* <p> The supported Amazon Web Services service that is used as the source for direct
|
|
6226
|
+
* queries in OpenSearch Service. </p>
|
|
6090
6227
|
* @public
|
|
6091
6228
|
*/
|
|
6092
6229
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6093
6230
|
/**
|
|
6094
|
-
* <p>
|
|
6095
|
-
*
|
|
6096
|
-
* </p>
|
|
6231
|
+
* <p> A description that provides additional context and details about the data source.
|
|
6232
|
+
* </p>
|
|
6097
6233
|
* @public
|
|
6098
6234
|
*/
|
|
6099
6235
|
Description?: string | undefined;
|
|
6100
6236
|
/**
|
|
6101
|
-
* <p>
|
|
6102
|
-
*
|
|
6103
|
-
* collections that are associated with the direct query data source.
|
|
6104
|
-
* </p>
|
|
6237
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
6238
|
+
* associated with the direct query data source. </p>
|
|
6105
6239
|
* @public
|
|
6106
6240
|
*/
|
|
6107
6241
|
OpenSearchArns?: string[] | undefined;
|
|
6108
6242
|
/**
|
|
6109
|
-
* <p>
|
|
6110
|
-
* The unique, system-generated identifier that represents the data source.
|
|
6111
|
-
* </p>
|
|
6243
|
+
* <p> The unique, system-generated identifier that represents the data source. </p>
|
|
6112
6244
|
* @public
|
|
6113
6245
|
*/
|
|
6114
6246
|
DataSourceArn?: string | undefined;
|
|
6115
6247
|
}
|
|
6116
6248
|
/**
|
|
6117
6249
|
* <p>Container for the parameters to the <code>GetDomainMaintenanceStatus</code>
|
|
6118
|
-
*
|
|
6250
|
+
* operation.</p>
|
|
6119
6251
|
* @public
|
|
6120
6252
|
*/
|
|
6121
6253
|
export interface GetDomainMaintenanceStatusRequest {
|
|
@@ -6159,7 +6291,8 @@ export declare const MaintenanceStatus: {
|
|
|
6159
6291
|
*/
|
|
6160
6292
|
export type MaintenanceStatus = (typeof MaintenanceStatus)[keyof typeof MaintenanceStatus];
|
|
6161
6293
|
/**
|
|
6162
|
-
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about
|
|
6294
|
+
* <p>The result of a <code>GetDomainMaintenanceStatus</code> request that information about
|
|
6295
|
+
* the requested action.</p>
|
|
6163
6296
|
* @public
|
|
6164
6297
|
*/
|
|
6165
6298
|
export interface GetDomainMaintenanceStatusResponse {
|
|
@@ -6195,7 +6328,8 @@ export interface GetDomainMaintenanceStatusResponse {
|
|
|
6195
6328
|
UpdatedAt?: Date | undefined;
|
|
6196
6329
|
}
|
|
6197
6330
|
/**
|
|
6198
|
-
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code>
|
|
6331
|
+
* <p>Container for the request parameters to the <code>GetPackageVersionHistory</code>
|
|
6332
|
+
* operation.</p>
|
|
6199
6333
|
* @public
|
|
6200
6334
|
*/
|
|
6201
6335
|
export interface GetPackageVersionHistoryRequest {
|
|
@@ -6205,16 +6339,16 @@ export interface GetPackageVersionHistoryRequest {
|
|
|
6205
6339
|
*/
|
|
6206
6340
|
PackageID: string | undefined;
|
|
6207
6341
|
/**
|
|
6208
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6209
|
-
*
|
|
6342
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6343
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
6210
6344
|
* @public
|
|
6211
6345
|
*/
|
|
6212
6346
|
MaxResults?: number | undefined;
|
|
6213
6347
|
/**
|
|
6214
6348
|
* <p>If your initial <code>GetPackageVersionHistory</code> operation returns a
|
|
6215
|
-
*
|
|
6216
|
-
*
|
|
6217
|
-
*
|
|
6349
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
6350
|
+
* subsequent <code>GetPackageVersionHistory</code> operations, which returns results in
|
|
6351
|
+
* the next page. </p>
|
|
6218
6352
|
* @public
|
|
6219
6353
|
*/
|
|
6220
6354
|
NextToken?: string | undefined;
|
|
@@ -6240,7 +6374,8 @@ export interface PackageVersionHistory {
|
|
|
6240
6374
|
*/
|
|
6241
6375
|
CreatedAt?: Date | undefined;
|
|
6242
6376
|
/**
|
|
6243
|
-
* <p>Additional information about plugin properties if the package is a
|
|
6377
|
+
* <p>Additional information about plugin properties if the package is a
|
|
6378
|
+
* <code>ZIP-PLUGIN</code> package.</p>
|
|
6244
6379
|
* @public
|
|
6245
6380
|
*/
|
|
6246
6381
|
PluginProperties?: PluginProperties | undefined;
|
|
@@ -6251,7 +6386,8 @@ export interface PackageVersionHistory {
|
|
|
6251
6386
|
PackageConfiguration?: PackageConfiguration | undefined;
|
|
6252
6387
|
}
|
|
6253
6388
|
/**
|
|
6254
|
-
* <p>Container for response returned by <code>GetPackageVersionHistory</code>
|
|
6389
|
+
* <p>Container for response returned by <code>GetPackageVersionHistory</code>
|
|
6390
|
+
* operation.</p>
|
|
6255
6391
|
* @public
|
|
6256
6392
|
*/
|
|
6257
6393
|
export interface GetPackageVersionHistoryResponse {
|
|
@@ -6266,15 +6402,16 @@ export interface GetPackageVersionHistoryResponse {
|
|
|
6266
6402
|
*/
|
|
6267
6403
|
PackageVersionHistoryList?: PackageVersionHistory[] | undefined;
|
|
6268
6404
|
/**
|
|
6269
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6270
|
-
*
|
|
6271
|
-
*
|
|
6405
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6406
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6407
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6272
6408
|
* @public
|
|
6273
6409
|
*/
|
|
6274
6410
|
NextToken?: string | undefined;
|
|
6275
6411
|
}
|
|
6276
6412
|
/**
|
|
6277
|
-
* <p>Container for the request parameters to the <code>GetUpgradeHistory</code>
|
|
6413
|
+
* <p>Container for the request parameters to the <code>GetUpgradeHistory</code>
|
|
6414
|
+
* operation.</p>
|
|
6278
6415
|
* @public
|
|
6279
6416
|
*/
|
|
6280
6417
|
export interface GetUpgradeHistoryRequest {
|
|
@@ -6284,15 +6421,16 @@ export interface GetUpgradeHistoryRequest {
|
|
|
6284
6421
|
*/
|
|
6285
6422
|
DomainName: string | undefined;
|
|
6286
6423
|
/**
|
|
6287
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6288
|
-
*
|
|
6424
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6425
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
6289
6426
|
* @public
|
|
6290
6427
|
*/
|
|
6291
6428
|
MaxResults?: number | undefined;
|
|
6292
6429
|
/**
|
|
6293
|
-
* <p>If your initial <code>GetUpgradeHistory</code> operation returns a
|
|
6294
|
-
*
|
|
6295
|
-
*
|
|
6430
|
+
* <p>If your initial <code>GetUpgradeHistory</code> operation returns a
|
|
6431
|
+
* <code>nextToken</code>, you can include the returned <code>nextToken</code> in
|
|
6432
|
+
* subsequent <code>GetUpgradeHistory</code> operations, which returns results in the next
|
|
6433
|
+
* page.</p>
|
|
6296
6434
|
* @public
|
|
6297
6435
|
*/
|
|
6298
6436
|
NextToken?: string | undefined;
|
|
@@ -6365,19 +6503,21 @@ export interface UpgradeStepItem {
|
|
|
6365
6503
|
*/
|
|
6366
6504
|
UpgradeStepStatus?: UpgradeStatus | undefined;
|
|
6367
6505
|
/**
|
|
6368
|
-
* <p>A list of strings containing detailed information about the errors encountered in a
|
|
6506
|
+
* <p>A list of strings containing detailed information about the errors encountered in a
|
|
6507
|
+
* particular step.</p>
|
|
6369
6508
|
* @public
|
|
6370
6509
|
*/
|
|
6371
6510
|
Issues?: string[] | undefined;
|
|
6372
6511
|
/**
|
|
6373
|
-
* <p>The floating point value representing the progress percentage of a particular
|
|
6512
|
+
* <p>The floating point value representing the progress percentage of a particular
|
|
6513
|
+
* step.</p>
|
|
6374
6514
|
* @public
|
|
6375
6515
|
*/
|
|
6376
6516
|
ProgressPercent?: number | undefined;
|
|
6377
6517
|
}
|
|
6378
6518
|
/**
|
|
6379
|
-
* <p>History of the last 10 upgrades and upgrade eligibility checks for an Amazon
|
|
6380
|
-
*
|
|
6519
|
+
* <p>History of the last 10 upgrades and upgrade eligibility checks for an Amazon
|
|
6520
|
+
* OpenSearch Service domain.</p>
|
|
6381
6521
|
* @public
|
|
6382
6522
|
*/
|
|
6383
6523
|
export interface UpgradeHistory {
|
|
@@ -6388,7 +6528,7 @@ export interface UpgradeHistory {
|
|
|
6388
6528
|
UpgradeName?: string | undefined;
|
|
6389
6529
|
/**
|
|
6390
6530
|
* <p>UTC timestamp at which the upgrade API call was made, in the format
|
|
6391
|
-
*
|
|
6531
|
+
* <code>yyyy-MM-ddTHH:mm:ssZ</code>.</p>
|
|
6392
6532
|
* @public
|
|
6393
6533
|
*/
|
|
6394
6534
|
StartTimestamp?: Date | undefined;
|
|
@@ -6412,32 +6552,35 @@ export interface UpgradeHistory {
|
|
|
6412
6552
|
*/
|
|
6413
6553
|
UpgradeStatus?: UpgradeStatus | undefined;
|
|
6414
6554
|
/**
|
|
6415
|
-
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility
|
|
6555
|
+
* <p>A list of each step performed as part of a specific upgrade or upgrade eligibility
|
|
6556
|
+
* check.</p>
|
|
6416
6557
|
* @public
|
|
6417
6558
|
*/
|
|
6418
6559
|
StepsList?: UpgradeStepItem[] | undefined;
|
|
6419
6560
|
}
|
|
6420
6561
|
/**
|
|
6421
|
-
* <p>Container for the response returned by the <code>GetUpgradeHistory</code>
|
|
6562
|
+
* <p>Container for the response returned by the <code>GetUpgradeHistory</code>
|
|
6563
|
+
* operation.</p>
|
|
6422
6564
|
* @public
|
|
6423
6565
|
*/
|
|
6424
6566
|
export interface GetUpgradeHistoryResponse {
|
|
6425
6567
|
/**
|
|
6426
|
-
* <p>A list of objects corresponding to each upgrade or upgrade eligibility check performed
|
|
6427
|
-
*
|
|
6568
|
+
* <p>A list of objects corresponding to each upgrade or upgrade eligibility check performed
|
|
6569
|
+
* on a domain.</p>
|
|
6428
6570
|
* @public
|
|
6429
6571
|
*/
|
|
6430
6572
|
UpgradeHistories?: UpgradeHistory[] | undefined;
|
|
6431
6573
|
/**
|
|
6432
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6433
|
-
*
|
|
6434
|
-
*
|
|
6574
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6575
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6576
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6435
6577
|
* @public
|
|
6436
6578
|
*/
|
|
6437
6579
|
NextToken?: string | undefined;
|
|
6438
6580
|
}
|
|
6439
6581
|
/**
|
|
6440
|
-
* <p>Container for the request parameters to the <code>GetUpgradeStatus</code>
|
|
6582
|
+
* <p>Container for the request parameters to the <code>GetUpgradeStatus</code>
|
|
6583
|
+
* operation.</p>
|
|
6441
6584
|
* @public
|
|
6442
6585
|
*/
|
|
6443
6586
|
export interface GetUpgradeStatusRequest {
|
|
@@ -6448,7 +6591,8 @@ export interface GetUpgradeStatusRequest {
|
|
|
6448
6591
|
DomainName: string | undefined;
|
|
6449
6592
|
}
|
|
6450
6593
|
/**
|
|
6451
|
-
* <p>Container for the response returned by the <code>GetUpgradeStatus</code>
|
|
6594
|
+
* <p>Container for the response returned by the <code>GetUpgradeStatus</code>
|
|
6595
|
+
* operation.</p>
|
|
6452
6596
|
* @public
|
|
6453
6597
|
*/
|
|
6454
6598
|
export interface GetUpgradeStatusResponse {
|
|
@@ -6473,20 +6617,22 @@ export interface GetUpgradeStatusResponse {
|
|
|
6473
6617
|
*/
|
|
6474
6618
|
export interface ListApplicationsRequest {
|
|
6475
6619
|
/**
|
|
6476
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6477
|
-
*
|
|
6478
|
-
*
|
|
6620
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6621
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6622
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6479
6623
|
* @public
|
|
6480
6624
|
*/
|
|
6481
6625
|
nextToken?: string | undefined;
|
|
6482
6626
|
/**
|
|
6483
|
-
* <p>Filters the list of OpenSearch applications by status. Possible values:
|
|
6627
|
+
* <p>Filters the list of OpenSearch applications by status. Possible values:
|
|
6628
|
+
* <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>,
|
|
6629
|
+
* <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6484
6630
|
* @public
|
|
6485
6631
|
*/
|
|
6486
6632
|
statuses?: ApplicationStatus[] | undefined;
|
|
6487
6633
|
/**
|
|
6488
|
-
* <p>An optional parameter that specifies the maximum number of results to return for a
|
|
6489
|
-
*
|
|
6634
|
+
* <p>An optional parameter that specifies the maximum number of results to return for a
|
|
6635
|
+
* given request.</p>
|
|
6490
6636
|
* @public
|
|
6491
6637
|
*/
|
|
6492
6638
|
maxResults?: number | undefined;
|
|
@@ -6502,9 +6648,9 @@ export interface ApplicationSummary {
|
|
|
6502
6648
|
*/
|
|
6503
6649
|
id?: string | undefined;
|
|
6504
6650
|
/**
|
|
6505
|
-
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities
|
|
6506
|
-
*
|
|
6507
|
-
*
|
|
6651
|
+
* <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in
|
|
6652
|
+
* <i>Using Amazon Web Services Identity and Access Management</i> for
|
|
6653
|
+
* more information. </p>
|
|
6508
6654
|
* @public
|
|
6509
6655
|
*/
|
|
6510
6656
|
arn?: string | undefined;
|
|
@@ -6519,7 +6665,9 @@ export interface ApplicationSummary {
|
|
|
6519
6665
|
*/
|
|
6520
6666
|
endpoint?: string | undefined;
|
|
6521
6667
|
/**
|
|
6522
|
-
* <p>The current status of an OpenSearch application. Possible values:
|
|
6668
|
+
* <p>The current status of an OpenSearch application. Possible values:
|
|
6669
|
+
* <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>,
|
|
6670
|
+
* <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
|
|
6523
6671
|
* @public
|
|
6524
6672
|
*/
|
|
6525
6673
|
status?: ApplicationStatus | undefined;
|
|
@@ -6539,21 +6687,21 @@ export interface ApplicationSummary {
|
|
|
6539
6687
|
*/
|
|
6540
6688
|
export interface ListApplicationsResponse {
|
|
6541
6689
|
/**
|
|
6542
|
-
* <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status,
|
|
6690
|
+
* <p>Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status,
|
|
6691
|
+
* creation time, and last update time.</p>
|
|
6543
6692
|
* @public
|
|
6544
6693
|
*/
|
|
6545
6694
|
ApplicationSummaries?: ApplicationSummary[] | undefined;
|
|
6546
6695
|
/**
|
|
6547
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6548
|
-
*
|
|
6549
|
-
*
|
|
6696
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6697
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6698
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6550
6699
|
* @public
|
|
6551
6700
|
*/
|
|
6552
6701
|
nextToken?: string | undefined;
|
|
6553
6702
|
}
|
|
6554
6703
|
/**
|
|
6555
|
-
* <p>Container for the parameters to the <code>ListDataSources</code>
|
|
6556
|
-
* operation.</p>
|
|
6704
|
+
* <p>Container for the parameters to the <code>ListDataSources</code> operation.</p>
|
|
6557
6705
|
* @public
|
|
6558
6706
|
*/
|
|
6559
6707
|
export interface ListDataSourcesRequest {
|
|
@@ -6605,58 +6753,49 @@ export interface ListDataSourcesResponse {
|
|
|
6605
6753
|
*/
|
|
6606
6754
|
export interface ListDirectQueryDataSourcesRequest {
|
|
6607
6755
|
/**
|
|
6608
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6609
|
-
*
|
|
6610
|
-
*
|
|
6756
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6757
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6758
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6611
6759
|
* @public
|
|
6612
6760
|
*/
|
|
6613
6761
|
NextToken?: string | undefined;
|
|
6614
6762
|
}
|
|
6615
6763
|
/**
|
|
6616
|
-
* <p>
|
|
6617
|
-
* The configuration details for a data source that can be directly queried.
|
|
6618
|
-
* </p>
|
|
6764
|
+
* <p> The configuration details for a data source that can be directly queried. </p>
|
|
6619
6765
|
* @public
|
|
6620
6766
|
*/
|
|
6621
6767
|
export interface DirectQueryDataSource {
|
|
6622
6768
|
/**
|
|
6623
|
-
* <p>
|
|
6624
|
-
*
|
|
6625
|
-
* within your OpenSearch Service environment.
|
|
6626
|
-
* </p>
|
|
6769
|
+
* <p> A unique, user-defined label to identify the data source within your OpenSearch
|
|
6770
|
+
* Service environment. </p>
|
|
6627
6771
|
* @public
|
|
6628
6772
|
*/
|
|
6629
6773
|
DataSourceName?: string | undefined;
|
|
6630
6774
|
/**
|
|
6631
|
-
* <p>
|
|
6632
|
-
*
|
|
6633
|
-
* </p>
|
|
6775
|
+
* <p> The supported Amazon Web Services service that is used as the source for direct
|
|
6776
|
+
* queries in OpenSearch Service. </p>
|
|
6634
6777
|
* @public
|
|
6635
6778
|
*/
|
|
6636
6779
|
DataSourceType?: DirectQueryDataSourceType | undefined;
|
|
6637
6780
|
/**
|
|
6638
|
-
* <p>
|
|
6639
|
-
*
|
|
6781
|
+
* <p> A description that provides additional context and details about the data
|
|
6782
|
+
* source.</p>
|
|
6640
6783
|
* @public
|
|
6641
6784
|
*/
|
|
6642
6785
|
Description?: string | undefined;
|
|
6643
6786
|
/**
|
|
6644
|
-
* <p>
|
|
6645
|
-
*
|
|
6646
|
-
* collections that are associated with the direct query data source.
|
|
6647
|
-
* </p>
|
|
6787
|
+
* <p> A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are
|
|
6788
|
+
* associated with the direct query data source. </p>
|
|
6648
6789
|
* @public
|
|
6649
6790
|
*/
|
|
6650
6791
|
OpenSearchArns?: string[] | undefined;
|
|
6651
6792
|
/**
|
|
6652
|
-
* <p>
|
|
6653
|
-
* The unique, system-generated identifier that represents the data source.</p>
|
|
6793
|
+
* <p> The unique, system-generated identifier that represents the data source.</p>
|
|
6654
6794
|
* @public
|
|
6655
6795
|
*/
|
|
6656
6796
|
DataSourceArn?: string | undefined;
|
|
6657
6797
|
/**
|
|
6658
|
-
* <p>
|
|
6659
|
-
* A list of tags attached to a direct query data source.</p>
|
|
6798
|
+
* <p> A list of tags attached to a direct query data source.</p>
|
|
6660
6799
|
* @public
|
|
6661
6800
|
*/
|
|
6662
6801
|
TagList?: Tag[] | undefined;
|
|
@@ -6666,24 +6805,22 @@ export interface DirectQueryDataSource {
|
|
|
6666
6805
|
*/
|
|
6667
6806
|
export interface ListDirectQueryDataSourcesResponse {
|
|
6668
6807
|
/**
|
|
6669
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6670
|
-
*
|
|
6671
|
-
*
|
|
6808
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6809
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6810
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6672
6811
|
* @public
|
|
6673
6812
|
*/
|
|
6674
6813
|
NextToken?: string | undefined;
|
|
6675
6814
|
/**
|
|
6676
|
-
* <p>
|
|
6677
|
-
*
|
|
6678
|
-
* the <code>ListDirectQueryDataSources</code> API operation.
|
|
6679
|
-
* </p>
|
|
6815
|
+
* <p> A list of the direct query data sources that are returned by the
|
|
6816
|
+
* <code>ListDirectQueryDataSources</code> API operation. </p>
|
|
6680
6817
|
* @public
|
|
6681
6818
|
*/
|
|
6682
6819
|
DirectQueryDataSources?: DirectQueryDataSource[] | undefined;
|
|
6683
6820
|
}
|
|
6684
6821
|
/**
|
|
6685
6822
|
* <p>Container for the parameters to the <code>ListDomainMaintenances</code>
|
|
6686
|
-
*
|
|
6823
|
+
* operation.</p>
|
|
6687
6824
|
* @public
|
|
6688
6825
|
*/
|
|
6689
6826
|
export interface ListDomainMaintenancesRequest {
|
|
@@ -6703,15 +6840,16 @@ export interface ListDomainMaintenancesRequest {
|
|
|
6703
6840
|
*/
|
|
6704
6841
|
Status?: MaintenanceStatus | undefined;
|
|
6705
6842
|
/**
|
|
6706
|
-
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6707
|
-
*
|
|
6843
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
6844
|
+
* use <code>nextToken</code> to get the next page of results.</p>
|
|
6708
6845
|
* @public
|
|
6709
6846
|
*/
|
|
6710
6847
|
MaxResults?: number | undefined;
|
|
6711
6848
|
/**
|
|
6712
6849
|
* <p>If your initial <code>ListDomainMaintenances</code> operation returns a
|
|
6713
|
-
*
|
|
6714
|
-
*
|
|
6850
|
+
* <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent
|
|
6851
|
+
* <code>ListDomainMaintenances</code> operations, which returns results in the next
|
|
6852
|
+
* page.</p>
|
|
6715
6853
|
* @public
|
|
6716
6854
|
*/
|
|
6717
6855
|
NextToken?: string | undefined;
|
|
@@ -6763,7 +6901,8 @@ export interface DomainMaintenanceDetails {
|
|
|
6763
6901
|
UpdatedAt?: Date | undefined;
|
|
6764
6902
|
}
|
|
6765
6903
|
/**
|
|
6766
|
-
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information
|
|
6904
|
+
* <p>The result of a <code>ListDomainMaintenances</code> request that contains information
|
|
6905
|
+
* about the requested actions. </p>
|
|
6767
6906
|
* @public
|
|
6768
6907
|
*/
|
|
6769
6908
|
export interface ListDomainMaintenancesResponse {
|
|
@@ -6773,9 +6912,9 @@ export interface ListDomainMaintenancesResponse {
|
|
|
6773
6912
|
*/
|
|
6774
6913
|
DomainMaintenances?: DomainMaintenanceDetails[] | undefined;
|
|
6775
6914
|
/**
|
|
6776
|
-
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6777
|
-
*
|
|
6778
|
-
*
|
|
6915
|
+
* <p>When <code>nextToken</code> is returned, there are more results available. The value
|
|
6916
|
+
* of <code>nextToken</code> is a unique pagination token for each page. Send the request
|
|
6917
|
+
* again using the returned token to retrieve the next page.</p>
|
|
6779
6918
|
* @public
|
|
6780
6919
|
*/
|
|
6781
6920
|
NextToken?: string | undefined;
|
|
@@ -6792,34 +6931,6 @@ export declare const EngineType: {
|
|
|
6792
6931
|
* @public
|
|
6793
6932
|
*/
|
|
6794
6933
|
export type EngineType = (typeof EngineType)[keyof typeof EngineType];
|
|
6795
|
-
/**
|
|
6796
|
-
* <p>Container for the parameters to the <code>ListDomainNames</code> operation.</p>
|
|
6797
|
-
* @public
|
|
6798
|
-
*/
|
|
6799
|
-
export interface ListDomainNamesRequest {
|
|
6800
|
-
/**
|
|
6801
|
-
* <p>Filters the output by domain engine type.</p>
|
|
6802
|
-
* @public
|
|
6803
|
-
*/
|
|
6804
|
-
EngineType?: EngineType | undefined;
|
|
6805
|
-
}
|
|
6806
|
-
/**
|
|
6807
|
-
* <p>Information about an OpenSearch Service domain.</p>
|
|
6808
|
-
* @public
|
|
6809
|
-
*/
|
|
6810
|
-
export interface DomainInfo {
|
|
6811
|
-
/**
|
|
6812
|
-
* <p>Name of the domain.</p>
|
|
6813
|
-
* @public
|
|
6814
|
-
*/
|
|
6815
|
-
DomainName?: string | undefined;
|
|
6816
|
-
/**
|
|
6817
|
-
* <p>The type of search engine that the domain is running.<code>OpenSearch</code> for an
|
|
6818
|
-
* OpenSearch engine, or <code>Elasticsearch</code> for a legacy Elasticsearch OSS engine.</p>
|
|
6819
|
-
* @public
|
|
6820
|
-
*/
|
|
6821
|
-
EngineType?: EngineType | undefined;
|
|
6822
|
-
}
|
|
6823
6934
|
/**
|
|
6824
6935
|
* @internal
|
|
6825
6936
|
*/
|