aws-sdk-opensearchservice 1.16.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-opensearchservice/client.rb +357 -13
- data/lib/aws-sdk-opensearchservice/client_api.rb +195 -0
- data/lib/aws-sdk-opensearchservice/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-opensearchservice/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-opensearchservice/endpoints.rb +42 -0
- data/lib/aws-sdk-opensearchservice/errors.rb +16 -0
- data/lib/aws-sdk-opensearchservice/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-opensearchservice/types.rb +707 -51
- data/lib/aws-sdk-opensearchservice.rb +1 -1
- metadata +2 -2
@@ -439,12 +439,20 @@ module Aws::OpenSearchService
|
|
439
439
|
include Aws::Structure
|
440
440
|
end
|
441
441
|
|
442
|
+
# <note markdown="1"> This object is deprecated. Use the domain's [off-peak window][1] to
|
443
|
+
# schedule Auto-Tune optimizations. For migration instructions, see
|
444
|
+
# [Migrating from Auto-Tune maintenance windows][2].
|
445
|
+
#
|
446
|
+
# </note>
|
447
|
+
#
|
442
448
|
# The Auto-Tune maintenance schedule. For more information, see
|
443
|
-
# [Auto-Tune for Amazon OpenSearch Service][
|
449
|
+
# [Auto-Tune for Amazon OpenSearch Service][3].
|
444
450
|
#
|
445
451
|
#
|
446
452
|
#
|
447
|
-
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/
|
453
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
|
454
|
+
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate
|
455
|
+
# [3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
|
448
456
|
#
|
449
457
|
# @!attribute [rw] start_at
|
450
458
|
# The Epoch timestamp at which the Auto-Tune maintenance schedule
|
@@ -491,22 +499,39 @@ module Aws::OpenSearchService
|
|
491
499
|
# @return [String]
|
492
500
|
#
|
493
501
|
# @!attribute [rw] maintenance_schedules
|
502
|
+
# DEPRECATED. Use [off-peak window][1] instead.
|
503
|
+
#
|
494
504
|
# A list of maintenance schedules during which Auto-Tune can deploy
|
495
505
|
# changes.
|
506
|
+
#
|
507
|
+
#
|
508
|
+
#
|
509
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
|
496
510
|
# @return [Array<Types::AutoTuneMaintenanceSchedule>]
|
497
511
|
#
|
512
|
+
# @!attribute [rw] use_off_peak_window
|
513
|
+
# Whether to use the domain's [off-peak window][1] to deploy
|
514
|
+
# configuration changes on the domain rather than a maintenance
|
515
|
+
# schedule.
|
516
|
+
#
|
517
|
+
#
|
518
|
+
#
|
519
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
|
520
|
+
# @return [Boolean]
|
521
|
+
#
|
498
522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptions AWS API Documentation
|
499
523
|
#
|
500
524
|
class AutoTuneOptions < Struct.new(
|
501
525
|
:desired_state,
|
502
526
|
:rollback_on_disable,
|
503
|
-
:maintenance_schedules
|
527
|
+
:maintenance_schedules,
|
528
|
+
:use_off_peak_window)
|
504
529
|
SENSITIVE = []
|
505
530
|
include Aws::Structure
|
506
531
|
end
|
507
532
|
|
508
533
|
# Options for configuring Auto-Tune. For more information, see
|
509
|
-
# [Auto-Tune for Amazon OpenSearch Service][1]
|
534
|
+
# [Auto-Tune for Amazon OpenSearch Service][1]
|
510
535
|
#
|
511
536
|
#
|
512
537
|
#
|
@@ -518,18 +543,25 @@ module Aws::OpenSearchService
|
|
518
543
|
#
|
519
544
|
# @!attribute [rw] maintenance_schedules
|
520
545
|
# A list of maintenance schedules during which Auto-Tune can deploy
|
521
|
-
# changes. Maintenance
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
546
|
+
# changes. Maintenance windows are deprecated and have been replaced
|
547
|
+
# with [off-peak windows][1].
|
548
|
+
#
|
549
|
+
#
|
550
|
+
#
|
551
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
|
526
552
|
# @return [Array<Types::AutoTuneMaintenanceSchedule>]
|
527
553
|
#
|
554
|
+
# @!attribute [rw] use_off_peak_window
|
555
|
+
# Whether to schedule Auto-Tune optimizations that require blue/green
|
556
|
+
# deployments during the domain's configured daily off-peak window.
|
557
|
+
# @return [Boolean]
|
558
|
+
#
|
528
559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsInput AWS API Documentation
|
529
560
|
#
|
530
561
|
class AutoTuneOptionsInput < Struct.new(
|
531
562
|
:desired_state,
|
532
|
-
:maintenance_schedules
|
563
|
+
:maintenance_schedules,
|
564
|
+
:use_off_peak_window)
|
533
565
|
SENSITIVE = []
|
534
566
|
include Aws::Structure
|
535
567
|
end
|
@@ -545,11 +577,17 @@ module Aws::OpenSearchService
|
|
545
577
|
# Any errors that occurred while enabling or disabling Auto-Tune.
|
546
578
|
# @return [String]
|
547
579
|
#
|
580
|
+
# @!attribute [rw] use_off_peak_window
|
581
|
+
# Whether the domain's off-peak window will be used to deploy
|
582
|
+
# Auto-Tune changes rather than a maintenance schedule.
|
583
|
+
# @return [Boolean]
|
584
|
+
#
|
548
585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsOutput AWS API Documentation
|
549
586
|
#
|
550
587
|
class AutoTuneOptionsOutput < Struct.new(
|
551
588
|
:state,
|
552
|
-
:error_message
|
589
|
+
:error_message,
|
590
|
+
:use_off_peak_window)
|
553
591
|
SENSITIVE = []
|
554
592
|
include Aws::Structure
|
555
593
|
end
|
@@ -618,6 +656,55 @@ module Aws::OpenSearchService
|
|
618
656
|
include Aws::Structure
|
619
657
|
end
|
620
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
|
+
|
621
708
|
# An error occurred while processing the request.
|
622
709
|
#
|
623
710
|
# @!attribute [rw] message
|
@@ -806,7 +893,8 @@ module Aws::OpenSearchService
|
|
806
893
|
#
|
807
894
|
# @!attribute [rw] dedicated_master_count
|
808
895
|
# Number of dedicated master nodes in the cluster. This number must be
|
809
|
-
# greater than
|
896
|
+
# greater than 2 and not 4, otherwise you receive a validation
|
897
|
+
# exception.
|
810
898
|
# @return [Integer]
|
811
899
|
#
|
812
900
|
# @!attribute [rw] warm_enabled
|
@@ -825,6 +913,16 @@ module Aws::OpenSearchService
|
|
825
913
|
# Container for cold storage configuration options.
|
826
914
|
# @return [Types::ColdStorageOptions]
|
827
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
|
+
#
|
828
926
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ClusterConfig AWS API Documentation
|
829
927
|
#
|
830
928
|
class ClusterConfig < Struct.new(
|
@@ -838,7 +936,8 @@ module Aws::OpenSearchService
|
|
838
936
|
:warm_enabled,
|
839
937
|
:warm_type,
|
840
938
|
:warm_count,
|
841
|
-
:cold_storage_options
|
939
|
+
:cold_storage_options,
|
940
|
+
:multi_az_with_standby_enabled)
|
842
941
|
SENSITIVE = []
|
843
942
|
include Aws::Structure
|
844
943
|
end
|
@@ -963,7 +1062,7 @@ module Aws::OpenSearchService
|
|
963
1062
|
end
|
964
1063
|
|
965
1064
|
# An error occurred because the client attempts to remove a resource
|
966
|
-
# that
|
1065
|
+
# that is currently in use.
|
967
1066
|
#
|
968
1067
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ConflictException AWS API Documentation
|
969
1068
|
#
|
@@ -1103,6 +1202,19 @@ module Aws::OpenSearchService
|
|
1103
1202
|
# Options for Auto-Tune.
|
1104
1203
|
# @return [Types::AutoTuneOptionsInput]
|
1105
1204
|
#
|
1205
|
+
# @!attribute [rw] off_peak_window_options
|
1206
|
+
# Specifies a daily 10-hour time block during which OpenSearch Service
|
1207
|
+
# can perform configuration changes on the domain, including service
|
1208
|
+
# software updates and Auto-Tune enhancements that require a
|
1209
|
+
# blue/green deployment. If no options are specified, the default
|
1210
|
+
# start time of 10:00 P.M. local time (for the Region that the domain
|
1211
|
+
# is created in) is used.
|
1212
|
+
# @return [Types::OffPeakWindowOptions]
|
1213
|
+
#
|
1214
|
+
# @!attribute [rw] software_update_options
|
1215
|
+
# Software update options for the domain.
|
1216
|
+
# @return [Types::SoftwareUpdateOptions]
|
1217
|
+
#
|
1106
1218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomainRequest AWS API Documentation
|
1107
1219
|
#
|
1108
1220
|
class CreateDomainRequest < Struct.new(
|
@@ -1121,7 +1233,9 @@ module Aws::OpenSearchService
|
|
1121
1233
|
:domain_endpoint_options,
|
1122
1234
|
:advanced_security_options,
|
1123
1235
|
:tag_list,
|
1124
|
-
:auto_tune_options
|
1236
|
+
:auto_tune_options,
|
1237
|
+
:off_peak_window_options,
|
1238
|
+
:software_update_options)
|
1125
1239
|
SENSITIVE = []
|
1126
1240
|
include Aws::Structure
|
1127
1241
|
end
|
@@ -1224,7 +1338,7 @@ module Aws::OpenSearchService
|
|
1224
1338
|
# @return [String]
|
1225
1339
|
#
|
1226
1340
|
# @!attribute [rw] package_type
|
1227
|
-
#
|
1341
|
+
# The type of package.
|
1228
1342
|
# @return [String]
|
1229
1343
|
#
|
1230
1344
|
# @!attribute [rw] package_description
|
@@ -1560,6 +1674,127 @@ module Aws::OpenSearchService
|
|
1560
1674
|
include Aws::Structure
|
1561
1675
|
end
|
1562
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
|
+
|
1563
1798
|
# Container for the parameters to the `DescribeDomain` operation.
|
1564
1799
|
#
|
1565
1800
|
# @!attribute [rw] domain_name
|
@@ -2077,8 +2312,7 @@ module Aws::OpenSearchService
|
|
2077
2312
|
# @return [Types::ClusterConfigStatus]
|
2078
2313
|
#
|
2079
2314
|
# @!attribute [rw] ebs_options
|
2080
|
-
# Container for EBS options configured for
|
2081
|
-
# domain.
|
2315
|
+
# Container for EBS options configured for the domain.
|
2082
2316
|
# @return [Types::EBSOptionsStatus]
|
2083
2317
|
#
|
2084
2318
|
# @!attribute [rw] access_policies
|
@@ -2138,6 +2372,14 @@ module Aws::OpenSearchService
|
|
2138
2372
|
# configuration change.
|
2139
2373
|
# @return [Types::ChangeProgressDetails]
|
2140
2374
|
#
|
2375
|
+
# @!attribute [rw] off_peak_window_options
|
2376
|
+
# Container for off-peak window options for the domain.
|
2377
|
+
# @return [Types::OffPeakWindowOptionsStatus]
|
2378
|
+
#
|
2379
|
+
# @!attribute [rw] software_update_options
|
2380
|
+
# Software update options for the domain.
|
2381
|
+
# @return [Types::SoftwareUpdateOptionsStatus]
|
2382
|
+
#
|
2141
2383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainConfig AWS API Documentation
|
2142
2384
|
#
|
2143
2385
|
class DomainConfig < Struct.new(
|
@@ -2155,7 +2397,9 @@ module Aws::OpenSearchService
|
|
2155
2397
|
:domain_endpoint_options,
|
2156
2398
|
:advanced_security_options,
|
2157
2399
|
:auto_tune_options,
|
2158
|
-
:change_progress_details
|
2400
|
+
:change_progress_details,
|
2401
|
+
:off_peak_window_options,
|
2402
|
+
:software_update_options)
|
2159
2403
|
SENSITIVE = []
|
2160
2404
|
include Aws::Structure
|
2161
2405
|
end
|
@@ -2296,9 +2540,8 @@ module Aws::OpenSearchService
|
|
2296
2540
|
# @return [String]
|
2297
2541
|
#
|
2298
2542
|
# @!attribute [rw] reference_path
|
2299
|
-
#
|
2300
|
-
#
|
2301
|
-
# 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.
|
2302
2545
|
# @return [String]
|
2303
2546
|
#
|
2304
2547
|
# @!attribute [rw] error_details
|
@@ -2362,7 +2605,7 @@ module Aws::OpenSearchService
|
|
2362
2605
|
#
|
2363
2606
|
# @!attribute [rw] endpoints
|
2364
2607
|
# The key-value pair that exists if the OpenSearch Service domain uses
|
2365
|
-
# VPC endpoints.. Example `key, value
|
2608
|
+
# VPC endpoints.. Example `key, value`:
|
2366
2609
|
# `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.
|
2367
2610
|
# @return [Hash<String,String>]
|
2368
2611
|
#
|
@@ -2447,6 +2690,15 @@ module Aws::OpenSearchService
|
|
2447
2690
|
# Information about a configuration change happening on the domain.
|
2448
2691
|
# @return [Types::ChangeProgressDetails]
|
2449
2692
|
#
|
2693
|
+
# @!attribute [rw] off_peak_window_options
|
2694
|
+
# Options that specify a custom 10-hour window during which OpenSearch
|
2695
|
+
# Service can perform configuration changes on the domain.
|
2696
|
+
# @return [Types::OffPeakWindowOptions]
|
2697
|
+
#
|
2698
|
+
# @!attribute [rw] software_update_options
|
2699
|
+
# Service software update options for the domain.
|
2700
|
+
# @return [Types::SoftwareUpdateOptions]
|
2701
|
+
#
|
2450
2702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainStatus AWS API Documentation
|
2451
2703
|
#
|
2452
2704
|
class DomainStatus < Struct.new(
|
@@ -2474,7 +2726,9 @@ module Aws::OpenSearchService
|
|
2474
2726
|
:domain_endpoint_options,
|
2475
2727
|
:advanced_security_options,
|
2476
2728
|
:auto_tune_options,
|
2477
|
-
:change_progress_details
|
2729
|
+
:change_progress_details,
|
2730
|
+
:off_peak_window_options,
|
2731
|
+
:software_update_options)
|
2478
2732
|
SENSITIVE = []
|
2479
2733
|
include Aws::Structure
|
2480
2734
|
end
|
@@ -2669,6 +2923,20 @@ module Aws::OpenSearchService
|
|
2669
2923
|
include Aws::Structure
|
2670
2924
|
end
|
2671
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
|
+
|
2672
2940
|
# Additional information if the package is in an error state. Null
|
2673
2941
|
# otherwise.
|
2674
2942
|
#
|
@@ -2944,20 +3212,20 @@ module Aws::OpenSearchService
|
|
2944
3212
|
# * **PENDING\_ACCEPTANCE** - Inbound connection is not yet accepted
|
2945
3213
|
# by the remote domain owner.
|
2946
3214
|
#
|
2947
|
-
# * **APPROVED
|
3215
|
+
# * **APPROVED**: Inbound connection is pending acceptance by the
|
2948
3216
|
# remote domain owner.
|
2949
3217
|
#
|
2950
|
-
# * **PROVISIONING
|
3218
|
+
# * **PROVISIONING**: Inbound connection is being provisioned.
|
2951
3219
|
#
|
2952
|
-
# * **ACTIVE
|
3220
|
+
# * **ACTIVE**: Inbound connection is active and ready to use.
|
2953
3221
|
#
|
2954
|
-
# * **REJECTING
|
3222
|
+
# * **REJECTING**: Inbound connection rejection is in process.
|
2955
3223
|
#
|
2956
|
-
# * **REJECTED
|
3224
|
+
# * **REJECTED**: Inbound connection is rejected.
|
2957
3225
|
#
|
2958
|
-
# * **DELETING
|
3226
|
+
# * **DELETING**: Inbound connection deletion is in progress.
|
2959
3227
|
#
|
2960
|
-
# * **DELETED
|
3228
|
+
# * **DELETED**: Inbound connection is deleted and can no longer be
|
2961
3229
|
# used.
|
2962
3230
|
# @return [String]
|
2963
3231
|
#
|
@@ -3044,6 +3312,10 @@ module Aws::OpenSearchService
|
|
3044
3312
|
# or an UltraWarm node.
|
3045
3313
|
# @return [Array<String>]
|
3046
3314
|
#
|
3315
|
+
# @!attribute [rw] availability_zones
|
3316
|
+
# The supported Availability Zones for the instance type.
|
3317
|
+
# @return [Array<String>]
|
3318
|
+
#
|
3047
3319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InstanceTypeDetails AWS API Documentation
|
3048
3320
|
#
|
3049
3321
|
class InstanceTypeDetails < Struct.new(
|
@@ -3053,7 +3325,8 @@ module Aws::OpenSearchService
|
|
3053
3325
|
:app_logs_enabled,
|
3054
3326
|
:advanced_security_enabled,
|
3055
3327
|
:warm_enabled,
|
3056
|
-
:instance_role
|
3328
|
+
:instance_role,
|
3329
|
+
:availability_zones)
|
3057
3330
|
SENSITIVE = []
|
3058
3331
|
include Aws::Structure
|
3059
3332
|
end
|
@@ -3065,8 +3338,8 @@ module Aws::OpenSearchService
|
|
3065
3338
|
#
|
3066
3339
|
class InternalException < Aws::EmptyStructure; end
|
3067
3340
|
|
3068
|
-
#
|
3069
|
-
#
|
3341
|
+
# Request processing failed because you provided an invalid pagination
|
3342
|
+
# token.
|
3070
3343
|
#
|
3071
3344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InvalidPaginationTokenException AWS API Documentation
|
3072
3345
|
#
|
@@ -3196,13 +3469,13 @@ module Aws::OpenSearchService
|
|
3196
3469
|
end
|
3197
3470
|
|
3198
3471
|
# @!attribute [rw] engine_version
|
3199
|
-
#
|
3472
|
+
# The version of OpenSearch or Elasticsearch, in the format
|
3200
3473
|
# Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
|
3201
3474
|
# version of OpenSearch.
|
3202
3475
|
# @return [String]
|
3203
3476
|
#
|
3204
3477
|
# @!attribute [rw] domain_name
|
3205
|
-
#
|
3478
|
+
# The name of the domain.
|
3206
3479
|
# @return [String]
|
3207
3480
|
#
|
3208
3481
|
# @!attribute [rw] max_results
|
@@ -3217,13 +3490,25 @@ module Aws::OpenSearchService
|
|
3217
3490
|
# next page.
|
3218
3491
|
# @return [String]
|
3219
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
|
+
#
|
3220
3503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetailsRequest AWS API Documentation
|
3221
3504
|
#
|
3222
3505
|
class ListInstanceTypeDetailsRequest < Struct.new(
|
3223
3506
|
:engine_version,
|
3224
3507
|
:domain_name,
|
3225
3508
|
:max_results,
|
3226
|
-
:next_token
|
3509
|
+
:next_token,
|
3510
|
+
:retrieve_a_zs,
|
3511
|
+
:instance_type)
|
3227
3512
|
SENSITIVE = []
|
3228
3513
|
include Aws::Structure
|
3229
3514
|
end
|
@@ -3302,6 +3587,52 @@ module Aws::OpenSearchService
|
|
3302
3587
|
include Aws::Structure
|
3303
3588
|
end
|
3304
3589
|
|
3590
|
+
# @!attribute [rw] domain_name
|
3591
|
+
# The name of the domain.
|
3592
|
+
# @return [String]
|
3593
|
+
#
|
3594
|
+
# @!attribute [rw] max_results
|
3595
|
+
# An optional parameter that specifies the maximum number of results
|
3596
|
+
# to return. You can use `nextToken` to get the next page of results.
|
3597
|
+
# @return [Integer]
|
3598
|
+
#
|
3599
|
+
# @!attribute [rw] next_token
|
3600
|
+
# If your initial `ListScheduledActions` operation returns a
|
3601
|
+
# `nextToken`, you can include the returned `nextToken` in subsequent
|
3602
|
+
# `ListScheduledActions` operations, which returns results in the next
|
3603
|
+
# page.
|
3604
|
+
# @return [String]
|
3605
|
+
#
|
3606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActionsRequest AWS API Documentation
|
3607
|
+
#
|
3608
|
+
class ListScheduledActionsRequest < Struct.new(
|
3609
|
+
:domain_name,
|
3610
|
+
:max_results,
|
3611
|
+
:next_token)
|
3612
|
+
SENSITIVE = []
|
3613
|
+
include Aws::Structure
|
3614
|
+
end
|
3615
|
+
|
3616
|
+
# @!attribute [rw] scheduled_actions
|
3617
|
+
# A list of actions that are scheduled for the domain.
|
3618
|
+
# @return [Array<Types::ScheduledAction>]
|
3619
|
+
#
|
3620
|
+
# @!attribute [rw] next_token
|
3621
|
+
# When `nextToken` is returned, there are more results available. The
|
3622
|
+
# value of `nextToken` is a unique pagination token for each page.
|
3623
|
+
# Make the call again using the returned token to retrieve the next
|
3624
|
+
# page.
|
3625
|
+
# @return [String]
|
3626
|
+
#
|
3627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActionsResponse AWS API Documentation
|
3628
|
+
#
|
3629
|
+
class ListScheduledActionsResponse < Struct.new(
|
3630
|
+
:scheduled_actions,
|
3631
|
+
:next_token)
|
3632
|
+
SENSITIVE = []
|
3633
|
+
include Aws::Structure
|
3634
|
+
end
|
3635
|
+
|
3305
3636
|
# Container for the parameters to the `ListTags` operation.
|
3306
3637
|
#
|
3307
3638
|
# @!attribute [rw] arn
|
@@ -3615,6 +3946,91 @@ module Aws::OpenSearchService
|
|
3615
3946
|
include Aws::Structure
|
3616
3947
|
end
|
3617
3948
|
|
3949
|
+
# A custom 10-hour, low-traffic window during which OpenSearch Service
|
3950
|
+
# can perform mandatory configuration changes on the domain. These
|
3951
|
+
# actions can include scheduled service software updates and blue/green
|
3952
|
+
# Auto-Tune enhancements. OpenSearch Service will schedule these actions
|
3953
|
+
# during the window that you specify.
|
3954
|
+
#
|
3955
|
+
# If you don't specify a window start time, it defaults to 10:00 P.M.
|
3956
|
+
# local time.
|
3957
|
+
#
|
3958
|
+
# For more information, see [Defining off-peak maintenance windows for
|
3959
|
+
# Amazon OpenSearch Service][1].
|
3960
|
+
#
|
3961
|
+
#
|
3962
|
+
#
|
3963
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
|
3964
|
+
#
|
3965
|
+
# @!attribute [rw] window_start_time
|
3966
|
+
# A custom start time for the off-peak window, in Coordinated
|
3967
|
+
# Universal Time (UTC). The window length will always be 10 hours, so
|
3968
|
+
# you can't specify an end time. For example, if you specify 11:00
|
3969
|
+
# P.M. UTC as a start time, the end time will automatically be set to
|
3970
|
+
# 9:00 A.M.
|
3971
|
+
# @return [Types::WindowStartTime]
|
3972
|
+
#
|
3973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindow AWS API Documentation
|
3974
|
+
#
|
3975
|
+
class OffPeakWindow < Struct.new(
|
3976
|
+
:window_start_time)
|
3977
|
+
SENSITIVE = []
|
3978
|
+
include Aws::Structure
|
3979
|
+
end
|
3980
|
+
|
3981
|
+
# Options for a domain's [off-peak window][1], during which OpenSearch
|
3982
|
+
# Service can perform mandatory configuration changes on the domain.
|
3983
|
+
#
|
3984
|
+
#
|
3985
|
+
#
|
3986
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
|
3987
|
+
#
|
3988
|
+
# @!attribute [rw] enabled
|
3989
|
+
# Whether to enable an off-peak window.
|
3990
|
+
#
|
3991
|
+
# This option is only available when modifying a domain created prior
|
3992
|
+
# to February 16, 2023, not when creating a new domain. All domains
|
3993
|
+
# created after this date have the off-peak window enabled by default.
|
3994
|
+
# You can't disable the off-peak window after it's enabled for a
|
3995
|
+
# domain.
|
3996
|
+
# @return [Boolean]
|
3997
|
+
#
|
3998
|
+
# @!attribute [rw] off_peak_window
|
3999
|
+
# Off-peak window settings for the domain.
|
4000
|
+
# @return [Types::OffPeakWindow]
|
4001
|
+
#
|
4002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindowOptions AWS API Documentation
|
4003
|
+
#
|
4004
|
+
class OffPeakWindowOptions < Struct.new(
|
4005
|
+
:enabled,
|
4006
|
+
:off_peak_window)
|
4007
|
+
SENSITIVE = []
|
4008
|
+
include Aws::Structure
|
4009
|
+
end
|
4010
|
+
|
4011
|
+
# The status of [off-peak window][1] options for a domain.
|
4012
|
+
#
|
4013
|
+
#
|
4014
|
+
#
|
4015
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
|
4016
|
+
#
|
4017
|
+
# @!attribute [rw] options
|
4018
|
+
# The domain's off-peak window configuration.
|
4019
|
+
# @return [Types::OffPeakWindowOptions]
|
4020
|
+
#
|
4021
|
+
# @!attribute [rw] status
|
4022
|
+
# The current status of off-peak window options.
|
4023
|
+
# @return [Types::OptionStatus]
|
4024
|
+
#
|
4025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindowOptionsStatus AWS API Documentation
|
4026
|
+
#
|
4027
|
+
class OffPeakWindowOptionsStatus < Struct.new(
|
4028
|
+
:options,
|
4029
|
+
:status)
|
4030
|
+
SENSITIVE = []
|
4031
|
+
include Aws::Structure
|
4032
|
+
end
|
4033
|
+
|
3618
4034
|
# Provides the current status of an entity.
|
3619
4035
|
#
|
3620
4036
|
# @!attribute [rw] creation_date
|
@@ -3705,7 +4121,7 @@ module Aws::OpenSearchService
|
|
3705
4121
|
# * **VALIDATION\_FAILED** - Validation failed for the connection
|
3706
4122
|
# request.
|
3707
4123
|
#
|
3708
|
-
# * **PENDING\_ACCEPTANCE
|
4124
|
+
# * **PENDING\_ACCEPTANCE**: Outbound connection request is validated
|
3709
4125
|
# and is not yet accepted by the remote domain owner.
|
3710
4126
|
#
|
3711
4127
|
# * **APPROVED** - Outbound connection has been approved by the remote
|
@@ -3747,7 +4163,7 @@ module Aws::OpenSearchService
|
|
3747
4163
|
# @return [String]
|
3748
4164
|
#
|
3749
4165
|
# @!attribute [rw] package_name
|
3750
|
-
#
|
4166
|
+
# The user-specified name of the package.
|
3751
4167
|
# @return [String]
|
3752
4168
|
#
|
3753
4169
|
# @!attribute [rw] package_type
|
@@ -3759,7 +4175,9 @@ module Aws::OpenSearchService
|
|
3759
4175
|
# @return [String]
|
3760
4176
|
#
|
3761
4177
|
# @!attribute [rw] package_status
|
3762
|
-
#
|
4178
|
+
# The current status of the package. The available options are
|
4179
|
+
# `AVAILABLE`, `COPYING`, `COPY_FAILED`, `VALIDATNG`,
|
4180
|
+
# `VALIDATION_FAILED`, `DELETING`, and `DELETE_FAILED`.
|
3763
4181
|
# @return [String]
|
3764
4182
|
#
|
3765
4183
|
# @!attribute [rw] created_at
|
@@ -4228,6 +4646,68 @@ module Aws::OpenSearchService
|
|
4228
4646
|
include Aws::Structure
|
4229
4647
|
end
|
4230
4648
|
|
4649
|
+
# Information about a scheduled configuration change for an OpenSearch
|
4650
|
+
# Service domain. This actions can be a [service software update][1] or
|
4651
|
+
# a [blue/green Auto-Tune enhancement][2].
|
4652
|
+
#
|
4653
|
+
#
|
4654
|
+
#
|
4655
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
|
4656
|
+
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
|
4657
|
+
#
|
4658
|
+
# @!attribute [rw] id
|
4659
|
+
# The unique identifier of the scheduled action.
|
4660
|
+
# @return [String]
|
4661
|
+
#
|
4662
|
+
# @!attribute [rw] type
|
4663
|
+
# The type of action that will be taken on the domain.
|
4664
|
+
# @return [String]
|
4665
|
+
#
|
4666
|
+
# @!attribute [rw] severity
|
4667
|
+
# The severity of the action.
|
4668
|
+
# @return [String]
|
4669
|
+
#
|
4670
|
+
# @!attribute [rw] scheduled_time
|
4671
|
+
# The time when the change is scheduled to happen.
|
4672
|
+
# @return [Integer]
|
4673
|
+
#
|
4674
|
+
# @!attribute [rw] description
|
4675
|
+
# A description of the action to be taken.
|
4676
|
+
# @return [String]
|
4677
|
+
#
|
4678
|
+
# @!attribute [rw] scheduled_by
|
4679
|
+
# Whether the action was scheduled manually (`CUSTOMER`, or by
|
4680
|
+
# OpenSearch Service automatically (`SYSTEM`).
|
4681
|
+
# @return [String]
|
4682
|
+
#
|
4683
|
+
# @!attribute [rw] status
|
4684
|
+
# The current status of the scheduled action.
|
4685
|
+
# @return [String]
|
4686
|
+
#
|
4687
|
+
# @!attribute [rw] mandatory
|
4688
|
+
# Whether the action is required or optional.
|
4689
|
+
# @return [Boolean]
|
4690
|
+
#
|
4691
|
+
# @!attribute [rw] cancellable
|
4692
|
+
# Whether or not the scheduled action is cancellable.
|
4693
|
+
# @return [Boolean]
|
4694
|
+
#
|
4695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ScheduledAction AWS API Documentation
|
4696
|
+
#
|
4697
|
+
class ScheduledAction < Struct.new(
|
4698
|
+
:id,
|
4699
|
+
:type,
|
4700
|
+
:severity,
|
4701
|
+
:scheduled_time,
|
4702
|
+
:description,
|
4703
|
+
:scheduled_by,
|
4704
|
+
:status,
|
4705
|
+
:mandatory,
|
4706
|
+
:cancellable)
|
4707
|
+
SENSITIVE = []
|
4708
|
+
include Aws::Structure
|
4709
|
+
end
|
4710
|
+
|
4231
4711
|
# Specifies details about a scheduled Auto-Tune action. For more
|
4232
4712
|
# information, see [Auto-Tune for Amazon OpenSearch Service][1].
|
4233
4713
|
#
|
@@ -4325,6 +4805,22 @@ module Aws::OpenSearchService
|
|
4325
4805
|
include Aws::Structure
|
4326
4806
|
end
|
4327
4807
|
|
4808
|
+
# An exception for attempting to schedule a domain action during an
|
4809
|
+
# unavailable time slot.
|
4810
|
+
#
|
4811
|
+
# @!attribute [rw] slot_suggestions
|
4812
|
+
# Alternate time slots during which OpenSearch Service has available
|
4813
|
+
# capacity to schedule a domain action.
|
4814
|
+
# @return [Array<Integer>]
|
4815
|
+
#
|
4816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SlotNotAvailableException AWS API Documentation
|
4817
|
+
#
|
4818
|
+
class SlotNotAvailableException < Struct.new(
|
4819
|
+
:slot_suggestions)
|
4820
|
+
SENSITIVE = []
|
4821
|
+
include Aws::Structure
|
4822
|
+
end
|
4823
|
+
|
4328
4824
|
# The time, in UTC format, when OpenSearch Service takes a daily
|
4329
4825
|
# automated snapshot of the specified domain. Default is `0` hours.
|
4330
4826
|
#
|
@@ -4361,6 +4857,41 @@ module Aws::OpenSearchService
|
|
4361
4857
|
include Aws::Structure
|
4362
4858
|
end
|
4363
4859
|
|
4860
|
+
# Options for configuring service software updates for a domain.
|
4861
|
+
#
|
4862
|
+
# @!attribute [rw] auto_software_update_enabled
|
4863
|
+
# Whether automatic service software updates are enabled for the
|
4864
|
+
# domain.
|
4865
|
+
# @return [Boolean]
|
4866
|
+
#
|
4867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SoftwareUpdateOptions AWS API Documentation
|
4868
|
+
#
|
4869
|
+
class SoftwareUpdateOptions < Struct.new(
|
4870
|
+
:auto_software_update_enabled)
|
4871
|
+
SENSITIVE = []
|
4872
|
+
include Aws::Structure
|
4873
|
+
end
|
4874
|
+
|
4875
|
+
# The status of the service software options for a domain.
|
4876
|
+
#
|
4877
|
+
# @!attribute [rw] options
|
4878
|
+
# The service software update options for a domain.
|
4879
|
+
# @return [Types::SoftwareUpdateOptions]
|
4880
|
+
#
|
4881
|
+
# @!attribute [rw] status
|
4882
|
+
# The status of service software update options, including creation
|
4883
|
+
# date and last updated date.
|
4884
|
+
# @return [Types::OptionStatus]
|
4885
|
+
#
|
4886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SoftwareUpdateOptionsStatus AWS API Documentation
|
4887
|
+
#
|
4888
|
+
class SoftwareUpdateOptionsStatus < Struct.new(
|
4889
|
+
:options,
|
4890
|
+
:status)
|
4891
|
+
SENSITIVE = []
|
4892
|
+
include Aws::Structure
|
4893
|
+
end
|
4894
|
+
|
4364
4895
|
# Container for the request parameters to the
|
4365
4896
|
# `StartServiceSoftwareUpdate` operation.
|
4366
4897
|
#
|
@@ -4369,10 +4900,37 @@ module Aws::OpenSearchService
|
|
4369
4900
|
# software.
|
4370
4901
|
# @return [String]
|
4371
4902
|
#
|
4903
|
+
# @!attribute [rw] schedule_at
|
4904
|
+
# When to start the service software update.
|
4905
|
+
#
|
4906
|
+
# * `NOW` - Immediately schedules the update to happen in the current
|
4907
|
+
# hour if there's capacity available.
|
4908
|
+
#
|
4909
|
+
# * `TIMESTAMP` - Lets you specify a custom date and time to apply the
|
4910
|
+
# update. If you specify this value, you must also provide a value
|
4911
|
+
# for `DesiredStartTime`.
|
4912
|
+
#
|
4913
|
+
# * `OFF_PEAK_WINDOW` - Marks the update to be picked up during an
|
4914
|
+
# upcoming off-peak window. There's no guarantee that the update
|
4915
|
+
# will happen during the next immediate window. Depending on
|
4916
|
+
# capacity, it might happen in subsequent days.
|
4917
|
+
#
|
4918
|
+
# Default: `NOW` if you don't specify a value for `DesiredStartTime`,
|
4919
|
+
# and `TIMESTAMP` if you do.
|
4920
|
+
# @return [String]
|
4921
|
+
#
|
4922
|
+
# @!attribute [rw] desired_start_time
|
4923
|
+
# The Epoch timestamp when you want the service software update to
|
4924
|
+
# start. You only need to specify this parameter if you set
|
4925
|
+
# `ScheduleAt` to `TIMESTAMP`.
|
4926
|
+
# @return [Integer]
|
4927
|
+
#
|
4372
4928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdateRequest AWS API Documentation
|
4373
4929
|
#
|
4374
4930
|
class StartServiceSoftwareUpdateRequest < Struct.new(
|
4375
|
-
:domain_name
|
4931
|
+
:domain_name,
|
4932
|
+
:schedule_at,
|
4933
|
+
:desired_start_time)
|
4376
4934
|
SENSITIVE = []
|
4377
4935
|
include Aws::Structure
|
4378
4936
|
end
|
@@ -4539,12 +5097,6 @@ module Aws::OpenSearchService
|
|
4539
5097
|
# Queries with more than the permitted number of clauses result in a
|
4540
5098
|
# `TooManyClauses` error.
|
4541
5099
|
#
|
4542
|
-
# * `"override_main_response_version": "true" | "false"` - Note the
|
4543
|
-
# use of a string rather than a boolean. Specifies whether the
|
4544
|
-
# domain reports its version as 7.10 to allow Elasticsearch OSS
|
4545
|
-
# clients and plugins to continue working with it. Default is false
|
4546
|
-
# when creating a domain and true when upgrading a domain.
|
4547
|
-
#
|
4548
5100
|
# For more information, see [Advanced cluster parameters][1].
|
4549
5101
|
#
|
4550
5102
|
#
|
@@ -4558,7 +5110,7 @@ module Aws::OpenSearchService
|
|
4558
5110
|
# @return [String]
|
4559
5111
|
#
|
4560
5112
|
# @!attribute [rw] log_publishing_options
|
4561
|
-
# Options to publish OpenSearch
|
5113
|
+
# Options to publish OpenSearch logs to Amazon CloudWatch Logs.
|
4562
5114
|
# @return [Hash<String,Types::LogPublishingOption>]
|
4563
5115
|
#
|
4564
5116
|
# @!attribute [rw] encryption_at_rest_options
|
@@ -4571,7 +5123,7 @@ module Aws::OpenSearchService
|
|
4571
5123
|
# @return [Types::DomainEndpointOptions]
|
4572
5124
|
#
|
4573
5125
|
# @!attribute [rw] node_to_node_encryption_options
|
4574
|
-
# Node-
|
5126
|
+
# Node-to-node encryption options for the domain.
|
4575
5127
|
# @return [Types::NodeToNodeEncryptionOptions]
|
4576
5128
|
#
|
4577
5129
|
# @!attribute [rw] advanced_security_options
|
@@ -4603,6 +5155,14 @@ module Aws::OpenSearchService
|
|
4603
5155
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check
|
4604
5156
|
# @return [String]
|
4605
5157
|
#
|
5158
|
+
# @!attribute [rw] off_peak_window_options
|
5159
|
+
# Off-peak window options for the domain.
|
5160
|
+
# @return [Types::OffPeakWindowOptions]
|
5161
|
+
#
|
5162
|
+
# @!attribute [rw] software_update_options
|
5163
|
+
# Service software update options for the domain.
|
5164
|
+
# @return [Types::SoftwareUpdateOptions]
|
5165
|
+
#
|
4606
5166
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfigRequest AWS API Documentation
|
4607
5167
|
#
|
4608
5168
|
class UpdateDomainConfigRequest < Struct.new(
|
@@ -4621,7 +5181,9 @@ module Aws::OpenSearchService
|
|
4621
5181
|
:advanced_security_options,
|
4622
5182
|
:auto_tune_options,
|
4623
5183
|
:dry_run,
|
4624
|
-
:dry_run_mode
|
5184
|
+
:dry_run_mode,
|
5185
|
+
:off_peak_window_options,
|
5186
|
+
:software_update_options)
|
4625
5187
|
SENSITIVE = []
|
4626
5188
|
include Aws::Structure
|
4627
5189
|
end
|
@@ -4695,6 +5257,76 @@ module Aws::OpenSearchService
|
|
4695
5257
|
include Aws::Structure
|
4696
5258
|
end
|
4697
5259
|
|
5260
|
+
# @!attribute [rw] domain_name
|
5261
|
+
# The name of the domain to reschedule an action for.
|
5262
|
+
# @return [String]
|
5263
|
+
#
|
5264
|
+
# @!attribute [rw] action_id
|
5265
|
+
# The unique identifier of the action to reschedule. To retrieve this
|
5266
|
+
# ID, send a [ListScheduledActions][1] request.
|
5267
|
+
#
|
5268
|
+
#
|
5269
|
+
#
|
5270
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
|
5271
|
+
# @return [String]
|
5272
|
+
#
|
5273
|
+
# @!attribute [rw] action_type
|
5274
|
+
# The type of action to reschedule. Can be one of
|
5275
|
+
# `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or
|
5276
|
+
# `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a
|
5277
|
+
# [ListScheduledActions][1] request.
|
5278
|
+
#
|
5279
|
+
#
|
5280
|
+
#
|
5281
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
|
5282
|
+
# @return [String]
|
5283
|
+
#
|
5284
|
+
# @!attribute [rw] schedule_at
|
5285
|
+
# When to schedule the action.
|
5286
|
+
#
|
5287
|
+
# * `NOW` - Immediately schedules the update to happen in the current
|
5288
|
+
# hour if there's capacity available.
|
5289
|
+
#
|
5290
|
+
# * `TIMESTAMP` - Lets you specify a custom date and time to apply the
|
5291
|
+
# update. If you specify this value, you must also provide a value
|
5292
|
+
# for `DesiredStartTime`.
|
5293
|
+
#
|
5294
|
+
# * `OFF_PEAK_WINDOW` - Marks the action to be picked up during an
|
5295
|
+
# upcoming off-peak window. There's no guarantee that the change
|
5296
|
+
# will be implemented during the next immediate window. Depending on
|
5297
|
+
# capacity, it might happen in subsequent days.
|
5298
|
+
# @return [String]
|
5299
|
+
#
|
5300
|
+
# @!attribute [rw] desired_start_time
|
5301
|
+
# The time to implement the change, in Coordinated Universal Time
|
5302
|
+
# (UTC). Only specify this parameter if you set `ScheduleAt` to
|
5303
|
+
# `TIMESTAMP`.
|
5304
|
+
# @return [Integer]
|
5305
|
+
#
|
5306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledActionRequest AWS API Documentation
|
5307
|
+
#
|
5308
|
+
class UpdateScheduledActionRequest < Struct.new(
|
5309
|
+
:domain_name,
|
5310
|
+
:action_id,
|
5311
|
+
:action_type,
|
5312
|
+
:schedule_at,
|
5313
|
+
:desired_start_time)
|
5314
|
+
SENSITIVE = []
|
5315
|
+
include Aws::Structure
|
5316
|
+
end
|
5317
|
+
|
5318
|
+
# @!attribute [rw] scheduled_action
|
5319
|
+
# Information about the rescheduled action.
|
5320
|
+
# @return [Types::ScheduledAction]
|
5321
|
+
#
|
5322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledActionResponse AWS API Documentation
|
5323
|
+
#
|
5324
|
+
class UpdateScheduledActionResponse < Struct.new(
|
5325
|
+
:scheduled_action)
|
5326
|
+
SENSITIVE = []
|
5327
|
+
include Aws::Structure
|
5328
|
+
end
|
5329
|
+
|
4698
5330
|
# @!attribute [rw] vpc_endpoint_id
|
4699
5331
|
# The unique identifier of the endpoint.
|
4700
5332
|
# @return [String]
|
@@ -4977,7 +5609,7 @@ module Aws::OpenSearchService
|
|
4977
5609
|
include Aws::Structure
|
4978
5610
|
end
|
4979
5611
|
|
4980
|
-
# An exception for
|
5612
|
+
# An exception for accessing or deleting a resource that doesn't exist.
|
4981
5613
|
#
|
4982
5614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ValidationException AWS API Documentation
|
4983
5615
|
#
|
@@ -5121,6 +5753,30 @@ module Aws::OpenSearchService
|
|
5121
5753
|
include Aws::Structure
|
5122
5754
|
end
|
5123
5755
|
|
5756
|
+
# The desired start time for an [off-peak maintenance window][1].
|
5757
|
+
#
|
5758
|
+
#
|
5759
|
+
#
|
5760
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
|
5761
|
+
#
|
5762
|
+
# @!attribute [rw] hours
|
5763
|
+
# The start hour of the window in Coordinated Universal Time (UTC),
|
5764
|
+
# using 24-hour time. For example, `17` refers to 5:00 P.M. UTC.
|
5765
|
+
# @return [Integer]
|
5766
|
+
#
|
5767
|
+
# @!attribute [rw] minutes
|
5768
|
+
# The start minute of the window, in UTC.
|
5769
|
+
# @return [Integer]
|
5770
|
+
#
|
5771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/WindowStartTime AWS API Documentation
|
5772
|
+
#
|
5773
|
+
class WindowStartTime < Struct.new(
|
5774
|
+
:hours,
|
5775
|
+
:minutes)
|
5776
|
+
SENSITIVE = []
|
5777
|
+
include Aws::Structure
|
5778
|
+
end
|
5779
|
+
|
5124
5780
|
# The zone awareness configuration for an Amazon OpenSearch Service
|
5125
5781
|
# domain.
|
5126
5782
|
#
|