lib/aws-sdk-opensearchservice/client.rb in aws-sdk-opensearchservice-1.36.0 vs lib/aws-sdk-opensearchservice/client.rb in aws-sdk-opensearchservice-1.37.0

- old
+ new

@@ -601,10 +601,54 @@ def authorize_vpc_endpoint_access(params = {}, options = {}) req = build_request(:authorize_vpc_endpoint_access, params) req.send_request(options) end + # Cancels a pending configuration change on an Amazon OpenSearch Service + # domain. + # + # @option params [required, String] :domain_name + # The name of an OpenSearch Service domain. Domain names are unique + # across the domains owned by an account within an Amazon Web Services + # Region. + # + # @option params [Boolean] :dry_run + # When set to `True`, returns the list of change IDs and properties that + # will be cancelled without actually cancelling the change. + # + # @return [Types::CancelDomainConfigChangeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CancelDomainConfigChangeResponse#cancelled_change_ids #cancelled_change_ids} => Array<String> + # * {Types::CancelDomainConfigChangeResponse#cancelled_change_properties #cancelled_change_properties} => Array<Types::CancelledChangeProperty> + # * {Types::CancelDomainConfigChangeResponse#dry_run #dry_run} => Boolean + # + # @example Request syntax with placeholder values + # + # resp = client.cancel_domain_config_change({ + # domain_name: "DomainName", # required + # dry_run: false, + # }) + # + # @example Response structure + # + # resp.cancelled_change_ids #=> Array + # resp.cancelled_change_ids[0] #=> String + # resp.cancelled_change_properties #=> Array + # resp.cancelled_change_properties[0].property_name #=> String + # resp.cancelled_change_properties[0].cancelled_value #=> String + # resp.cancelled_change_properties[0].active_value #=> String + # resp.dry_run #=> Boolean + # + # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChange AWS API Documentation + # + # @overload cancel_domain_config_change(params = {}) + # @param [Hash] params ({}) + def cancel_domain_config_change(params = {}, options = {}) + req = build_request(:cancel_domain_config_change, params) + req.send_request(options) + end + # Cancels a scheduled service software update for an Amazon OpenSearch # Service domain. You can only perform this operation before the # `AutomatedUpdateDate` and when the domain's `UpdateStatus` is # `PENDING_UPDATE`. For more information, see [Service software updates # in Amazon OpenSearch Service][1]. @@ -982,14 +1026,24 @@ # 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" # resp.domain_status.auto_tune_options.error_message #=> String # resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean # resp.domain_status.change_progress_details.change_id #=> String # resp.domain_status.change_progress_details.message #=> String + # resp.domain_status.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.domain_status.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.domain_status.change_progress_details.start_time #=> Time + # resp.domain_status.change_progress_details.last_updated_time #=> Time # resp.domain_status.off_peak_window_options.enabled #=> Boolean # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer # resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean + # resp.domain_status.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting" + # resp.domain_status.modifying_properties #=> Array + # resp.domain_status.modifying_properties[0].name #=> String + # resp.domain_status.modifying_properties[0].active_value #=> String + # resp.domain_status.modifying_properties[0].pending_value #=> String + # resp.domain_status.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain AWS API Documentation # # @overload create_domain(params = {}) # @param [Hash] params ({}) @@ -1332,14 +1386,24 @@ # 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" # resp.domain_status.auto_tune_options.error_message #=> String # resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean # resp.domain_status.change_progress_details.change_id #=> String # resp.domain_status.change_progress_details.message #=> String + # resp.domain_status.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.domain_status.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.domain_status.change_progress_details.start_time #=> Time + # resp.domain_status.change_progress_details.last_updated_time #=> Time # resp.domain_status.off_peak_window_options.enabled #=> Boolean # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer # resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean + # resp.domain_status.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting" + # resp.domain_status.modifying_properties #=> Array + # resp.domain_status.modifying_properties[0].name #=> String + # resp.domain_status.modifying_properties[0].active_value #=> String + # resp.domain_status.modifying_properties[0].pending_value #=> String + # resp.domain_status.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain AWS API Documentation # # @overload delete_domain(params = {}) # @param [Hash] params ({}) @@ -1615,14 +1679,24 @@ # 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" # resp.domain_status.auto_tune_options.error_message #=> String # resp.domain_status.auto_tune_options.use_off_peak_window #=> Boolean # resp.domain_status.change_progress_details.change_id #=> String # resp.domain_status.change_progress_details.message #=> String + # resp.domain_status.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.domain_status.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.domain_status.change_progress_details.start_time #=> Time + # resp.domain_status.change_progress_details.last_updated_time #=> Time # resp.domain_status.off_peak_window_options.enabled #=> Boolean # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer # resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer # resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean + # resp.domain_status.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting" + # resp.domain_status.modifying_properties #=> Array + # resp.domain_status.modifying_properties[0].name #=> String + # resp.domain_status.modifying_properties[0].active_value #=> String + # resp.domain_status.modifying_properties[0].pending_value #=> String + # resp.domain_status.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain AWS API Documentation # # @overload describe_domain(params = {}) # @param [Hash] params ({}) @@ -1726,10 +1800,13 @@ # resp.change_progress_status.change_progress_stages #=> Array # resp.change_progress_status.change_progress_stages[0].name #=> String # resp.change_progress_status.change_progress_stages[0].status #=> String # resp.change_progress_status.change_progress_stages[0].description #=> String # resp.change_progress_status.change_progress_stages[0].last_updated #=> Time + # resp.change_progress_status.last_updated_time #=> Time + # resp.change_progress_status.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.change_progress_status.initiated_by #=> String, one of "CUSTOMER", "SERVICE" # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainChangeProgress AWS API Documentation # # @overload describe_domain_change_progress(params = {}) # @param [Hash] params ({}) @@ -1895,10 +1972,14 @@ # resp.domain_config.auto_tune_options.status.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" # resp.domain_config.auto_tune_options.status.error_message #=> String # resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean # resp.domain_config.change_progress_details.change_id #=> String # resp.domain_config.change_progress_details.message #=> String + # resp.domain_config.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.domain_config.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.domain_config.change_progress_details.start_time #=> Time + # resp.domain_config.change_progress_details.last_updated_time #=> Time # resp.domain_config.off_peak_window_options.options.enabled #=> Boolean # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer # resp.domain_config.off_peak_window_options.status.creation_date #=> Time # resp.domain_config.off_peak_window_options.status.update_date #=> Time @@ -1909,10 +1990,15 @@ # resp.domain_config.software_update_options.status.creation_date #=> Time # resp.domain_config.software_update_options.status.update_date #=> Time # resp.domain_config.software_update_options.status.update_version #=> Integer # resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active" # resp.domain_config.software_update_options.status.pending_deletion #=> Boolean + # resp.domain_config.modifying_properties #=> Array + # resp.domain_config.modifying_properties[0].name #=> String + # resp.domain_config.modifying_properties[0].active_value #=> String + # resp.domain_config.modifying_properties[0].pending_value #=> String + # resp.domain_config.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig AWS API Documentation # # @overload describe_domain_config(params = {}) # @param [Hash] params ({}) @@ -2117,14 +2203,24 @@ # 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" # resp.domain_status_list[0].auto_tune_options.error_message #=> String # resp.domain_status_list[0].auto_tune_options.use_off_peak_window #=> Boolean # resp.domain_status_list[0].change_progress_details.change_id #=> String # resp.domain_status_list[0].change_progress_details.message #=> String + # resp.domain_status_list[0].change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.domain_status_list[0].change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.domain_status_list[0].change_progress_details.start_time #=> Time + # resp.domain_status_list[0].change_progress_details.last_updated_time #=> Time # resp.domain_status_list[0].off_peak_window_options.enabled #=> Boolean # resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer # resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer # resp.domain_status_list[0].software_update_options.auto_software_update_enabled #=> Boolean + # resp.domain_status_list[0].domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting" + # resp.domain_status_list[0].modifying_properties #=> Array + # resp.domain_status_list[0].modifying_properties[0].name #=> String + # resp.domain_status_list[0].modifying_properties[0].active_value #=> String + # resp.domain_status_list[0].modifying_properties[0].pending_value #=> String + # resp.domain_status_list[0].modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains AWS API Documentation # # @overload describe_domains(params = {}) # @param [Hash] params ({}) @@ -2252,14 +2348,24 @@ # 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" # resp.dry_run_config.auto_tune_options.error_message #=> String # resp.dry_run_config.auto_tune_options.use_off_peak_window #=> Boolean # resp.dry_run_config.change_progress_details.change_id #=> String # resp.dry_run_config.change_progress_details.message #=> String + # resp.dry_run_config.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.dry_run_config.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.dry_run_config.change_progress_details.start_time #=> Time + # resp.dry_run_config.change_progress_details.last_updated_time #=> Time # resp.dry_run_config.off_peak_window_options.enabled #=> Boolean # resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer # resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer # resp.dry_run_config.software_update_options.auto_software_update_enabled #=> Boolean + # resp.dry_run_config.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting" + # resp.dry_run_config.modifying_properties #=> Array + # resp.dry_run_config.modifying_properties[0].name #=> String + # resp.dry_run_config.modifying_properties[0].active_value #=> String + # resp.dry_run_config.modifying_properties[0].pending_value #=> String + # resp.dry_run_config.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # resp.dry_run_results.deployment_type #=> String # resp.dry_run_results.message #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDryRunProgress AWS API Documentation # @@ -4261,10 +4367,14 @@ # resp.domain_config.auto_tune_options.status.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" # resp.domain_config.auto_tune_options.status.error_message #=> String # resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean # resp.domain_config.change_progress_details.change_id #=> String # resp.domain_config.change_progress_details.message #=> String + # resp.domain_config.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.domain_config.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.domain_config.change_progress_details.start_time #=> Time + # resp.domain_config.change_progress_details.last_updated_time #=> Time # resp.domain_config.off_peak_window_options.options.enabled #=> Boolean # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer # resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer # resp.domain_config.off_peak_window_options.status.creation_date #=> Time # resp.domain_config.off_peak_window_options.status.update_date #=> Time @@ -4275,10 +4385,15 @@ # resp.domain_config.software_update_options.status.creation_date #=> Time # resp.domain_config.software_update_options.status.update_date #=> Time # resp.domain_config.software_update_options.status.update_version #=> Integer # resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active" # resp.domain_config.software_update_options.status.pending_deletion #=> Boolean + # resp.domain_config.modifying_properties #=> Array + # resp.domain_config.modifying_properties[0].name #=> String + # resp.domain_config.modifying_properties[0].active_value #=> String + # resp.domain_config.modifying_properties[0].pending_value #=> String + # resp.domain_config.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON" # resp.dry_run_results.deployment_type #=> String # resp.dry_run_results.message #=> String # resp.dry_run_progress_status.dry_run_id #=> String # resp.dry_run_progress_status.dry_run_status #=> String # resp.dry_run_progress_status.creation_date #=> String @@ -4541,10 +4656,14 @@ # resp.perform_check_only #=> Boolean # resp.advanced_options #=> Hash # resp.advanced_options["String"] #=> String # resp.change_progress_details.change_id #=> String # resp.change_progress_details.message #=> String + # resp.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled" + # resp.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE" + # resp.change_progress_details.start_time #=> Time + # resp.change_progress_details.last_updated_time #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomain AWS API Documentation # # @overload upgrade_domain(params = {}) # @param [Hash] params ({}) @@ -4564,10 +4683,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-opensearchservice' - context[:gem_version] = '1.36.0' + context[:gem_version] = '1.37.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated