aws-sdk-opensearchservice 1.17.0 → 1.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +88 -11
- data/lib/aws-sdk-opensearchservice/client_api.rb +68 -0
- data/lib/aws-sdk-opensearchservice/endpoints.rb +14 -0
- data/lib/aws-sdk-opensearchservice/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-opensearchservice/types.rb +240 -33
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 95184feff42bd9959eb47780c105793dc956623d15f813feeb3dda04015c09a0
|
4
|
+
data.tar.gz: 83c0bc304cdfc7e6480f4a385d676f0027a167b6217922ece6183b3786bb7d0f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f61a3dbc449334540a20ca32d244e7c5f972db5587fd0e80e9021649c2bc32f5db57c4fb9c8502f54a11eb1895fbed4588b5eb93bd43d1e75462b78d198f84f5
|
7
|
+
data.tar.gz: 67c2eef8a2ad157a1f23cbc22cf79789e6c0f5d9e2ad2f868653d4dbbd85cf79b11b0fd54d056550afdb34015438a2c9ae7e9edc3051a3c2de348eac4e8f0a58
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.18.0 (2023-05-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon OpenSearch Service adds the option to deploy a domain across multiple Availability Zones, with each AZ containing a complete copy of data and with nodes in one AZ acting as a standby. This option provides 99.99% availability and consistent performance in the event of infrastructure failure.
|
8
|
+
|
4
9
|
1.17.0 (2023-02-22)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.18.0
|
@@ -724,6 +724,7 @@ module Aws::OpenSearchService
|
|
724
724
|
# cold_storage_options: {
|
725
725
|
# enabled: false, # required
|
726
726
|
# },
|
727
|
+
# multi_az_with_standby_enabled: false,
|
727
728
|
# },
|
728
729
|
# ebs_options: {
|
729
730
|
# ebs_enabled: false,
|
@@ -849,6 +850,7 @@ module Aws::OpenSearchService
|
|
849
850
|
# resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
850
851
|
# resp.domain_status.cluster_config.warm_count #=> Integer
|
851
852
|
# resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
|
853
|
+
# resp.domain_status.cluster_config.multi_az_with_standby_enabled #=> Boolean
|
852
854
|
# resp.domain_status.ebs_options.ebs_enabled #=> Boolean
|
853
855
|
# resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
|
854
856
|
# resp.domain_status.ebs_options.volume_size #=> Integer
|
@@ -1005,7 +1007,7 @@ module Aws::OpenSearchService
|
|
1005
1007
|
# Unique name for the package.
|
1006
1008
|
#
|
1007
1009
|
# @option params [required, String] :package_type
|
1008
|
-
#
|
1010
|
+
# The type of package.
|
1009
1011
|
#
|
1010
1012
|
# @option params [String] :package_description
|
1011
1013
|
# Description of the package.
|
@@ -1143,6 +1145,7 @@ module Aws::OpenSearchService
|
|
1143
1145
|
# resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
1144
1146
|
# resp.domain_status.cluster_config.warm_count #=> Integer
|
1145
1147
|
# resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
|
1148
|
+
# resp.domain_status.cluster_config.multi_az_with_standby_enabled #=> Boolean
|
1146
1149
|
# resp.domain_status.ebs_options.ebs_enabled #=> Boolean
|
1147
1150
|
# resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
|
1148
1151
|
# resp.domain_status.ebs_options.volume_size #=> Integer
|
@@ -1416,6 +1419,7 @@ module Aws::OpenSearchService
|
|
1416
1419
|
# resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
1417
1420
|
# resp.domain_status.cluster_config.warm_count #=> Integer
|
1418
1421
|
# resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
|
1422
|
+
# resp.domain_status.cluster_config.multi_az_with_standby_enabled #=> Boolean
|
1419
1423
|
# resp.domain_status.ebs_options.ebs_enabled #=> Boolean
|
1420
1424
|
# resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
|
1421
1425
|
# resp.domain_status.ebs_options.volume_size #=> Integer
|
@@ -1626,6 +1630,7 @@ module Aws::OpenSearchService
|
|
1626
1630
|
# resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
1627
1631
|
# resp.domain_config.cluster_config.options.warm_count #=> Integer
|
1628
1632
|
# resp.domain_config.cluster_config.options.cold_storage_options.enabled #=> Boolean
|
1633
|
+
# resp.domain_config.cluster_config.options.multi_az_with_standby_enabled #=> Boolean
|
1629
1634
|
# resp.domain_config.cluster_config.status.creation_date #=> Time
|
1630
1635
|
# resp.domain_config.cluster_config.status.update_date #=> Time
|
1631
1636
|
# resp.domain_config.cluster_config.status.update_version #=> Integer
|
@@ -1767,6 +1772,67 @@ module Aws::OpenSearchService
|
|
1767
1772
|
req.send_request(options)
|
1768
1773
|
end
|
1769
1774
|
|
1775
|
+
# Returns information about domain and node health, the standby
|
1776
|
+
# Availability Zone, number of nodes per Availability Zone, and shard
|
1777
|
+
# count per node.
|
1778
|
+
#
|
1779
|
+
# @option params [required, String] :domain_name
|
1780
|
+
# The name of the domain.
|
1781
|
+
#
|
1782
|
+
# @return [Types::DescribeDomainHealthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1783
|
+
#
|
1784
|
+
# * {Types::DescribeDomainHealthResponse#domain_state #domain_state} => String
|
1785
|
+
# * {Types::DescribeDomainHealthResponse#availability_zone_count #availability_zone_count} => String
|
1786
|
+
# * {Types::DescribeDomainHealthResponse#active_availability_zone_count #active_availability_zone_count} => String
|
1787
|
+
# * {Types::DescribeDomainHealthResponse#stand_by_availability_zone_count #stand_by_availability_zone_count} => String
|
1788
|
+
# * {Types::DescribeDomainHealthResponse#data_node_count #data_node_count} => String
|
1789
|
+
# * {Types::DescribeDomainHealthResponse#dedicated_master #dedicated_master} => Boolean
|
1790
|
+
# * {Types::DescribeDomainHealthResponse#master_eligible_node_count #master_eligible_node_count} => String
|
1791
|
+
# * {Types::DescribeDomainHealthResponse#warm_node_count #warm_node_count} => String
|
1792
|
+
# * {Types::DescribeDomainHealthResponse#master_node #master_node} => String
|
1793
|
+
# * {Types::DescribeDomainHealthResponse#cluster_health #cluster_health} => String
|
1794
|
+
# * {Types::DescribeDomainHealthResponse#total_shards #total_shards} => String
|
1795
|
+
# * {Types::DescribeDomainHealthResponse#total_un_assigned_shards #total_un_assigned_shards} => String
|
1796
|
+
# * {Types::DescribeDomainHealthResponse#environment_information #environment_information} => Array<Types::EnvironmentInfo>
|
1797
|
+
#
|
1798
|
+
# @example Request syntax with placeholder values
|
1799
|
+
#
|
1800
|
+
# resp = client.describe_domain_health({
|
1801
|
+
# domain_name: "DomainName", # required
|
1802
|
+
# })
|
1803
|
+
#
|
1804
|
+
# @example Response structure
|
1805
|
+
#
|
1806
|
+
# resp.domain_state #=> String, one of "Active", "Processing", "NotAvailable"
|
1807
|
+
# resp.availability_zone_count #=> String
|
1808
|
+
# resp.active_availability_zone_count #=> String
|
1809
|
+
# resp.stand_by_availability_zone_count #=> String
|
1810
|
+
# resp.data_node_count #=> String
|
1811
|
+
# resp.dedicated_master #=> Boolean
|
1812
|
+
# resp.master_eligible_node_count #=> String
|
1813
|
+
# resp.warm_node_count #=> String
|
1814
|
+
# resp.master_node #=> String, one of "Available", "UnAvailable"
|
1815
|
+
# resp.cluster_health #=> String, one of "Red", "Yellow", "Green", "NotAvailable"
|
1816
|
+
# resp.total_shards #=> String
|
1817
|
+
# resp.total_un_assigned_shards #=> String
|
1818
|
+
# resp.environment_information #=> Array
|
1819
|
+
# resp.environment_information[0].availability_zone_information #=> Array
|
1820
|
+
# resp.environment_information[0].availability_zone_information[0].availability_zone_name #=> String
|
1821
|
+
# resp.environment_information[0].availability_zone_information[0].zone_status #=> String, one of "Active", "StandBy", "NotAvailable"
|
1822
|
+
# resp.environment_information[0].availability_zone_information[0].configured_data_node_count #=> String
|
1823
|
+
# resp.environment_information[0].availability_zone_information[0].available_data_node_count #=> String
|
1824
|
+
# resp.environment_information[0].availability_zone_information[0].total_shards #=> String
|
1825
|
+
# resp.environment_information[0].availability_zone_information[0].total_un_assigned_shards #=> String
|
1826
|
+
#
|
1827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealth AWS API Documentation
|
1828
|
+
#
|
1829
|
+
# @overload describe_domain_health(params = {})
|
1830
|
+
# @param [Hash] params ({})
|
1831
|
+
def describe_domain_health(params = {}, options = {})
|
1832
|
+
req = build_request(:describe_domain_health, params)
|
1833
|
+
req.send_request(options)
|
1834
|
+
end
|
1835
|
+
|
1770
1836
|
# Returns domain configuration information about the specified Amazon
|
1771
1837
|
# OpenSearch Service domains.
|
1772
1838
|
#
|
@@ -1810,6 +1876,7 @@ module Aws::OpenSearchService
|
|
1810
1876
|
# resp.domain_status_list[0].cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
1811
1877
|
# resp.domain_status_list[0].cluster_config.warm_count #=> Integer
|
1812
1878
|
# resp.domain_status_list[0].cluster_config.cold_storage_options.enabled #=> Boolean
|
1879
|
+
# resp.domain_status_list[0].cluster_config.multi_az_with_standby_enabled #=> Boolean
|
1813
1880
|
# resp.domain_status_list[0].ebs_options.ebs_enabled #=> Boolean
|
1814
1881
|
# resp.domain_status_list[0].ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
|
1815
1882
|
# resp.domain_status_list[0].ebs_options.volume_size #=> Integer
|
@@ -1942,6 +2009,7 @@ module Aws::OpenSearchService
|
|
1942
2009
|
# resp.dry_run_config.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
1943
2010
|
# resp.dry_run_config.cluster_config.warm_count #=> Integer
|
1944
2011
|
# resp.dry_run_config.cluster_config.cold_storage_options.enabled #=> Boolean
|
2012
|
+
# resp.dry_run_config.cluster_config.multi_az_with_standby_enabled #=> Boolean
|
1945
2013
|
# resp.dry_run_config.ebs_options.ebs_enabled #=> Boolean
|
1946
2014
|
# resp.dry_run_config.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
|
1947
2015
|
# resp.dry_run_config.ebs_options.volume_size #=> Integer
|
@@ -2524,7 +2592,8 @@ module Aws::OpenSearchService
|
|
2524
2592
|
end
|
2525
2593
|
|
2526
2594
|
# Returns a list of Amazon OpenSearch Service package versions, along
|
2527
|
-
# with their creation time
|
2595
|
+
# with their creation time, commit message, and plugin properties (if
|
2596
|
+
# the package is a zip plugin package). For more information, see
|
2528
2597
|
# [Custom packages for Amazon OpenSearch Service][1].
|
2529
2598
|
#
|
2530
2599
|
#
|
@@ -2761,12 +2830,12 @@ module Aws::OpenSearchService
|
|
2761
2830
|
# or Elasticsearch version.
|
2762
2831
|
#
|
2763
2832
|
# @option params [required, String] :engine_version
|
2764
|
-
#
|
2833
|
+
# The version of OpenSearch or Elasticsearch, in the format
|
2765
2834
|
# Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest version
|
2766
2835
|
# of OpenSearch.
|
2767
2836
|
#
|
2768
2837
|
# @option params [String] :domain_name
|
2769
|
-
#
|
2838
|
+
# The name of the domain.
|
2770
2839
|
#
|
2771
2840
|
# @option params [Integer] :max_results
|
2772
2841
|
# An optional parameter that specifies the maximum number of results to
|
@@ -2778,6 +2847,14 @@ module Aws::OpenSearchService
|
|
2778
2847
|
# `ListInstanceTypeDetails` operations, which returns results in the
|
2779
2848
|
# next page.
|
2780
2849
|
#
|
2850
|
+
# @option params [Boolean] :retrieve_a_zs
|
2851
|
+
# An optional parameter that specifies the Availability Zones for the
|
2852
|
+
# domain.
|
2853
|
+
#
|
2854
|
+
# @option params [String] :instance_type
|
2855
|
+
# An optional parameter that lists information for a given instance
|
2856
|
+
# type.
|
2857
|
+
#
|
2781
2858
|
# @return [Types::ListInstanceTypeDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2782
2859
|
#
|
2783
2860
|
# * {Types::ListInstanceTypeDetailsResponse#instance_type_details #instance_type_details} => Array<Types::InstanceTypeDetails>
|
@@ -2792,6 +2869,8 @@ module Aws::OpenSearchService
|
|
2792
2869
|
# domain_name: "DomainName",
|
2793
2870
|
# max_results: 1,
|
2794
2871
|
# next_token: "NextToken",
|
2872
|
+
# retrieve_a_zs: false,
|
2873
|
+
# instance_type: "InstanceTypeString",
|
2795
2874
|
# })
|
2796
2875
|
#
|
2797
2876
|
# @example Response structure
|
@@ -2805,6 +2884,8 @@ module Aws::OpenSearchService
|
|
2805
2884
|
# resp.instance_type_details[0].warm_enabled #=> Boolean
|
2806
2885
|
# resp.instance_type_details[0].instance_role #=> Array
|
2807
2886
|
# resp.instance_type_details[0].instance_role[0] #=> String
|
2887
|
+
# resp.instance_type_details[0].availability_zones #=> Array
|
2888
|
+
# resp.instance_type_details[0].availability_zones[0] #=> String
|
2808
2889
|
# resp.next_token #=> String
|
2809
2890
|
#
|
2810
2891
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails AWS API Documentation
|
@@ -3388,12 +3469,6 @@ module Aws::OpenSearchService
|
|
3388
3469
|
# with more than the permitted number of clauses result in a
|
3389
3470
|
# `TooManyClauses` error.
|
3390
3471
|
#
|
3391
|
-
# * `"override_main_response_version": "true" | "false"` - Note the use
|
3392
|
-
# of a string rather than a boolean. Specifies whether the domain
|
3393
|
-
# reports its version as 7.10 to allow Elasticsearch OSS clients and
|
3394
|
-
# plugins to continue working with it. Default is false when creating
|
3395
|
-
# a domain and true when upgrading a domain.
|
3396
|
-
#
|
3397
3472
|
# For more information, see [Advanced cluster parameters][1].
|
3398
3473
|
#
|
3399
3474
|
#
|
@@ -3474,6 +3549,7 @@ module Aws::OpenSearchService
|
|
3474
3549
|
# cold_storage_options: {
|
3475
3550
|
# enabled: false, # required
|
3476
3551
|
# },
|
3552
|
+
# multi_az_with_standby_enabled: false,
|
3477
3553
|
# },
|
3478
3554
|
# ebs_options: {
|
3479
3555
|
# ebs_enabled: false,
|
@@ -3591,6 +3667,7 @@ module Aws::OpenSearchService
|
|
3591
3667
|
# resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
|
3592
3668
|
# resp.domain_config.cluster_config.options.warm_count #=> Integer
|
3593
3669
|
# resp.domain_config.cluster_config.options.cold_storage_options.enabled #=> Boolean
|
3670
|
+
# resp.domain_config.cluster_config.options.multi_az_with_standby_enabled #=> Boolean
|
3594
3671
|
# resp.domain_config.cluster_config.status.creation_date #=> Time
|
3595
3672
|
# resp.domain_config.cluster_config.status.update_date #=> Time
|
3596
3673
|
# resp.domain_config.cluster_config.status.update_version #=> Integer
|
@@ -4005,7 +4082,7 @@ module Aws::OpenSearchService
|
|
4005
4082
|
params: params,
|
4006
4083
|
config: config)
|
4007
4084
|
context[:gem_name] = 'aws-sdk-opensearchservice'
|
4008
|
-
context[:gem_version] = '1.
|
4085
|
+
context[:gem_version] = '1.18.0'
|
4009
4086
|
Seahorse::Client::Request.new(handlers, context)
|
4010
4087
|
end
|
4011
4088
|
|
@@ -51,6 +51,10 @@ module Aws::OpenSearchService
|
|
51
51
|
AutoTuneState = Shapes::StringShape.new(name: 'AutoTuneState')
|
52
52
|
AutoTuneStatus = Shapes::StructureShape.new(name: 'AutoTuneStatus')
|
53
53
|
AutoTuneType = Shapes::StringShape.new(name: 'AutoTuneType')
|
54
|
+
AvailabilityZone = Shapes::StringShape.new(name: 'AvailabilityZone')
|
55
|
+
AvailabilityZoneInfo = Shapes::StructureShape.new(name: 'AvailabilityZoneInfo')
|
56
|
+
AvailabilityZoneInfoList = Shapes::ListShape.new(name: 'AvailabilityZoneInfoList')
|
57
|
+
AvailabilityZoneList = Shapes::ListShape.new(name: 'AvailabilityZoneList')
|
54
58
|
BackendRole = Shapes::StringShape.new(name: 'BackendRole')
|
55
59
|
BaseException = Shapes::StructureShape.new(name: 'BaseException')
|
56
60
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
@@ -106,6 +110,8 @@ module Aws::OpenSearchService
|
|
106
110
|
DescribeDomainChangeProgressResponse = Shapes::StructureShape.new(name: 'DescribeDomainChangeProgressResponse')
|
107
111
|
DescribeDomainConfigRequest = Shapes::StructureShape.new(name: 'DescribeDomainConfigRequest')
|
108
112
|
DescribeDomainConfigResponse = Shapes::StructureShape.new(name: 'DescribeDomainConfigResponse')
|
113
|
+
DescribeDomainHealthRequest = Shapes::StructureShape.new(name: 'DescribeDomainHealthRequest')
|
114
|
+
DescribeDomainHealthResponse = Shapes::StructureShape.new(name: 'DescribeDomainHealthResponse')
|
109
115
|
DescribeDomainRequest = Shapes::StructureShape.new(name: 'DescribeDomainRequest')
|
110
116
|
DescribeDomainResponse = Shapes::StructureShape.new(name: 'DescribeDomainResponse')
|
111
117
|
DescribeDomainsRequest = Shapes::StructureShape.new(name: 'DescribeDomainsRequest')
|
@@ -140,6 +146,7 @@ module Aws::OpenSearchService
|
|
140
146
|
DomainConfig = Shapes::StructureShape.new(name: 'DomainConfig')
|
141
147
|
DomainEndpointOptions = Shapes::StructureShape.new(name: 'DomainEndpointOptions')
|
142
148
|
DomainEndpointOptionsStatus = Shapes::StructureShape.new(name: 'DomainEndpointOptionsStatus')
|
149
|
+
DomainHealth = Shapes::StringShape.new(name: 'DomainHealth')
|
143
150
|
DomainId = Shapes::StringShape.new(name: 'DomainId')
|
144
151
|
DomainInfo = Shapes::StructureShape.new(name: 'DomainInfo')
|
145
152
|
DomainInfoList = Shapes::ListShape.new(name: 'DomainInfoList')
|
@@ -150,6 +157,7 @@ module Aws::OpenSearchService
|
|
150
157
|
DomainPackageDetails = Shapes::StructureShape.new(name: 'DomainPackageDetails')
|
151
158
|
DomainPackageDetailsList = Shapes::ListShape.new(name: 'DomainPackageDetailsList')
|
152
159
|
DomainPackageStatus = Shapes::StringShape.new(name: 'DomainPackageStatus')
|
160
|
+
DomainState = Shapes::StringShape.new(name: 'DomainState')
|
153
161
|
DomainStatus = Shapes::StructureShape.new(name: 'DomainStatus')
|
154
162
|
DomainStatusList = Shapes::ListShape.new(name: 'DomainStatusList')
|
155
163
|
Double = Shapes::FloatShape.new(name: 'Double')
|
@@ -166,6 +174,8 @@ module Aws::OpenSearchService
|
|
166
174
|
Endpoint = Shapes::StringShape.new(name: 'Endpoint')
|
167
175
|
EndpointsMap = Shapes::MapShape.new(name: 'EndpointsMap')
|
168
176
|
EngineType = Shapes::StringShape.new(name: 'EngineType')
|
177
|
+
EnvironmentInfo = Shapes::StructureShape.new(name: 'EnvironmentInfo')
|
178
|
+
EnvironmentInfoList = Shapes::ListShape.new(name: 'EnvironmentInfoList')
|
169
179
|
ErrorDetails = Shapes::StructureShape.new(name: 'ErrorDetails')
|
170
180
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
171
181
|
ErrorType = Shapes::StringShape.new(name: 'ErrorType')
|
@@ -192,6 +202,7 @@ module Aws::OpenSearchService
|
|
192
202
|
InstanceRoleList = Shapes::ListShape.new(name: 'InstanceRoleList')
|
193
203
|
InstanceTypeDetails = Shapes::StructureShape.new(name: 'InstanceTypeDetails')
|
194
204
|
InstanceTypeDetailsList = Shapes::ListShape.new(name: 'InstanceTypeDetailsList')
|
205
|
+
InstanceTypeString = Shapes::StringShape.new(name: 'InstanceTypeString')
|
195
206
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
196
207
|
IntegerClass = Shapes::IntegerShape.new(name: 'IntegerClass')
|
197
208
|
InternalException = Shapes::StructureShape.new(name: 'InternalException')
|
@@ -232,6 +243,7 @@ module Aws::OpenSearchService
|
|
232
243
|
LogPublishingOptionsStatus = Shapes::StructureShape.new(name: 'LogPublishingOptionsStatus')
|
233
244
|
LogType = Shapes::StringShape.new(name: 'LogType')
|
234
245
|
Long = Shapes::IntegerShape.new(name: 'Long')
|
246
|
+
MasterNodeStatus = Shapes::StringShape.new(name: 'MasterNodeStatus')
|
235
247
|
MasterUserOptions = Shapes::StructureShape.new(name: 'MasterUserOptions')
|
236
248
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
237
249
|
MaximumInstanceCount = Shapes::IntegerShape.new(name: 'MaximumInstanceCount')
|
@@ -241,6 +253,9 @@ module Aws::OpenSearchService
|
|
241
253
|
NodeToNodeEncryptionOptions = Shapes::StructureShape.new(name: 'NodeToNodeEncryptionOptions')
|
242
254
|
NodeToNodeEncryptionOptionsStatus = Shapes::StructureShape.new(name: 'NodeToNodeEncryptionOptionsStatus')
|
243
255
|
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
256
|
+
NumberOfAZs = Shapes::StringShape.new(name: 'NumberOfAZs')
|
257
|
+
NumberOfNodes = Shapes::StringShape.new(name: 'NumberOfNodes')
|
258
|
+
NumberOfShards = Shapes::StringShape.new(name: 'NumberOfShards')
|
244
259
|
OffPeakWindow = Shapes::StructureShape.new(name: 'OffPeakWindow')
|
245
260
|
OffPeakWindowOptions = Shapes::StructureShape.new(name: 'OffPeakWindowOptions')
|
246
261
|
OffPeakWindowOptionsStatus = Shapes::StructureShape.new(name: 'OffPeakWindowOptionsStatus')
|
@@ -377,6 +392,7 @@ module Aws::OpenSearchService
|
|
377
392
|
VpcEndpoints = Shapes::ListShape.new(name: 'VpcEndpoints')
|
378
393
|
WindowStartTime = Shapes::StructureShape.new(name: 'WindowStartTime')
|
379
394
|
ZoneAwarenessConfig = Shapes::StructureShape.new(name: 'ZoneAwarenessConfig')
|
395
|
+
ZoneStatus = Shapes::StringShape.new(name: 'ZoneStatus')
|
380
396
|
|
381
397
|
AWSDomainInformation.add_member(:owner_id, Shapes::ShapeRef.new(shape: OwnerId, location_name: "OwnerId"))
|
382
398
|
AWSDomainInformation.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location_name: "DomainName"))
|
@@ -494,6 +510,18 @@ module Aws::OpenSearchService
|
|
494
510
|
AutoTuneStatus.add_member(:pending_deletion, Shapes::ShapeRef.new(shape: Boolean, location_name: "PendingDeletion"))
|
495
511
|
AutoTuneStatus.struct_class = Types::AutoTuneStatus
|
496
512
|
|
513
|
+
AvailabilityZoneInfo.add_member(:availability_zone_name, Shapes::ShapeRef.new(shape: AvailabilityZone, location_name: "AvailabilityZoneName"))
|
514
|
+
AvailabilityZoneInfo.add_member(:zone_status, Shapes::ShapeRef.new(shape: ZoneStatus, location_name: "ZoneStatus"))
|
515
|
+
AvailabilityZoneInfo.add_member(:configured_data_node_count, Shapes::ShapeRef.new(shape: NumberOfNodes, location_name: "ConfiguredDataNodeCount"))
|
516
|
+
AvailabilityZoneInfo.add_member(:available_data_node_count, Shapes::ShapeRef.new(shape: NumberOfNodes, location_name: "AvailableDataNodeCount"))
|
517
|
+
AvailabilityZoneInfo.add_member(:total_shards, Shapes::ShapeRef.new(shape: NumberOfShards, location_name: "TotalShards"))
|
518
|
+
AvailabilityZoneInfo.add_member(:total_un_assigned_shards, Shapes::ShapeRef.new(shape: NumberOfShards, location_name: "TotalUnAssignedShards"))
|
519
|
+
AvailabilityZoneInfo.struct_class = Types::AvailabilityZoneInfo
|
520
|
+
|
521
|
+
AvailabilityZoneInfoList.member = Shapes::ShapeRef.new(shape: AvailabilityZoneInfo)
|
522
|
+
|
523
|
+
AvailabilityZoneList.member = Shapes::ShapeRef.new(shape: AvailabilityZone)
|
524
|
+
|
497
525
|
BaseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
|
498
526
|
BaseException.struct_class = Types::BaseException
|
499
527
|
|
@@ -535,6 +563,7 @@ module Aws::OpenSearchService
|
|
535
563
|
ClusterConfig.add_member(:warm_type, Shapes::ShapeRef.new(shape: OpenSearchWarmPartitionInstanceType, location_name: "WarmType"))
|
536
564
|
ClusterConfig.add_member(:warm_count, Shapes::ShapeRef.new(shape: IntegerClass, location_name: "WarmCount"))
|
537
565
|
ClusterConfig.add_member(:cold_storage_options, Shapes::ShapeRef.new(shape: ColdStorageOptions, location_name: "ColdStorageOptions"))
|
566
|
+
ClusterConfig.add_member(:multi_az_with_standby_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "MultiAZWithStandbyEnabled"))
|
538
567
|
ClusterConfig.struct_class = Types::ClusterConfig
|
539
568
|
|
540
569
|
ClusterConfigStatus.add_member(:options, Shapes::ShapeRef.new(shape: ClusterConfig, required: true, location_name: "Options"))
|
@@ -672,6 +701,24 @@ module Aws::OpenSearchService
|
|
672
701
|
DescribeDomainConfigResponse.add_member(:domain_config, Shapes::ShapeRef.new(shape: DomainConfig, required: true, location_name: "DomainConfig"))
|
673
702
|
DescribeDomainConfigResponse.struct_class = Types::DescribeDomainConfigResponse
|
674
703
|
|
704
|
+
DescribeDomainHealthRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location: "uri", location_name: "DomainName"))
|
705
|
+
DescribeDomainHealthRequest.struct_class = Types::DescribeDomainHealthRequest
|
706
|
+
|
707
|
+
DescribeDomainHealthResponse.add_member(:domain_state, Shapes::ShapeRef.new(shape: DomainState, location_name: "DomainState"))
|
708
|
+
DescribeDomainHealthResponse.add_member(:availability_zone_count, Shapes::ShapeRef.new(shape: NumberOfAZs, location_name: "AvailabilityZoneCount"))
|
709
|
+
DescribeDomainHealthResponse.add_member(:active_availability_zone_count, Shapes::ShapeRef.new(shape: NumberOfAZs, location_name: "ActiveAvailabilityZoneCount"))
|
710
|
+
DescribeDomainHealthResponse.add_member(:stand_by_availability_zone_count, Shapes::ShapeRef.new(shape: NumberOfAZs, location_name: "StandByAvailabilityZoneCount"))
|
711
|
+
DescribeDomainHealthResponse.add_member(:data_node_count, Shapes::ShapeRef.new(shape: NumberOfNodes, location_name: "DataNodeCount"))
|
712
|
+
DescribeDomainHealthResponse.add_member(:dedicated_master, Shapes::ShapeRef.new(shape: Boolean, location_name: "DedicatedMaster"))
|
713
|
+
DescribeDomainHealthResponse.add_member(:master_eligible_node_count, Shapes::ShapeRef.new(shape: NumberOfNodes, location_name: "MasterEligibleNodeCount"))
|
714
|
+
DescribeDomainHealthResponse.add_member(:warm_node_count, Shapes::ShapeRef.new(shape: NumberOfNodes, location_name: "WarmNodeCount"))
|
715
|
+
DescribeDomainHealthResponse.add_member(:master_node, Shapes::ShapeRef.new(shape: MasterNodeStatus, location_name: "MasterNode"))
|
716
|
+
DescribeDomainHealthResponse.add_member(:cluster_health, Shapes::ShapeRef.new(shape: DomainHealth, location_name: "ClusterHealth"))
|
717
|
+
DescribeDomainHealthResponse.add_member(:total_shards, Shapes::ShapeRef.new(shape: NumberOfShards, location_name: "TotalShards"))
|
718
|
+
DescribeDomainHealthResponse.add_member(:total_un_assigned_shards, Shapes::ShapeRef.new(shape: NumberOfShards, location_name: "TotalUnAssignedShards"))
|
719
|
+
DescribeDomainHealthResponse.add_member(:environment_information, Shapes::ShapeRef.new(shape: EnvironmentInfoList, location_name: "EnvironmentInformation"))
|
720
|
+
DescribeDomainHealthResponse.struct_class = Types::DescribeDomainHealthResponse
|
721
|
+
|
675
722
|
DescribeDomainRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, required: true, location: "uri", location_name: "DomainName"))
|
676
723
|
DescribeDomainRequest.struct_class = Types::DescribeDomainRequest
|
677
724
|
|
@@ -893,6 +940,11 @@ module Aws::OpenSearchService
|
|
893
940
|
EndpointsMap.key = Shapes::ShapeRef.new(shape: String)
|
894
941
|
EndpointsMap.value = Shapes::ShapeRef.new(shape: ServiceUrl)
|
895
942
|
|
943
|
+
EnvironmentInfo.add_member(:availability_zone_information, Shapes::ShapeRef.new(shape: AvailabilityZoneInfoList, location_name: "AvailabilityZoneInformation"))
|
944
|
+
EnvironmentInfo.struct_class = Types::EnvironmentInfo
|
945
|
+
|
946
|
+
EnvironmentInfoList.member = Shapes::ShapeRef.new(shape: EnvironmentInfo)
|
947
|
+
|
896
948
|
ErrorDetails.add_member(:error_type, Shapes::ShapeRef.new(shape: ErrorType, location_name: "ErrorType"))
|
897
949
|
ErrorDetails.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
898
950
|
ErrorDetails.struct_class = Types::ErrorDetails
|
@@ -965,6 +1017,7 @@ module Aws::OpenSearchService
|
|
965
1017
|
InstanceTypeDetails.add_member(:advanced_security_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "AdvancedSecurityEnabled"))
|
966
1018
|
InstanceTypeDetails.add_member(:warm_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "WarmEnabled"))
|
967
1019
|
InstanceTypeDetails.add_member(:instance_role, Shapes::ShapeRef.new(shape: InstanceRoleList, location_name: "InstanceRole"))
|
1020
|
+
InstanceTypeDetails.add_member(:availability_zones, Shapes::ShapeRef.new(shape: AvailabilityZoneList, location_name: "AvailabilityZones"))
|
968
1021
|
InstanceTypeDetails.struct_class = Types::InstanceTypeDetails
|
969
1022
|
|
970
1023
|
InstanceTypeDetailsList.member = Shapes::ShapeRef.new(shape: InstanceTypeDetails)
|
@@ -1008,6 +1061,8 @@ module Aws::OpenSearchService
|
|
1008
1061
|
ListInstanceTypeDetailsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: DomainName, location: "querystring", location_name: "domainName"))
|
1009
1062
|
ListInstanceTypeDetailsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
1010
1063
|
ListInstanceTypeDetailsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
1064
|
+
ListInstanceTypeDetailsRequest.add_member(:retrieve_a_zs, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "retrieveAZs"))
|
1065
|
+
ListInstanceTypeDetailsRequest.add_member(:instance_type, Shapes::ShapeRef.new(shape: InstanceTypeString, location: "querystring", location_name: "instanceType"))
|
1011
1066
|
ListInstanceTypeDetailsRequest.struct_class = Types::ListInstanceTypeDetailsRequest
|
1012
1067
|
|
1013
1068
|
ListInstanceTypeDetailsResponse.add_member(:instance_type_details, Shapes::ShapeRef.new(shape: InstanceTypeDetailsList, location_name: "InstanceTypeDetails"))
|
@@ -1703,6 +1758,19 @@ module Aws::OpenSearchService
|
|
1703
1758
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1704
1759
|
end)
|
1705
1760
|
|
1761
|
+
api.add_operation(:describe_domain_health, Seahorse::Model::Operation.new.tap do |o|
|
1762
|
+
o.name = "DescribeDomainHealth"
|
1763
|
+
o.http_method = "GET"
|
1764
|
+
o.http_request_uri = "/2021-01-01/opensearch/domain/{DomainName}/health"
|
1765
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeDomainHealthRequest)
|
1766
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeDomainHealthResponse)
|
1767
|
+
o.errors << Shapes::ShapeRef.new(shape: BaseException)
|
1768
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalException)
|
1769
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1770
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1771
|
+
o.errors << Shapes::ShapeRef.new(shape: DisabledOperationException)
|
1772
|
+
end)
|
1773
|
+
|
1706
1774
|
api.add_operation(:describe_domains, Seahorse::Model::Operation.new.tap do |o|
|
1707
1775
|
o.name = "DescribeDomains"
|
1708
1776
|
o.http_method = "POST"
|
@@ -263,6 +263,20 @@ module Aws::OpenSearchService
|
|
263
263
|
end
|
264
264
|
end
|
265
265
|
|
266
|
+
class DescribeDomainHealth
|
267
|
+
def self.build(context)
|
268
|
+
unless context.config.regional_endpoint
|
269
|
+
endpoint = context.config.endpoint.to_s
|
270
|
+
end
|
271
|
+
Aws::OpenSearchService::EndpointParameters.new(
|
272
|
+
region: context.config.region,
|
273
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
274
|
+
use_fips: context.config.use_fips_endpoint,
|
275
|
+
endpoint: endpoint,
|
276
|
+
)
|
277
|
+
end
|
278
|
+
end
|
279
|
+
|
266
280
|
class DescribeDomains
|
267
281
|
def self.build(context)
|
268
282
|
unless context.config.regional_endpoint
|
@@ -92,6 +92,8 @@ module Aws::OpenSearchService
|
|
92
92
|
Aws::OpenSearchService::Endpoints::DescribeDomainChangeProgress.build(context)
|
93
93
|
when :describe_domain_config
|
94
94
|
Aws::OpenSearchService::Endpoints::DescribeDomainConfig.build(context)
|
95
|
+
when :describe_domain_health
|
96
|
+
Aws::OpenSearchService::Endpoints::DescribeDomainHealth.build(context)
|
95
97
|
when :describe_domains
|
96
98
|
Aws::OpenSearchService::Endpoints::DescribeDomains.build(context)
|
97
99
|
when :describe_dry_run_progress
|
@@ -656,6 +656,55 @@ module Aws::OpenSearchService
|
|
656
656
|
include Aws::Structure
|
657
657
|
end
|
658
658
|
|
659
|
+
# Information about an Availability Zone on a domain.
|
660
|
+
#
|
661
|
+
# @!attribute [rw] availability_zone_name
|
662
|
+
# The name of the Availability Zone.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] zone_status
|
666
|
+
# The current state of the Availability Zone. Current options are
|
667
|
+
# `Active` and `StandBy`.
|
668
|
+
#
|
669
|
+
# * `Active` - Data nodes in the Availability Zone are in use.
|
670
|
+
#
|
671
|
+
# * `StandBy` - Data nodes in the Availability Zone are in a standby
|
672
|
+
# state.
|
673
|
+
#
|
674
|
+
# * `NotAvailable` - Unable to retrieve information.
|
675
|
+
# @return [String]
|
676
|
+
#
|
677
|
+
# @!attribute [rw] configured_data_node_count
|
678
|
+
# The total number of data nodes configured in the Availability Zone.
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] available_data_node_count
|
682
|
+
# The number of data nodes active in the Availability Zone.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] total_shards
|
686
|
+
# The total number of primary and replica shards in the Availability
|
687
|
+
# Zone.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] total_un_assigned_shards
|
691
|
+
# The total number of primary and replica shards that aren't
|
692
|
+
# allocated to any of the nodes in the Availability Zone.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AvailabilityZoneInfo AWS API Documentation
|
696
|
+
#
|
697
|
+
class AvailabilityZoneInfo < Struct.new(
|
698
|
+
:availability_zone_name,
|
699
|
+
:zone_status,
|
700
|
+
:configured_data_node_count,
|
701
|
+
:available_data_node_count,
|
702
|
+
:total_shards,
|
703
|
+
:total_un_assigned_shards)
|
704
|
+
SENSITIVE = []
|
705
|
+
include Aws::Structure
|
706
|
+
end
|
707
|
+
|
659
708
|
# An error occurred while processing the request.
|
660
709
|
#
|
661
710
|
# @!attribute [rw] message
|
@@ -844,7 +893,8 @@ module Aws::OpenSearchService
|
|
844
893
|
#
|
845
894
|
# @!attribute [rw] dedicated_master_count
|
846
895
|
# Number of dedicated master nodes in the cluster. This number must be
|
847
|
-
# greater than
|
896
|
+
# greater than 2 and not 4, otherwise you receive a validation
|
897
|
+
# exception.
|
848
898
|
# @return [Integer]
|
849
899
|
#
|
850
900
|
# @!attribute [rw] warm_enabled
|
@@ -863,6 +913,16 @@ module Aws::OpenSearchService
|
|
863
913
|
# Container for cold storage configuration options.
|
864
914
|
# @return [Types::ColdStorageOptions]
|
865
915
|
#
|
916
|
+
# @!attribute [rw] multi_az_with_standby_enabled
|
917
|
+
# A boolean that indicates whether a multi-AZ domain is turned on with
|
918
|
+
# a standby AZ. For more information, see [Configuring a multi-AZ
|
919
|
+
# domain in Amazon OpenSearch Service][1].
|
920
|
+
#
|
921
|
+
#
|
922
|
+
#
|
923
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html
|
924
|
+
# @return [Boolean]
|
925
|
+
#
|
866
926
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ClusterConfig AWS API Documentation
|
867
927
|
#
|
868
928
|
class ClusterConfig < Struct.new(
|
@@ -876,7 +936,8 @@ module Aws::OpenSearchService
|
|
876
936
|
:warm_enabled,
|
877
937
|
:warm_type,
|
878
938
|
:warm_count,
|
879
|
-
:cold_storage_options
|
939
|
+
:cold_storage_options,
|
940
|
+
:multi_az_with_standby_enabled)
|
880
941
|
SENSITIVE = []
|
881
942
|
include Aws::Structure
|
882
943
|
end
|
@@ -1277,7 +1338,7 @@ module Aws::OpenSearchService
|
|
1277
1338
|
# @return [String]
|
1278
1339
|
#
|
1279
1340
|
# @!attribute [rw] package_type
|
1280
|
-
#
|
1341
|
+
# The type of package.
|
1281
1342
|
# @return [String]
|
1282
1343
|
#
|
1283
1344
|
# @!attribute [rw] package_description
|
@@ -1613,6 +1674,127 @@ module Aws::OpenSearchService
|
|
1613
1674
|
include Aws::Structure
|
1614
1675
|
end
|
1615
1676
|
|
1677
|
+
# Container for the parameters to the `DescribeDomainHealth` operation.
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] domain_name
|
1680
|
+
# The name of the domain.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealthRequest AWS API Documentation
|
1684
|
+
#
|
1685
|
+
class DescribeDomainHealthRequest < Struct.new(
|
1686
|
+
:domain_name)
|
1687
|
+
SENSITIVE = []
|
1688
|
+
include Aws::Structure
|
1689
|
+
end
|
1690
|
+
|
1691
|
+
# The result of a `DescribeDomainHealth` request. Contains health
|
1692
|
+
# information for the requested domain.
|
1693
|
+
#
|
1694
|
+
# @!attribute [rw] domain_state
|
1695
|
+
# The current state of the domain.
|
1696
|
+
#
|
1697
|
+
# * `Processing` - The domain has updates in progress.
|
1698
|
+
#
|
1699
|
+
# * `Active` - Requested changes have been processed and deployed to
|
1700
|
+
# the domain.
|
1701
|
+
# @return [String]
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] availability_zone_count
|
1704
|
+
# The number of Availability Zones configured for the domain. If the
|
1705
|
+
# service is unable to fetch this information, it will return
|
1706
|
+
# `NotAvailable`.
|
1707
|
+
# @return [String]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] active_availability_zone_count
|
1710
|
+
# The number of active Availability Zones configured for the domain.
|
1711
|
+
# If the service is unable to fetch this information, it will return
|
1712
|
+
# `NotAvailable`.
|
1713
|
+
# @return [String]
|
1714
|
+
#
|
1715
|
+
# @!attribute [rw] stand_by_availability_zone_count
|
1716
|
+
# The number of standby Availability Zones configured for the domain.
|
1717
|
+
# If the service is unable to fetch this information, it will return
|
1718
|
+
# `NotAvailable`.
|
1719
|
+
# @return [String]
|
1720
|
+
#
|
1721
|
+
# @!attribute [rw] data_node_count
|
1722
|
+
# The number of data nodes configured for the domain. If the service
|
1723
|
+
# is unable to fetch this information, it will return `NotAvailable`.
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] dedicated_master
|
1727
|
+
# A boolean that indicates if dedicated master nodes are activated for
|
1728
|
+
# the domain.
|
1729
|
+
# @return [Boolean]
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] master_eligible_node_count
|
1732
|
+
# The number of nodes that can be elected as a master node. If
|
1733
|
+
# dedicated master nodes is turned on, this value is the number of
|
1734
|
+
# dedicated master nodes configured for the domain. If the service is
|
1735
|
+
# unable to fetch this information, it will return `NotAvailable`.
|
1736
|
+
# @return [String]
|
1737
|
+
#
|
1738
|
+
# @!attribute [rw] warm_node_count
|
1739
|
+
# The number of warm nodes configured for the domain.
|
1740
|
+
# @return [String]
|
1741
|
+
#
|
1742
|
+
# @!attribute [rw] master_node
|
1743
|
+
# Indicates whether the domain has an elected master node.
|
1744
|
+
#
|
1745
|
+
# * **Available** - The domain has an elected master node.
|
1746
|
+
#
|
1747
|
+
# * **UnAvailable** - The master node hasn't yet been elected, and a
|
1748
|
+
# quorum to elect a new master node hasn't been reached.
|
1749
|
+
# @return [String]
|
1750
|
+
#
|
1751
|
+
# @!attribute [rw] cluster_health
|
1752
|
+
# The current health status of your cluster.
|
1753
|
+
#
|
1754
|
+
# * `Red` - At least one primary shard is not allocated to any node.
|
1755
|
+
#
|
1756
|
+
# * `Yellow` - All primary shards are allocated to nodes, but some
|
1757
|
+
# replicas aren’t.
|
1758
|
+
#
|
1759
|
+
# * `Green` - All primary shards and their replicas are allocated to
|
1760
|
+
# nodes.
|
1761
|
+
#
|
1762
|
+
# * `NotAvailable` - Unable to retrieve cluster health.
|
1763
|
+
# @return [String]
|
1764
|
+
#
|
1765
|
+
# @!attribute [rw] total_shards
|
1766
|
+
# The total number of primary and replica shards for the domain.
|
1767
|
+
# @return [String]
|
1768
|
+
#
|
1769
|
+
# @!attribute [rw] total_un_assigned_shards
|
1770
|
+
# The total number of primary and replica shards not allocated to any
|
1771
|
+
# of the nodes for the cluster.
|
1772
|
+
# @return [String]
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] environment_information
|
1775
|
+
# A list of `EnvironmentInfo` for the domain.
|
1776
|
+
# @return [Array<Types::EnvironmentInfo>]
|
1777
|
+
#
|
1778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealthResponse AWS API Documentation
|
1779
|
+
#
|
1780
|
+
class DescribeDomainHealthResponse < Struct.new(
|
1781
|
+
:domain_state,
|
1782
|
+
:availability_zone_count,
|
1783
|
+
:active_availability_zone_count,
|
1784
|
+
:stand_by_availability_zone_count,
|
1785
|
+
:data_node_count,
|
1786
|
+
:dedicated_master,
|
1787
|
+
:master_eligible_node_count,
|
1788
|
+
:warm_node_count,
|
1789
|
+
:master_node,
|
1790
|
+
:cluster_health,
|
1791
|
+
:total_shards,
|
1792
|
+
:total_un_assigned_shards,
|
1793
|
+
:environment_information)
|
1794
|
+
SENSITIVE = []
|
1795
|
+
include Aws::Structure
|
1796
|
+
end
|
1797
|
+
|
1616
1798
|
# Container for the parameters to the `DescribeDomain` operation.
|
1617
1799
|
#
|
1618
1800
|
# @!attribute [rw] domain_name
|
@@ -2075,7 +2257,7 @@ module Aws::OpenSearchService
|
|
2075
2257
|
include Aws::Structure
|
2076
2258
|
end
|
2077
2259
|
|
2078
|
-
# An error occured because the client wanted to access
|
2260
|
+
# An error occured because the client wanted to access an unsupported
|
2079
2261
|
# operation.
|
2080
2262
|
#
|
2081
2263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DisabledOperationException AWS API Documentation
|
@@ -2358,9 +2540,8 @@ module Aws::OpenSearchService
|
|
2358
2540
|
# @return [String]
|
2359
2541
|
#
|
2360
2542
|
# @!attribute [rw] reference_path
|
2361
|
-
#
|
2362
|
-
#
|
2363
|
-
# files.
|
2543
|
+
# The relative path of the package on the OpenSearch Service cluster
|
2544
|
+
# nodes. This is `synonym_path` when the package is for synonym files.
|
2364
2545
|
# @return [String]
|
2365
2546
|
#
|
2366
2547
|
# @!attribute [rw] error_details
|
@@ -2424,7 +2605,7 @@ module Aws::OpenSearchService
|
|
2424
2605
|
#
|
2425
2606
|
# @!attribute [rw] endpoints
|
2426
2607
|
# The key-value pair that exists if the OpenSearch Service domain uses
|
2427
|
-
# VPC endpoints.. Example `key, value
|
2608
|
+
# VPC endpoints.. Example `key, value`:
|
2428
2609
|
# `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.
|
2429
2610
|
# @return [Hash<String,String>]
|
2430
2611
|
#
|
@@ -2742,6 +2923,20 @@ module Aws::OpenSearchService
|
|
2742
2923
|
include Aws::Structure
|
2743
2924
|
end
|
2744
2925
|
|
2926
|
+
# Information about the active domain environment.
|
2927
|
+
#
|
2928
|
+
# @!attribute [rw] availability_zone_information
|
2929
|
+
# A list of `AvailabilityZoneInfo` for the domain.
|
2930
|
+
# @return [Array<Types::AvailabilityZoneInfo>]
|
2931
|
+
#
|
2932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/EnvironmentInfo AWS API Documentation
|
2933
|
+
#
|
2934
|
+
class EnvironmentInfo < Struct.new(
|
2935
|
+
:availability_zone_information)
|
2936
|
+
SENSITIVE = []
|
2937
|
+
include Aws::Structure
|
2938
|
+
end
|
2939
|
+
|
2745
2940
|
# Additional information if the package is in an error state. Null
|
2746
2941
|
# otherwise.
|
2747
2942
|
#
|
@@ -3017,20 +3212,20 @@ module Aws::OpenSearchService
|
|
3017
3212
|
# * **PENDING\_ACCEPTANCE** - Inbound connection is not yet accepted
|
3018
3213
|
# by the remote domain owner.
|
3019
3214
|
#
|
3020
|
-
# * **APPROVED
|
3215
|
+
# * **APPROVED**: Inbound connection is pending acceptance by the
|
3021
3216
|
# remote domain owner.
|
3022
3217
|
#
|
3023
|
-
# * **PROVISIONING
|
3218
|
+
# * **PROVISIONING**: Inbound connection is being provisioned.
|
3024
3219
|
#
|
3025
|
-
# * **ACTIVE
|
3220
|
+
# * **ACTIVE**: Inbound connection is active and ready to use.
|
3026
3221
|
#
|
3027
|
-
# * **REJECTING
|
3222
|
+
# * **REJECTING**: Inbound connection rejection is in process.
|
3028
3223
|
#
|
3029
|
-
# * **REJECTED
|
3224
|
+
# * **REJECTED**: Inbound connection is rejected.
|
3030
3225
|
#
|
3031
|
-
# * **DELETING
|
3226
|
+
# * **DELETING**: Inbound connection deletion is in progress.
|
3032
3227
|
#
|
3033
|
-
# * **DELETED
|
3228
|
+
# * **DELETED**: Inbound connection is deleted and can no longer be
|
3034
3229
|
# used.
|
3035
3230
|
# @return [String]
|
3036
3231
|
#
|
@@ -3117,6 +3312,10 @@ module Aws::OpenSearchService
|
|
3117
3312
|
# or an UltraWarm node.
|
3118
3313
|
# @return [Array<String>]
|
3119
3314
|
#
|
3315
|
+
# @!attribute [rw] availability_zones
|
3316
|
+
# The supported Availability Zones for the instance type.
|
3317
|
+
# @return [Array<String>]
|
3318
|
+
#
|
3120
3319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InstanceTypeDetails AWS API Documentation
|
3121
3320
|
#
|
3122
3321
|
class InstanceTypeDetails < Struct.new(
|
@@ -3126,7 +3325,8 @@ module Aws::OpenSearchService
|
|
3126
3325
|
:app_logs_enabled,
|
3127
3326
|
:advanced_security_enabled,
|
3128
3327
|
:warm_enabled,
|
3129
|
-
:instance_role
|
3328
|
+
:instance_role,
|
3329
|
+
:availability_zones)
|
3130
3330
|
SENSITIVE = []
|
3131
3331
|
include Aws::Structure
|
3132
3332
|
end
|
@@ -3138,8 +3338,8 @@ module Aws::OpenSearchService
|
|
3138
3338
|
#
|
3139
3339
|
class InternalException < Aws::EmptyStructure; end
|
3140
3340
|
|
3141
|
-
#
|
3142
|
-
#
|
3341
|
+
# Request processing failed because you provided an invalid pagination
|
3342
|
+
# token.
|
3143
3343
|
#
|
3144
3344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InvalidPaginationTokenException AWS API Documentation
|
3145
3345
|
#
|
@@ -3269,13 +3469,13 @@ module Aws::OpenSearchService
|
|
3269
3469
|
end
|
3270
3470
|
|
3271
3471
|
# @!attribute [rw] engine_version
|
3272
|
-
#
|
3472
|
+
# The version of OpenSearch or Elasticsearch, in the format
|
3273
3473
|
# Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
|
3274
3474
|
# version of OpenSearch.
|
3275
3475
|
# @return [String]
|
3276
3476
|
#
|
3277
3477
|
# @!attribute [rw] domain_name
|
3278
|
-
#
|
3478
|
+
# The name of the domain.
|
3279
3479
|
# @return [String]
|
3280
3480
|
#
|
3281
3481
|
# @!attribute [rw] max_results
|
@@ -3290,13 +3490,25 @@ module Aws::OpenSearchService
|
|
3290
3490
|
# next page.
|
3291
3491
|
# @return [String]
|
3292
3492
|
#
|
3493
|
+
# @!attribute [rw] retrieve_a_zs
|
3494
|
+
# An optional parameter that specifies the Availability Zones for the
|
3495
|
+
# domain.
|
3496
|
+
# @return [Boolean]
|
3497
|
+
#
|
3498
|
+
# @!attribute [rw] instance_type
|
3499
|
+
# An optional parameter that lists information for a given instance
|
3500
|
+
# type.
|
3501
|
+
# @return [String]
|
3502
|
+
#
|
3293
3503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetailsRequest AWS API Documentation
|
3294
3504
|
#
|
3295
3505
|
class ListInstanceTypeDetailsRequest < Struct.new(
|
3296
3506
|
:engine_version,
|
3297
3507
|
:domain_name,
|
3298
3508
|
:max_results,
|
3299
|
-
:next_token
|
3509
|
+
:next_token,
|
3510
|
+
:retrieve_a_zs,
|
3511
|
+
:instance_type)
|
3300
3512
|
SENSITIVE = []
|
3301
3513
|
include Aws::Structure
|
3302
3514
|
end
|
@@ -3777,7 +3989,7 @@ module Aws::OpenSearchService
|
|
3777
3989
|
# Whether to enable an off-peak window.
|
3778
3990
|
#
|
3779
3991
|
# This option is only available when modifying a domain created prior
|
3780
|
-
# to February
|
3992
|
+
# to February 16, 2023, not when creating a new domain. All domains
|
3781
3993
|
# created after this date have the off-peak window enabled by default.
|
3782
3994
|
# You can't disable the off-peak window after it's enabled for a
|
3783
3995
|
# domain.
|
@@ -3909,7 +4121,7 @@ module Aws::OpenSearchService
|
|
3909
4121
|
# * **VALIDATION\_FAILED** - Validation failed for the connection
|
3910
4122
|
# request.
|
3911
4123
|
#
|
3912
|
-
# * **PENDING\_ACCEPTANCE
|
4124
|
+
# * **PENDING\_ACCEPTANCE**: Outbound connection request is validated
|
3913
4125
|
# and is not yet accepted by the remote domain owner.
|
3914
4126
|
#
|
3915
4127
|
# * **APPROVED** - Outbound connection has been approved by the remote
|
@@ -3951,7 +4163,7 @@ module Aws::OpenSearchService
|
|
3951
4163
|
# @return [String]
|
3952
4164
|
#
|
3953
4165
|
# @!attribute [rw] package_name
|
3954
|
-
#
|
4166
|
+
# The user-specified name of the package.
|
3955
4167
|
# @return [String]
|
3956
4168
|
#
|
3957
4169
|
# @!attribute [rw] package_type
|
@@ -3963,7 +4175,9 @@ module Aws::OpenSearchService
|
|
3963
4175
|
# @return [String]
|
3964
4176
|
#
|
3965
4177
|
# @!attribute [rw] package_status
|
3966
|
-
#
|
4178
|
+
# The current status of the package. The available options are
|
4179
|
+
# `AVAILABLE`, `COPYING`, `COPY_FAILED`, `VALIDATNG`,
|
4180
|
+
# `VALIDATION_FAILED`, `DELETING`, and `DELETE_FAILED`.
|
3967
4181
|
# @return [String]
|
3968
4182
|
#
|
3969
4183
|
# @!attribute [rw] created_at
|
@@ -4300,8 +4514,7 @@ module Aws::OpenSearchService
|
|
4300
4514
|
#
|
4301
4515
|
class ResourceAlreadyExistsException < Aws::EmptyStructure; end
|
4302
4516
|
|
4303
|
-
# An exception for accessing or deleting a resource that
|
4304
|
-
# exist..
|
4517
|
+
# An exception for accessing or deleting a resource that doesn't exist.
|
4305
4518
|
#
|
4306
4519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ResourceNotFoundException AWS API Documentation
|
4307
4520
|
#
|
@@ -4884,12 +5097,6 @@ module Aws::OpenSearchService
|
|
4884
5097
|
# Queries with more than the permitted number of clauses result in a
|
4885
5098
|
# `TooManyClauses` error.
|
4886
5099
|
#
|
4887
|
-
# * `"override_main_response_version": "true" | "false"` - Note the
|
4888
|
-
# use of a string rather than a boolean. Specifies whether the
|
4889
|
-
# domain reports its version as 7.10 to allow Elasticsearch OSS
|
4890
|
-
# clients and plugins to continue working with it. Default is false
|
4891
|
-
# when creating a domain and true when upgrading a domain.
|
4892
|
-
#
|
4893
5100
|
# For more information, see [Advanced cluster parameters][1].
|
4894
5101
|
#
|
4895
5102
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-opensearchservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.18.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-05-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|