cdk-docker-image-deployment 0.0.66 → 0.0.67

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.
Files changed (37) hide show
  1. package/.jsii +3 -3
  2. package/lib/destination.js +1 -1
  3. package/lib/docker-image-deployment.js +1 -1
  4. package/lib/source.js +1 -1
  5. package/node_modules/aws-sdk/CHANGELOG.md +12 -1
  6. package/node_modules/aws-sdk/README.md +1 -1
  7. package/node_modules/aws-sdk/apis/acm-2015-12-08.min.json +2 -1
  8. package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.min.json +78 -10
  9. package/node_modules/aws-sdk/apis/billingconductor-2021-07-30.paginators.json +6 -0
  10. package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +844 -836
  11. package/node_modules/aws-sdk/apis/fms-2018-01-01.min.json +354 -87
  12. package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +174 -140
  13. package/node_modules/aws-sdk/apis/metadata.json +4 -0
  14. package/node_modules/aws-sdk/apis/opensearch-2021-01-01.min.json +459 -139
  15. package/node_modules/aws-sdk/apis/resource-explorer-2-2022-07-28.examples.json +5 -0
  16. package/node_modules/aws-sdk/apis/resource-explorer-2-2022-07-28.min.json +624 -0
  17. package/node_modules/aws-sdk/apis/resource-explorer-2-2022-07-28.paginators.json +28 -0
  18. package/node_modules/aws-sdk/clients/acm.d.ts +9 -4
  19. package/node_modules/aws-sdk/clients/all.d.ts +1 -0
  20. package/node_modules/aws-sdk/clients/all.js +2 -1
  21. package/node_modules/aws-sdk/clients/billingconductor.d.ts +163 -63
  22. package/node_modules/aws-sdk/clients/ec2.d.ts +16 -0
  23. package/node_modules/aws-sdk/clients/fms.d.ts +322 -1
  24. package/node_modules/aws-sdk/clients/lightsail.d.ts +85 -17
  25. package/node_modules/aws-sdk/clients/opensearch.d.ts +890 -430
  26. package/node_modules/aws-sdk/clients/polly.d.ts +1 -1
  27. package/node_modules/aws-sdk/clients/resourceexplorer2.d.ts +693 -0
  28. package/node_modules/aws-sdk/clients/resourceexplorer2.js +18 -0
  29. package/node_modules/aws-sdk/clients/route53.d.ts +4 -4
  30. package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
  31. package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +48 -11
  32. package/node_modules/aws-sdk/dist/aws-sdk.js +853 -840
  33. package/node_modules/aws-sdk/dist/aws-sdk.min.js +77 -77
  34. package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +2 -0
  35. package/node_modules/aws-sdk/lib/core.js +1 -1
  36. package/node_modules/aws-sdk/package.json +1 -1
  37. package/package.json +4 -4
@@ -12,372 +12,454 @@ declare class OpenSearch extends Service {
12
12
  constructor(options?: OpenSearch.Types.ClientConfiguration)
13
13
  config: Config & OpenSearch.Types.ClientConfiguration;
14
14
  /**
15
- * Allows the remote domain owner to accept an inbound cross-cluster connection request.
15
+ * Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
16
16
  */
17
17
  acceptInboundConnection(params: OpenSearch.Types.AcceptInboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.AcceptInboundConnectionResponse) => void): Request<OpenSearch.Types.AcceptInboundConnectionResponse, AWSError>;
18
18
  /**
19
- * Allows the remote domain owner to accept an inbound cross-cluster connection request.
19
+ * Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
20
20
  */
21
21
  acceptInboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.AcceptInboundConnectionResponse) => void): Request<OpenSearch.Types.AcceptInboundConnectionResponse, AWSError>;
22
22
  /**
23
- * Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
23
+ * Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. An domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
24
24
  */
25
25
  addTags(params: OpenSearch.Types.AddTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
26
26
  /**
27
- * Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
27
+ * Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. An domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
28
28
  */
29
29
  addTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
30
30
  /**
31
- * Associates a package with an Amazon OpenSearch Service domain.
31
+ * Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
32
32
  */
33
33
  associatePackage(params: OpenSearch.Types.AssociatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.AssociatePackageResponse) => void): Request<OpenSearch.Types.AssociatePackageResponse, AWSError>;
34
34
  /**
35
- * Associates a package with an Amazon OpenSearch Service domain.
35
+ * Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
36
36
  */
37
37
  associatePackage(callback?: (err: AWSError, data: OpenSearch.Types.AssociatePackageResponse) => void): Request<OpenSearch.Types.AssociatePackageResponse, AWSError>;
38
38
  /**
39
- * Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
39
+ * Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
40
+ */
41
+ authorizeVpcEndpointAccess(params: OpenSearch.Types.AuthorizeVpcEndpointAccessRequest, callback?: (err: AWSError, data: OpenSearch.Types.AuthorizeVpcEndpointAccessResponse) => void): Request<OpenSearch.Types.AuthorizeVpcEndpointAccessResponse, AWSError>;
42
+ /**
43
+ * Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
44
+ */
45
+ authorizeVpcEndpointAccess(callback?: (err: AWSError, data: OpenSearch.Types.AuthorizeVpcEndpointAccessResponse) => void): Request<OpenSearch.Types.AuthorizeVpcEndpointAccessResponse, AWSError>;
46
+ /**
47
+ * Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
40
48
  */
41
49
  cancelServiceSoftwareUpdate(params: OpenSearch.Types.CancelServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: OpenSearch.Types.CancelServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.CancelServiceSoftwareUpdateResponse, AWSError>;
42
50
  /**
43
- * Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
51
+ * Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
44
52
  */
45
53
  cancelServiceSoftwareUpdate(callback?: (err: AWSError, data: OpenSearch.Types.CancelServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.CancelServiceSoftwareUpdateResponse, AWSError>;
46
54
  /**
47
- * Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
55
+ * Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
48
56
  */
49
57
  createDomain(params: OpenSearch.Types.CreateDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreateDomainResponse) => void): Request<OpenSearch.Types.CreateDomainResponse, AWSError>;
50
58
  /**
51
- * Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
59
+ * Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
52
60
  */
53
61
  createDomain(callback?: (err: AWSError, data: OpenSearch.Types.CreateDomainResponse) => void): Request<OpenSearch.Types.CreateDomainResponse, AWSError>;
54
62
  /**
55
- * Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
63
+ * Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
56
64
  */
57
65
  createOutboundConnection(params: OpenSearch.Types.CreateOutboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreateOutboundConnectionResponse) => void): Request<OpenSearch.Types.CreateOutboundConnectionResponse, AWSError>;
58
66
  /**
59
- * Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
67
+ * Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
60
68
  */
61
69
  createOutboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.CreateOutboundConnectionResponse) => void): Request<OpenSearch.Types.CreateOutboundConnectionResponse, AWSError>;
62
70
  /**
63
- * Create a package for use with Amazon OpenSearch Service domains.
71
+ * Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
64
72
  */
65
73
  createPackage(params: OpenSearch.Types.CreatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreatePackageResponse) => void): Request<OpenSearch.Types.CreatePackageResponse, AWSError>;
66
74
  /**
67
- * Create a package for use with Amazon OpenSearch Service domains.
75
+ * Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
68
76
  */
69
77
  createPackage(callback?: (err: AWSError, data: OpenSearch.Types.CreatePackageResponse) => void): Request<OpenSearch.Types.CreatePackageResponse, AWSError>;
70
78
  /**
71
- * Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
79
+ * Creates an Amazon OpenSearch Service-managed VPC endpoint.
80
+ */
81
+ createVpcEndpoint(params: OpenSearch.Types.CreateVpcEndpointRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreateVpcEndpointResponse) => void): Request<OpenSearch.Types.CreateVpcEndpointResponse, AWSError>;
82
+ /**
83
+ * Creates an Amazon OpenSearch Service-managed VPC endpoint.
84
+ */
85
+ createVpcEndpoint(callback?: (err: AWSError, data: OpenSearch.Types.CreateVpcEndpointResponse) => void): Request<OpenSearch.Types.CreateVpcEndpointResponse, AWSError>;
86
+ /**
87
+ * Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
72
88
  */
73
89
  deleteDomain(params: OpenSearch.Types.DeleteDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteDomainResponse) => void): Request<OpenSearch.Types.DeleteDomainResponse, AWSError>;
74
90
  /**
75
- * Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
91
+ * Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
76
92
  */
77
93
  deleteDomain(callback?: (err: AWSError, data: OpenSearch.Types.DeleteDomainResponse) => void): Request<OpenSearch.Types.DeleteDomainResponse, AWSError>;
78
94
  /**
79
- * Allows the remote domain owner to delete an existing inbound cross-cluster connection.
95
+ * Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
80
96
  */
81
97
  deleteInboundConnection(params: OpenSearch.Types.DeleteInboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteInboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteInboundConnectionResponse, AWSError>;
82
98
  /**
83
- * Allows the remote domain owner to delete an existing inbound cross-cluster connection.
99
+ * Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
84
100
  */
85
101
  deleteInboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.DeleteInboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteInboundConnectionResponse, AWSError>;
86
102
  /**
87
- * Allows the local domain owner to delete an existing outbound cross-cluster connection.
103
+ * Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
88
104
  */
89
105
  deleteOutboundConnection(params: OpenSearch.Types.DeleteOutboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteOutboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteOutboundConnectionResponse, AWSError>;
90
106
  /**
91
- * Allows the local domain owner to delete an existing outbound cross-cluster connection.
107
+ * Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
92
108
  */
93
109
  deleteOutboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.DeleteOutboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteOutboundConnectionResponse, AWSError>;
94
110
  /**
95
- * Deletes the package.
111
+ * Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
96
112
  */
97
113
  deletePackage(params: OpenSearch.Types.DeletePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeletePackageResponse) => void): Request<OpenSearch.Types.DeletePackageResponse, AWSError>;
98
114
  /**
99
- * Deletes the package.
115
+ * Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
100
116
  */
101
117
  deletePackage(callback?: (err: AWSError, data: OpenSearch.Types.DeletePackageResponse) => void): Request<OpenSearch.Types.DeletePackageResponse, AWSError>;
102
118
  /**
103
- * Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
119
+ * Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
120
+ */
121
+ deleteVpcEndpoint(params: OpenSearch.Types.DeleteVpcEndpointRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteVpcEndpointResponse) => void): Request<OpenSearch.Types.DeleteVpcEndpointResponse, AWSError>;
122
+ /**
123
+ * Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
124
+ */
125
+ deleteVpcEndpoint(callback?: (err: AWSError, data: OpenSearch.Types.DeleteVpcEndpointResponse) => void): Request<OpenSearch.Types.DeleteVpcEndpointResponse, AWSError>;
126
+ /**
127
+ * Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
104
128
  */
105
129
  describeDomain(params: OpenSearch.Types.DescribeDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainResponse) => void): Request<OpenSearch.Types.DescribeDomainResponse, AWSError>;
106
130
  /**
107
- * Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
131
+ * Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
108
132
  */
109
133
  describeDomain(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainResponse) => void): Request<OpenSearch.Types.DescribeDomainResponse, AWSError>;
110
134
  /**
111
- * Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
135
+ * Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
112
136
  */
113
137
  describeDomainAutoTunes(params: OpenSearch.Types.DescribeDomainAutoTunesRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainAutoTunesResponse) => void): Request<OpenSearch.Types.DescribeDomainAutoTunesResponse, AWSError>;
114
138
  /**
115
- * Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
139
+ * Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
116
140
  */
117
141
  describeDomainAutoTunes(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainAutoTunesResponse) => void): Request<OpenSearch.Types.DescribeDomainAutoTunesResponse, AWSError>;
118
142
  /**
119
- * Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
143
+ * Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
120
144
  */
121
145
  describeDomainChangeProgress(params: OpenSearch.Types.DescribeDomainChangeProgressRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainChangeProgressResponse) => void): Request<OpenSearch.Types.DescribeDomainChangeProgressResponse, AWSError>;
122
146
  /**
123
- * Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
147
+ * Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
124
148
  */
125
149
  describeDomainChangeProgress(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainChangeProgressResponse) => void): Request<OpenSearch.Types.DescribeDomainChangeProgressResponse, AWSError>;
126
150
  /**
127
- * Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
151
+ * Returns the configuration of an Amazon OpenSearch Service domain.
128
152
  */
129
153
  describeDomainConfig(params: OpenSearch.Types.DescribeDomainConfigRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainConfigResponse) => void): Request<OpenSearch.Types.DescribeDomainConfigResponse, AWSError>;
130
154
  /**
131
- * Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
155
+ * Returns the configuration of an Amazon OpenSearch Service domain.
132
156
  */
133
157
  describeDomainConfig(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainConfigResponse) => void): Request<OpenSearch.Types.DescribeDomainConfigResponse, AWSError>;
134
158
  /**
135
- * Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
159
+ * Returns domain configuration information about the specified Amazon OpenSearch Service domains.
136
160
  */
137
161
  describeDomains(params: OpenSearch.Types.DescribeDomainsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainsResponse) => void): Request<OpenSearch.Types.DescribeDomainsResponse, AWSError>;
138
162
  /**
139
- * Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
163
+ * Returns domain configuration information about the specified Amazon OpenSearch Service domains.
140
164
  */
141
165
  describeDomains(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainsResponse) => void): Request<OpenSearch.Types.DescribeDomainsResponse, AWSError>;
142
166
  /**
143
- * Lists all the inbound cross-cluster connections for a remote domain.
167
+ * Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
144
168
  */
145
169
  describeInboundConnections(params: OpenSearch.Types.DescribeInboundConnectionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeInboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeInboundConnectionsResponse, AWSError>;
146
170
  /**
147
- * Lists all the inbound cross-cluster connections for a remote domain.
171
+ * Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
148
172
  */
149
173
  describeInboundConnections(callback?: (err: AWSError, data: OpenSearch.Types.DescribeInboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeInboundConnectionsResponse, AWSError>;
150
174
  /**
151
- * Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.
175
+ * Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
152
176
  */
153
177
  describeInstanceTypeLimits(params: OpenSearch.Types.DescribeInstanceTypeLimitsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeInstanceTypeLimitsResponse) => void): Request<OpenSearch.Types.DescribeInstanceTypeLimitsResponse, AWSError>;
154
178
  /**
155
- * Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.
179
+ * Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
156
180
  */
157
181
  describeInstanceTypeLimits(callback?: (err: AWSError, data: OpenSearch.Types.DescribeInstanceTypeLimitsResponse) => void): Request<OpenSearch.Types.DescribeInstanceTypeLimitsResponse, AWSError>;
158
182
  /**
159
- * Lists all the outbound cross-cluster connections for a local domain.
183
+ * Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
160
184
  */
161
185
  describeOutboundConnections(params: OpenSearch.Types.DescribeOutboundConnectionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeOutboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeOutboundConnectionsResponse, AWSError>;
162
186
  /**
163
- * Lists all the outbound cross-cluster connections for a local domain.
187
+ * Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
164
188
  */
165
189
  describeOutboundConnections(callback?: (err: AWSError, data: OpenSearch.Types.DescribeOutboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeOutboundConnectionsResponse, AWSError>;
166
190
  /**
167
- * Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
191
+ * Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
168
192
  */
169
193
  describePackages(params: OpenSearch.Types.DescribePackagesRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribePackagesResponse) => void): Request<OpenSearch.Types.DescribePackagesResponse, AWSError>;
170
194
  /**
171
- * Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
195
+ * Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
172
196
  */
173
197
  describePackages(callback?: (err: AWSError, data: OpenSearch.Types.DescribePackagesResponse) => void): Request<OpenSearch.Types.DescribePackagesResponse, AWSError>;
174
198
  /**
175
- * Lists available reserved OpenSearch instance offerings.
199
+ * Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
176
200
  */
177
201
  describeReservedInstanceOfferings(params: OpenSearch.Types.DescribeReservedInstanceOfferingsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstanceOfferingsResponse) => void): Request<OpenSearch.Types.DescribeReservedInstanceOfferingsResponse, AWSError>;
178
202
  /**
179
- * Lists available reserved OpenSearch instance offerings.
203
+ * Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
180
204
  */
181
205
  describeReservedInstanceOfferings(callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstanceOfferingsResponse) => void): Request<OpenSearch.Types.DescribeReservedInstanceOfferingsResponse, AWSError>;
182
206
  /**
183
- * Returns information about reserved OpenSearch instances for this account.
207
+ * Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
184
208
  */
185
209
  describeReservedInstances(params: OpenSearch.Types.DescribeReservedInstancesRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstancesResponse) => void): Request<OpenSearch.Types.DescribeReservedInstancesResponse, AWSError>;
186
210
  /**
187
- * Returns information about reserved OpenSearch instances for this account.
211
+ * Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
188
212
  */
189
213
  describeReservedInstances(callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstancesResponse) => void): Request<OpenSearch.Types.DescribeReservedInstancesResponse, AWSError>;
190
214
  /**
191
- * Dissociates a package from the Amazon OpenSearch Service domain.
215
+ * Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
216
+ */
217
+ describeVpcEndpoints(params: OpenSearch.Types.DescribeVpcEndpointsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeVpcEndpointsResponse) => void): Request<OpenSearch.Types.DescribeVpcEndpointsResponse, AWSError>;
218
+ /**
219
+ * Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
220
+ */
221
+ describeVpcEndpoints(callback?: (err: AWSError, data: OpenSearch.Types.DescribeVpcEndpointsResponse) => void): Request<OpenSearch.Types.DescribeVpcEndpointsResponse, AWSError>;
222
+ /**
223
+ * Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
192
224
  */
193
225
  dissociatePackage(params: OpenSearch.Types.DissociatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.DissociatePackageResponse) => void): Request<OpenSearch.Types.DissociatePackageResponse, AWSError>;
194
226
  /**
195
- * Dissociates a package from the Amazon OpenSearch Service domain.
227
+ * Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
196
228
  */
197
229
  dissociatePackage(callback?: (err: AWSError, data: OpenSearch.Types.DissociatePackageResponse) => void): Request<OpenSearch.Types.DissociatePackageResponse, AWSError>;
198
230
  /**
199
- * Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.
231
+ * Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
200
232
  */
201
233
  getCompatibleVersions(params: OpenSearch.Types.GetCompatibleVersionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetCompatibleVersionsResponse) => void): Request<OpenSearch.Types.GetCompatibleVersionsResponse, AWSError>;
202
234
  /**
203
- * Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.
235
+ * Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
204
236
  */
205
237
  getCompatibleVersions(callback?: (err: AWSError, data: OpenSearch.Types.GetCompatibleVersionsResponse) => void): Request<OpenSearch.Types.GetCompatibleVersionsResponse, AWSError>;
206
238
  /**
207
- * Returns a list of package versions, along with their creation time and commit message.
239
+ * Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.
208
240
  */
209
241
  getPackageVersionHistory(params: OpenSearch.Types.GetPackageVersionHistoryRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetPackageVersionHistoryResponse) => void): Request<OpenSearch.Types.GetPackageVersionHistoryResponse, AWSError>;
210
242
  /**
211
- * Returns a list of package versions, along with their creation time and commit message.
243
+ * Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.
212
244
  */
213
245
  getPackageVersionHistory(callback?: (err: AWSError, data: OpenSearch.Types.GetPackageVersionHistoryResponse) => void): Request<OpenSearch.Types.GetPackageVersionHistoryResponse, AWSError>;
214
246
  /**
215
- * Retrieves the complete history of the last 10 upgrades performed on the domain.
247
+ * Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
216
248
  */
217
249
  getUpgradeHistory(params: OpenSearch.Types.GetUpgradeHistoryRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeHistoryResponse) => void): Request<OpenSearch.Types.GetUpgradeHistoryResponse, AWSError>;
218
250
  /**
219
- * Retrieves the complete history of the last 10 upgrades performed on the domain.
251
+ * Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
220
252
  */
221
253
  getUpgradeHistory(callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeHistoryResponse) => void): Request<OpenSearch.Types.GetUpgradeHistoryResponse, AWSError>;
222
254
  /**
223
- * Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
255
+ * Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
224
256
  */
225
257
  getUpgradeStatus(params: OpenSearch.Types.GetUpgradeStatusRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeStatusResponse) => void): Request<OpenSearch.Types.GetUpgradeStatusResponse, AWSError>;
226
258
  /**
227
- * Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
259
+ * Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
228
260
  */
229
261
  getUpgradeStatus(callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeStatusResponse) => void): Request<OpenSearch.Types.GetUpgradeStatusResponse, AWSError>;
230
262
  /**
231
- * Returns the names of all domains owned by the current user's account.
263
+ * Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
232
264
  */
233
265
  listDomainNames(params: OpenSearch.Types.ListDomainNamesRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListDomainNamesResponse) => void): Request<OpenSearch.Types.ListDomainNamesResponse, AWSError>;
234
266
  /**
235
- * Returns the names of all domains owned by the current user's account.
267
+ * Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
236
268
  */
237
269
  listDomainNames(callback?: (err: AWSError, data: OpenSearch.Types.ListDomainNamesResponse) => void): Request<OpenSearch.Types.ListDomainNamesResponse, AWSError>;
238
270
  /**
239
- * Lists all Amazon OpenSearch Service domains associated with the package.
271
+ * Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
240
272
  */
241
273
  listDomainsForPackage(params: OpenSearch.Types.ListDomainsForPackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListDomainsForPackageResponse) => void): Request<OpenSearch.Types.ListDomainsForPackageResponse, AWSError>;
242
274
  /**
243
- * Lists all Amazon OpenSearch Service domains associated with the package.
275
+ * Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
244
276
  */
245
277
  listDomainsForPackage(callback?: (err: AWSError, data: OpenSearch.Types.ListDomainsForPackageResponse) => void): Request<OpenSearch.Types.ListDomainsForPackageResponse, AWSError>;
246
278
  /**
247
- *
279
+ * Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
248
280
  */
249
281
  listInstanceTypeDetails(params: OpenSearch.Types.ListInstanceTypeDetailsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListInstanceTypeDetailsResponse) => void): Request<OpenSearch.Types.ListInstanceTypeDetailsResponse, AWSError>;
250
282
  /**
251
- *
283
+ * Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
252
284
  */
253
285
  listInstanceTypeDetails(callback?: (err: AWSError, data: OpenSearch.Types.ListInstanceTypeDetailsResponse) => void): Request<OpenSearch.Types.ListInstanceTypeDetailsResponse, AWSError>;
254
286
  /**
255
- * Lists all packages associated with the Amazon OpenSearch Service domain.
287
+ * Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
256
288
  */
257
289
  listPackagesForDomain(params: OpenSearch.Types.ListPackagesForDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListPackagesForDomainResponse) => void): Request<OpenSearch.Types.ListPackagesForDomainResponse, AWSError>;
258
290
  /**
259
- * Lists all packages associated with the Amazon OpenSearch Service domain.
291
+ * Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
260
292
  */
261
293
  listPackagesForDomain(callback?: (err: AWSError, data: OpenSearch.Types.ListPackagesForDomainResponse) => void): Request<OpenSearch.Types.ListPackagesForDomainResponse, AWSError>;
262
294
  /**
263
- * Returns all tags for the given domain.
295
+ * Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
264
296
  */
265
297
  listTags(params: OpenSearch.Types.ListTagsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListTagsResponse) => void): Request<OpenSearch.Types.ListTagsResponse, AWSError>;
266
298
  /**
267
- * Returns all tags for the given domain.
299
+ * Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
268
300
  */
269
301
  listTags(callback?: (err: AWSError, data: OpenSearch.Types.ListTagsResponse) => void): Request<OpenSearch.Types.ListTagsResponse, AWSError>;
270
302
  /**
271
- * List all supported versions of OpenSearch and Elasticsearch.
303
+ * Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
272
304
  */
273
305
  listVersions(params: OpenSearch.Types.ListVersionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListVersionsResponse) => void): Request<OpenSearch.Types.ListVersionsResponse, AWSError>;
274
306
  /**
275
- * List all supported versions of OpenSearch and Elasticsearch.
307
+ * Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
276
308
  */
277
309
  listVersions(callback?: (err: AWSError, data: OpenSearch.Types.ListVersionsResponse) => void): Request<OpenSearch.Types.ListVersionsResponse, AWSError>;
278
310
  /**
279
- * Allows you to purchase reserved OpenSearch instances.
311
+ * Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
312
+ */
313
+ listVpcEndpointAccess(params: OpenSearch.Types.ListVpcEndpointAccessRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListVpcEndpointAccessResponse) => void): Request<OpenSearch.Types.ListVpcEndpointAccessResponse, AWSError>;
314
+ /**
315
+ * Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
316
+ */
317
+ listVpcEndpointAccess(callback?: (err: AWSError, data: OpenSearch.Types.ListVpcEndpointAccessResponse) => void): Request<OpenSearch.Types.ListVpcEndpointAccessResponse, AWSError>;
318
+ /**
319
+ * Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
320
+ */
321
+ listVpcEndpoints(params: OpenSearch.Types.ListVpcEndpointsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListVpcEndpointsResponse) => void): Request<OpenSearch.Types.ListVpcEndpointsResponse, AWSError>;
322
+ /**
323
+ * Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
324
+ */
325
+ listVpcEndpoints(callback?: (err: AWSError, data: OpenSearch.Types.ListVpcEndpointsResponse) => void): Request<OpenSearch.Types.ListVpcEndpointsResponse, AWSError>;
326
+ /**
327
+ * Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
328
+ */
329
+ listVpcEndpointsForDomain(params: OpenSearch.Types.ListVpcEndpointsForDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListVpcEndpointsForDomainResponse) => void): Request<OpenSearch.Types.ListVpcEndpointsForDomainResponse, AWSError>;
330
+ /**
331
+ * Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
332
+ */
333
+ listVpcEndpointsForDomain(callback?: (err: AWSError, data: OpenSearch.Types.ListVpcEndpointsForDomainResponse) => void): Request<OpenSearch.Types.ListVpcEndpointsForDomainResponse, AWSError>;
334
+ /**
335
+ * Allows you to purchase Amazon OpenSearch Service Reserved Instances.
280
336
  */
281
337
  purchaseReservedInstanceOffering(params: OpenSearch.Types.PurchaseReservedInstanceOfferingRequest, callback?: (err: AWSError, data: OpenSearch.Types.PurchaseReservedInstanceOfferingResponse) => void): Request<OpenSearch.Types.PurchaseReservedInstanceOfferingResponse, AWSError>;
282
338
  /**
283
- * Allows you to purchase reserved OpenSearch instances.
339
+ * Allows you to purchase Amazon OpenSearch Service Reserved Instances.
284
340
  */
285
341
  purchaseReservedInstanceOffering(callback?: (err: AWSError, data: OpenSearch.Types.PurchaseReservedInstanceOfferingResponse) => void): Request<OpenSearch.Types.PurchaseReservedInstanceOfferingResponse, AWSError>;
286
342
  /**
287
- * Allows the remote domain owner to reject an inbound cross-cluster connection request.
343
+ * Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
288
344
  */
289
345
  rejectInboundConnection(params: OpenSearch.Types.RejectInboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.RejectInboundConnectionResponse) => void): Request<OpenSearch.Types.RejectInboundConnectionResponse, AWSError>;
290
346
  /**
291
- * Allows the remote domain owner to reject an inbound cross-cluster connection request.
347
+ * Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
292
348
  */
293
349
  rejectInboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.RejectInboundConnectionResponse) => void): Request<OpenSearch.Types.RejectInboundConnectionResponse, AWSError>;
294
350
  /**
295
- * Removes the specified set of tags from the given domain.
351
+ * Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
296
352
  */
297
353
  removeTags(params: OpenSearch.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
298
354
  /**
299
- * Removes the specified set of tags from the given domain.
355
+ * Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
300
356
  */
301
357
  removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
302
358
  /**
303
- * Schedules a service software update for an Amazon OpenSearch Service domain.
359
+ * Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
360
+ */
361
+ revokeVpcEndpointAccess(params: OpenSearch.Types.RevokeVpcEndpointAccessRequest, callback?: (err: AWSError, data: OpenSearch.Types.RevokeVpcEndpointAccessResponse) => void): Request<OpenSearch.Types.RevokeVpcEndpointAccessResponse, AWSError>;
362
+ /**
363
+ * Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
364
+ */
365
+ revokeVpcEndpointAccess(callback?: (err: AWSError, data: OpenSearch.Types.RevokeVpcEndpointAccessResponse) => void): Request<OpenSearch.Types.RevokeVpcEndpointAccessResponse, AWSError>;
366
+ /**
367
+ * Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
304
368
  */
305
369
  startServiceSoftwareUpdate(params: OpenSearch.Types.StartServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: OpenSearch.Types.StartServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.StartServiceSoftwareUpdateResponse, AWSError>;
306
370
  /**
307
- * Schedules a service software update for an Amazon OpenSearch Service domain.
371
+ * Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
308
372
  */
309
373
  startServiceSoftwareUpdate(callback?: (err: AWSError, data: OpenSearch.Types.StartServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.StartServiceSoftwareUpdateResponse, AWSError>;
310
374
  /**
311
- * Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
375
+ * Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
312
376
  */
313
377
  updateDomainConfig(params: OpenSearch.Types.UpdateDomainConfigRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpdateDomainConfigResponse) => void): Request<OpenSearch.Types.UpdateDomainConfigResponse, AWSError>;
314
378
  /**
315
- * Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
379
+ * Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
316
380
  */
317
381
  updateDomainConfig(callback?: (err: AWSError, data: OpenSearch.Types.UpdateDomainConfigResponse) => void): Request<OpenSearch.Types.UpdateDomainConfigResponse, AWSError>;
318
382
  /**
319
- * Updates a package for use with Amazon OpenSearch Service domains.
383
+ * Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
320
384
  */
321
385
  updatePackage(params: OpenSearch.Types.UpdatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpdatePackageResponse) => void): Request<OpenSearch.Types.UpdatePackageResponse, AWSError>;
322
386
  /**
323
- * Updates a package for use with Amazon OpenSearch Service domains.
387
+ * Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
324
388
  */
325
389
  updatePackage(callback?: (err: AWSError, data: OpenSearch.Types.UpdatePackageResponse) => void): Request<OpenSearch.Types.UpdatePackageResponse, AWSError>;
326
390
  /**
327
- * Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
391
+ * Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
392
+ */
393
+ updateVpcEndpoint(params: OpenSearch.Types.UpdateVpcEndpointRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpdateVpcEndpointResponse) => void): Request<OpenSearch.Types.UpdateVpcEndpointResponse, AWSError>;
394
+ /**
395
+ * Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
396
+ */
397
+ updateVpcEndpoint(callback?: (err: AWSError, data: OpenSearch.Types.UpdateVpcEndpointResponse) => void): Request<OpenSearch.Types.UpdateVpcEndpointResponse, AWSError>;
398
+ /**
399
+ * Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
328
400
  */
329
401
  upgradeDomain(params: OpenSearch.Types.UpgradeDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpgradeDomainResponse) => void): Request<OpenSearch.Types.UpgradeDomainResponse, AWSError>;
330
402
  /**
331
- * Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
403
+ * Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
332
404
  */
333
405
  upgradeDomain(callback?: (err: AWSError, data: OpenSearch.Types.UpgradeDomainResponse) => void): Request<OpenSearch.Types.UpgradeDomainResponse, AWSError>;
334
406
  }
335
407
  declare namespace OpenSearch {
336
408
  export type ARN = string;
409
+ export type AWSAccount = string;
337
410
  export interface AWSDomainInformation {
411
+ /**
412
+ * The Amazon Web Services account ID of the domain owner.
413
+ */
338
414
  OwnerId?: OwnerId;
415
+ /**
416
+ * Name of the domain.
417
+ */
339
418
  DomainName: DomainName;
419
+ /**
420
+ * The Amazon Web Services Region in which the domain is located.
421
+ */
340
422
  Region?: Region;
341
423
  }
342
424
  export interface AcceptInboundConnectionRequest {
343
425
  /**
344
- * The ID of the inbound connection you want to accept.
426
+ * The ID of the inbound connection to accept.
345
427
  */
346
428
  ConnectionId: ConnectionId;
347
429
  }
348
430
  export interface AcceptInboundConnectionResponse {
349
431
  /**
350
- * The InboundConnection of the accepted inbound connection.
432
+ * Information about the accepted inbound connection.
351
433
  */
352
434
  Connection?: InboundConnection;
353
435
  }
354
436
  export interface AccessPoliciesStatus {
355
437
  /**
356
- * The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policiesfor more information.
438
+ * The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.
357
439
  */
358
440
  Options: PolicyDocument;
359
441
  /**
360
- * The status of the access policy for the domain. See OptionStatus for the status information that's included.
442
+ * The status of the access policy for the domain.
361
443
  */
362
444
  Status: OptionStatus;
363
445
  }
364
446
  export interface AddTagsRequest {
365
447
  /**
366
- * Specify the ARN of the domain you want to add tags to.
448
+ * Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
367
449
  */
368
450
  ARN: ARN;
369
451
  /**
370
- * List of Tag to add to the domain.
452
+ * List of resource tags.
371
453
  */
372
454
  TagList: TagList;
373
455
  }
374
456
  export interface AdditionalLimit {
375
457
  /**
376
- * Additional limit is specific to a given InstanceType and for each of its InstanceRole etc. Attributes and their details: MaximumNumberOfDataNodesSupported This attribute is present on the master node only to specify how much data nodes up to which given ESPartitionInstanceType can support as master node. MaximumNumberOfDataNodesWithoutMasterNode This attribute is present on data node only to specify how much data nodes of given ESPartitionInstanceType up to which you don't need any master nodes to govern them.
458
+ * MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support. MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
377
459
  */
378
460
  LimitName?: LimitName;
379
461
  /**
380
- * Value for a given AdditionalLimit$LimitName .
462
+ * The values of the additional instance type limits.
381
463
  */
382
464
  LimitValues?: LimitValueList;
383
465
  }
@@ -389,13 +471,13 @@ declare namespace OpenSearch {
389
471
  */
390
472
  Options: AdvancedOptions;
391
473
  /**
392
- * The OptionStatus for advanced options for the specified domain.
474
+ * The status of advanced options for the specified domain.
393
475
  */
394
476
  Status: OptionStatus;
395
477
  }
396
478
  export interface AdvancedSecurityOptions {
397
479
  /**
398
- * True if advanced security is enabled.
480
+ * True if fine-grained access control is enabled.
399
481
  */
400
482
  Enabled?: Boolean;
401
483
  /**
@@ -403,47 +485,47 @@ declare namespace OpenSearch {
403
485
  */
404
486
  InternalUserDatabaseEnabled?: Boolean;
405
487
  /**
406
- * Describes the SAML application configured for a domain.
488
+ * Container for information about the SAML configuration for OpenSearch Dashboards.
407
489
  */
408
490
  SAMLOptions?: SAMLOptionsOutput;
409
491
  /**
410
- * Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
492
+ * Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
411
493
  */
412
494
  AnonymousAuthDisableDate?: DisableTimestamp;
413
495
  /**
414
- * True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
496
+ * True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
415
497
  */
416
498
  AnonymousAuthEnabled?: Boolean;
417
499
  }
418
500
  export interface AdvancedSecurityOptionsInput {
419
501
  /**
420
- * True if advanced security is enabled.
502
+ * True to enable fine-grained access control.
421
503
  */
422
504
  Enabled?: Boolean;
423
505
  /**
424
- * True if the internal user database is enabled.
506
+ * True to enable the internal user database.
425
507
  */
426
508
  InternalUserDatabaseEnabled?: Boolean;
427
509
  /**
428
- * Credentials for the master user: username and password, ARN, or both.
510
+ * Container for information about the master user.
429
511
  */
430
512
  MasterUserOptions?: MasterUserOptions;
431
513
  /**
432
- * The SAML application configuration for the domain.
514
+ * Container for information about the SAML configuration for OpenSearch Dashboards.
433
515
  */
434
516
  SAMLOptions?: SAMLOptionsInput;
435
517
  /**
436
- * True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
518
+ * True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
437
519
  */
438
520
  AnonymousAuthEnabled?: Boolean;
439
521
  }
440
522
  export interface AdvancedSecurityOptionsStatus {
441
523
  /**
442
- * Advanced security options for the specified domain.
524
+ * Container for fine-grained access control settings.
443
525
  */
444
526
  Options: AdvancedSecurityOptions;
445
527
  /**
446
- * Status of the advanced security options for the specified domain.
528
+ * Status of the fine-grained access control settings for a domain.
447
529
  */
448
530
  Status: OptionStatus;
449
531
  }
@@ -453,99 +535,129 @@ declare namespace OpenSearch {
453
535
  */
454
536
  PackageID: PackageID;
455
537
  /**
456
- * The name of the domain to associate the package with.
538
+ * Name of the domain to associate the package with.
457
539
  */
458
540
  DomainName: DomainName;
459
541
  }
460
542
  export interface AssociatePackageResponse {
461
543
  /**
462
- * DomainPackageDetails
544
+ * Information about a package that is associated with a domain.
463
545
  */
464
546
  DomainPackageDetails?: DomainPackageDetails;
465
547
  }
548
+ export interface AuthorizeVpcEndpointAccessRequest {
549
+ /**
550
+ * The name of the OpenSearch Service domain to provide access to.
551
+ */
552
+ DomainName: DomainName;
553
+ /**
554
+ * The Amazon Web Services account ID to grant access to.
555
+ */
556
+ Account: AWSAccount;
557
+ }
558
+ export interface AuthorizeVpcEndpointAccessResponse {
559
+ /**
560
+ * Information about the Amazon Web Services account or service that was provided access to the domain.
561
+ */
562
+ AuthorizedPrincipal: AuthorizedPrincipal;
563
+ }
564
+ export interface AuthorizedPrincipal {
565
+ /**
566
+ * The type of principal.
567
+ */
568
+ PrincipalType?: PrincipalType;
569
+ /**
570
+ * The IAM principal that is allowed access to the domain.
571
+ */
572
+ Principal?: String;
573
+ }
574
+ export type AuthorizedPrincipalList = AuthorizedPrincipal[];
466
575
  export interface AutoTune {
467
576
  /**
468
- * Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
577
+ * The type of Auto-Tune action.
469
578
  */
470
579
  AutoTuneType?: AutoTuneType;
471
580
  /**
472
- * Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
581
+ * Details about an Auto-Tune action.
473
582
  */
474
583
  AutoTuneDetails?: AutoTuneDetails;
475
584
  }
476
585
  export type AutoTuneDate = Date;
477
586
  export type AutoTuneDesiredState = "ENABLED"|"DISABLED"|string;
478
587
  export interface AutoTuneDetails {
588
+ /**
589
+ * Container for details about a scheduled Auto-Tune action.
590
+ */
479
591
  ScheduledAutoTuneDetails?: ScheduledAutoTuneDetails;
480
592
  }
481
593
  export type AutoTuneList = AutoTune[];
482
594
  export interface AutoTuneMaintenanceSchedule {
483
595
  /**
484
- * The timestamp at which the Auto-Tune maintenance schedule starts.
596
+ * The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
485
597
  */
486
598
  StartAt?: StartAt;
487
599
  /**
488
- * Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
600
+ * The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.
489
601
  */
490
602
  Duration?: Duration;
491
603
  /**
492
- * A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
604
+ * A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
493
605
  */
494
606
  CronExpressionForRecurrence?: String;
495
607
  }
496
608
  export type AutoTuneMaintenanceScheduleList = AutoTuneMaintenanceSchedule[];
497
609
  export interface AutoTuneOptions {
498
610
  /**
499
- * The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
611
+ * Whether Auto-Tune is enabled or disabled.
500
612
  */
501
613
  DesiredState?: AutoTuneDesiredState;
502
614
  /**
503
- * The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
615
+ * When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.
504
616
  */
505
617
  RollbackOnDisable?: RollbackOnDisable;
506
618
  /**
507
- * A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
619
+ * A list of maintenance schedules during which Auto-Tune can deploy changes.
508
620
  */
509
621
  MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
510
622
  }
511
623
  export interface AutoTuneOptionsInput {
512
624
  /**
513
- * The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
625
+ * Whether Auto-Tune is enabled or disabled.
514
626
  */
515
627
  DesiredState?: AutoTuneDesiredState;
516
628
  /**
517
- * A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
629
+ * A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance schedules are overwrite, not append. If your request includes no schedules, the request deletes all existing schedules. To preserve existing schedules, make a call to DescribeDomainConfig first and use the MaintenanceSchedules portion of the response as the basis for this section.
518
630
  */
519
631
  MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
520
632
  }
521
633
  export interface AutoTuneOptionsOutput {
522
634
  /**
523
- * The AutoTuneState for the domain.
635
+ * The current state of Auto-Tune on the domain.
524
636
  */
525
637
  State?: AutoTuneState;
526
638
  /**
527
- * The error message while enabling or disabling Auto-Tune.
639
+ * Any errors that occurred while enabling or disabling Auto-Tune.
528
640
  */
529
641
  ErrorMessage?: String;
530
642
  }
531
643
  export interface AutoTuneOptionsStatus {
532
644
  /**
533
- * Specifies Auto-Tune options for the domain.
645
+ * Auto-Tune settings for updating a domain.
534
646
  */
535
647
  Options?: AutoTuneOptions;
536
648
  /**
537
- * The status of the Auto-Tune options for the domain.
649
+ * The current status of Auto-Tune for a domain.
538
650
  */
539
651
  Status?: AutoTuneStatus;
540
652
  }
541
653
  export type AutoTuneState = "ENABLED"|"DISABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_SCHEDULED"|"DISABLED_AND_ROLLBACK_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_COMPLETE"|"DISABLED_AND_ROLLBACK_ERROR"|"ERROR"|string;
542
654
  export interface AutoTuneStatus {
543
655
  /**
544
- * The timestamp of the Auto-Tune options creation date.
656
+ * Date and time when Auto-Tune was enabled for the domain.
545
657
  */
546
658
  CreationDate: UpdateTimestamp;
547
659
  /**
548
- * The timestamp of when the Auto-Tune options were last updated.
660
+ * Date and time when the Auto-Tune options were last updated for the domain.
549
661
  */
550
662
  UpdateDate: UpdateTimestamp;
551
663
  /**
@@ -553,11 +665,11 @@ declare namespace OpenSearch {
553
665
  */
554
666
  UpdateVersion?: UIntValue;
555
667
  /**
556
- * The AutoTuneState for the domain.
668
+ * The current state of Auto-Tune on the domain.
557
669
  */
558
670
  State: AutoTuneState;
559
671
  /**
560
- * The error message while enabling or disabling Auto-Tune.
672
+ * Any errors that occurred while enabling or disabling Auto-Tune.
561
673
  */
562
674
  ErrorMessage?: String;
563
675
  /**
@@ -570,41 +682,41 @@ declare namespace OpenSearch {
570
682
  export type Boolean = boolean;
571
683
  export interface CancelServiceSoftwareUpdateRequest {
572
684
  /**
573
- * The name of the domain that you want to stop the latest service software update on.
685
+ * Name of the OpenSearch Service domain that you want to cancel the service software update on.
574
686
  */
575
687
  DomainName: DomainName;
576
688
  }
577
689
  export interface CancelServiceSoftwareUpdateResponse {
578
690
  /**
579
- * The current status of the OpenSearch service software update.
691
+ * Container for the state of your domain relative to the latest service software.
580
692
  */
581
693
  ServiceSoftwareOptions?: ServiceSoftwareOptions;
582
694
  }
583
695
  export interface ChangeProgressDetails {
584
696
  /**
585
- * The unique change identifier associated with a specific domain configuration change.
697
+ * The ID of the configuration change.
586
698
  */
587
699
  ChangeId?: GUID;
588
700
  /**
589
- * Contains an optional message associated with the domain configuration change.
701
+ * A message corresponding to the status of the configuration change.
590
702
  */
591
703
  Message?: Message;
592
704
  }
593
705
  export interface ChangeProgressStage {
594
706
  /**
595
- * The name of the specific progress stage.
707
+ * The name of the stage.
596
708
  */
597
709
  Name?: ChangeProgressStageName;
598
710
  /**
599
- * The overall status of a specific progress stage.
711
+ * The status of the stage.
600
712
  */
601
713
  Status?: ChangeProgressStageStatus;
602
714
  /**
603
- * The description of the progress stage.
715
+ * The description of the stage.
604
716
  */
605
717
  Description?: Description;
606
718
  /**
607
- * The last updated timestamp of the progress stage.
719
+ * The most recent updated timestamp of the stage.
608
720
  */
609
721
  LastUpdated?: LastUpdated;
610
722
  }
@@ -621,15 +733,15 @@ declare namespace OpenSearch {
621
733
  */
622
734
  StartTime?: UpdateTimestamp;
623
735
  /**
624
- * The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
736
+ * The overall status of the domain configuration change.
625
737
  */
626
738
  Status?: OverallChangeStatus;
627
739
  /**
628
- * The list of properties involved in the domain configuration change that are still in pending.
740
+ * The list of properties in the domain configuration change that are still pending.
629
741
  */
630
742
  PendingProperties?: StringList;
631
743
  /**
632
- * The list of properties involved in the domain configuration change that are completed.
744
+ * The list of properties in the domain configuration change that have completed.
633
745
  */
634
746
  CompletedProperties?: StringList;
635
747
  /**
@@ -641,78 +753,79 @@ declare namespace OpenSearch {
641
753
  */
642
754
  ChangeProgressStages?: ChangeProgressStageList;
643
755
  }
756
+ export type ClientToken = string;
644
757
  export type CloudWatchLogsLogGroupArn = string;
645
758
  export interface ClusterConfig {
646
759
  /**
647
- * The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
760
+ * Instance type of data nodes in the cluster.
648
761
  */
649
762
  InstanceType?: OpenSearchPartitionInstanceType;
650
763
  /**
651
- * The number of instances in the specified domain cluster.
764
+ * Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
652
765
  */
653
766
  InstanceCount?: IntegerClass;
654
767
  /**
655
- * A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
768
+ * Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.
656
769
  */
657
770
  DedicatedMasterEnabled?: Boolean;
658
771
  /**
659
- * A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
772
+ * Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
660
773
  */
661
774
  ZoneAwarenessEnabled?: Boolean;
662
775
  /**
663
- * The zone awareness configuration for a domain when zone awareness is enabled.
776
+ * Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.
664
777
  */
665
778
  ZoneAwarenessConfig?: ZoneAwarenessConfig;
666
779
  /**
667
- * The instance type for a dedicated master node.
780
+ * OpenSearch Service instance type of the dedicated master nodes in the cluster.
668
781
  */
669
782
  DedicatedMasterType?: OpenSearchPartitionInstanceType;
670
783
  /**
671
- * Total number of dedicated master nodes, active and on standby, for the cluster.
784
+ * Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
672
785
  */
673
786
  DedicatedMasterCount?: IntegerClass;
674
787
  /**
675
- * True to enable UltraWarm storage.
788
+ * Whether to enable warm storage for the cluster.
676
789
  */
677
790
  WarmEnabled?: Boolean;
678
791
  /**
679
- * The instance type for the OpenSearch cluster's warm nodes.
792
+ * The instance type for the cluster's warm nodes.
680
793
  */
681
794
  WarmType?: OpenSearchWarmPartitionInstanceType;
682
795
  /**
683
- * The number of UltraWarm nodes in the cluster.
796
+ * The number of warm nodes in the cluster.
684
797
  */
685
798
  WarmCount?: IntegerClass;
686
799
  /**
687
- * Specifies the ColdStorageOptions config for a Domain
800
+ * Container for cold storage configuration options.
688
801
  */
689
802
  ColdStorageOptions?: ColdStorageOptions;
690
803
  }
691
804
  export interface ClusterConfigStatus {
692
805
  /**
693
- * The cluster configuration for the specified domain.
806
+ * Cluster configuration options for the specified domain.
694
807
  */
695
808
  Options: ClusterConfig;
696
809
  /**
697
- * The cluster configuration status for the specified domain.
810
+ * The status of cluster configuration options for the specified domain.
698
811
  */
699
812
  Status: OptionStatus;
700
813
  }
701
814
  export interface CognitoOptions {
702
815
  /**
703
- * The option to enable Cognito for OpenSearch Dashboards authentication.
816
+ * Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
704
817
  */
705
818
  Enabled?: Boolean;
706
819
  /**
707
- * The Cognito user pool ID for OpenSearch Dashboards authentication.
820
+ * The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
708
821
  */
709
822
  UserPoolId?: UserPoolId;
710
823
  /**
711
- * The Cognito identity pool ID for OpenSearch Dashboards authentication.
824
+ * The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
712
825
  */
713
826
  IdentityPoolId?: IdentityPoolId;
714
827
  /**
715
- * The role ARN that provides OpenSearch permissions for accessing Cognito resources.
828
+ * The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
716
829
  */
717
830
  RoleArn?: RoleArn;
718
831
  }
@@ -728,7 +841,7 @@ declare namespace OpenSearch {
728
841
  }
729
842
  export interface ColdStorageOptions {
730
843
  /**
731
- * Enable cold storage option. Accepted values true or false
844
+ * Whether to enable or disable cold storage on the domain.
732
845
  */
733
846
  Enabled: Boolean;
734
847
  }
@@ -736,9 +849,12 @@ declare namespace OpenSearch {
736
849
  export type CompatibleVersionsList = CompatibleVersionsMap[];
737
850
  export interface CompatibleVersionsMap {
738
851
  /**
739
- * The current version of OpenSearch a domain is on.
852
+ * The current version that the OpenSearch Service domain is running.
740
853
  */
741
854
  SourceVersion?: VersionString;
855
+ /**
856
+ * The possible versions that you can upgrade the domain to.
857
+ */
742
858
  TargetVersions?: VersionList;
743
859
  }
744
860
  export type ConnectionAlias = string;
@@ -746,67 +862,67 @@ declare namespace OpenSearch {
746
862
  export type ConnectionStatusMessage = string;
747
863
  export interface CreateDomainRequest {
748
864
  /**
749
- * The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
865
+ * Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
750
866
  */
751
867
  DomainName: DomainName;
752
868
  /**
753
- * String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
869
+ * String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.
754
870
  */
755
871
  EngineVersion?: VersionString;
756
872
  /**
757
- * Configuration options for a domain. Specifies the instance type and number of instances in the domain.
873
+ * Container for the cluster configuration of a domain.
758
874
  */
759
875
  ClusterConfig?: ClusterConfig;
760
876
  /**
761
- * Options to enable, disable, and specify the type and size of EBS storage volumes.
877
+ * Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
762
878
  */
763
879
  EBSOptions?: EBSOptions;
764
880
  /**
765
- * IAM access policy as a JSON-formatted string.
881
+ * Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
766
882
  */
767
883
  AccessPolicies?: PolicyDocument;
768
884
  /**
769
- * Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
885
+ * DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
770
886
  */
771
887
  SnapshotOptions?: SnapshotOptions;
772
888
  /**
773
- * Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
889
+ * Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
774
890
  */
775
891
  VPCOptions?: VPCOptions;
776
892
  /**
777
- * Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
893
+ * Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
778
894
  */
779
895
  CognitoOptions?: CognitoOptions;
780
896
  /**
781
- * Options for encryption of data at rest.
897
+ * Key-value pairs to enable encryption at rest.
782
898
  */
783
899
  EncryptionAtRestOptions?: EncryptionAtRestOptions;
784
900
  /**
785
- * Node-to-node encryption options.
901
+ * Enables node-to-node encryption.
786
902
  */
787
903
  NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
788
904
  /**
789
- * Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
905
+ * Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error. "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain. For more information, see Advanced cluster parameters.
790
906
  */
791
907
  AdvancedOptions?: AdvancedOptions;
792
908
  /**
793
- * Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
909
+ * Key-value pairs to configure slow log publishing.
794
910
  */
795
911
  LogPublishingOptions?: LogPublishingOptions;
796
912
  /**
797
- * Options to specify configurations that will be applied to the domain endpoint.
913
+ * Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
798
914
  */
799
915
  DomainEndpointOptions?: DomainEndpointOptions;
800
916
  /**
801
- * Specifies advanced security options.
917
+ * Options for fine-grained access control.
802
918
  */
803
919
  AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
804
920
  /**
805
- * A list of Tag added during domain creation.
921
+ * List of tags to add to the domain upon creation.
806
922
  */
807
923
  TagList?: TagList;
808
924
  /**
809
- * Specifies Auto-Tune options.
925
+ * Options for Auto-Tune.
810
926
  */
811
927
  AutoTuneOptions?: AutoTuneOptionsInput;
812
928
  }
@@ -818,47 +934,47 @@ declare namespace OpenSearch {
818
934
  }
819
935
  export interface CreateOutboundConnectionRequest {
820
936
  /**
821
- * The AWSDomainInformation for the local OpenSearch domain.
937
+ * Name and Region of the source (local) domain.
822
938
  */
823
939
  LocalDomainInfo: DomainInformationContainer;
824
940
  /**
825
- * The AWSDomainInformation for the remote OpenSearch domain.
941
+ * Name and Region of the destination (remote) domain.
826
942
  */
827
943
  RemoteDomainInfo: DomainInformationContainer;
828
944
  /**
829
- * The connection alias used used by the customer for this cross-cluster connection.
945
+ * Name of the connection.
830
946
  */
831
947
  ConnectionAlias: ConnectionAlias;
832
948
  }
833
949
  export interface CreateOutboundConnectionResponse {
834
950
  /**
835
- * The AWSDomainInformation for the local OpenSearch domain.
951
+ * Information about the source (local) domain.
836
952
  */
837
953
  LocalDomainInfo?: DomainInformationContainer;
838
954
  /**
839
- * The AWSDomainInformation for the remote OpenSearch domain.
955
+ * Information about the destination (remote) domain.
840
956
  */
841
957
  RemoteDomainInfo?: DomainInformationContainer;
842
958
  /**
843
- * The connection alias provided during the create connection request.
959
+ * Name of the connection.
844
960
  */
845
961
  ConnectionAlias?: ConnectionAlias;
846
962
  /**
847
- * The OutboundConnectionStatus for the newly created connection.
963
+ * The status of the connection.
848
964
  */
849
965
  ConnectionStatus?: OutboundConnectionStatus;
850
966
  /**
851
- * The unique ID for the created outbound connection, which is used for subsequent operations on the connection.
967
+ * The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
852
968
  */
853
969
  ConnectionId?: ConnectionId;
854
970
  }
855
971
  export interface CreatePackageRequest {
856
972
  /**
857
- * Unique identifier for the package.
973
+ * Unique name for the package.
858
974
  */
859
975
  PackageName: PackageName;
860
976
  /**
861
- * Type of package. Currently supports only TXT-DICTIONARY.
977
+ * Type of package.
862
978
  */
863
979
  PackageType: PackageType;
864
980
  /**
@@ -866,16 +982,36 @@ declare namespace OpenSearch {
866
982
  */
867
983
  PackageDescription?: PackageDescription;
868
984
  /**
869
- * The Amazon S3 location from which to import the package.
985
+ * The Amazon S3 location from which to import the package.
870
986
  */
871
987
  PackageSource: PackageSource;
872
988
  }
873
989
  export interface CreatePackageResponse {
874
990
  /**
875
- * Information about the package.
991
+ * Basic information about an OpenSearch Service package.
876
992
  */
877
993
  PackageDetails?: PackageDetails;
878
994
  }
995
+ export interface CreateVpcEndpointRequest {
996
+ /**
997
+ * The Amazon Resource Name (ARN) of the domain to grant access to.
998
+ */
999
+ DomainArn: DomainArn;
1000
+ /**
1001
+ * Options to specify the subnets and security groups for the endpoint.
1002
+ */
1003
+ VpcOptions: VPCOptions;
1004
+ /**
1005
+ * Unique, case-sensitive identifier to ensure idempotency of the request.
1006
+ */
1007
+ ClientToken?: ClientToken;
1008
+ }
1009
+ export interface CreateVpcEndpointResponse {
1010
+ /**
1011
+ * Information about the newly created VPC endpoint.
1012
+ */
1013
+ VpcEndpoint: VpcEndpoint;
1014
+ }
879
1015
  export type CreatedAt = Date;
880
1016
  export interface DeleteDomainRequest {
881
1017
  /**
@@ -897,7 +1033,7 @@ declare namespace OpenSearch {
897
1033
  }
898
1034
  export interface DeleteInboundConnectionResponse {
899
1035
  /**
900
- * The InboundConnection of the deleted inbound connection.
1036
+ * The deleted inbound connection.
901
1037
  */
902
1038
  Connection?: InboundConnection;
903
1039
  }
@@ -909,173 +1045,188 @@ declare namespace OpenSearch {
909
1045
  }
910
1046
  export interface DeleteOutboundConnectionResponse {
911
1047
  /**
912
- * The OutboundConnection of the deleted outbound connection.
1048
+ * The deleted inbound connection.
913
1049
  */
914
1050
  Connection?: OutboundConnection;
915
1051
  }
916
1052
  export interface DeletePackageRequest {
917
1053
  /**
918
- * The internal ID of the package you want to delete. Use DescribePackages to find this value.
1054
+ * The internal ID of the package you want to delete. Use DescribePackages to find this value.
919
1055
  */
920
1056
  PackageID: PackageID;
921
1057
  }
922
1058
  export interface DeletePackageResponse {
923
1059
  /**
924
- * PackageDetails
1060
+ * Information about the deleted package.
925
1061
  */
926
1062
  PackageDetails?: PackageDetails;
927
1063
  }
1064
+ export interface DeleteVpcEndpointRequest {
1065
+ /**
1066
+ * The unique identifier of the endpoint.
1067
+ */
1068
+ VpcEndpointId: VpcEndpointId;
1069
+ }
1070
+ export interface DeleteVpcEndpointResponse {
1071
+ /**
1072
+ * Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).
1073
+ */
1074
+ VpcEndpointSummary: VpcEndpointSummary;
1075
+ }
928
1076
  export type DeploymentCloseDateTimeStamp = Date;
929
1077
  export type DeploymentStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE"|string;
930
1078
  export type DeploymentType = string;
931
1079
  export interface DescribeDomainAutoTunesRequest {
932
1080
  /**
933
- * The domain name for which you want Auto-Tune action details.
1081
+ * Name of the domain that you want Auto-Tune details about.
934
1082
  */
935
1083
  DomainName: DomainName;
936
1084
  /**
937
- * Set this value to limit the number of results returned. If not specified, defaults to 100.
1085
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
938
1086
  */
939
1087
  MaxResults?: MaxResults;
940
1088
  /**
941
- * NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.
1089
+ * If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.
942
1090
  */
943
1091
  NextToken?: NextToken;
944
1092
  }
945
1093
  export interface DescribeDomainAutoTunesResponse {
946
1094
  /**
947
- * The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.
1095
+ * The list of setting adjustments that Auto-Tune has made to the domain.
948
1096
  */
949
1097
  AutoTunes?: AutoTuneList;
950
1098
  /**
951
- * An identifier to allow retrieval of paginated results.
1099
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
952
1100
  */
953
1101
  NextToken?: NextToken;
954
1102
  }
955
1103
  export interface DescribeDomainChangeProgressRequest {
956
1104
  /**
957
- * The domain you want to get the progress information about.
1105
+ * The name of the domain to get progress information for.
958
1106
  */
959
1107
  DomainName: DomainName;
960
1108
  /**
961
- * The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.
1109
+ * The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
962
1110
  */
963
1111
  ChangeId?: GUID;
964
1112
  }
965
1113
  export interface DescribeDomainChangeProgressResponse {
966
1114
  /**
967
- * Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.
1115
+ * Container for information about the stages of a configuration change happening on a domain.
968
1116
  */
969
1117
  ChangeProgressStatus?: ChangeProgressStatusDetails;
970
1118
  }
971
1119
  export interface DescribeDomainConfigRequest {
972
1120
  /**
973
- * The domain you want to get information about.
1121
+ * Name of the OpenSearch Service domain configuration that you want to describe.
974
1122
  */
975
1123
  DomainName: DomainName;
976
1124
  }
977
1125
  export interface DescribeDomainConfigResponse {
978
1126
  /**
979
- * The configuration information of the domain requested in the DescribeDomainConfig request.
1127
+ * Container for the configuration of the OpenSearch Service domain.
980
1128
  */
981
1129
  DomainConfig: DomainConfig;
982
1130
  }
983
1131
  export interface DescribeDomainRequest {
984
1132
  /**
985
- * The name of the domain for which you want information.
1133
+ * The name of the domain that you want information about.
986
1134
  */
987
1135
  DomainName: DomainName;
988
1136
  }
989
1137
  export interface DescribeDomainResponse {
990
1138
  /**
991
- * The current status of the domain.
1139
+ * List that contains the status of each specified OpenSearch Service domain.
992
1140
  */
993
1141
  DomainStatus: DomainStatus;
994
1142
  }
995
1143
  export interface DescribeDomainsRequest {
996
1144
  /**
997
- * The domains for which you want information.
1145
+ * Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.
998
1146
  */
999
1147
  DomainNames: DomainNameList;
1000
1148
  }
1001
1149
  export interface DescribeDomainsResponse {
1002
1150
  /**
1003
- * The status of the domains requested in the DescribeDomains request.
1151
+ * The status of the requested domains.
1004
1152
  */
1005
1153
  DomainStatusList: DomainStatusList;
1006
1154
  }
1007
1155
  export interface DescribeInboundConnectionsRequest {
1008
1156
  /**
1009
- * A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are: connection-id local-domain-info.domain-name local-domain-info.owner-id local-domain-info.region remote-domain-info.domain-name
1157
+ * A list of filters used to match properties for inbound cross-cluster connections.
1010
1158
  */
1011
1159
  Filters?: FilterList;
1012
1160
  /**
1013
- * Set this value to limit the number of results returned. If not specified, defaults to 100.
1161
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1014
1162
  */
1015
1163
  MaxResults?: MaxResults;
1016
1164
  /**
1017
- * If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
1165
+ * If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
1018
1166
  */
1019
1167
  NextToken?: NextToken;
1020
1168
  }
1021
1169
  export interface DescribeInboundConnectionsResponse {
1022
1170
  /**
1023
- * A list of InboundConnection matching the specified filter criteria.
1171
+ * List of inbound connections.
1024
1172
  */
1025
1173
  Connections?: InboundConnections;
1026
1174
  /**
1027
- * If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
1175
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1028
1176
  */
1029
1177
  NextToken?: NextToken;
1030
1178
  }
1031
1179
  export interface DescribeInstanceTypeLimitsRequest {
1032
1180
  /**
1033
- * The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.
1181
+ * The name of the domain. Only specify if you need the limits for an existing domain.
1034
1182
  */
1035
1183
  DomainName?: DomainName;
1036
1184
  /**
1037
- * The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.
1185
+ * The OpenSearch Service instance type for which you need limit information.
1038
1186
  */
1039
1187
  InstanceType: OpenSearchPartitionInstanceType;
1040
1188
  /**
1041
- * Version of OpenSearch for which Limits are needed.
1189
+ * Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
1042
1190
  */
1043
1191
  EngineVersion: VersionString;
1044
1192
  }
1045
1193
  export interface DescribeInstanceTypeLimitsResponse {
1194
+ /**
1195
+ * Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.
1196
+ */
1046
1197
  LimitsByRole?: LimitsByRole;
1047
1198
  }
1048
1199
  export interface DescribeOutboundConnectionsRequest {
1049
1200
  /**
1050
- * A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are: connection-id remote-domain-info.domain-name remote-domain-info.owner-id remote-domain-info.region local-domain-info.domain-name
1201
+ * List of filter names and values that you can use for requests.
1051
1202
  */
1052
1203
  Filters?: FilterList;
1053
1204
  /**
1054
- * Set this value to limit the number of results returned. If not specified, defaults to 100.
1205
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1055
1206
  */
1056
1207
  MaxResults?: MaxResults;
1057
1208
  /**
1058
- * NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.
1209
+ * If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.
1059
1210
  */
1060
1211
  NextToken?: NextToken;
1061
1212
  }
1062
1213
  export interface DescribeOutboundConnectionsResponse {
1063
1214
  /**
1064
- * A list of OutboundConnection matching the specified filter criteria.
1215
+ * List of outbound connections that match the filter criteria.
1065
1216
  */
1066
1217
  Connections?: OutboundConnections;
1067
1218
  /**
1068
- * If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
1219
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1069
1220
  */
1070
1221
  NextToken?: NextToken;
1071
1222
  }
1072
1223
  export interface DescribePackagesFilter {
1073
1224
  /**
1074
- * Any field from PackageDetails.
1225
+ * Any field from PackageDetails.
1075
1226
  */
1076
1227
  Name?: DescribePackagesFilterName;
1077
1228
  /**
1078
- * A list of values for the specified field.
1229
+ * A list of values for the specified filter field.
1079
1230
  */
1080
1231
  Value?: DescribePackagesFilterValues;
1081
1232
  }
@@ -1085,160 +1236,180 @@ declare namespace OpenSearch {
1085
1236
  export type DescribePackagesFilterValues = DescribePackagesFilterValue[];
1086
1237
  export interface DescribePackagesRequest {
1087
1238
  /**
1088
- * Only returns packages that match the DescribePackagesFilterList values.
1239
+ * Only returns packages that match the DescribePackagesFilterList values.
1089
1240
  */
1090
1241
  Filters?: DescribePackagesFilterList;
1091
1242
  /**
1092
- * Limits results to a maximum number of packages.
1243
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1093
1244
  */
1094
1245
  MaxResults?: MaxResults;
1095
1246
  /**
1096
- * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
1247
+ * If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
1097
1248
  */
1098
1249
  NextToken?: NextToken;
1099
1250
  }
1100
1251
  export interface DescribePackagesResponse {
1101
1252
  /**
1102
- * List of PackageDetails objects.
1253
+ * Basic information about a package.
1103
1254
  */
1104
1255
  PackageDetailsList?: PackageDetailsList;
1256
+ /**
1257
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1258
+ */
1105
1259
  NextToken?: String;
1106
1260
  }
1107
1261
  export interface DescribeReservedInstanceOfferingsRequest {
1108
1262
  /**
1109
- * The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
1263
+ * The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
1110
1264
  */
1111
1265
  ReservedInstanceOfferingId?: GUID;
1112
1266
  /**
1113
- * Set this value to limit the number of results returned. If not specified, defaults to 100.
1267
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1114
1268
  */
1115
1269
  MaxResults?: MaxResults;
1116
1270
  /**
1117
- * Provides an identifier to allow retrieval of paginated results.
1271
+ * If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
1118
1272
  */
1119
1273
  NextToken?: NextToken;
1120
1274
  }
1121
1275
  export interface DescribeReservedInstanceOfferingsResponse {
1122
1276
  /**
1123
- * Provides an identifier to allow retrieval of paginated results.
1277
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1124
1278
  */
1125
1279
  NextToken?: NextToken;
1126
1280
  /**
1127
- * List of reserved OpenSearch instance offerings
1281
+ * List of Reserved Instance offerings.
1128
1282
  */
1129
1283
  ReservedInstanceOfferings?: ReservedInstanceOfferingList;
1130
1284
  }
1131
1285
  export interface DescribeReservedInstancesRequest {
1132
1286
  /**
1133
- * The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
1287
+ * The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
1134
1288
  */
1135
1289
  ReservedInstanceId?: GUID;
1136
1290
  /**
1137
- * Set this value to limit the number of results returned. If not specified, defaults to 100.
1291
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1138
1292
  */
1139
1293
  MaxResults?: MaxResults;
1140
1294
  /**
1141
- * Provides an identifier to allow retrieval of paginated results.
1295
+ * If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
1142
1296
  */
1143
1297
  NextToken?: NextToken;
1144
1298
  }
1145
1299
  export interface DescribeReservedInstancesResponse {
1146
1300
  /**
1147
- * Provides an identifier to allow retrieval of paginated results.
1301
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1148
1302
  */
1149
1303
  NextToken?: String;
1150
1304
  /**
1151
- * List of reserved OpenSearch instances.
1305
+ * List of Reserved Instances in the current Region.
1152
1306
  */
1153
1307
  ReservedInstances?: ReservedInstanceList;
1154
1308
  }
1309
+ export interface DescribeVpcEndpointsRequest {
1310
+ /**
1311
+ * The unique identifiers of the endpoints to get information about.
1312
+ */
1313
+ VpcEndpointIds: VpcEndpointIdList;
1314
+ }
1315
+ export interface DescribeVpcEndpointsResponse {
1316
+ /**
1317
+ * Information about each requested VPC endpoint.
1318
+ */
1319
+ VpcEndpoints: VpcEndpoints;
1320
+ /**
1321
+ * Any errors associated with the request.
1322
+ */
1323
+ VpcEndpointErrors: VpcEndpointErrorList;
1324
+ }
1155
1325
  export type Description = string;
1156
1326
  export type DisableTimestamp = Date;
1157
1327
  export interface DissociatePackageRequest {
1158
1328
  /**
1159
- * The internal ID of the package to associate with a domain. Use DescribePackages to find this value.
1329
+ * Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
1160
1330
  */
1161
1331
  PackageID: PackageID;
1162
1332
  /**
1163
- * The name of the domain to associate the package with.
1333
+ * Name of the domain to dissociate the package from.
1164
1334
  */
1165
1335
  DomainName: DomainName;
1166
1336
  }
1167
1337
  export interface DissociatePackageResponse {
1168
1338
  /**
1169
- * DomainPackageDetails
1339
+ * Information about a package that has been dissociated from the domain.
1170
1340
  */
1171
1341
  DomainPackageDetails?: DomainPackageDetails;
1172
1342
  }
1343
+ export type DomainArn = string;
1173
1344
  export interface DomainConfig {
1174
1345
  /**
1175
- * String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
1346
+ * The OpenSearch or Elasticsearch version that the domain is running.
1176
1347
  */
1177
1348
  EngineVersion?: VersionStatus;
1178
1349
  /**
1179
- * The ClusterConfig for the domain.
1350
+ * Container for the cluster configuration of a the domain.
1180
1351
  */
1181
1352
  ClusterConfig?: ClusterConfigStatus;
1182
1353
  /**
1183
- * The EBSOptions for the domain.
1354
+ * Container for EBS options configured for an OpenSearch Service domain.
1184
1355
  */
1185
1356
  EBSOptions?: EBSOptionsStatus;
1186
1357
  /**
1187
- * IAM access policy as a JSON-formatted string.
1358
+ * Specifies the access policies for the domain.
1188
1359
  */
1189
1360
  AccessPolicies?: AccessPoliciesStatus;
1190
1361
  /**
1191
- * The SnapshotOptions for the domain.
1362
+ * DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
1192
1363
  */
1193
1364
  SnapshotOptions?: SnapshotOptionsStatus;
1194
1365
  /**
1195
- * The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
1366
+ * The current VPC options for the domain and the status of any updates to their configuration.
1196
1367
  */
1197
1368
  VPCOptions?: VPCDerivedInfoStatus;
1198
1369
  /**
1199
- * The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
1370
+ * Container for Amazon Cognito options for the domain.
1200
1371
  */
1201
1372
  CognitoOptions?: CognitoOptionsStatus;
1202
1373
  /**
1203
- * The EncryptionAtRestOptions for the domain.
1374
+ * Key-value pairs to enable encryption at rest.
1204
1375
  */
1205
1376
  EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus;
1206
1377
  /**
1207
- * The NodeToNodeEncryptionOptions for the domain.
1378
+ * Whether node-to-node encryption is enabled or disabled.
1208
1379
  */
1209
1380
  NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus;
1210
1381
  /**
1211
- * The AdvancedOptions for the domain. See Advanced options for more information.
1382
+ * Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
1212
1383
  */
1213
1384
  AdvancedOptions?: AdvancedOptionsStatus;
1214
1385
  /**
1215
- * Log publishing options for the given domain.
1386
+ * Key-value pairs to configure slow log publishing.
1216
1387
  */
1217
1388
  LogPublishingOptions?: LogPublishingOptionsStatus;
1218
1389
  /**
1219
- * The DomainEndpointOptions for the domain.
1390
+ * Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
1220
1391
  */
1221
1392
  DomainEndpointOptions?: DomainEndpointOptionsStatus;
1222
1393
  /**
1223
- * Specifies AdvancedSecurityOptions for the domain.
1394
+ * Container for fine-grained access control settings for the domain.
1224
1395
  */
1225
1396
  AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus;
1226
1397
  /**
1227
- * Specifies AutoTuneOptions for the domain.
1398
+ * Container for Auto-Tune settings for the domain.
1228
1399
  */
1229
1400
  AutoTuneOptions?: AutoTuneOptionsStatus;
1230
1401
  /**
1231
- * Specifies change details of the domain configuration change.
1402
+ * Container for information about the progress of an existing configuration change.
1232
1403
  */
1233
1404
  ChangeProgressDetails?: ChangeProgressDetails;
1234
1405
  }
1235
1406
  export interface DomainEndpointOptions {
1236
1407
  /**
1237
- * Whether only HTTPS endpoint should be enabled for the domain.
1408
+ * True to require that all traffic to the domain arrive over HTTPS.
1238
1409
  */
1239
1410
  EnforceHTTPS?: Boolean;
1240
1411
  /**
1241
- * Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher. Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
1412
+ * Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher. Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2
1242
1413
  */
1243
1414
  TLSSecurityPolicy?: TLSSecurityPolicy;
1244
1415
  /**
@@ -1246,37 +1417,40 @@ declare namespace OpenSearch {
1246
1417
  */
1247
1418
  CustomEndpointEnabled?: Boolean;
1248
1419
  /**
1249
- * The fully qualified domain for your custom endpoint.
1420
+ * The fully qualified URL for the custom endpoint.
1250
1421
  */
1251
1422
  CustomEndpoint?: DomainNameFqdn;
1252
1423
  /**
1253
- * The ACM certificate ARN for your custom endpoint.
1424
+ * The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
1254
1425
  */
1255
1426
  CustomEndpointCertificateArn?: ARN;
1256
1427
  }
1257
1428
  export interface DomainEndpointOptionsStatus {
1258
1429
  /**
1259
- * Options to configure the endpoint for the domain.
1430
+ * Options to configure the endpoint for a domain.
1260
1431
  */
1261
1432
  Options: DomainEndpointOptions;
1262
1433
  /**
1263
- * The status of the endpoint options for the domain. See OptionStatus for the status information that's included.
1434
+ * The status of the endpoint options for a domain.
1264
1435
  */
1265
1436
  Status: OptionStatus;
1266
1437
  }
1267
1438
  export type DomainId = string;
1268
1439
  export interface DomainInfo {
1269
1440
  /**
1270
- * The DomainName.
1441
+ * Name of the domain.
1271
1442
  */
1272
1443
  DomainName?: DomainName;
1273
1444
  /**
1274
- * Specifies the EngineType of the domain.
1445
+ * The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
1275
1446
  */
1276
1447
  EngineType?: EngineType;
1277
1448
  }
1278
1449
  export type DomainInfoList = DomainInfo[];
1279
1450
  export interface DomainInformationContainer {
1451
+ /**
1452
+ * Information about an Amazon OpenSearch Service domain.
1453
+ */
1280
1454
  AWSDomainInformation?: AWSDomainInformation;
1281
1455
  }
1282
1456
  export type DomainName = string;
@@ -1284,7 +1458,7 @@ declare namespace OpenSearch {
1284
1458
  export type DomainNameList = DomainName[];
1285
1459
  export interface DomainPackageDetails {
1286
1460
  /**
1287
- * The internal ID of the package.
1461
+ * Internal ID of the package.
1288
1462
  */
1289
1463
  PackageID?: PackageID;
1290
1464
  /**
@@ -1292,24 +1466,27 @@ declare namespace OpenSearch {
1292
1466
  */
1293
1467
  PackageName?: PackageName;
1294
1468
  /**
1295
- * Currently supports only TXT-DICTIONARY.
1469
+ * The type of package.
1296
1470
  */
1297
1471
  PackageType?: PackageType;
1298
1472
  /**
1299
- * The timestamp of the most recent update to the package association status.
1473
+ * Timestamp of the most recent update to the package association status.
1300
1474
  */
1301
1475
  LastUpdated?: LastUpdated;
1302
1476
  /**
1303
- * The name of the domain you've associated a package with.
1477
+ * Name of the domain that the package is associated with.
1304
1478
  */
1305
1479
  DomainName?: DomainName;
1306
1480
  /**
1307
- * State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.
1481
+ * State of the association.
1308
1482
  */
1309
1483
  DomainPackageStatus?: DomainPackageStatus;
1484
+ /**
1485
+ * The current version of the package.
1486
+ */
1310
1487
  PackageVersion?: PackageVersion;
1311
1488
  /**
1312
- * The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.
1489
+ * Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.
1313
1490
  */
1314
1491
  ReferencePath?: ReferencePath;
1315
1492
  /**
@@ -1321,80 +1498,83 @@ declare namespace OpenSearch {
1321
1498
  export type DomainPackageStatus = "ASSOCIATING"|"ASSOCIATION_FAILED"|"ACTIVE"|"DISSOCIATING"|"DISSOCIATION_FAILED"|string;
1322
1499
  export interface DomainStatus {
1323
1500
  /**
1324
- * The unique identifier for the specified domain.
1501
+ * Unique identifier for the domain.
1325
1502
  */
1326
1503
  DomainId: DomainId;
1327
1504
  /**
1328
- * The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
1505
+ * Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
1329
1506
  */
1330
1507
  DomainName: DomainName;
1331
1508
  /**
1332
- * The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
1509
+ * The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
1333
1510
  */
1334
1511
  ARN: ARN;
1335
1512
  /**
1336
- * The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
1513
+ * Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
1337
1514
  */
1338
1515
  Created?: Boolean;
1339
1516
  /**
1340
- * The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
1517
+ * Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
1341
1518
  */
1342
1519
  Deleted?: Boolean;
1343
1520
  /**
1344
- * The domain endpoint that you use to submit index and search requests.
1521
+ * Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
1345
1522
  */
1346
1523
  Endpoint?: ServiceUrl;
1347
1524
  /**
1348
- * Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
1525
+ * The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
1349
1526
  */
1350
1527
  Endpoints?: EndpointsMap;
1351
1528
  /**
1352
- * The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
1529
+ * The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
1353
1530
  */
1354
1531
  Processing?: Boolean;
1355
1532
  /**
1356
- * The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
1533
+ * The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
1357
1534
  */
1358
1535
  UpgradeProcessing?: Boolean;
1536
+ /**
1537
+ * Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
1538
+ */
1359
1539
  EngineVersion?: VersionString;
1360
1540
  /**
1361
- * The type and number of instances in the domain.
1541
+ * Container for the cluster configuration of the domain.
1362
1542
  */
1363
1543
  ClusterConfig: ClusterConfig;
1364
1544
  /**
1365
- * The EBSOptions for the specified domain.
1545
+ * Container for EBS-based storage settings for the domain.
1366
1546
  */
1367
1547
  EBSOptions?: EBSOptions;
1368
1548
  /**
1369
- * IAM access policy as a JSON-formatted string.
1549
+ * Identity and Access Management (IAM) policy document specifying the access policies for the domain.
1370
1550
  */
1371
1551
  AccessPolicies?: PolicyDocument;
1372
1552
  /**
1373
- * The status of the SnapshotOptions.
1553
+ * DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
1374
1554
  */
1375
1555
  SnapshotOptions?: SnapshotOptions;
1376
1556
  /**
1377
- * The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
1557
+ * The VPC configuration for the domain.
1378
1558
  */
1379
1559
  VPCOptions?: VPCDerivedInfo;
1380
1560
  /**
1381
- * The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
1561
+ * Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
1382
1562
  */
1383
1563
  CognitoOptions?: CognitoOptions;
1384
1564
  /**
1385
- * The status of the EncryptionAtRestOptions.
1565
+ * Encryption at rest settings for the domain.
1386
1566
  */
1387
1567
  EncryptionAtRestOptions?: EncryptionAtRestOptions;
1388
1568
  /**
1389
- * The status of the NodeToNodeEncryptionOptions.
1569
+ * Whether node-to-node encryption is enabled or disabled.
1390
1570
  */
1391
1571
  NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
1392
1572
  /**
1393
- * The status of the AdvancedOptions.
1573
+ * Key-value pairs that specify advanced configuration options.
1394
1574
  */
1395
1575
  AdvancedOptions?: AdvancedOptions;
1396
1576
  /**
1397
- * Log publishing options for the given domain.
1577
+ * Log publishing options for the domain.
1398
1578
  */
1399
1579
  LogPublishingOptions?: LogPublishingOptions;
1400
1580
  /**
@@ -1402,19 +1582,19 @@ declare namespace OpenSearch {
1402
1582
  */
1403
1583
  ServiceSoftwareOptions?: ServiceSoftwareOptions;
1404
1584
  /**
1405
- * The current status of the domain's endpoint options.
1585
+ * Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
1406
1586
  */
1407
1587
  DomainEndpointOptions?: DomainEndpointOptions;
1408
1588
  /**
1409
- * The current status of the domain's advanced security options.
1589
+ * Settings for fine-grained access control.
1410
1590
  */
1411
1591
  AdvancedSecurityOptions?: AdvancedSecurityOptions;
1412
1592
  /**
1413
- * The current status of the domain's Auto-Tune options.
1593
+ * Auto-Tune settings for the domain.
1414
1594
  */
1415
1595
  AutoTuneOptions?: AutoTuneOptionsOutput;
1416
1596
  /**
1417
- * Specifies change details of the domain configuration change.
1597
+ * Information about a configuration change happening on the domain.
1418
1598
  */
1419
1599
  ChangeProgressDetails?: ChangeProgressDetails;
1420
1600
  }
@@ -1423,50 +1603,50 @@ declare namespace OpenSearch {
1423
1603
  export type DryRun = boolean;
1424
1604
  export interface DryRunResults {
1425
1605
  /**
1426
- * Specifies the way in which Amazon OpenSearch Service applies the update. Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).
1606
+ * Specifies the way in which OpenSearch Service will apply an update. Possible values are: Blue/Green - The update requires a blue/green deployment. DynamicUpdate - No blue/green deployment required Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete. None - The request doesn't include any configuration changes.
1427
1607
  */
1428
1608
  DeploymentType?: DeploymentType;
1429
1609
  /**
1430
- * Contains an optional message associated with the DryRunResults.
1610
+ * A message corresponding to the deployment type.
1431
1611
  */
1432
1612
  Message?: Message;
1433
1613
  }
1434
1614
  export interface Duration {
1435
1615
  /**
1436
- * Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
1616
+ * Integer to specify the value of a maintenance schedule duration.
1437
1617
  */
1438
1618
  Value?: DurationValue;
1439
1619
  /**
1440
- * The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
1620
+ * The unit of measurement for the duration of a maintenance schedule.
1441
1621
  */
1442
1622
  Unit?: TimeUnit;
1443
1623
  }
1444
1624
  export type DurationValue = number;
1445
1625
  export interface EBSOptions {
1446
1626
  /**
1447
- * Whether EBS-based storage is enabled.
1627
+ * Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
1448
1628
  */
1449
1629
  EBSEnabled?: Boolean;
1450
1630
  /**
1451
- * The volume type for EBS-based storage.
1631
+ * Specifies the type of EBS volumes attached to data nodes.
1452
1632
  */
1453
1633
  VolumeType?: VolumeType;
1454
1634
  /**
1455
- * Integer to specify the size of an EBS volume.
1635
+ * Specifies the size (in GiB) of EBS volumes attached to data nodes.
1456
1636
  */
1457
1637
  VolumeSize?: IntegerClass;
1458
1638
  /**
1459
- * The IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
1639
+ * Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
1460
1640
  */
1461
1641
  Iops?: IntegerClass;
1462
1642
  /**
1463
- * The Throughput for GP3 EBS volume (SSD).
1643
+ * Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
1464
1644
  */
1465
1645
  Throughput?: IntegerClass;
1466
1646
  }
1467
1647
  export interface EBSOptionsStatus {
1468
1648
  /**
1469
- * The EBS options for the specified domain.
1649
+ * The configured EBS options for the specified domain.
1470
1650
  */
1471
1651
  Options: EBSOptions;
1472
1652
  /**
@@ -1476,133 +1656,161 @@ declare namespace OpenSearch {
1476
1656
  }
1477
1657
  export interface EncryptionAtRestOptions {
1478
1658
  /**
1479
- * The option to enable encryption at rest.
1659
+ * True to enable encryption at rest.
1480
1660
  */
1481
1661
  Enabled?: Boolean;
1482
1662
  /**
1483
- * The KMS key ID for encryption at rest options.
1663
+ * The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
1484
1664
  */
1485
1665
  KmsKeyId?: KmsKeyId;
1486
1666
  }
1487
1667
  export interface EncryptionAtRestOptionsStatus {
1488
1668
  /**
1489
- * The Encryption At Rest options for the specified domain.
1669
+ * Encryption at rest options for the specified domain.
1490
1670
  */
1491
1671
  Options: EncryptionAtRestOptions;
1492
1672
  /**
1493
- * The status of the Encryption At Rest options for the specified domain.
1673
+ * The status of the encryption at rest options for the specified domain.
1494
1674
  */
1495
1675
  Status: OptionStatus;
1496
1676
  }
1677
+ export type Endpoint = string;
1497
1678
  export type EndpointsMap = {[key: string]: ServiceUrl};
1498
1679
  export type EngineType = "OpenSearch"|"Elasticsearch"|string;
1499
1680
  export interface ErrorDetails {
1681
+ /**
1682
+ * The type of error that occurred.
1683
+ */
1500
1684
  ErrorType?: ErrorType;
1685
+ /**
1686
+ * A message describing the error.
1687
+ */
1501
1688
  ErrorMessage?: ErrorMessage;
1502
1689
  }
1503
1690
  export type ErrorMessage = string;
1504
1691
  export type ErrorType = string;
1505
1692
  export interface Filter {
1506
1693
  /**
1507
- * The name of the filter.
1694
+ * The name of the filter.
1508
1695
  */
1509
1696
  Name?: NonEmptyString;
1510
1697
  /**
1511
- * Contains one or more values for the filter.
1698
+ * One or more values for the filter.
1512
1699
  */
1513
1700
  Values?: ValueStringList;
1514
1701
  }
1515
1702
  export type FilterList = Filter[];
1516
1703
  export type GUID = string;
1517
1704
  export interface GetCompatibleVersionsRequest {
1705
+ /**
1706
+ * The name of an existing domain. Provide this parameter to limit the results to a single domain.
1707
+ */
1518
1708
  DomainName?: DomainName;
1519
1709
  }
1520
1710
  export interface GetCompatibleVersionsResponse {
1521
1711
  /**
1522
- * A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.
1712
+ * A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
1523
1713
  */
1524
1714
  CompatibleVersions?: CompatibleVersionsList;
1525
1715
  }
1526
1716
  export interface GetPackageVersionHistoryRequest {
1527
1717
  /**
1528
- * Returns an audit history of package versions.
1718
+ * The unique identifier of the package.
1529
1719
  */
1530
1720
  PackageID: PackageID;
1531
1721
  /**
1532
- * Limits results to a maximum number of package versions.
1722
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1533
1723
  */
1534
1724
  MaxResults?: MaxResults;
1535
1725
  /**
1536
- * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
1726
+ * If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.
1537
1727
  */
1538
1728
  NextToken?: NextToken;
1539
1729
  }
1540
1730
  export interface GetPackageVersionHistoryResponse {
1731
+ /**
1732
+ * The unique identifier of the package.
1733
+ */
1541
1734
  PackageID?: PackageID;
1542
1735
  /**
1543
- * List of PackageVersionHistory objects.
1736
+ * A list of package versions, along with their creation time and commit message.
1544
1737
  */
1545
1738
  PackageVersionHistoryList?: PackageVersionHistoryList;
1739
+ /**
1740
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1741
+ */
1546
1742
  NextToken?: String;
1547
1743
  }
1548
1744
  export interface GetUpgradeHistoryRequest {
1745
+ /**
1746
+ * The name of an existing domain.
1747
+ */
1549
1748
  DomainName: DomainName;
1749
+ /**
1750
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1751
+ */
1550
1752
  MaxResults?: MaxResults;
1753
+ /**
1754
+ * If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.
1755
+ */
1551
1756
  NextToken?: NextToken;
1552
1757
  }
1553
1758
  export interface GetUpgradeHistoryResponse {
1554
1759
  /**
1555
- * A list of UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.
1760
+ * A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
1556
1761
  */
1557
1762
  UpgradeHistories?: UpgradeHistoryList;
1558
1763
  /**
1559
- * Pagination token that needs to be supplied to the next call to get the next page of results.
1764
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1560
1765
  */
1561
1766
  NextToken?: String;
1562
1767
  }
1563
1768
  export interface GetUpgradeStatusRequest {
1769
+ /**
1770
+ * The domain of the domain to get upgrade status information for.
1771
+ */
1564
1772
  DomainName: DomainName;
1565
1773
  }
1566
1774
  export interface GetUpgradeStatusResponse {
1567
1775
  /**
1568
- * One of three steps an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
1776
+ * One of three steps that an upgrade or upgrade eligibility check goes through.
1569
1777
  */
1570
1778
  UpgradeStep?: UpgradeStep;
1571
1779
  /**
1572
- * One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
1780
+ * The status of the current step that an upgrade is on.
1573
1781
  */
1574
1782
  StepStatus?: UpgradeStatus;
1575
1783
  /**
1576
- * A string that briefly describes the update.
1784
+ * A string that describes the update.
1577
1785
  */
1578
1786
  UpgradeName?: UpgradeName;
1579
1787
  }
1580
1788
  export type IdentityPoolId = string;
1581
1789
  export interface InboundConnection {
1582
1790
  /**
1583
- * The AWSDomainInformation for the local OpenSearch domain.
1791
+ * Information about the source (local) domain.
1584
1792
  */
1585
1793
  LocalDomainInfo?: DomainInformationContainer;
1586
1794
  /**
1587
- * The AWSDomainInformation for the remote OpenSearch domain.
1795
+ * Information about the destination (remote) domain.
1588
1796
  */
1589
1797
  RemoteDomainInfo?: DomainInformationContainer;
1590
1798
  /**
1591
- * The connection ID for the inbound cross-cluster connection.
1799
+ * The unique identifier of the connection.
1592
1800
  */
1593
1801
  ConnectionId?: ConnectionId;
1594
1802
  /**
1595
- * The InboundConnectionStatus for the outbound connection.
1803
+ * The current status of the connection.
1596
1804
  */
1597
1805
  ConnectionStatus?: InboundConnectionStatus;
1598
1806
  }
1599
1807
  export interface InboundConnectionStatus {
1600
1808
  /**
1601
- * The state code for the inbound connection. Can be one of the following: PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner. APPROVED: Inbound connection is pending acceptance by the remote domain owner. PROVISIONING: Inbound connection provisioning is in progress. ACTIVE: Inbound connection is active and ready to use. REJECTING: Inbound connection rejection is in process. REJECTED: Inbound connection is rejected. DELETING: Inbound connection deletion is in progress. DELETED: Inbound connection is deleted and can no longer be used.
1809
+ * The status code for the connection. Can be one of the following: PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner. APPROVED: Inbound connection is pending acceptance by the remote domain owner. PROVISIONING: Inbound connection is being provisioned. ACTIVE: Inbound connection is active and ready to use. REJECTING: Inbound connection rejection is in process. REJECTED: Inbound connection is rejected. DELETING: Inbound connection deletion is in progress. DELETED: Inbound connection is deleted and can no longer be used.
1602
1810
  */
1603
1811
  StatusCode?: InboundConnectionStatusCode;
1604
1812
  /**
1605
- * Verbose information for the inbound connection status.
1813
+ * Information about the connection.
1606
1814
  */
1607
1815
  Message?: ConnectionStatusMessage;
1608
1816
  }
@@ -1610,21 +1818,51 @@ declare namespace OpenSearch {
1610
1818
  export type InboundConnections = InboundConnection[];
1611
1819
  export type InstanceCount = number;
1612
1820
  export interface InstanceCountLimits {
1821
+ /**
1822
+ * The maximum allowed number of instances.
1823
+ */
1613
1824
  MinimumInstanceCount?: MinimumInstanceCount;
1825
+ /**
1826
+ * The minimum allowed number of instances.
1827
+ */
1614
1828
  MaximumInstanceCount?: MaximumInstanceCount;
1615
1829
  }
1616
1830
  export interface InstanceLimits {
1831
+ /**
1832
+ * Limits on the number of instances that can be created for a given instance type.
1833
+ */
1617
1834
  InstanceCountLimits?: InstanceCountLimits;
1618
1835
  }
1619
1836
  export type InstanceRole = string;
1620
1837
  export type InstanceRoleList = InstanceRole[];
1621
1838
  export interface InstanceTypeDetails {
1839
+ /**
1840
+ * The instance type.
1841
+ */
1622
1842
  InstanceType?: OpenSearchPartitionInstanceType;
1843
+ /**
1844
+ * Whether encryption at rest and node-to-node encryption are supported for the instance type.
1845
+ */
1623
1846
  EncryptionEnabled?: Boolean;
1847
+ /**
1848
+ * Whether Amazon Cognito access is supported for the instance type.
1849
+ */
1624
1850
  CognitoEnabled?: Boolean;
1851
+ /**
1852
+ * Whether logging is supported for the instance type.
1853
+ */
1625
1854
  AppLogsEnabled?: Boolean;
1855
+ /**
1856
+ * Whether fine-grained access control is supported for the instance type.
1857
+ */
1626
1858
  AdvancedSecurityEnabled?: Boolean;
1859
+ /**
1860
+ * Whether UltraWarm is supported for the instance type.
1861
+ */
1627
1862
  WarmEnabled?: Boolean;
1863
+ /**
1864
+ * Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
1865
+ */
1628
1866
  InstanceRole?: InstanceRoleList;
1629
1867
  }
1630
1868
  export type InstanceTypeDetailsList = InstanceTypeDetails[];
@@ -1639,57 +1877,81 @@ declare namespace OpenSearch {
1639
1877
  export type LimitValueList = LimitValue[];
1640
1878
  export interface Limits {
1641
1879
  /**
1642
- * Storage-related types and attributes that are available for a given InstanceType.
1880
+ * Storage-related attributes that are available for a given instance type.
1643
1881
  */
1644
1882
  StorageTypes?: StorageTypeList;
1883
+ /**
1884
+ * The limits for a given instance type.
1885
+ */
1645
1886
  InstanceLimits?: InstanceLimits;
1646
1887
  /**
1647
- * List of additional limits that are specific to a given InstanceType and for each of its InstanceRole .
1888
+ * List of additional limits that are specific to a given instance type for each of its instance roles.
1648
1889
  */
1649
1890
  AdditionalLimits?: AdditionalLimitList;
1650
1891
  }
1651
1892
  export type LimitsByRole = {[key: string]: Limits};
1652
1893
  export interface ListDomainNamesRequest {
1653
1894
  /**
1654
- * Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
1895
+ * Filters the output by domain engine type.
1655
1896
  */
1656
1897
  EngineType?: EngineType;
1657
1898
  }
1658
1899
  export interface ListDomainNamesResponse {
1659
1900
  /**
1660
- * List of domain names and respective engine types.
1901
+ * The names of all OpenSearch Service domains owned by the current user and their respective engine types.
1661
1902
  */
1662
1903
  DomainNames?: DomainInfoList;
1663
1904
  }
1664
1905
  export interface ListDomainsForPackageRequest {
1665
1906
  /**
1666
- * The package for which to list associated domains.
1907
+ * The unique identifier of the package for which to list associated domains.
1667
1908
  */
1668
1909
  PackageID: PackageID;
1669
1910
  /**
1670
- * Limits the results to a maximum number of domains.
1911
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1671
1912
  */
1672
1913
  MaxResults?: MaxResults;
1673
1914
  /**
1674
- * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
1915
+ * If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.
1675
1916
  */
1676
1917
  NextToken?: NextToken;
1677
1918
  }
1678
1919
  export interface ListDomainsForPackageResponse {
1679
1920
  /**
1680
- * List of DomainPackageDetails objects.
1921
+ * Information about all domains associated with a package.
1681
1922
  */
1682
1923
  DomainPackageDetailsList?: DomainPackageDetailsList;
1924
+ /**
1925
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1926
+ */
1683
1927
  NextToken?: String;
1684
1928
  }
1685
1929
  export interface ListInstanceTypeDetailsRequest {
1930
+ /**
1931
+ * Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
1932
+ */
1686
1933
  EngineVersion: VersionString;
1934
+ /**
1935
+ * Name of the domain to list instance type details for.
1936
+ */
1687
1937
  DomainName?: DomainName;
1938
+ /**
1939
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1940
+ */
1688
1941
  MaxResults?: MaxResults;
1942
+ /**
1943
+ * If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.
1944
+ */
1689
1945
  NextToken?: NextToken;
1690
1946
  }
1691
1947
  export interface ListInstanceTypeDetailsResponse {
1948
+ /**
1949
+ * Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
1950
+ */
1692
1951
  InstanceTypeDetails?: InstanceTypeDetailsList;
1952
+ /**
1953
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1954
+ */
1693
1955
  NextToken?: NextToken;
1694
1956
  }
1695
1957
  export interface ListPackagesForDomainRequest {
@@ -1698,51 +1960,119 @@ declare namespace OpenSearch {
1698
1960
  */
1699
1961
  DomainName: DomainName;
1700
1962
  /**
1701
- * Limits results to a maximum number of packages.
1963
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1702
1964
  */
1703
1965
  MaxResults?: MaxResults;
1704
1966
  /**
1705
- * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
1967
+ * If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.
1706
1968
  */
1707
1969
  NextToken?: NextToken;
1708
1970
  }
1709
1971
  export interface ListPackagesForDomainResponse {
1710
1972
  /**
1711
- * List of DomainPackageDetails objects.
1973
+ * List of all packages associated with a domain.
1712
1974
  */
1713
1975
  DomainPackageDetailsList?: DomainPackageDetailsList;
1714
1976
  /**
1715
- * Pagination token to supply to the next call to get the next page of results.
1977
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
1716
1978
  */
1717
1979
  NextToken?: String;
1718
1980
  }
1719
1981
  export interface ListTagsRequest {
1720
1982
  /**
1721
- * Specify the ARN of the domain that the tags you want to view are attached to.
1983
+ * Amazon Resource Name (ARN) for the domain to view tags for.
1722
1984
  */
1723
1985
  ARN: ARN;
1724
1986
  }
1725
1987
  export interface ListTagsResponse {
1726
1988
  /**
1727
- * List of Tag for the requested domain.
1989
+ * List of resource tags associated with the specified domain.
1728
1990
  */
1729
1991
  TagList?: TagList;
1730
1992
  }
1731
1993
  export interface ListVersionsRequest {
1732
1994
  /**
1733
- * Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.
1995
+ * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
1734
1996
  */
1735
1997
  MaxResults?: MaxResults;
1998
+ /**
1999
+ * If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.
2000
+ */
1736
2001
  NextToken?: NextToken;
1737
2002
  }
1738
2003
  export interface ListVersionsResponse {
2004
+ /**
2005
+ * A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
2006
+ */
1739
2007
  Versions?: VersionList;
2008
+ /**
2009
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
2010
+ */
1740
2011
  NextToken?: NextToken;
1741
2012
  }
2013
+ export interface ListVpcEndpointAccessRequest {
2014
+ /**
2015
+ * The name of the OpenSearch Service domain to retrieve access information for.
2016
+ */
2017
+ DomainName: DomainName;
2018
+ /**
2019
+ * If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.
2020
+ */
2021
+ NextToken?: NextToken;
2022
+ }
2023
+ export interface ListVpcEndpointAccessResponse {
2024
+ /**
2025
+ * A list of IAM principals that can currently access the domain.
2026
+ */
2027
+ AuthorizedPrincipalList: AuthorizedPrincipalList;
2028
+ /**
2029
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
2030
+ */
2031
+ NextToken: NextToken;
2032
+ }
2033
+ export interface ListVpcEndpointsForDomainRequest {
2034
+ /**
2035
+ * The name of the domain to list associated VPC endpoints for.
2036
+ */
2037
+ DomainName: DomainName;
2038
+ /**
2039
+ * If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.
2040
+ */
2041
+ NextToken?: NextToken;
2042
+ }
2043
+ export interface ListVpcEndpointsForDomainResponse {
2044
+ /**
2045
+ * Information about each endpoint associated with the domain.
2046
+ */
2047
+ VpcEndpointSummaryList: VpcEndpointSummaryList;
2048
+ /**
2049
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
2050
+ */
2051
+ NextToken: NextToken;
2052
+ }
2053
+ export interface ListVpcEndpointsRequest {
2054
+ /**
2055
+ * If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
2056
+ */
2057
+ NextToken?: NextToken;
2058
+ }
2059
+ export interface ListVpcEndpointsResponse {
2060
+ /**
2061
+ * Information about each endpoint.
2062
+ */
2063
+ VpcEndpointSummaryList: VpcEndpointSummaryList;
2064
+ /**
2065
+ * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
2066
+ */
2067
+ NextToken: NextToken;
2068
+ }
1742
2069
  export interface LogPublishingOption {
2070
+ /**
2071
+ * The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
2072
+ */
1743
2073
  CloudWatchLogsLogGroupArn?: CloudWatchLogsLogGroupArn;
1744
2074
  /**
1745
- * Whether the given log publishing option is enabled or not.
2075
+ * Whether the log should be published.
1746
2076
  */
1747
2077
  Enabled?: Boolean;
1748
2078
  }
@@ -1753,7 +2083,7 @@ declare namespace OpenSearch {
1753
2083
  */
1754
2084
  Options?: LogPublishingOptions;
1755
2085
  /**
1756
- * The status of the log publishing options for the domain. See OptionStatus for the status information that's included.
2086
+ * The status of the log publishing options for the domain.
1757
2087
  */
1758
2088
  Status?: OptionStatus;
1759
2089
  }
@@ -1761,15 +2091,15 @@ declare namespace OpenSearch {
1761
2091
  export type Long = number;
1762
2092
  export interface MasterUserOptions {
1763
2093
  /**
1764
- * ARN for the master user (if IAM is enabled).
2094
+ * Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.
1765
2095
  */
1766
2096
  MasterUserARN?: ARN;
1767
2097
  /**
1768
- * The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
2098
+ * User name for the master user. Only specify if InternalUserDatabaseEnabled is true.
1769
2099
  */
1770
2100
  MasterUserName?: Username;
1771
2101
  /**
1772
- * The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
2102
+ * Password for the master user. Only specify if InternalUserDatabaseEnabled is true.
1773
2103
  */
1774
2104
  MasterUserPassword?: Password;
1775
2105
  }
@@ -1800,7 +2130,7 @@ declare namespace OpenSearch {
1800
2130
  export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|string;
1801
2131
  export interface OptionStatus {
1802
2132
  /**
1803
- * The timestamp of when the entity was created.
2133
+ * The timestamp when the entity was created.
1804
2134
  */
1805
2135
  CreationDate: UpdateTimestamp;
1806
2136
  /**
@@ -1812,43 +2142,43 @@ declare namespace OpenSearch {
1812
2142
  */
1813
2143
  UpdateVersion?: UIntValue;
1814
2144
  /**
1815
- * Provides the OptionState for the domain.
2145
+ * The state of the entity.
1816
2146
  */
1817
2147
  State: OptionState;
1818
2148
  /**
1819
- * Indicates whether the domain is being deleted.
2149
+ * Indicates whether the entity is being deleted.
1820
2150
  */
1821
2151
  PendingDeletion?: Boolean;
1822
2152
  }
1823
2153
  export interface OutboundConnection {
1824
2154
  /**
1825
- * The DomainInformation for the local OpenSearch domain.
2155
+ * Information about the source (local) domain.
1826
2156
  */
1827
2157
  LocalDomainInfo?: DomainInformationContainer;
1828
2158
  /**
1829
- * The DomainInformation for the remote OpenSearch domain.
2159
+ * Information about the destination (remote) domain.
1830
2160
  */
1831
2161
  RemoteDomainInfo?: DomainInformationContainer;
1832
2162
  /**
1833
- * The connection ID for the outbound cross-cluster connection.
2163
+ * Unique identifier of the connection.
1834
2164
  */
1835
2165
  ConnectionId?: ConnectionId;
1836
2166
  /**
1837
- * The connection alias for the outbound cross-cluster connection.
2167
+ * Name of the connection.
1838
2168
  */
1839
2169
  ConnectionAlias?: ConnectionAlias;
1840
2170
  /**
1841
- * The OutboundConnectionStatus for the outbound connection.
2171
+ * Status of the connection.
1842
2172
  */
1843
2173
  ConnectionStatus?: OutboundConnectionStatus;
1844
2174
  }
1845
2175
  export interface OutboundConnectionStatus {
1846
2176
  /**
1847
- * The state code for the outbound connection. Can be one of the following: VALIDATING: The outbound connection request is being validated. VALIDATION_FAILED: Validation failed for the connection request. PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner. APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned. PROVISIONING: Outbound connection request is in process. ACTIVE: Outbound connection is active and ready to use. REJECTING: Outbound connection rejection by remote domain owner is in progress. REJECTED: Outbound connection request is rejected by remote domain owner. DELETING: Outbound connection deletion is in progress. DELETED: Outbound connection is deleted and can no longer be used.
2177
+ * The status code for the outbound connection. Can be one of the following: VALIDATING - The outbound connection request is being validated. VALIDATION_FAILED - Validation failed for the connection request. PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner. APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned. PROVISIONING - Outbound connection request is in process. ACTIVE - Outbound connection is active and ready to use. REJECTING - Outbound connection rejection by remote domain owner is in progress. REJECTED - Outbound connection request is rejected by remote domain owner. DELETING - Outbound connection deletion is in progress. DELETED - Outbound connection is deleted and can no longer be used.
1848
2178
  */
1849
2179
  StatusCode?: OutboundConnectionStatusCode;
1850
2180
  /**
1851
- * Verbose information for the outbound connection status.
2181
+ * Verbose information for the outbound connection.
1852
2182
  */
1853
2183
  Message?: ConnectionStatusMessage;
1854
2184
  }
@@ -1859,7 +2189,7 @@ declare namespace OpenSearch {
1859
2189
  export type PackageDescription = string;
1860
2190
  export interface PackageDetails {
1861
2191
  /**
1862
- * Internal ID of the package.
2192
+ * The unique identifier of the package.
1863
2193
  */
1864
2194
  PackageID?: PackageID;
1865
2195
  /**
@@ -1867,7 +2197,7 @@ declare namespace OpenSearch {
1867
2197
  */
1868
2198
  PackageName?: PackageName;
1869
2199
  /**
1870
- * Currently supports only TXT-DICTIONARY.
2200
+ * The type of package.
1871
2201
  */
1872
2202
  PackageType?: PackageType;
1873
2203
  /**
@@ -1875,14 +2205,20 @@ declare namespace OpenSearch {
1875
2205
  */
1876
2206
  PackageDescription?: PackageDescription;
1877
2207
  /**
1878
- * Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
2208
+ * Current status of the package.
1879
2209
  */
1880
2210
  PackageStatus?: PackageStatus;
1881
2211
  /**
1882
- * The timestamp of when the package was created.
2212
+ * The timestamp when the package was created.
1883
2213
  */
1884
2214
  CreatedAt?: CreatedAt;
2215
+ /**
2216
+ * Date and time when the package was last updated.
2217
+ */
1885
2218
  LastUpdatedAt?: LastUpdated;
2219
+ /**
2220
+ * The package version.
2221
+ */
1886
2222
  AvailablePackageVersion?: PackageVersion;
1887
2223
  /**
1888
2224
  * Additional information if the package is in an error state. Null otherwise.
@@ -1911,20 +2247,21 @@ declare namespace OpenSearch {
1911
2247
  */
1912
2248
  PackageVersion?: PackageVersion;
1913
2249
  /**
1914
- * A message associated with the package version.
2250
+ * A message associated with the package version when it was uploaded.
1915
2251
  */
1916
2252
  CommitMessage?: CommitMessage;
1917
2253
  /**
1918
- * The timestamp of when the package was created.
2254
+ * The date and time when the package was created.
1919
2255
  */
1920
2256
  CreatedAt?: CreatedAt;
1921
2257
  }
1922
2258
  export type PackageVersionHistoryList = PackageVersionHistory[];
1923
2259
  export type Password = string;
1924
2260
  export type PolicyDocument = string;
2261
+ export type PrincipalType = "AWS_ACCOUNT"|"AWS_SERVICE"|string;
1925
2262
  export interface PurchaseReservedInstanceOfferingRequest {
1926
2263
  /**
1927
- * The ID of the reserved OpenSearch instance offering to purchase.
2264
+ * The ID of the Reserved Instance offering to purchase.
1928
2265
  */
1929
2266
  ReservedInstanceOfferingId: GUID;
1930
2267
  /**
@@ -1938,7 +2275,7 @@ declare namespace OpenSearch {
1938
2275
  }
1939
2276
  export interface PurchaseReservedInstanceOfferingResponse {
1940
2277
  /**
1941
- * Details of the reserved OpenSearch instance which was purchased.
2278
+ * The ID of the Reserved Instance offering that was purchased.
1942
2279
  */
1943
2280
  ReservedInstanceId?: GUID;
1944
2281
  /**
@@ -1961,23 +2298,23 @@ declare namespace OpenSearch {
1961
2298
  export type Region = string;
1962
2299
  export interface RejectInboundConnectionRequest {
1963
2300
  /**
1964
- * The ID of the inbound connection to reject.
2301
+ * The unique identifier of the inbound connection to reject.
1965
2302
  */
1966
2303
  ConnectionId: ConnectionId;
1967
2304
  }
1968
2305
  export interface RejectInboundConnectionResponse {
1969
2306
  /**
1970
- * The InboundConnection of the rejected inbound connection.
2307
+ * Contains details about the rejected inbound connection.
1971
2308
  */
1972
2309
  Connection?: InboundConnection;
1973
2310
  }
1974
2311
  export interface RemoveTagsRequest {
1975
2312
  /**
1976
- * The ARN of the domain from which you want to delete the specified tags.
2313
+ * The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
1977
2314
  */
1978
2315
  ARN: ARN;
1979
2316
  /**
1980
- * The TagKey list you want to remove from the domain.
2317
+ * The list of tag keys to remove from the domain.
1981
2318
  */
1982
2319
  TagKeys: StringList;
1983
2320
  }
@@ -1991,17 +2328,20 @@ declare namespace OpenSearch {
1991
2328
  * The unique identifier for the reservation.
1992
2329
  */
1993
2330
  ReservedInstanceId?: GUID;
2331
+ /**
2332
+ * The unique identifier of the billing subscription.
2333
+ */
1994
2334
  BillingSubscriptionId?: Long;
1995
2335
  /**
1996
- * The offering identifier.
2336
+ * The unique identifier of the Reserved Instance offering.
1997
2337
  */
1998
2338
  ReservedInstanceOfferingId?: String;
1999
2339
  /**
2000
- * The OpenSearch instance type offered by the reserved instance offering.
2340
+ * The OpenSearch instance type offered by theReserved Instance offering.
2001
2341
  */
2002
2342
  InstanceType?: OpenSearchPartitionInstanceType;
2003
2343
  /**
2004
- * The time the reservation started.
2344
+ * The date and time when the reservation was purchased.
2005
2345
  */
2006
2346
  StartTime?: UpdateTimestamp;
2007
2347
  /**
@@ -2009,15 +2349,15 @@ declare namespace OpenSearch {
2009
2349
  */
2010
2350
  Duration?: Integer;
2011
2351
  /**
2012
- * The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
2352
+ * The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
2013
2353
  */
2014
2354
  FixedPrice?: Double;
2015
2355
  /**
2016
- * The rate you are charged for each hour for the domain that is using this reserved instance.
2356
+ * The hourly rate at which you're charged for the domain using this Reserved Instance.
2017
2357
  */
2018
2358
  UsagePrice?: Double;
2019
2359
  /**
2020
- * The currency code for the reserved OpenSearch instance offering.
2360
+ * The currency code for the offering.
2021
2361
  */
2022
2362
  CurrencyCode?: String;
2023
2363
  /**
@@ -2025,26 +2365,26 @@ declare namespace OpenSearch {
2025
2365
  */
2026
2366
  InstanceCount?: Integer;
2027
2367
  /**
2028
- * The state of the reserved OpenSearch instance.
2368
+ * The state of the Reserved Instance.
2029
2369
  */
2030
2370
  State?: String;
2031
2371
  /**
2032
- * The payment option as defined in the reserved OpenSearch instance offering.
2372
+ * The payment option as defined in the Reserved Instance offering.
2033
2373
  */
2034
2374
  PaymentOption?: ReservedInstancePaymentOption;
2035
2375
  /**
2036
- * The charge to your account regardless of whether you are creating any domains using the instance offering.
2376
+ * The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
2037
2377
  */
2038
2378
  RecurringCharges?: RecurringChargeList;
2039
2379
  }
2040
2380
  export type ReservedInstanceList = ReservedInstance[];
2041
2381
  export interface ReservedInstanceOffering {
2042
2382
  /**
2043
- * The OpenSearch reserved instance offering identifier.
2383
+ * The unique identifier of the Reserved Instance offering.
2044
2384
  */
2045
2385
  ReservedInstanceOfferingId?: GUID;
2046
2386
  /**
2047
- * The OpenSearch instance type offered by the reserved instance offering.
2387
+ * The OpenSearch instance type offered by the Reserved Instance offering.
2048
2388
  */
2049
2389
  InstanceType?: OpenSearchPartitionInstanceType;
2050
2390
  /**
@@ -2052,28 +2392,40 @@ declare namespace OpenSearch {
2052
2392
  */
2053
2393
  Duration?: Integer;
2054
2394
  /**
2055
- * The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.
2395
+ * The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
2056
2396
  */
2057
2397
  FixedPrice?: Double;
2058
2398
  /**
2059
- * The rate you are charged for each hour the domain that is using the offering is running.
2399
+ * The hourly rate at which you're charged for the domain using this Reserved Instance.
2060
2400
  */
2061
2401
  UsagePrice?: Double;
2062
2402
  /**
2063
- * The currency code for the reserved OpenSearch instance offering.
2403
+ * The currency code for the Reserved Instance offering.
2064
2404
  */
2065
2405
  CurrencyCode?: String;
2066
2406
  /**
2067
- * Payment option for the reserved OpenSearch instance offering
2407
+ * Payment option for the Reserved Instance offering
2068
2408
  */
2069
2409
  PaymentOption?: ReservedInstancePaymentOption;
2070
2410
  /**
2071
- * The charge to your account regardless of whether you are creating any domains using the instance offering.
2411
+ * The recurring charge to your account, regardless of whether you creates any domains using the offering.
2072
2412
  */
2073
2413
  RecurringCharges?: RecurringChargeList;
2074
2414
  }
2075
2415
  export type ReservedInstanceOfferingList = ReservedInstanceOffering[];
2076
2416
  export type ReservedInstancePaymentOption = "ALL_UPFRONT"|"PARTIAL_UPFRONT"|"NO_UPFRONT"|string;
2417
+ export interface RevokeVpcEndpointAccessRequest {
2418
+ /**
2419
+ * The name of the OpenSearch Service domain.
2420
+ */
2421
+ DomainName: DomainName;
2422
+ /**
2423
+ * The account ID to revoke access from.
2424
+ */
2425
+ Account: AWSAccount;
2426
+ }
2427
+ export interface RevokeVpcEndpointAccessResponse {
2428
+ }
2077
2429
  export type RoleArn = string;
2078
2430
  export type RollbackOnDisable = "NO_ROLLBACK"|"DEFAULT_ROLLBACK"|string;
2079
2431
  export type S3BucketName = string;
@@ -2081,18 +2433,18 @@ declare namespace OpenSearch {
2081
2433
  export type SAMLEntityId = string;
2082
2434
  export interface SAMLIdp {
2083
2435
  /**
2084
- * The metadata of the SAML application in XML format.
2436
+ * The metadata of the SAML application, in XML format.
2085
2437
  */
2086
2438
  MetadataContent: SAMLMetadata;
2087
2439
  /**
2088
- * The unique entity ID of the application in SAML identity provider.
2440
+ * The unique entity ID of the application in the SAML identity provider.
2089
2441
  */
2090
2442
  EntityId: SAMLEntityId;
2091
2443
  }
2092
2444
  export type SAMLMetadata = string;
2093
2445
  export interface SAMLOptionsInput {
2094
2446
  /**
2095
- * True if SAML is enabled.
2447
+ * True to enable SAML authentication for a domain.
2096
2448
  */
2097
2449
  Enabled?: Boolean;
2098
2450
  /**
@@ -2100,7 +2452,7 @@ declare namespace OpenSearch {
2100
2452
  */
2101
2453
  Idp?: SAMLIdp;
2102
2454
  /**
2103
- * The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
2455
+ * The SAML master user name, which is stored in the domain's internal user database.
2104
2456
  */
2105
2457
  MasterUserName?: Username;
2106
2458
  /**
@@ -2108,7 +2460,7 @@ declare namespace OpenSearch {
2108
2460
  */
2109
2461
  MasterBackendRole?: BackendRole;
2110
2462
  /**
2111
- * Element of the SAML assertion to use for username. Default is NameID.
2463
+ * Element of the SAML assertion to use for the user name. Default is NameID.
2112
2464
  */
2113
2465
  SubjectKey?: String;
2114
2466
  /**
@@ -2116,7 +2468,7 @@ declare namespace OpenSearch {
2116
2468
  */
2117
2469
  RolesKey?: String;
2118
2470
  /**
2119
- * The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
2471
+ * The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
2120
2472
  */
2121
2473
  SessionTimeoutMinutes?: IntegerClass;
2122
2474
  }
@@ -2146,19 +2498,19 @@ declare namespace OpenSearch {
2146
2498
  export type ScheduledAutoTuneDescription = string;
2147
2499
  export interface ScheduledAutoTuneDetails {
2148
2500
  /**
2149
- * The timestamp of the Auto-Tune action scheduled for the domain.
2501
+ * The date and time when the Auto-Tune action is scheduled for the domain.
2150
2502
  */
2151
2503
  Date?: AutoTuneDate;
2152
2504
  /**
2153
- * The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
2505
+ * The type of Auto-Tune action.
2154
2506
  */
2155
2507
  ActionType?: ScheduledAutoTuneActionType;
2156
2508
  /**
2157
- * The Auto-Tune action description.
2509
+ * A description of the Auto-Tune action.
2158
2510
  */
2159
2511
  Action?: ScheduledAutoTuneDescription;
2160
2512
  /**
2161
- * The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
2513
+ * The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.
2162
2514
  */
2163
2515
  Severity?: ScheduledAutoTuneSeverityType;
2164
2516
  }
@@ -2169,38 +2521,38 @@ declare namespace OpenSearch {
2169
2521
  */
2170
2522
  CurrentVersion?: String;
2171
2523
  /**
2172
- * The new service software version if one is available.
2524
+ * The new service software version, if one is available.
2173
2525
  */
2174
2526
  NewVersion?: String;
2175
2527
  /**
2176
- * True if you're able to update your service software version. False if you can't update your service software version.
2528
+ * True if you're able to update your service software version. False if you can't update your service software version.
2177
2529
  */
2178
2530
  UpdateAvailable?: Boolean;
2179
2531
  /**
2180
- * True if you're able to cancel your service software version update. False if you can't cancel your service software update.
2532
+ * True if you're able to cancel your service software version update. False if you can't cancel your service software update.
2181
2533
  */
2182
2534
  Cancellable?: Boolean;
2183
2535
  /**
2184
- * The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
2536
+ * The status of your service software update.
2185
2537
  */
2186
2538
  UpdateStatus?: DeploymentStatus;
2187
2539
  /**
2188
- * The description of the UpdateStatus.
2540
+ * A description of the service software update status.
2189
2541
  */
2190
2542
  Description?: String;
2191
2543
  /**
2192
- * The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
2544
+ * The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
2193
2545
  */
2194
2546
  AutomatedUpdateDate?: DeploymentCloseDateTimeStamp;
2195
2547
  /**
2196
- * True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
2548
+ * True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
2197
2549
  */
2198
2550
  OptionalDeployment?: Boolean;
2199
2551
  }
2200
2552
  export type ServiceUrl = string;
2201
2553
  export interface SnapshotOptions {
2202
2554
  /**
2203
- * The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
2555
+ * The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
2204
2556
  */
2205
2557
  AutomatedSnapshotStartHour?: IntegerClass;
2206
2558
  }
@@ -2223,27 +2575,33 @@ declare namespace OpenSearch {
2223
2575
  }
2224
2576
  export interface StartServiceSoftwareUpdateResponse {
2225
2577
  /**
2226
- * The current status of the OpenSearch service software update.
2578
+ * The current status of the OpenSearch Service software update.
2227
2579
  */
2228
2580
  ServiceSoftwareOptions?: ServiceSoftwareOptions;
2229
2581
  }
2230
2582
  export type StartTimestamp = Date;
2231
2583
  export type StorageSubTypeName = string;
2232
2584
  export interface StorageType {
2585
+ /**
2586
+ * The name of the storage type.
2587
+ */
2233
2588
  StorageTypeName?: StorageTypeName;
2589
+ /**
2590
+ * The storage sub-type, such as gp3 or io1.
2591
+ */
2234
2592
  StorageSubTypeName?: StorageSubTypeName;
2235
2593
  /**
2236
- * Limits that are applicable for the given storage type.
2594
+ * Limits that are applicable for the given storage type.
2237
2595
  */
2238
2596
  StorageTypeLimits?: StorageTypeLimitList;
2239
2597
  }
2240
2598
  export interface StorageTypeLimit {
2241
2599
  /**
2242
- * Name of storage limits that are applicable for the given storage type. If StorageType is "ebs", the following storage options are applicable: MinimumVolumeSize Minimum amount of volume size that is applicable for the given storage type. Can be empty if not applicable. MaximumVolumeSize Maximum amount of volume size that is applicable for the given storage type. Can be empty if not applicable. MaximumIops Maximum amount of Iops that is applicable for given the storage type. Can be empty if not applicable. MinimumIops Minimum amount of Iops that is applicable for given the storage type. Can be empty if not applicable. MaximumThroughput Maximum amount of Throughput that is applicable for given the storage type. Can be empty if not applicable. MinimumThroughput Minimum amount of Throughput that is applicable for given the storage type. Can be empty if not applicable.
2600
+ * Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available: MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable. MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable. MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable. MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable. MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable. MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
2243
2601
  */
2244
2602
  LimitName?: LimitName;
2245
2603
  /**
2246
- * Values for the StorageTypeLimit$LimitName .
2604
+ * The limit values.
2247
2605
  */
2248
2606
  LimitValues?: LimitValueList;
2249
2607
  }
@@ -2255,11 +2613,11 @@ declare namespace OpenSearch {
2255
2613
  export type TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|string;
2256
2614
  export interface Tag {
2257
2615
  /**
2258
- * The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.
2616
+ * The tag key. Tag keys must be unique for the domain to which they are attached.
2259
2617
  */
2260
2618
  Key: TagKey;
2261
2619
  /**
2262
- * The TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
2620
+ * The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
2263
2621
  */
2264
2622
  Value: TagValue;
2265
2623
  }
@@ -2271,15 +2629,15 @@ declare namespace OpenSearch {
2271
2629
  export type UIntValue = number;
2272
2630
  export interface UpdateDomainConfigRequest {
2273
2631
  /**
2274
- * The name of the domain you're updating.
2632
+ * The name of the domain that you're updating.
2275
2633
  */
2276
2634
  DomainName: DomainName;
2277
2635
  /**
2278
- * The type and number of instances to instantiate for the domain cluster.
2636
+ * Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
2279
2637
  */
2280
2638
  ClusterConfig?: ClusterConfig;
2281
2639
  /**
2282
- * Specify the type and size of the EBS volume to use.
2640
+ * The type and size of the EBS volume to attach to instances in the domain.
2283
2641
  */
2284
2642
  EBSOptions?: EBSOptions;
2285
2643
  /**
@@ -2287,47 +2645,47 @@ declare namespace OpenSearch {
2287
2645
  */
2288
2646
  SnapshotOptions?: SnapshotOptions;
2289
2647
  /**
2290
- * Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
2648
+ * Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
2291
2649
  */
2292
2650
  VPCOptions?: VPCOptions;
2293
2651
  /**
2294
- * Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
2652
+ * Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
2295
2653
  */
2296
2654
  CognitoOptions?: CognitoOptions;
2297
2655
  /**
2298
- * Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced options for more information.
2656
+ * Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error. "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain. For more information, see Advanced cluster parameters.
2299
2657
  */
2300
2658
  AdvancedOptions?: AdvancedOptions;
2301
2659
  /**
2302
- * IAM access policy as a JSON-formatted string.
2660
+ * Identity and Access Management (IAM) access policy as a JSON-formatted string.
2303
2661
  */
2304
2662
  AccessPolicies?: PolicyDocument;
2305
2663
  /**
2306
- * Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
2664
+ * Options to publish OpenSearch lots to Amazon CloudWatch Logs.
2307
2665
  */
2308
2666
  LogPublishingOptions?: LogPublishingOptions;
2309
2667
  /**
2310
- * Specifies encryption of data at rest options.
2668
+ * Encryption at rest options for the domain.
2311
2669
  */
2312
2670
  EncryptionAtRestOptions?: EncryptionAtRestOptions;
2313
2671
  /**
2314
- * Options to specify configuration that will be applied to the domain endpoint.
2672
+ * Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
2315
2673
  */
2316
2674
  DomainEndpointOptions?: DomainEndpointOptions;
2317
2675
  /**
2318
- * Specifies node-to-node encryption options.
2676
+ * Node-To-Node Encryption options for the domain.
2319
2677
  */
2320
2678
  NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
2321
2679
  /**
2322
- * Specifies advanced security options.
2680
+ * Options for fine-grained access control.
2323
2681
  */
2324
2682
  AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
2325
2683
  /**
2326
- * Specifies Auto-Tune options.
2684
+ * Options for Auto-Tune.
2327
2685
  */
2328
2686
  AutoTuneOptions?: AutoTuneOptions;
2329
2687
  /**
2330
- * This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
2688
+ * This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.
2331
2689
  */
2332
2690
  DryRun?: DryRun;
2333
2691
  }
@@ -2337,7 +2695,7 @@ declare namespace OpenSearch {
2337
2695
  */
2338
2696
  DomainConfig: DomainConfig;
2339
2697
  /**
2340
- * Contains result of DryRun.
2698
+ * Results of a dry run performed in an update domain request.
2341
2699
  */
2342
2700
  DryRunResults?: DryRunResults;
2343
2701
  }
@@ -2346,64 +2704,101 @@ declare namespace OpenSearch {
2346
2704
  * The unique identifier for the package.
2347
2705
  */
2348
2706
  PackageID: PackageID;
2707
+ /**
2708
+ * Amazon S3 bucket and key for the package.
2709
+ */
2349
2710
  PackageSource: PackageSource;
2350
2711
  /**
2351
2712
  * A new description of the package.
2352
2713
  */
2353
2714
  PackageDescription?: PackageDescription;
2354
2715
  /**
2355
- * A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.
2716
+ * Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.
2356
2717
  */
2357
2718
  CommitMessage?: CommitMessage;
2358
2719
  }
2359
2720
  export interface UpdatePackageResponse {
2360
2721
  /**
2361
- * Information about the package.
2722
+ * Information about a package.
2362
2723
  */
2363
2724
  PackageDetails?: PackageDetails;
2364
2725
  }
2365
2726
  export type UpdateTimestamp = Date;
2727
+ export interface UpdateVpcEndpointRequest {
2728
+ /**
2729
+ * The unique identifier of the endpoint.
2730
+ */
2731
+ VpcEndpointId: VpcEndpointId;
2732
+ /**
2733
+ * The security groups and/or subnets to add, remove, or modify.
2734
+ */
2735
+ VpcOptions: VPCOptions;
2736
+ }
2737
+ export interface UpdateVpcEndpointResponse {
2738
+ /**
2739
+ * The endpoint to be updated.
2740
+ */
2741
+ VpcEndpoint: VpcEndpoint;
2742
+ }
2366
2743
  export interface UpgradeDomainRequest {
2744
+ /**
2745
+ * Name of the OpenSearch Service domain that you want to upgrade.
2746
+ */
2367
2747
  DomainName: DomainName;
2368
2748
  /**
2369
- * The version of OpenSearch you intend to upgrade the domain to.
2749
+ * OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
2370
2750
  */
2371
2751
  TargetVersion: VersionString;
2372
2752
  /**
2373
- * When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
2753
+ * When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
2374
2754
  */
2375
2755
  PerformCheckOnly?: Boolean;
2756
+ /**
2757
+ * Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
2758
+ */
2376
2759
  AdvancedOptions?: AdvancedOptions;
2377
2760
  }
2378
2761
  export interface UpgradeDomainResponse {
2762
+ /**
2763
+ * The unique identifier of the domain upgrade.
2764
+ */
2379
2765
  UpgradeId?: String;
2766
+ /**
2767
+ * The name of the domain that was upgraded.
2768
+ */
2380
2769
  DomainName?: DomainName;
2381
2770
  /**
2382
- * The version of OpenSearch that you intend to upgrade the domain to.
2771
+ * OpenSearch or Elasticsearch version that the domain was upgraded to.
2383
2772
  */
2384
2773
  TargetVersion?: VersionString;
2385
2774
  /**
2386
- * When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
2775
+ * When true, indicates that an upgrade eligibility check was performed.
2387
2776
  */
2388
2777
  PerformCheckOnly?: Boolean;
2778
+ /**
2779
+ * The advanced options configuration for the domain.
2780
+ */
2389
2781
  AdvancedOptions?: AdvancedOptions;
2782
+ /**
2783
+ * Container for information about a configuration change happening on a domain.
2784
+ */
2390
2785
  ChangeProgressDetails?: ChangeProgressDetails;
2391
2786
  }
2392
2787
  export interface UpgradeHistory {
2393
2788
  /**
2394
- * A string that briefly describes the upgrade.
2789
+ * A string that describes the upgrade.
2395
2790
  */
2396
2791
  UpgradeName?: UpgradeName;
2397
2792
  /**
2398
- * UTC timestamp at which the upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
2793
+ * UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.
2399
2794
  */
2400
2795
  StartTimestamp?: StartTimestamp;
2401
2796
  /**
2402
- * The current status of the upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
2797
+ * The current status of the upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
2403
2798
  */
2404
2799
  UpgradeStatus?: UpgradeStatus;
2405
2800
  /**
2406
- * A list of UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.
2801
+ * A list of each step performed as part of a specific upgrade or upgrade eligibility check.
2407
2802
  */
2408
2803
  StepsList?: UpgradeStepsList;
2409
2804
  }
@@ -2413,11 +2808,11 @@ declare namespace OpenSearch {
2413
2808
  export type UpgradeStep = "PRE_UPGRADE_CHECK"|"SNAPSHOT"|"UPGRADE"|string;
2414
2809
  export interface UpgradeStepItem {
2415
2810
  /**
2416
- * One of three steps an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
2811
+ * One of three steps that an upgrade or upgrade eligibility check goes through: PreUpgradeCheck Snapshot Upgrade
2417
2812
  */
2418
2813
  UpgradeStep?: UpgradeStep;
2419
2814
  /**
2420
- * The current status of the upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
2815
+ * The current status of the upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
2421
2816
  */
2422
2817
  UpgradeStepStatus?: UpgradeStatus;
2423
2818
  /**
@@ -2434,19 +2829,19 @@ declare namespace OpenSearch {
2434
2829
  export type Username = string;
2435
2830
  export interface VPCDerivedInfo {
2436
2831
  /**
2437
- * The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
2832
+ * The ID for your VPC. Amazon VPC generates this value when you create a VPC.
2438
2833
  */
2439
2834
  VPCId?: String;
2440
2835
  /**
2441
- * The subnets for the VPC endpoint.
2836
+ * A list of subnet IDs associated with the VPC endpoints for the domain.
2442
2837
  */
2443
2838
  SubnetIds?: StringList;
2444
2839
  /**
2445
- * The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
2840
+ * The list of Availability Zones associated with the VPC subnets.
2446
2841
  */
2447
2842
  AvailabilityZones?: StringList;
2448
2843
  /**
2449
- * The security groups for the VPC endpoint.
2844
+ * The list of security group IDs associated with the VPC endpoints for the domain.
2450
2845
  */
2451
2846
  SecurityGroupIds?: StringList;
2452
2847
  }
@@ -2462,11 +2857,11 @@ declare namespace OpenSearch {
2462
2857
  }
2463
2858
  export interface VPCOptions {
2464
2859
  /**
2465
- * The subnets for the VPC endpoint.
2860
+ * A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
2466
2861
  */
2467
2862
  SubnetIds?: StringList;
2468
2863
  /**
2469
- * The security groups for the VPC endpoint.
2864
+ * The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
2470
2865
  */
2471
2866
  SecurityGroupIds?: StringList;
2472
2867
  }
@@ -2474,19 +2869,84 @@ declare namespace OpenSearch {
2474
2869
  export type VersionList = VersionString[];
2475
2870
  export interface VersionStatus {
2476
2871
  /**
2477
- * The OpenSearch version for the specified OpenSearch domain.
2872
+ * The OpenSearch or Elasticsearch version for the specified domain.
2478
2873
  */
2479
2874
  Options: VersionString;
2480
2875
  /**
2481
- * The status of the OpenSearch version options for the specified OpenSearch domain.
2876
+ * The status of the version options for the specified domain.
2482
2877
  */
2483
2878
  Status: OptionStatus;
2484
2879
  }
2485
2880
  export type VersionString = string;
2486
2881
  export type VolumeType = "standard"|"gp2"|"io1"|"gp3"|string;
2882
+ export interface VpcEndpoint {
2883
+ /**
2884
+ * The unique identifier of the endpoint.
2885
+ */
2886
+ VpcEndpointId?: VpcEndpointId;
2887
+ /**
2888
+ * The creator of the endpoint.
2889
+ */
2890
+ VpcEndpointOwner?: AWSAccount;
2891
+ /**
2892
+ * The Amazon Resource Name (ARN) of the domain associated with the endpoint.
2893
+ */
2894
+ DomainArn?: DomainArn;
2895
+ /**
2896
+ * Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
2897
+ */
2898
+ VpcOptions?: VPCDerivedInfo;
2899
+ /**
2900
+ * The current status of the endpoint.
2901
+ */
2902
+ Status?: VpcEndpointStatus;
2903
+ /**
2904
+ * The connection endpoint ID for connecting to the domain.
2905
+ */
2906
+ Endpoint?: Endpoint;
2907
+ }
2908
+ export interface VpcEndpointError {
2909
+ /**
2910
+ * The unique identifier of the endpoint.
2911
+ */
2912
+ VpcEndpointId?: VpcEndpointId;
2913
+ /**
2914
+ * The code associated with the error.
2915
+ */
2916
+ ErrorCode?: VpcEndpointErrorCode;
2917
+ /**
2918
+ * A message describing the error.
2919
+ */
2920
+ ErrorMessage?: String;
2921
+ }
2922
+ export type VpcEndpointErrorCode = "ENDPOINT_NOT_FOUND"|"SERVER_ERROR"|string;
2923
+ export type VpcEndpointErrorList = VpcEndpointError[];
2924
+ export type VpcEndpointId = string;
2925
+ export type VpcEndpointIdList = VpcEndpointId[];
2926
+ export type VpcEndpointStatus = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETE_FAILED"|string;
2927
+ export interface VpcEndpointSummary {
2928
+ /**
2929
+ * The unique identifier of the endpoint.
2930
+ */
2931
+ VpcEndpointId?: VpcEndpointId;
2932
+ /**
2933
+ * The creator of the endpoint.
2934
+ */
2935
+ VpcEndpointOwner?: String;
2936
+ /**
2937
+ * The Amazon Resource Name (ARN) of the domain associated with the endpoint.
2938
+ */
2939
+ DomainArn?: DomainArn;
2940
+ /**
2941
+ * The current status of the endpoint.
2942
+ */
2943
+ Status?: VpcEndpointStatus;
2944
+ }
2945
+ export type VpcEndpointSummaryList = VpcEndpointSummary[];
2946
+ export type VpcEndpoints = VpcEndpoint[];
2487
2947
  export interface ZoneAwarenessConfig {
2488
2948
  /**
2489
- * An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
2949
+ * If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.
2490
2950
  */
2491
2951
  AvailabilityZoneCount?: IntegerClass;
2492
2952
  }