Skip to content

AutoTuneOptionsOutput

Source code in docs_src/capo_opensearch/types/auto_tune_options_output.py
class AutoTuneOptionsOutput(TypedDict, closed=True):
    state: NotRequired["capo_opensearch.types.auto_tune_state.AutoTuneState"]
    """<p>The current state of Auto-Tune on the domain.</p>"""
    error_message: NotRequired["capo_opensearch.types.string.String"]
    """<p>Any errors that occurred while enabling or disabling Auto-Tune.</p>"""
    use_off_peak_window: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.</p>"""

error_message instance-attribute

error_message: NotRequired[String]

Any errors that occurred while enabling or disabling Auto-Tune.

state instance-attribute

state: NotRequired[AutoTuneState]

The current state of Auto-Tune on the domain.

use_off_peak_window instance-attribute

use_off_peak_window: NotRequired[Boolean]

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.