aws-sdk-opensearchservice 1.16.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.
@@ -688,6 +688,17 @@ module Aws::OpenSearchService
688
688
  # @option params [Types::AutoTuneOptionsInput] :auto_tune_options
689
689
  # Options for Auto-Tune.
690
690
  #
691
+ # @option params [Types::OffPeakWindowOptions] :off_peak_window_options
692
+ # Specifies a daily 10-hour time block during which OpenSearch Service
693
+ # can perform configuration changes on the domain, including service
694
+ # software updates and Auto-Tune enhancements that require a blue/green
695
+ # deployment. If no options are specified, the default start time of
696
+ # 10:00 P.M. local time (for the Region that the domain is created in)
697
+ # is used.
698
+ #
699
+ # @option params [Types::SoftwareUpdateOptions] :software_update_options
700
+ # Software update options for the domain.
701
+ #
691
702
  # @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
692
703
  #
693
704
  # * {Types::CreateDomainResponse#domain_status #domain_status} => Types::DomainStatus
@@ -713,6 +724,7 @@ module Aws::OpenSearchService
713
724
  # cold_storage_options: {
714
725
  # enabled: false, # required
715
726
  # },
727
+ # multi_az_with_standby_enabled: false,
716
728
  # },
717
729
  # ebs_options: {
718
730
  # ebs_enabled: false,
@@ -798,6 +810,19 @@ module Aws::OpenSearchService
798
810
  # cron_expression_for_recurrence: "String",
799
811
  # },
800
812
  # ],
813
+ # use_off_peak_window: false,
814
+ # },
815
+ # off_peak_window_options: {
816
+ # enabled: false,
817
+ # off_peak_window: {
818
+ # window_start_time: {
819
+ # hours: 1, # required
820
+ # minutes: 1, # required
821
+ # },
822
+ # },
823
+ # },
824
+ # software_update_options: {
825
+ # auto_software_update_enabled: false,
801
826
  # },
802
827
  # })
803
828
  #
@@ -825,6 +850,7 @@ module Aws::OpenSearchService
825
850
  # resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
826
851
  # resp.domain_status.cluster_config.warm_count #=> Integer
827
852
  # resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
853
+ # resp.domain_status.cluster_config.multi_az_with_standby_enabled #=> Boolean
828
854
  # resp.domain_status.ebs_options.ebs_enabled #=> Boolean
829
855
  # resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
830
856
  # resp.domain_status.ebs_options.volume_size #=> Integer
@@ -876,8 +902,13 @@ module Aws::OpenSearchService
876
902
  # resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
877
903
  # resp.domain_status.auto_tune_options.state #=> String, one of "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"
878
904
  # resp.domain_status.auto_tune_options.error_message #=> String
905
+ # resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
879
906
  # resp.domain_status.change_progress_details.change_id #=> String
880
907
  # resp.domain_status.change_progress_details.message #=> String
908
+ # resp.domain_status.off_peak_window_options.enabled #=> Boolean
909
+ # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
910
+ # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
911
+ # resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean
881
912
  #
882
913
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain AWS API Documentation
883
914
  #
@@ -976,7 +1007,7 @@ module Aws::OpenSearchService
976
1007
  # Unique name for the package.
977
1008
  #
978
1009
  # @option params [required, String] :package_type
979
- # Type of package.
1010
+ # The type of package.
980
1011
  #
981
1012
  # @option params [String] :package_description
982
1013
  # Description of the package.
@@ -1114,6 +1145,7 @@ module Aws::OpenSearchService
1114
1145
  # resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1115
1146
  # resp.domain_status.cluster_config.warm_count #=> Integer
1116
1147
  # resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
1148
+ # resp.domain_status.cluster_config.multi_az_with_standby_enabled #=> Boolean
1117
1149
  # resp.domain_status.ebs_options.ebs_enabled #=> Boolean
1118
1150
  # resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
1119
1151
  # resp.domain_status.ebs_options.volume_size #=> Integer
@@ -1165,8 +1197,13 @@ module Aws::OpenSearchService
1165
1197
  # resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
1166
1198
  # resp.domain_status.auto_tune_options.state #=> String, one of "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"
1167
1199
  # resp.domain_status.auto_tune_options.error_message #=> String
1200
+ # resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
1168
1201
  # resp.domain_status.change_progress_details.change_id #=> String
1169
1202
  # resp.domain_status.change_progress_details.message #=> String
1203
+ # resp.domain_status.off_peak_window_options.enabled #=> Boolean
1204
+ # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
1205
+ # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
1206
+ # resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean
1170
1207
  #
1171
1208
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain AWS API Documentation
1172
1209
  #
@@ -1382,6 +1419,7 @@ module Aws::OpenSearchService
1382
1419
  # resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1383
1420
  # resp.domain_status.cluster_config.warm_count #=> Integer
1384
1421
  # resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
1422
+ # resp.domain_status.cluster_config.multi_az_with_standby_enabled #=> Boolean
1385
1423
  # resp.domain_status.ebs_options.ebs_enabled #=> Boolean
1386
1424
  # resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
1387
1425
  # resp.domain_status.ebs_options.volume_size #=> Integer
@@ -1433,8 +1471,13 @@ module Aws::OpenSearchService
1433
1471
  # resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
1434
1472
  # resp.domain_status.auto_tune_options.state #=> String, one of "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"
1435
1473
  # resp.domain_status.auto_tune_options.error_message #=> String
1474
+ # resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
1436
1475
  # resp.domain_status.change_progress_details.change_id #=> String
1437
1476
  # resp.domain_status.change_progress_details.message #=> String
1477
+ # resp.domain_status.off_peak_window_options.enabled #=> Boolean
1478
+ # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
1479
+ # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
1480
+ # resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean
1438
1481
  #
1439
1482
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain AWS API Documentation
1440
1483
  #
@@ -1587,6 +1630,7 @@ module Aws::OpenSearchService
1587
1630
  # resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1588
1631
  # resp.domain_config.cluster_config.options.warm_count #=> Integer
1589
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
1590
1634
  # resp.domain_config.cluster_config.status.creation_date #=> Time
1591
1635
  # resp.domain_config.cluster_config.status.update_date #=> Time
1592
1636
  # resp.domain_config.cluster_config.status.update_version #=> Integer
@@ -1695,6 +1739,7 @@ module Aws::OpenSearchService
1695
1739
  # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
1696
1740
  # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
1697
1741
  # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
1742
+ # resp.domain_config.auto_tune_options.options.use_off_peak_window #=> Boolean
1698
1743
  # resp.domain_config.auto_tune_options.status.creation_date #=> Time
1699
1744
  # resp.domain_config.auto_tune_options.status.update_date #=> Time
1700
1745
  # resp.domain_config.auto_tune_options.status.update_version #=> Integer
@@ -1703,6 +1748,20 @@ module Aws::OpenSearchService
1703
1748
  # resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
1704
1749
  # resp.domain_config.change_progress_details.change_id #=> String
1705
1750
  # resp.domain_config.change_progress_details.message #=> String
1751
+ # resp.domain_config.off_peak_window_options.options.enabled #=> Boolean
1752
+ # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer
1753
+ # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer
1754
+ # resp.domain_config.off_peak_window_options.status.creation_date #=> Time
1755
+ # resp.domain_config.off_peak_window_options.status.update_date #=> Time
1756
+ # resp.domain_config.off_peak_window_options.status.update_version #=> Integer
1757
+ # resp.domain_config.off_peak_window_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1758
+ # resp.domain_config.off_peak_window_options.status.pending_deletion #=> Boolean
1759
+ # resp.domain_config.software_update_options.options.auto_software_update_enabled #=> Boolean
1760
+ # resp.domain_config.software_update_options.status.creation_date #=> Time
1761
+ # resp.domain_config.software_update_options.status.update_date #=> Time
1762
+ # resp.domain_config.software_update_options.status.update_version #=> Integer
1763
+ # resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1764
+ # resp.domain_config.software_update_options.status.pending_deletion #=> Boolean
1706
1765
  #
1707
1766
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig AWS API Documentation
1708
1767
  #
@@ -1713,6 +1772,67 @@ module Aws::OpenSearchService
1713
1772
  req.send_request(options)
1714
1773
  end
1715
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
+
1716
1836
  # Returns domain configuration information about the specified Amazon
1717
1837
  # OpenSearch Service domains.
1718
1838
  #
@@ -1756,6 +1876,7 @@ module Aws::OpenSearchService
1756
1876
  # resp.domain_status_list[0].cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1757
1877
  # resp.domain_status_list[0].cluster_config.warm_count #=> Integer
1758
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
1759
1880
  # resp.domain_status_list[0].ebs_options.ebs_enabled #=> Boolean
1760
1881
  # resp.domain_status_list[0].ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
1761
1882
  # resp.domain_status_list[0].ebs_options.volume_size #=> Integer
@@ -1807,8 +1928,13 @@ module Aws::OpenSearchService
1807
1928
  # resp.domain_status_list[0].advanced_security_options.anonymous_auth_enabled #=> Boolean
1808
1929
  # resp.domain_status_list[0].auto_tune_options.state #=> String, one of "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"
1809
1930
  # resp.domain_status_list[0].auto_tune_options.error_message #=> String
1931
+ # resp.domain_status_list[0].auto_tune_options.use_off_peak_window #=> Boolean
1810
1932
  # resp.domain_status_list[0].change_progress_details.change_id #=> String
1811
1933
  # resp.domain_status_list[0].change_progress_details.message #=> String
1934
+ # resp.domain_status_list[0].off_peak_window_options.enabled #=> Boolean
1935
+ # resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
1936
+ # resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
1937
+ # resp.domain_status_list[0].software_update_options.auto_software_update_enabled #=> Boolean
1812
1938
  #
1813
1939
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains AWS API Documentation
1814
1940
  #
@@ -1883,6 +2009,7 @@ module Aws::OpenSearchService
1883
2009
  # resp.dry_run_config.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1884
2010
  # resp.dry_run_config.cluster_config.warm_count #=> Integer
1885
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
1886
2013
  # resp.dry_run_config.ebs_options.ebs_enabled #=> Boolean
1887
2014
  # resp.dry_run_config.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
1888
2015
  # resp.dry_run_config.ebs_options.volume_size #=> Integer
@@ -1934,8 +2061,13 @@ module Aws::OpenSearchService
1934
2061
  # resp.dry_run_config.advanced_security_options.anonymous_auth_enabled #=> Boolean
1935
2062
  # resp.dry_run_config.auto_tune_options.state #=> String, one of "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"
1936
2063
  # resp.dry_run_config.auto_tune_options.error_message #=> String
2064
+ # resp.dry_run_config.auto_tune_options.use_off_peak_window #=> Boolean
1937
2065
  # resp.dry_run_config.change_progress_details.change_id #=> String
1938
2066
  # resp.dry_run_config.change_progress_details.message #=> String
2067
+ # resp.dry_run_config.off_peak_window_options.enabled #=> Boolean
2068
+ # resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
2069
+ # resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
2070
+ # resp.dry_run_config.software_update_options.auto_software_update_enabled #=> Boolean
1939
2071
  # resp.dry_run_results.deployment_type #=> String
1940
2072
  # resp.dry_run_results.message #=> String
1941
2073
  #
@@ -2460,7 +2592,8 @@ module Aws::OpenSearchService
2460
2592
  end
2461
2593
 
2462
2594
  # Returns a list of Amazon OpenSearch Service package versions, along
2463
- # with their creation time and commit message. For more information, see
2595
+ # with their creation time, commit message, and plugin properties (if
2596
+ # the package is a zip plugin package). For more information, see
2464
2597
  # [Custom packages for Amazon OpenSearch Service][1].
2465
2598
  #
2466
2599
  #
@@ -2697,12 +2830,12 @@ module Aws::OpenSearchService
2697
2830
  # or Elasticsearch version.
2698
2831
  #
2699
2832
  # @option params [required, String] :engine_version
2700
- # Version of OpenSearch or Elasticsearch, in the format
2833
+ # The version of OpenSearch or Elasticsearch, in the format
2701
2834
  # Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest version
2702
2835
  # of OpenSearch.
2703
2836
  #
2704
2837
  # @option params [String] :domain_name
2705
- # Name of the domain to list instance type details for.
2838
+ # The name of the domain.
2706
2839
  #
2707
2840
  # @option params [Integer] :max_results
2708
2841
  # An optional parameter that specifies the maximum number of results to
@@ -2714,6 +2847,14 @@ module Aws::OpenSearchService
2714
2847
  # `ListInstanceTypeDetails` operations, which returns results in the
2715
2848
  # next page.
2716
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
+ #
2717
2858
  # @return [Types::ListInstanceTypeDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2718
2859
  #
2719
2860
  # * {Types::ListInstanceTypeDetailsResponse#instance_type_details #instance_type_details} => Array<Types::InstanceTypeDetails>
@@ -2728,6 +2869,8 @@ module Aws::OpenSearchService
2728
2869
  # domain_name: "DomainName",
2729
2870
  # max_results: 1,
2730
2871
  # next_token: "NextToken",
2872
+ # retrieve_a_zs: false,
2873
+ # instance_type: "InstanceTypeString",
2731
2874
  # })
2732
2875
  #
2733
2876
  # @example Response structure
@@ -2741,6 +2884,8 @@ module Aws::OpenSearchService
2741
2884
  # resp.instance_type_details[0].warm_enabled #=> Boolean
2742
2885
  # resp.instance_type_details[0].instance_role #=> Array
2743
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
2744
2889
  # resp.next_token #=> String
2745
2890
  #
2746
2891
  # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails AWS API Documentation
@@ -2812,6 +2957,66 @@ module Aws::OpenSearchService
2812
2957
  req.send_request(options)
2813
2958
  end
2814
2959
 
2960
+ # Retrieves a list of configuration changes that are scheduled for a
2961
+ # domain. These changes can be [service software updates][1] or
2962
+ # [blue/green Auto-Tune enhancements][2].
2963
+ #
2964
+ #
2965
+ #
2966
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
2967
+ # [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
2968
+ #
2969
+ # @option params [required, String] :domain_name
2970
+ # The name of the domain.
2971
+ #
2972
+ # @option params [Integer] :max_results
2973
+ # An optional parameter that specifies the maximum number of results to
2974
+ # return. You can use `nextToken` to get the next page of results.
2975
+ #
2976
+ # @option params [String] :next_token
2977
+ # If your initial `ListScheduledActions` operation returns a
2978
+ # `nextToken`, you can include the returned `nextToken` in subsequent
2979
+ # `ListScheduledActions` operations, which returns results in the next
2980
+ # page.
2981
+ #
2982
+ # @return [Types::ListScheduledActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2983
+ #
2984
+ # * {Types::ListScheduledActionsResponse#scheduled_actions #scheduled_actions} => Array<Types::ScheduledAction>
2985
+ # * {Types::ListScheduledActionsResponse#next_token #next_token} => String
2986
+ #
2987
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2988
+ #
2989
+ # @example Request syntax with placeholder values
2990
+ #
2991
+ # resp = client.list_scheduled_actions({
2992
+ # domain_name: "DomainName", # required
2993
+ # max_results: 1,
2994
+ # next_token: "NextToken",
2995
+ # })
2996
+ #
2997
+ # @example Response structure
2998
+ #
2999
+ # resp.scheduled_actions #=> Array
3000
+ # resp.scheduled_actions[0].id #=> String
3001
+ # resp.scheduled_actions[0].type #=> String, one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
3002
+ # resp.scheduled_actions[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
3003
+ # resp.scheduled_actions[0].scheduled_time #=> Integer
3004
+ # resp.scheduled_actions[0].description #=> String
3005
+ # resp.scheduled_actions[0].scheduled_by #=> String, one of "CUSTOMER", "SYSTEM"
3006
+ # resp.scheduled_actions[0].status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
3007
+ # resp.scheduled_actions[0].mandatory #=> Boolean
3008
+ # resp.scheduled_actions[0].cancellable #=> Boolean
3009
+ # resp.next_token #=> String
3010
+ #
3011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActions AWS API Documentation
3012
+ #
3013
+ # @overload list_scheduled_actions(params = {})
3014
+ # @param [Hash] params ({})
3015
+ def list_scheduled_actions(params = {}, options = {})
3016
+ req = build_request(:list_scheduled_actions, params)
3017
+ req.send_request(options)
3018
+ end
3019
+
2815
3020
  # Returns all resource tags for an Amazon OpenSearch Service domain. For
2816
3021
  # more information, see [Tagging Amazon OpenSearch Service domains][1].
2817
3022
  #
@@ -3157,6 +3362,29 @@ module Aws::OpenSearchService
3157
3362
  # The name of the domain that you want to update to the latest service
3158
3363
  # software.
3159
3364
  #
3365
+ # @option params [String] :schedule_at
3366
+ # When to start the service software update.
3367
+ #
3368
+ # * `NOW` - Immediately schedules the update to happen in the current
3369
+ # hour if there's capacity available.
3370
+ #
3371
+ # * `TIMESTAMP` - Lets you specify a custom date and time to apply the
3372
+ # update. If you specify this value, you must also provide a value for
3373
+ # `DesiredStartTime`.
3374
+ #
3375
+ # * `OFF_PEAK_WINDOW` - Marks the update to be picked up during an
3376
+ # upcoming off-peak window. There's no guarantee that the update will
3377
+ # happen during the next immediate window. Depending on capacity, it
3378
+ # might happen in subsequent days.
3379
+ #
3380
+ # Default: `NOW` if you don't specify a value for `DesiredStartTime`,
3381
+ # and `TIMESTAMP` if you do.
3382
+ #
3383
+ # @option params [Integer] :desired_start_time
3384
+ # The Epoch timestamp when you want the service software update to
3385
+ # start. You only need to specify this parameter if you set `ScheduleAt`
3386
+ # to `TIMESTAMP`.
3387
+ #
3160
3388
  # @return [Types::StartServiceSoftwareUpdateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3161
3389
  #
3162
3390
  # * {Types::StartServiceSoftwareUpdateResponse#service_software_options #service_software_options} => Types::ServiceSoftwareOptions
@@ -3165,6 +3393,8 @@ module Aws::OpenSearchService
3165
3393
  #
3166
3394
  # resp = client.start_service_software_update({
3167
3395
  # domain_name: "DomainName", # required
3396
+ # schedule_at: "NOW", # accepts NOW, TIMESTAMP, OFF_PEAK_WINDOW
3397
+ # desired_start_time: 1,
3168
3398
  # })
3169
3399
  #
3170
3400
  # @example Response structure
@@ -3239,12 +3469,6 @@ module Aws::OpenSearchService
3239
3469
  # with more than the permitted number of clauses result in a
3240
3470
  # `TooManyClauses` error.
3241
3471
  #
3242
- # * `"override_main_response_version": "true" | "false"` - Note the use
3243
- # of a string rather than a boolean. Specifies whether the domain
3244
- # reports its version as 7.10 to allow Elasticsearch OSS clients and
3245
- # plugins to continue working with it. Default is false when creating
3246
- # a domain and true when upgrading a domain.
3247
- #
3248
3472
  # For more information, see [Advanced cluster parameters][1].
3249
3473
  #
3250
3474
  #
@@ -3256,7 +3480,7 @@ module Aws::OpenSearchService
3256
3480
  # string.
3257
3481
  #
3258
3482
  # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
3259
- # Options to publish OpenSearch lots to Amazon CloudWatch Logs.
3483
+ # Options to publish OpenSearch logs to Amazon CloudWatch Logs.
3260
3484
  #
3261
3485
  # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
3262
3486
  # Encryption at rest options for the domain.
@@ -3266,7 +3490,7 @@ module Aws::OpenSearchService
3266
3490
  # HTTPS for all traffic.
3267
3491
  #
3268
3492
  # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
3269
- # Node-To-Node Encryption options for the domain.
3493
+ # Node-to-node encryption options for the domain.
3270
3494
  #
3271
3495
  # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
3272
3496
  # Options for fine-grained access control.
@@ -3293,6 +3517,12 @@ module Aws::OpenSearchService
3293
3517
  #
3294
3518
  # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check
3295
3519
  #
3520
+ # @option params [Types::OffPeakWindowOptions] :off_peak_window_options
3521
+ # Off-peak window options for the domain.
3522
+ #
3523
+ # @option params [Types::SoftwareUpdateOptions] :software_update_options
3524
+ # Service software update options for the domain.
3525
+ #
3296
3526
  # @return [Types::UpdateDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3297
3527
  #
3298
3528
  # * {Types::UpdateDomainConfigResponse#domain_config #domain_config} => Types::DomainConfig
@@ -3319,6 +3549,7 @@ module Aws::OpenSearchService
3319
3549
  # cold_storage_options: {
3320
3550
  # enabled: false, # required
3321
3551
  # },
3552
+ # multi_az_with_standby_enabled: false,
3322
3553
  # },
3323
3554
  # ebs_options: {
3324
3555
  # ebs_enabled: false,
@@ -3399,9 +3630,22 @@ module Aws::OpenSearchService
3399
3630
  # cron_expression_for_recurrence: "String",
3400
3631
  # },
3401
3632
  # ],
3633
+ # use_off_peak_window: false,
3402
3634
  # },
3403
3635
  # dry_run: false,
3404
3636
  # dry_run_mode: "Basic", # accepts Basic, Verbose
3637
+ # off_peak_window_options: {
3638
+ # enabled: false,
3639
+ # off_peak_window: {
3640
+ # window_start_time: {
3641
+ # hours: 1, # required
3642
+ # minutes: 1, # required
3643
+ # },
3644
+ # },
3645
+ # },
3646
+ # software_update_options: {
3647
+ # auto_software_update_enabled: false,
3648
+ # },
3405
3649
  # })
3406
3650
  #
3407
3651
  # @example Response structure
@@ -3423,6 +3667,7 @@ module Aws::OpenSearchService
3423
3667
  # resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
3424
3668
  # resp.domain_config.cluster_config.options.warm_count #=> Integer
3425
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
3426
3671
  # resp.domain_config.cluster_config.status.creation_date #=> Time
3427
3672
  # resp.domain_config.cluster_config.status.update_date #=> Time
3428
3673
  # resp.domain_config.cluster_config.status.update_version #=> Integer
@@ -3531,6 +3776,7 @@ module Aws::OpenSearchService
3531
3776
  # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
3532
3777
  # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
3533
3778
  # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
3779
+ # resp.domain_config.auto_tune_options.options.use_off_peak_window #=> Boolean
3534
3780
  # resp.domain_config.auto_tune_options.status.creation_date #=> Time
3535
3781
  # resp.domain_config.auto_tune_options.status.update_date #=> Time
3536
3782
  # resp.domain_config.auto_tune_options.status.update_version #=> Integer
@@ -3539,6 +3785,20 @@ module Aws::OpenSearchService
3539
3785
  # resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
3540
3786
  # resp.domain_config.change_progress_details.change_id #=> String
3541
3787
  # resp.domain_config.change_progress_details.message #=> String
3788
+ # resp.domain_config.off_peak_window_options.options.enabled #=> Boolean
3789
+ # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer
3790
+ # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer
3791
+ # resp.domain_config.off_peak_window_options.status.creation_date #=> Time
3792
+ # resp.domain_config.off_peak_window_options.status.update_date #=> Time
3793
+ # resp.domain_config.off_peak_window_options.status.update_version #=> Integer
3794
+ # resp.domain_config.off_peak_window_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
3795
+ # resp.domain_config.off_peak_window_options.status.pending_deletion #=> Boolean
3796
+ # resp.domain_config.software_update_options.options.auto_software_update_enabled #=> Boolean
3797
+ # resp.domain_config.software_update_options.status.creation_date #=> Time
3798
+ # resp.domain_config.software_update_options.status.update_date #=> Time
3799
+ # resp.domain_config.software_update_options.status.update_version #=> Integer
3800
+ # resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
3801
+ # resp.domain_config.software_update_options.status.pending_deletion #=> Boolean
3542
3802
  # resp.dry_run_results.deployment_type #=> String
3543
3803
  # resp.dry_run_results.message #=> String
3544
3804
  # resp.dry_run_progress_status.dry_run_id #=> String
@@ -3617,6 +3877,90 @@ module Aws::OpenSearchService
3617
3877
  req.send_request(options)
3618
3878
  end
3619
3879
 
3880
+ # Reschedules a planned domain configuration change for a later time.
3881
+ # This change can be a scheduled [service software update][1] or a
3882
+ # [blue/green Auto-Tune enhancement][2].
3883
+ #
3884
+ #
3885
+ #
3886
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
3887
+ # [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
3888
+ #
3889
+ # @option params [required, String] :domain_name
3890
+ # The name of the domain to reschedule an action for.
3891
+ #
3892
+ # @option params [required, String] :action_id
3893
+ # The unique identifier of the action to reschedule. To retrieve this
3894
+ # ID, send a [ListScheduledActions][1] request.
3895
+ #
3896
+ #
3897
+ #
3898
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
3899
+ #
3900
+ # @option params [required, String] :action_type
3901
+ # The type of action to reschedule. Can be one of
3902
+ # `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or
3903
+ # `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a
3904
+ # [ListScheduledActions][1] request.
3905
+ #
3906
+ #
3907
+ #
3908
+ # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
3909
+ #
3910
+ # @option params [required, String] :schedule_at
3911
+ # When to schedule the action.
3912
+ #
3913
+ # * `NOW` - Immediately schedules the update to happen in the current
3914
+ # hour if there's capacity available.
3915
+ #
3916
+ # * `TIMESTAMP` - Lets you specify a custom date and time to apply the
3917
+ # update. If you specify this value, you must also provide a value for
3918
+ # `DesiredStartTime`.
3919
+ #
3920
+ # * `OFF_PEAK_WINDOW` - Marks the action to be picked up during an
3921
+ # upcoming off-peak window. There's no guarantee that the change will
3922
+ # be implemented during the next immediate window. Depending on
3923
+ # capacity, it might happen in subsequent days.
3924
+ #
3925
+ # @option params [Integer] :desired_start_time
3926
+ # The time to implement the change, in Coordinated Universal Time (UTC).
3927
+ # Only specify this parameter if you set `ScheduleAt` to `TIMESTAMP`.
3928
+ #
3929
+ # @return [Types::UpdateScheduledActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3930
+ #
3931
+ # * {Types::UpdateScheduledActionResponse#scheduled_action #scheduled_action} => Types::ScheduledAction
3932
+ #
3933
+ # @example Request syntax with placeholder values
3934
+ #
3935
+ # resp = client.update_scheduled_action({
3936
+ # domain_name: "DomainName", # required
3937
+ # action_id: "String", # required
3938
+ # action_type: "SERVICE_SOFTWARE_UPDATE", # required, accepts SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, JVM_YOUNG_GEN_TUNING
3939
+ # schedule_at: "NOW", # required, accepts NOW, TIMESTAMP, OFF_PEAK_WINDOW
3940
+ # desired_start_time: 1,
3941
+ # })
3942
+ #
3943
+ # @example Response structure
3944
+ #
3945
+ # resp.scheduled_action.id #=> String
3946
+ # resp.scheduled_action.type #=> String, one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
3947
+ # resp.scheduled_action.severity #=> String, one of "HIGH", "MEDIUM", "LOW"
3948
+ # resp.scheduled_action.scheduled_time #=> Integer
3949
+ # resp.scheduled_action.description #=> String
3950
+ # resp.scheduled_action.scheduled_by #=> String, one of "CUSTOMER", "SYSTEM"
3951
+ # resp.scheduled_action.status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
3952
+ # resp.scheduled_action.mandatory #=> Boolean
3953
+ # resp.scheduled_action.cancellable #=> Boolean
3954
+ #
3955
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledAction AWS API Documentation
3956
+ #
3957
+ # @overload update_scheduled_action(params = {})
3958
+ # @param [Hash] params ({})
3959
+ def update_scheduled_action(params = {}, options = {})
3960
+ req = build_request(:update_scheduled_action, params)
3961
+ req.send_request(options)
3962
+ end
3963
+
3620
3964
  # Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
3621
3965
  #
3622
3966
  # @option params [required, String] :vpc_endpoint_id
@@ -3738,7 +4082,7 @@ module Aws::OpenSearchService
3738
4082
  params: params,
3739
4083
  config: config)
3740
4084
  context[:gem_name] = 'aws-sdk-opensearchservice'
3741
- context[:gem_version] = '1.16.0'
4085
+ context[:gem_version] = '1.18.0'
3742
4086
  Seahorse::Client::Request.new(handlers, context)
3743
4087
  end
3744
4088