aws-sdk-opensearchservice 1.16.0 → 1.17.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 +270 -3
- data/lib/aws-sdk-opensearchservice/client_api.rb +127 -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 +28 -0
- data/lib/aws-sdk-opensearchservice/errors.rb +16 -0
- data/lib/aws-sdk-opensearchservice/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-opensearchservice/types.rb +473 -24
- 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: 6c64d5d3248e3ead04d08f40b05e755c10a28c73dba6e8d513b1a688a5d2707e
|
4
|
+
data.tar.gz: 5646a3bc1ca3183ad69c49609c916bbb74f2ccf4249f5c45f074e8f57bbb6f2a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7d8feef11773b5ad857da17446de3803f8b8d829ac5001086b823078a03f588347fb17284d9710c272856a54a6115556b5b798efd86a768b7b41e5c0b764a82e
|
7
|
+
data.tar.gz: d4b43498f3e6bcca634a8699c877a29985d7fb0d01abbc7b8ed48a55225795fc80f2edb96a72160b4ad8c029ac3634b8f6953d7f980a52dc65f6da5066b7a833
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.17.0 (2023-02-22)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release lets customers configure Off-peak window and software update related properties for a new/existing domain. It enhances the capabilities of StartServiceSoftwareUpdate API; adds 2 new APIs - ListScheduledActions & UpdateScheduledAction; and allows Auto-tune to make use of Off-peak window.
|
8
|
+
|
4
9
|
1.16.0 (2023-01-31)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.17.0
|
@@ -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
|
@@ -798,6 +809,19 @@ module Aws::OpenSearchService
|
|
798
809
|
# cron_expression_for_recurrence: "String",
|
799
810
|
# },
|
800
811
|
# ],
|
812
|
+
# use_off_peak_window: false,
|
813
|
+
# },
|
814
|
+
# off_peak_window_options: {
|
815
|
+
# enabled: false,
|
816
|
+
# off_peak_window: {
|
817
|
+
# window_start_time: {
|
818
|
+
# hours: 1, # required
|
819
|
+
# minutes: 1, # required
|
820
|
+
# },
|
821
|
+
# },
|
822
|
+
# },
|
823
|
+
# software_update_options: {
|
824
|
+
# auto_software_update_enabled: false,
|
801
825
|
# },
|
802
826
|
# })
|
803
827
|
#
|
@@ -876,8 +900,13 @@ module Aws::OpenSearchService
|
|
876
900
|
# resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
877
901
|
# 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
902
|
# resp.domain_status.auto_tune_options.error_message #=> String
|
903
|
+
# resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
|
879
904
|
# resp.domain_status.change_progress_details.change_id #=> String
|
880
905
|
# resp.domain_status.change_progress_details.message #=> String
|
906
|
+
# resp.domain_status.off_peak_window_options.enabled #=> Boolean
|
907
|
+
# resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
|
908
|
+
# resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
|
909
|
+
# resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean
|
881
910
|
#
|
882
911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain AWS API Documentation
|
883
912
|
#
|
@@ -1165,8 +1194,13 @@ module Aws::OpenSearchService
|
|
1165
1194
|
# resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1166
1195
|
# 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
1196
|
# resp.domain_status.auto_tune_options.error_message #=> String
|
1197
|
+
# resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
|
1168
1198
|
# resp.domain_status.change_progress_details.change_id #=> String
|
1169
1199
|
# resp.domain_status.change_progress_details.message #=> String
|
1200
|
+
# resp.domain_status.off_peak_window_options.enabled #=> Boolean
|
1201
|
+
# resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
|
1202
|
+
# resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
|
1203
|
+
# resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean
|
1170
1204
|
#
|
1171
1205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain AWS API Documentation
|
1172
1206
|
#
|
@@ -1433,8 +1467,13 @@ module Aws::OpenSearchService
|
|
1433
1467
|
# resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1434
1468
|
# 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
1469
|
# resp.domain_status.auto_tune_options.error_message #=> String
|
1470
|
+
# resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean
|
1436
1471
|
# resp.domain_status.change_progress_details.change_id #=> String
|
1437
1472
|
# resp.domain_status.change_progress_details.message #=> String
|
1473
|
+
# resp.domain_status.off_peak_window_options.enabled #=> Boolean
|
1474
|
+
# resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
|
1475
|
+
# resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
|
1476
|
+
# resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean
|
1438
1477
|
#
|
1439
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain AWS API Documentation
|
1440
1479
|
#
|
@@ -1695,6 +1734,7 @@ module Aws::OpenSearchService
|
|
1695
1734
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
|
1696
1735
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
|
1697
1736
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
|
1737
|
+
# resp.domain_config.auto_tune_options.options.use_off_peak_window #=> Boolean
|
1698
1738
|
# resp.domain_config.auto_tune_options.status.creation_date #=> Time
|
1699
1739
|
# resp.domain_config.auto_tune_options.status.update_date #=> Time
|
1700
1740
|
# resp.domain_config.auto_tune_options.status.update_version #=> Integer
|
@@ -1703,6 +1743,20 @@ module Aws::OpenSearchService
|
|
1703
1743
|
# resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
|
1704
1744
|
# resp.domain_config.change_progress_details.change_id #=> String
|
1705
1745
|
# resp.domain_config.change_progress_details.message #=> String
|
1746
|
+
# resp.domain_config.off_peak_window_options.options.enabled #=> Boolean
|
1747
|
+
# resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer
|
1748
|
+
# resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer
|
1749
|
+
# resp.domain_config.off_peak_window_options.status.creation_date #=> Time
|
1750
|
+
# resp.domain_config.off_peak_window_options.status.update_date #=> Time
|
1751
|
+
# resp.domain_config.off_peak_window_options.status.update_version #=> Integer
|
1752
|
+
# resp.domain_config.off_peak_window_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
1753
|
+
# resp.domain_config.off_peak_window_options.status.pending_deletion #=> Boolean
|
1754
|
+
# resp.domain_config.software_update_options.options.auto_software_update_enabled #=> Boolean
|
1755
|
+
# resp.domain_config.software_update_options.status.creation_date #=> Time
|
1756
|
+
# resp.domain_config.software_update_options.status.update_date #=> Time
|
1757
|
+
# resp.domain_config.software_update_options.status.update_version #=> Integer
|
1758
|
+
# resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
1759
|
+
# resp.domain_config.software_update_options.status.pending_deletion #=> Boolean
|
1706
1760
|
#
|
1707
1761
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig AWS API Documentation
|
1708
1762
|
#
|
@@ -1807,8 +1861,13 @@ module Aws::OpenSearchService
|
|
1807
1861
|
# resp.domain_status_list[0].advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1808
1862
|
# 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
1863
|
# resp.domain_status_list[0].auto_tune_options.error_message #=> String
|
1864
|
+
# resp.domain_status_list[0].auto_tune_options.use_off_peak_window #=> Boolean
|
1810
1865
|
# resp.domain_status_list[0].change_progress_details.change_id #=> String
|
1811
1866
|
# resp.domain_status_list[0].change_progress_details.message #=> String
|
1867
|
+
# resp.domain_status_list[0].off_peak_window_options.enabled #=> Boolean
|
1868
|
+
# resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
|
1869
|
+
# resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
|
1870
|
+
# resp.domain_status_list[0].software_update_options.auto_software_update_enabled #=> Boolean
|
1812
1871
|
#
|
1813
1872
|
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains AWS API Documentation
|
1814
1873
|
#
|
@@ -1934,8 +1993,13 @@ module Aws::OpenSearchService
|
|
1934
1993
|
# resp.dry_run_config.advanced_security_options.anonymous_auth_enabled #=> Boolean
|
1935
1994
|
# 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
1995
|
# resp.dry_run_config.auto_tune_options.error_message #=> String
|
1996
|
+
# resp.dry_run_config.auto_tune_options.use_off_peak_window #=> Boolean
|
1937
1997
|
# resp.dry_run_config.change_progress_details.change_id #=> String
|
1938
1998
|
# resp.dry_run_config.change_progress_details.message #=> String
|
1999
|
+
# resp.dry_run_config.off_peak_window_options.enabled #=> Boolean
|
2000
|
+
# resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
|
2001
|
+
# resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
|
2002
|
+
# resp.dry_run_config.software_update_options.auto_software_update_enabled #=> Boolean
|
1939
2003
|
# resp.dry_run_results.deployment_type #=> String
|
1940
2004
|
# resp.dry_run_results.message #=> String
|
1941
2005
|
#
|
@@ -2812,6 +2876,66 @@ module Aws::OpenSearchService
|
|
2812
2876
|
req.send_request(options)
|
2813
2877
|
end
|
2814
2878
|
|
2879
|
+
# Retrieves a list of configuration changes that are scheduled for a
|
2880
|
+
# domain. These changes can be [service software updates][1] or
|
2881
|
+
# [blue/green Auto-Tune enhancements][2].
|
2882
|
+
#
|
2883
|
+
#
|
2884
|
+
#
|
2885
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
|
2886
|
+
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
|
2887
|
+
#
|
2888
|
+
# @option params [required, String] :domain_name
|
2889
|
+
# The name of the domain.
|
2890
|
+
#
|
2891
|
+
# @option params [Integer] :max_results
|
2892
|
+
# An optional parameter that specifies the maximum number of results to
|
2893
|
+
# return. You can use `nextToken` to get the next page of results.
|
2894
|
+
#
|
2895
|
+
# @option params [String] :next_token
|
2896
|
+
# If your initial `ListScheduledActions` operation returns a
|
2897
|
+
# `nextToken`, you can include the returned `nextToken` in subsequent
|
2898
|
+
# `ListScheduledActions` operations, which returns results in the next
|
2899
|
+
# page.
|
2900
|
+
#
|
2901
|
+
# @return [Types::ListScheduledActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2902
|
+
#
|
2903
|
+
# * {Types::ListScheduledActionsResponse#scheduled_actions #scheduled_actions} => Array<Types::ScheduledAction>
|
2904
|
+
# * {Types::ListScheduledActionsResponse#next_token #next_token} => String
|
2905
|
+
#
|
2906
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2907
|
+
#
|
2908
|
+
# @example Request syntax with placeholder values
|
2909
|
+
#
|
2910
|
+
# resp = client.list_scheduled_actions({
|
2911
|
+
# domain_name: "DomainName", # required
|
2912
|
+
# max_results: 1,
|
2913
|
+
# next_token: "NextToken",
|
2914
|
+
# })
|
2915
|
+
#
|
2916
|
+
# @example Response structure
|
2917
|
+
#
|
2918
|
+
# resp.scheduled_actions #=> Array
|
2919
|
+
# resp.scheduled_actions[0].id #=> String
|
2920
|
+
# resp.scheduled_actions[0].type #=> String, one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
|
2921
|
+
# resp.scheduled_actions[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
|
2922
|
+
# resp.scheduled_actions[0].scheduled_time #=> Integer
|
2923
|
+
# resp.scheduled_actions[0].description #=> String
|
2924
|
+
# resp.scheduled_actions[0].scheduled_by #=> String, one of "CUSTOMER", "SYSTEM"
|
2925
|
+
# resp.scheduled_actions[0].status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
2926
|
+
# resp.scheduled_actions[0].mandatory #=> Boolean
|
2927
|
+
# resp.scheduled_actions[0].cancellable #=> Boolean
|
2928
|
+
# resp.next_token #=> String
|
2929
|
+
#
|
2930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActions AWS API Documentation
|
2931
|
+
#
|
2932
|
+
# @overload list_scheduled_actions(params = {})
|
2933
|
+
# @param [Hash] params ({})
|
2934
|
+
def list_scheduled_actions(params = {}, options = {})
|
2935
|
+
req = build_request(:list_scheduled_actions, params)
|
2936
|
+
req.send_request(options)
|
2937
|
+
end
|
2938
|
+
|
2815
2939
|
# Returns all resource tags for an Amazon OpenSearch Service domain. For
|
2816
2940
|
# more information, see [Tagging Amazon OpenSearch Service domains][1].
|
2817
2941
|
#
|
@@ -3157,6 +3281,29 @@ module Aws::OpenSearchService
|
|
3157
3281
|
# The name of the domain that you want to update to the latest service
|
3158
3282
|
# software.
|
3159
3283
|
#
|
3284
|
+
# @option params [String] :schedule_at
|
3285
|
+
# When to start the service software update.
|
3286
|
+
#
|
3287
|
+
# * `NOW` - Immediately schedules the update to happen in the current
|
3288
|
+
# hour if there's capacity available.
|
3289
|
+
#
|
3290
|
+
# * `TIMESTAMP` - Lets you specify a custom date and time to apply the
|
3291
|
+
# update. If you specify this value, you must also provide a value for
|
3292
|
+
# `DesiredStartTime`.
|
3293
|
+
#
|
3294
|
+
# * `OFF_PEAK_WINDOW` - Marks the update to be picked up during an
|
3295
|
+
# upcoming off-peak window. There's no guarantee that the update will
|
3296
|
+
# happen during the next immediate window. Depending on capacity, it
|
3297
|
+
# might happen in subsequent days.
|
3298
|
+
#
|
3299
|
+
# Default: `NOW` if you don't specify a value for `DesiredStartTime`,
|
3300
|
+
# and `TIMESTAMP` if you do.
|
3301
|
+
#
|
3302
|
+
# @option params [Integer] :desired_start_time
|
3303
|
+
# The Epoch timestamp when you want the service software update to
|
3304
|
+
# start. You only need to specify this parameter if you set `ScheduleAt`
|
3305
|
+
# to `TIMESTAMP`.
|
3306
|
+
#
|
3160
3307
|
# @return [Types::StartServiceSoftwareUpdateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3161
3308
|
#
|
3162
3309
|
# * {Types::StartServiceSoftwareUpdateResponse#service_software_options #service_software_options} => Types::ServiceSoftwareOptions
|
@@ -3165,6 +3312,8 @@ module Aws::OpenSearchService
|
|
3165
3312
|
#
|
3166
3313
|
# resp = client.start_service_software_update({
|
3167
3314
|
# domain_name: "DomainName", # required
|
3315
|
+
# schedule_at: "NOW", # accepts NOW, TIMESTAMP, OFF_PEAK_WINDOW
|
3316
|
+
# desired_start_time: 1,
|
3168
3317
|
# })
|
3169
3318
|
#
|
3170
3319
|
# @example Response structure
|
@@ -3256,7 +3405,7 @@ module Aws::OpenSearchService
|
|
3256
3405
|
# string.
|
3257
3406
|
#
|
3258
3407
|
# @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
|
3259
|
-
# Options to publish OpenSearch
|
3408
|
+
# Options to publish OpenSearch logs to Amazon CloudWatch Logs.
|
3260
3409
|
#
|
3261
3410
|
# @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
|
3262
3411
|
# Encryption at rest options for the domain.
|
@@ -3266,7 +3415,7 @@ module Aws::OpenSearchService
|
|
3266
3415
|
# HTTPS for all traffic.
|
3267
3416
|
#
|
3268
3417
|
# @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
|
3269
|
-
# Node-
|
3418
|
+
# Node-to-node encryption options for the domain.
|
3270
3419
|
#
|
3271
3420
|
# @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
|
3272
3421
|
# Options for fine-grained access control.
|
@@ -3293,6 +3442,12 @@ module Aws::OpenSearchService
|
|
3293
3442
|
#
|
3294
3443
|
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check
|
3295
3444
|
#
|
3445
|
+
# @option params [Types::OffPeakWindowOptions] :off_peak_window_options
|
3446
|
+
# Off-peak window options for the domain.
|
3447
|
+
#
|
3448
|
+
# @option params [Types::SoftwareUpdateOptions] :software_update_options
|
3449
|
+
# Service software update options for the domain.
|
3450
|
+
#
|
3296
3451
|
# @return [Types::UpdateDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3297
3452
|
#
|
3298
3453
|
# * {Types::UpdateDomainConfigResponse#domain_config #domain_config} => Types::DomainConfig
|
@@ -3399,9 +3554,22 @@ module Aws::OpenSearchService
|
|
3399
3554
|
# cron_expression_for_recurrence: "String",
|
3400
3555
|
# },
|
3401
3556
|
# ],
|
3557
|
+
# use_off_peak_window: false,
|
3402
3558
|
# },
|
3403
3559
|
# dry_run: false,
|
3404
3560
|
# dry_run_mode: "Basic", # accepts Basic, Verbose
|
3561
|
+
# off_peak_window_options: {
|
3562
|
+
# enabled: false,
|
3563
|
+
# off_peak_window: {
|
3564
|
+
# window_start_time: {
|
3565
|
+
# hours: 1, # required
|
3566
|
+
# minutes: 1, # required
|
3567
|
+
# },
|
3568
|
+
# },
|
3569
|
+
# },
|
3570
|
+
# software_update_options: {
|
3571
|
+
# auto_software_update_enabled: false,
|
3572
|
+
# },
|
3405
3573
|
# })
|
3406
3574
|
#
|
3407
3575
|
# @example Response structure
|
@@ -3531,6 +3699,7 @@ module Aws::OpenSearchService
|
|
3531
3699
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
|
3532
3700
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
|
3533
3701
|
# resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
|
3702
|
+
# resp.domain_config.auto_tune_options.options.use_off_peak_window #=> Boolean
|
3534
3703
|
# resp.domain_config.auto_tune_options.status.creation_date #=> Time
|
3535
3704
|
# resp.domain_config.auto_tune_options.status.update_date #=> Time
|
3536
3705
|
# resp.domain_config.auto_tune_options.status.update_version #=> Integer
|
@@ -3539,6 +3708,20 @@ module Aws::OpenSearchService
|
|
3539
3708
|
# resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
|
3540
3709
|
# resp.domain_config.change_progress_details.change_id #=> String
|
3541
3710
|
# resp.domain_config.change_progress_details.message #=> String
|
3711
|
+
# resp.domain_config.off_peak_window_options.options.enabled #=> Boolean
|
3712
|
+
# resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer
|
3713
|
+
# resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer
|
3714
|
+
# resp.domain_config.off_peak_window_options.status.creation_date #=> Time
|
3715
|
+
# resp.domain_config.off_peak_window_options.status.update_date #=> Time
|
3716
|
+
# resp.domain_config.off_peak_window_options.status.update_version #=> Integer
|
3717
|
+
# resp.domain_config.off_peak_window_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
3718
|
+
# resp.domain_config.off_peak_window_options.status.pending_deletion #=> Boolean
|
3719
|
+
# resp.domain_config.software_update_options.options.auto_software_update_enabled #=> Boolean
|
3720
|
+
# resp.domain_config.software_update_options.status.creation_date #=> Time
|
3721
|
+
# resp.domain_config.software_update_options.status.update_date #=> Time
|
3722
|
+
# resp.domain_config.software_update_options.status.update_version #=> Integer
|
3723
|
+
# resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
|
3724
|
+
# resp.domain_config.software_update_options.status.pending_deletion #=> Boolean
|
3542
3725
|
# resp.dry_run_results.deployment_type #=> String
|
3543
3726
|
# resp.dry_run_results.message #=> String
|
3544
3727
|
# resp.dry_run_progress_status.dry_run_id #=> String
|
@@ -3617,6 +3800,90 @@ module Aws::OpenSearchService
|
|
3617
3800
|
req.send_request(options)
|
3618
3801
|
end
|
3619
3802
|
|
3803
|
+
# Reschedules a planned domain configuration change for a later time.
|
3804
|
+
# This change can be a scheduled [service software update][1] or a
|
3805
|
+
# [blue/green Auto-Tune enhancement][2].
|
3806
|
+
#
|
3807
|
+
#
|
3808
|
+
#
|
3809
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
|
3810
|
+
# [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
|
3811
|
+
#
|
3812
|
+
# @option params [required, String] :domain_name
|
3813
|
+
# The name of the domain to reschedule an action for.
|
3814
|
+
#
|
3815
|
+
# @option params [required, String] :action_id
|
3816
|
+
# The unique identifier of the action to reschedule. To retrieve this
|
3817
|
+
# ID, send a [ListScheduledActions][1] request.
|
3818
|
+
#
|
3819
|
+
#
|
3820
|
+
#
|
3821
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
|
3822
|
+
#
|
3823
|
+
# @option params [required, String] :action_type
|
3824
|
+
# The type of action to reschedule. Can be one of
|
3825
|
+
# `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or
|
3826
|
+
# `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a
|
3827
|
+
# [ListScheduledActions][1] request.
|
3828
|
+
#
|
3829
|
+
#
|
3830
|
+
#
|
3831
|
+
# [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
|
3832
|
+
#
|
3833
|
+
# @option params [required, String] :schedule_at
|
3834
|
+
# When to schedule the action.
|
3835
|
+
#
|
3836
|
+
# * `NOW` - Immediately schedules the update to happen in the current
|
3837
|
+
# hour if there's capacity available.
|
3838
|
+
#
|
3839
|
+
# * `TIMESTAMP` - Lets you specify a custom date and time to apply the
|
3840
|
+
# update. If you specify this value, you must also provide a value for
|
3841
|
+
# `DesiredStartTime`.
|
3842
|
+
#
|
3843
|
+
# * `OFF_PEAK_WINDOW` - Marks the action to be picked up during an
|
3844
|
+
# upcoming off-peak window. There's no guarantee that the change will
|
3845
|
+
# be implemented during the next immediate window. Depending on
|
3846
|
+
# capacity, it might happen in subsequent days.
|
3847
|
+
#
|
3848
|
+
# @option params [Integer] :desired_start_time
|
3849
|
+
# The time to implement the change, in Coordinated Universal Time (UTC).
|
3850
|
+
# Only specify this parameter if you set `ScheduleAt` to `TIMESTAMP`.
|
3851
|
+
#
|
3852
|
+
# @return [Types::UpdateScheduledActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3853
|
+
#
|
3854
|
+
# * {Types::UpdateScheduledActionResponse#scheduled_action #scheduled_action} => Types::ScheduledAction
|
3855
|
+
#
|
3856
|
+
# @example Request syntax with placeholder values
|
3857
|
+
#
|
3858
|
+
# resp = client.update_scheduled_action({
|
3859
|
+
# domain_name: "DomainName", # required
|
3860
|
+
# action_id: "String", # required
|
3861
|
+
# action_type: "SERVICE_SOFTWARE_UPDATE", # required, accepts SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, JVM_YOUNG_GEN_TUNING
|
3862
|
+
# schedule_at: "NOW", # required, accepts NOW, TIMESTAMP, OFF_PEAK_WINDOW
|
3863
|
+
# desired_start_time: 1,
|
3864
|
+
# })
|
3865
|
+
#
|
3866
|
+
# @example Response structure
|
3867
|
+
#
|
3868
|
+
# resp.scheduled_action.id #=> String
|
3869
|
+
# resp.scheduled_action.type #=> String, one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
|
3870
|
+
# resp.scheduled_action.severity #=> String, one of "HIGH", "MEDIUM", "LOW"
|
3871
|
+
# resp.scheduled_action.scheduled_time #=> Integer
|
3872
|
+
# resp.scheduled_action.description #=> String
|
3873
|
+
# resp.scheduled_action.scheduled_by #=> String, one of "CUSTOMER", "SYSTEM"
|
3874
|
+
# resp.scheduled_action.status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
3875
|
+
# resp.scheduled_action.mandatory #=> Boolean
|
3876
|
+
# resp.scheduled_action.cancellable #=> Boolean
|
3877
|
+
#
|
3878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledAction AWS API Documentation
|
3879
|
+
#
|
3880
|
+
# @overload update_scheduled_action(params = {})
|
3881
|
+
# @param [Hash] params ({})
|
3882
|
+
def update_scheduled_action(params = {}, options = {})
|
3883
|
+
req = build_request(:update_scheduled_action, params)
|
3884
|
+
req.send_request(options)
|
3885
|
+
end
|
3886
|
+
|
3620
3887
|
# Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
|
3621
3888
|
#
|
3622
3889
|
# @option params [required, String] :vpc_endpoint_id
|
@@ -3738,7 +4005,7 @@ module Aws::OpenSearchService
|
|
3738
4005
|
params: params,
|
3739
4006
|
config: config)
|
3740
4007
|
context[:gem_name] = 'aws-sdk-opensearchservice'
|
3741
|
-
context[:gem_version] = '1.
|
4008
|
+
context[:gem_version] = '1.17.0'
|
3742
4009
|
Seahorse::Client::Request.new(handlers, context)
|
3743
4010
|
end
|
3744
4011
|
|