Literals#
Index > OpenSearchService > Literals
Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.
ActionSeverityType#
# ActionSeverityType usage example
from mypy_boto3_opensearch.literals import ActionSeverityType
def get_value() -> ActionSeverityType:
return "HIGH"# ActionSeverityType definition
ActionSeverityType = Literal[
"HIGH",
"LOW",
"MEDIUM",
]ActionStatusType#
# ActionStatusType usage example
from mypy_boto3_opensearch.literals import ActionStatusType
def get_value() -> ActionStatusType:
return "COMPLETED"# ActionStatusType definition
ActionStatusType = Literal[
"COMPLETED",
"ELIGIBLE",
"FAILED",
"IN_PROGRESS",
"NOT_ELIGIBLE",
"PENDING_UPDATE",
]ActionTypeType#
# ActionTypeType usage example
from mypy_boto3_opensearch.literals import ActionTypeType
def get_value() -> ActionTypeType:
return "JVM_HEAP_SIZE_TUNING"# ActionTypeType definition
ActionTypeType = Literal[
"JVM_HEAP_SIZE_TUNING",
"JVM_YOUNG_GEN_TUNING",
"SERVICE_SOFTWARE_UPDATE",
]AutoTuneDesiredStateType#
# AutoTuneDesiredStateType usage example
from mypy_boto3_opensearch.literals import AutoTuneDesiredStateType
def get_value() -> AutoTuneDesiredStateType:
return "DISABLED"# AutoTuneDesiredStateType definition
AutoTuneDesiredStateType = Literal[
"DISABLED",
"ENABLED",
]AutoTuneStateType#
# AutoTuneStateType usage example
from mypy_boto3_opensearch.literals import AutoTuneStateType
def get_value() -> AutoTuneStateType:
return "DISABLED"# AutoTuneStateType definition
AutoTuneStateType = Literal[
"DISABLE_IN_PROGRESS",
"DISABLED",
"DISABLED_AND_ROLLBACK_COMPLETE",
"DISABLED_AND_ROLLBACK_ERROR",
"DISABLED_AND_ROLLBACK_IN_PROGRESS",
"DISABLED_AND_ROLLBACK_SCHEDULED",
"ENABLE_IN_PROGRESS",
"ENABLED",
"ERROR",
]AutoTuneTypeType#
# AutoTuneTypeType usage example
from mypy_boto3_opensearch.literals import AutoTuneTypeType
def get_value() -> AutoTuneTypeType:
return "SCHEDULED_ACTION"# AutoTuneTypeType definition
AutoTuneTypeType = Literal[
"SCHEDULED_ACTION",
]ConfigChangeStatusType#
# ConfigChangeStatusType usage example
from mypy_boto3_opensearch.literals import ConfigChangeStatusType
def get_value() -> ConfigChangeStatusType:
return "ApplyingChanges"# ConfigChangeStatusType definition
ConfigChangeStatusType = Literal[
"ApplyingChanges",
"Cancelled",
"Completed",
"Initializing",
"Pending",
"PendingUserInput",
"Validating",
"ValidationFailed",
]ConnectionModeType#
# ConnectionModeType usage example
from mypy_boto3_opensearch.literals import ConnectionModeType
def get_value() -> ConnectionModeType:
return "DIRECT"# ConnectionModeType definition
ConnectionModeType = Literal[
"DIRECT",
"VPC_ENDPOINT",
]DataSourceStatusType#
# DataSourceStatusType usage example
from mypy_boto3_opensearch.literals import DataSourceStatusType
def get_value() -> DataSourceStatusType:
return "ACTIVE"# DataSourceStatusType definition
DataSourceStatusType = Literal[
"ACTIVE",
"DISABLED",
]DeploymentStatusType#
# DeploymentStatusType usage example
from mypy_boto3_opensearch.literals import DeploymentStatusType
def get_value() -> DeploymentStatusType:
return "COMPLETED"# DeploymentStatusType definition
DeploymentStatusType = Literal[
"COMPLETED",
"ELIGIBLE",
"IN_PROGRESS",
"NOT_ELIGIBLE",
"PENDING_UPDATE",
]DescribePackagesFilterNameType#
# DescribePackagesFilterNameType usage example
from mypy_boto3_opensearch.literals import DescribePackagesFilterNameType
def get_value() -> DescribePackagesFilterNameType:
return "EngineVersion"# DescribePackagesFilterNameType definition
DescribePackagesFilterNameType = Literal[
"EngineVersion",
"PackageID",
"PackageName",
"PackageStatus",
"PackageType",
]DomainHealthType#
# DomainHealthType usage example
from mypy_boto3_opensearch.literals import DomainHealthType
def get_value() -> DomainHealthType:
return "Green"# DomainHealthType definition
DomainHealthType = Literal[
"Green",
"NotAvailable",
"Red",
"Yellow",
]DomainPackageStatusType#
# DomainPackageStatusType usage example
from mypy_boto3_opensearch.literals import DomainPackageStatusType
def get_value() -> DomainPackageStatusType:
return "ACTIVE"# DomainPackageStatusType definition
DomainPackageStatusType = Literal[
"ACTIVE",
"ASSOCIATING",
"ASSOCIATION_FAILED",
"DISSOCIATING",
"DISSOCIATION_FAILED",
]DomainProcessingStatusTypeType#
# DomainProcessingStatusTypeType usage example
from mypy_boto3_opensearch.literals import DomainProcessingStatusTypeType
def get_value() -> DomainProcessingStatusTypeType:
return "Active"# DomainProcessingStatusTypeType definition
DomainProcessingStatusTypeType = Literal[
"Active",
"Creating",
"Deleting",
"Isolated",
"Modifying",
"UpdatingServiceSoftware",
"UpgradingEngineVersion",
]DomainStateType#
# DomainStateType usage example
from mypy_boto3_opensearch.literals import DomainStateType
def get_value() -> DomainStateType:
return "Active"# DomainStateType definition
DomainStateType = Literal[
"Active",
"NotAvailable",
"Processing",
]DryRunModeType#
# DryRunModeType usage example
from mypy_boto3_opensearch.literals import DryRunModeType
def get_value() -> DryRunModeType:
return "Basic"# DryRunModeType definition
DryRunModeType = Literal[
"Basic",
"Verbose",
]EngineTypeType#
# EngineTypeType usage example
from mypy_boto3_opensearch.literals import EngineTypeType
def get_value() -> EngineTypeType:
return "Elasticsearch"# EngineTypeType definition
EngineTypeType = Literal[
"Elasticsearch",
"OpenSearch",
]IPAddressTypeType#
# IPAddressTypeType usage example
from mypy_boto3_opensearch.literals import IPAddressTypeType
def get_value() -> IPAddressTypeType:
return "dualstack"# IPAddressTypeType definition
IPAddressTypeType = Literal[
"dualstack",
"ipv4",
]InboundConnectionStatusCodeType#
# InboundConnectionStatusCodeType usage example
from mypy_boto3_opensearch.literals import InboundConnectionStatusCodeType
def get_value() -> InboundConnectionStatusCodeType:
return "ACTIVE"# InboundConnectionStatusCodeType definition
InboundConnectionStatusCodeType = Literal[
"ACTIVE",
"APPROVED",
"DELETED",
"DELETING",
"PENDING_ACCEPTANCE",
"PROVISIONING",
"REJECTED",
"REJECTING",
]InitiatedByType#
# InitiatedByType usage example
from mypy_boto3_opensearch.literals import InitiatedByType
def get_value() -> InitiatedByType:
return "CUSTOMER"# InitiatedByType definition
InitiatedByType = Literal[
"CUSTOMER",
"SERVICE",
]LogTypeType#
# LogTypeType usage example
from mypy_boto3_opensearch.literals import LogTypeType
def get_value() -> LogTypeType:
return "AUDIT_LOGS"# LogTypeType definition
LogTypeType = Literal[
"AUDIT_LOGS",
"ES_APPLICATION_LOGS",
"INDEX_SLOW_LOGS",
"SEARCH_SLOW_LOGS",
]MaintenanceStatusType#
# MaintenanceStatusType usage example
from mypy_boto3_opensearch.literals import MaintenanceStatusType
def get_value() -> MaintenanceStatusType:
return "COMPLETED"# MaintenanceStatusType definition
MaintenanceStatusType = Literal[
"COMPLETED",
"FAILED",
"IN_PROGRESS",
"PENDING",
"TIMED_OUT",
]MaintenanceTypeType#
# MaintenanceTypeType usage example
from mypy_boto3_opensearch.literals import MaintenanceTypeType
def get_value() -> MaintenanceTypeType:
return "REBOOT_NODE"# MaintenanceTypeType definition
MaintenanceTypeType = Literal[
"REBOOT_NODE",
"RESTART_DASHBOARD",
"RESTART_SEARCH_PROCESS",
]MasterNodeStatusType#
# MasterNodeStatusType usage example
from mypy_boto3_opensearch.literals import MasterNodeStatusType
def get_value() -> MasterNodeStatusType:
return "Available"# MasterNodeStatusType definition
MasterNodeStatusType = Literal[
"Available",
"UnAvailable",
]NaturalLanguageQueryGenerationCurrentStateType#
# NaturalLanguageQueryGenerationCurrentStateType usage example
from mypy_boto3_opensearch.literals import NaturalLanguageQueryGenerationCurrentStateType
def get_value() -> NaturalLanguageQueryGenerationCurrentStateType:
return "DISABLE_COMPLETE"# NaturalLanguageQueryGenerationCurrentStateType definition
NaturalLanguageQueryGenerationCurrentStateType = Literal[
"DISABLE_COMPLETE",
"DISABLE_FAILED",
"DISABLE_IN_PROGRESS",
"ENABLE_COMPLETE",
"ENABLE_FAILED",
"ENABLE_IN_PROGRESS",
"NOT_ENABLED",
]NaturalLanguageQueryGenerationDesiredStateType#
# NaturalLanguageQueryGenerationDesiredStateType usage example
from mypy_boto3_opensearch.literals import NaturalLanguageQueryGenerationDesiredStateType
def get_value() -> NaturalLanguageQueryGenerationDesiredStateType:
return "DISABLED"# NaturalLanguageQueryGenerationDesiredStateType definition
NaturalLanguageQueryGenerationDesiredStateType = Literal[
"DISABLED",
"ENABLED",
]NodeStatusType#
# NodeStatusType usage example
from mypy_boto3_opensearch.literals import NodeStatusType
def get_value() -> NodeStatusType:
return "Active"# NodeStatusType definition
NodeStatusType = Literal[
"Active",
"NotAvailable",
"StandBy",
]NodeTypeType#
# NodeTypeType usage example
from mypy_boto3_opensearch.literals import NodeTypeType
def get_value() -> NodeTypeType:
return "Data"# NodeTypeType definition
NodeTypeType = Literal[
"Data",
"Master",
"Ultrawarm",
]OpenSearchPartitionInstanceTypeType#
# OpenSearchPartitionInstanceTypeType usage example
from mypy_boto3_opensearch.literals import OpenSearchPartitionInstanceTypeType
def get_value() -> OpenSearchPartitionInstanceTypeType:
return "c4.2xlarge.search"# OpenSearchPartitionInstanceTypeType definition
OpenSearchPartitionInstanceTypeType = Literal[
"c4.2xlarge.search",
"c4.4xlarge.search",
"c4.8xlarge.search",
"c4.large.search",
"c4.xlarge.search",
"c5.18xlarge.search",
"c5.2xlarge.search",
"c5.4xlarge.search",
"c5.9xlarge.search",
"c5.large.search",
"c5.xlarge.search",
"c6g.12xlarge.search",
"c6g.2xlarge.search",
"c6g.4xlarge.search",
"c6g.8xlarge.search",
"c6g.large.search",
"c6g.xlarge.search",
"d2.2xlarge.search",
"d2.4xlarge.search",
"d2.8xlarge.search",
"d2.xlarge.search",
"i2.2xlarge.search",
"i2.xlarge.search",
"i3.16xlarge.search",
"i3.2xlarge.search",
"i3.4xlarge.search",
"i3.8xlarge.search",
"i3.large.search",
"i3.xlarge.search",
"m3.2xlarge.search",
"m3.large.search",
"m3.medium.search",
"m3.xlarge.search",
"m4.10xlarge.search",
"m4.2xlarge.search",
"m4.4xlarge.search",
"m4.large.search",
"m4.xlarge.search",
"m5.12xlarge.search",
"m5.24xlarge.search",
"m5.2xlarge.search",
"m5.4xlarge.search",
"m5.large.search",
"m5.xlarge.search",
"m6g.12xlarge.search",
"m6g.2xlarge.search",
"m6g.4xlarge.search",
"m6g.8xlarge.search",
"m6g.large.search",
"m6g.xlarge.search",
"or1.12xlarge.search",
"or1.16xlarge.search",
"or1.2xlarge.search",
"or1.4xlarge.search",
"or1.8xlarge.search",
"or1.large.search",
"or1.medium.search",
"or1.xlarge.search",
"r3.2xlarge.search",
"r3.4xlarge.search",
"r3.8xlarge.search",
"r3.large.search",
"r3.xlarge.search",
"r4.16xlarge.search",
"r4.2xlarge.search",
"r4.4xlarge.search",
"r4.8xlarge.search",
"r4.large.search",
"r4.xlarge.search",
"r5.12xlarge.search",
"r5.24xlarge.search",
"r5.2xlarge.search",
"r5.4xlarge.search",
"r5.large.search",
"r5.xlarge.search",
"r6g.12xlarge.search",
"r6g.2xlarge.search",
"r6g.4xlarge.search",
"r6g.8xlarge.search",
"r6g.large.search",
"r6g.xlarge.search",
"r6gd.12xlarge.search",
"r6gd.16xlarge.search",
"r6gd.2xlarge.search",
"r6gd.4xlarge.search",
"r6gd.8xlarge.search",
"r6gd.large.search",
"r6gd.xlarge.search",
"t2.medium.search",
"t2.micro.search",
"t2.small.search",
"t3.2xlarge.search",
"t3.large.search",
"t3.medium.search",
"t3.micro.search",
"t3.nano.search",
"t3.small.search",
"t3.xlarge.search",
"t4g.medium.search",
"t4g.small.search",
"ultrawarm1.large.search",
"ultrawarm1.medium.search",
"ultrawarm1.xlarge.search",
]OpenSearchWarmPartitionInstanceTypeType#
# OpenSearchWarmPartitionInstanceTypeType usage example
from mypy_boto3_opensearch.literals import OpenSearchWarmPartitionInstanceTypeType
def get_value() -> OpenSearchWarmPartitionInstanceTypeType:
return "ultrawarm1.large.search"# OpenSearchWarmPartitionInstanceTypeType definition
OpenSearchWarmPartitionInstanceTypeType = Literal[
"ultrawarm1.large.search",
"ultrawarm1.medium.search",
"ultrawarm1.xlarge.search",
]OptionStateType#
# OptionStateType usage example
from mypy_boto3_opensearch.literals import OptionStateType
def get_value() -> OptionStateType:
return "Active"# OptionStateType definition
OptionStateType = Literal[
"Active",
"Processing",
"RequiresIndexDocuments",
]OutboundConnectionStatusCodeType#
# OutboundConnectionStatusCodeType usage example
from mypy_boto3_opensearch.literals import OutboundConnectionStatusCodeType
def get_value() -> OutboundConnectionStatusCodeType:
return "ACTIVE"# OutboundConnectionStatusCodeType definition
OutboundConnectionStatusCodeType = Literal[
"ACTIVE",
"APPROVED",
"DELETED",
"DELETING",
"PENDING_ACCEPTANCE",
"PROVISIONING",
"REJECTED",
"REJECTING",
"VALIDATING",
"VALIDATION_FAILED",
]OverallChangeStatusType#
# OverallChangeStatusType usage example
from mypy_boto3_opensearch.literals import OverallChangeStatusType
def get_value() -> OverallChangeStatusType:
return "COMPLETED"# OverallChangeStatusType definition
OverallChangeStatusType = Literal[
"COMPLETED",
"FAILED",
"PENDING",
"PROCESSING",
]PackageStatusType#
# PackageStatusType usage example
from mypy_boto3_opensearch.literals import PackageStatusType
def get_value() -> PackageStatusType:
return "AVAILABLE"# PackageStatusType definition
PackageStatusType = Literal[
"AVAILABLE",
"COPY_FAILED",
"COPYING",
"DELETE_FAILED",
"DELETED",
"DELETING",
"VALIDATING",
"VALIDATION_FAILED",
]PackageTypeType#
# PackageTypeType usage example
from mypy_boto3_opensearch.literals import PackageTypeType
def get_value() -> PackageTypeType:
return "TXT-DICTIONARY"# PackageTypeType definition
PackageTypeType = Literal[
"TXT-DICTIONARY",
"ZIP-PLUGIN",
]PrincipalTypeType#
# PrincipalTypeType usage example
from mypy_boto3_opensearch.literals import PrincipalTypeType
def get_value() -> PrincipalTypeType:
return "AWS_ACCOUNT"# PrincipalTypeType definition
PrincipalTypeType = Literal[
"AWS_ACCOUNT",
"AWS_SERVICE",
]PropertyValueTypeType#
# PropertyValueTypeType usage example
from mypy_boto3_opensearch.literals import PropertyValueTypeType
def get_value() -> PropertyValueTypeType:
return "PLAIN_TEXT"# PropertyValueTypeType definition
PropertyValueTypeType = Literal[
"PLAIN_TEXT",
"STRINGIFIED_JSON",
]ReservedInstancePaymentOptionType#
# ReservedInstancePaymentOptionType usage example
from mypy_boto3_opensearch.literals import ReservedInstancePaymentOptionType
def get_value() -> ReservedInstancePaymentOptionType:
return "ALL_UPFRONT"# ReservedInstancePaymentOptionType definition
ReservedInstancePaymentOptionType = Literal[
"ALL_UPFRONT",
"NO_UPFRONT",
"PARTIAL_UPFRONT",
]RollbackOnDisableType#
# RollbackOnDisableType usage example
from mypy_boto3_opensearch.literals import RollbackOnDisableType
def get_value() -> RollbackOnDisableType:
return "DEFAULT_ROLLBACK"# RollbackOnDisableType definition
RollbackOnDisableType = Literal[
"DEFAULT_ROLLBACK",
"NO_ROLLBACK",
]ScheduleAtType#
# ScheduleAtType usage example
from mypy_boto3_opensearch.literals import ScheduleAtType
def get_value() -> ScheduleAtType:
return "NOW"# ScheduleAtType definition
ScheduleAtType = Literal[
"NOW",
"OFF_PEAK_WINDOW",
"TIMESTAMP",
]ScheduledAutoTuneActionTypeType#
# ScheduledAutoTuneActionTypeType usage example
from mypy_boto3_opensearch.literals import ScheduledAutoTuneActionTypeType
def get_value() -> ScheduledAutoTuneActionTypeType:
return "JVM_HEAP_SIZE_TUNING"# ScheduledAutoTuneActionTypeType definition
ScheduledAutoTuneActionTypeType = Literal[
"JVM_HEAP_SIZE_TUNING",
"JVM_YOUNG_GEN_TUNING",
]ScheduledAutoTuneSeverityTypeType#
# ScheduledAutoTuneSeverityTypeType usage example
from mypy_boto3_opensearch.literals import ScheduledAutoTuneSeverityTypeType
def get_value() -> ScheduledAutoTuneSeverityTypeType:
return "HIGH"# ScheduledAutoTuneSeverityTypeType definition
ScheduledAutoTuneSeverityTypeType = Literal[
"HIGH",
"LOW",
"MEDIUM",
]ScheduledByType#
# ScheduledByType usage example
from mypy_boto3_opensearch.literals import ScheduledByType
def get_value() -> ScheduledByType:
return "CUSTOMER"# ScheduledByType definition
ScheduledByType = Literal[
"CUSTOMER",
"SYSTEM",
]SkipUnavailableStatusType#
# SkipUnavailableStatusType usage example
from mypy_boto3_opensearch.literals import SkipUnavailableStatusType
def get_value() -> SkipUnavailableStatusType:
return "DISABLED"# SkipUnavailableStatusType definition
SkipUnavailableStatusType = Literal[
"DISABLED",
"ENABLED",
]