Skip to content

Literals#

Index > OpenSearchService > Literals

Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.

AWSServicePrincipalType#

# AWSServicePrincipalType usage example

from mypy_boto3_opensearch.literals import AWSServicePrincipalType

def get_value() -> AWSServicePrincipalType:
    return "application.opensearchservice.amazonaws.com"
# AWSServicePrincipalType definition

AWSServicePrincipalType = Literal[
    "application.opensearchservice.amazonaws.com",
]

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",
]

AppConfigTypeType#

# AppConfigTypeType usage example

from mypy_boto3_opensearch.literals import AppConfigTypeType

def get_value() -> AppConfigTypeType:
    return "opensearchDashboards.dashboardAdmin.groups"
# AppConfigTypeType definition

AppConfigTypeType = Literal[
    "opensearchDashboards.dashboardAdmin.groups",
    "opensearchDashboards.dashboardAdmin.users",
]

ApplicationStatusType#

# ApplicationStatusType usage example

from mypy_boto3_opensearch.literals import ApplicationStatusType

def get_value() -> ApplicationStatusType:
    return "ACTIVE"
# ApplicationStatusType definition

ApplicationStatusType = Literal[
    "ACTIVE",
    "CREATING",
    "DELETING",
    "FAILED",
    "UPDATING",
]

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",
    "PackageOwner",
    "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",
]

ListApplicationsPaginatorName#

# ListApplicationsPaginatorName usage example

from mypy_boto3_opensearch.literals import ListApplicationsPaginatorName

def get_value() -> ListApplicationsPaginatorName:
    return "list_applications"
# ListApplicationsPaginatorName definition

ListApplicationsPaginatorName = Literal[
    "list_applications",
]

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",
]

NodeOptionsNodeTypeType#

# NodeOptionsNodeTypeType usage example

from mypy_boto3_opensearch.literals import NodeOptionsNodeTypeType

def get_value() -> NodeOptionsNodeTypeType:
    return "coordinator"
# NodeOptionsNodeTypeType definition

NodeOptionsNodeTypeType = Literal[
    "coordinator",
]

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",
]

PackageScopeOperationEnumType#

# PackageScopeOperationEnumType usage example

from mypy_boto3_opensearch.literals import PackageScopeOperationEnumType

def get_value() -> PackageScopeOperationEnumType:
    return "ADD"
# PackageScopeOperationEnumType definition

PackageScopeOperationEnumType = Literal[
    "ADD",
    "OVERRIDE",
    "REMOVE",
]

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 "PACKAGE-CONFIG"
# PackageTypeType definition

PackageTypeType = Literal[
    "PACKAGE-CONFIG",
    "PACKAGE-LICENSE",
    "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",
]

RequirementLevelType#

# RequirementLevelType usage example

from mypy_boto3_opensearch.literals import RequirementLevelType

def get_value() -> RequirementLevelType:
    return "NONE"
# RequirementLevelType definition

RequirementLevelType = Literal[
    "NONE",
    "OPTIONAL",
    "REQUIRED",
]

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",
]

RolesKeyIdCOptionType#

# RolesKeyIdCOptionType usage example

from mypy_boto3_opensearch.literals import RolesKeyIdCOptionType

def get_value() -> RolesKeyIdCOptionType:
    return "GroupId"
# RolesKeyIdCOptionType definition

RolesKeyIdCOptionType = Literal[
    "GroupId",
    "GroupName",
]

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",
]

SubjectKeyIdCOptionType#

# SubjectKeyIdCOptionType usage example

from mypy_boto3_opensearch.literals import SubjectKeyIdCOptionType

def get_value() -> SubjectKeyIdCOptionType:
    return "Email"
# SubjectKeyIdCOptionType definition

SubjectKeyIdCOptionType = Literal[
    "Email",
    "UserId",
    "UserName",
]

TLSSecurityPolicyType#

# TLSSecurityPolicyType usage example

from mypy_boto3_opensearch.literals import TLSSecurityPolicyType

def get_value() -> TLSSecurityPolicyType:
    return "Policy-Min-TLS-1-0-2019-07"
# TLSSecurityPolicyType definition

TLSSecurityPolicyType = Literal[
    "Policy-Min-TLS-1-0-2019-07",
    "Policy-Min-TLS-1-2-2019-07",
    "Policy-Min-TLS-1-2-PFS-2023-10",
]

TimeUnitType#

# TimeUnitType usage example

from mypy_boto3_opensearch.literals import TimeUnitType

def get_value() -> TimeUnitType:
    return "HOURS"
# TimeUnitType definition

TimeUnitType = Literal[
    "HOURS",
]

UpgradeStatusType#

# UpgradeStatusType usage example

from mypy_boto3_opensearch.literals import UpgradeStatusType

def get_value() -> UpgradeStatusType:
    return "FAILED"
# UpgradeStatusType definition

UpgradeStatusType = Literal[
    "FAILED",
    "IN_PROGRESS",
    "SUCCEEDED",
    "SUCCEEDED_WITH_ISSUES",
]

UpgradeStepType#

# UpgradeStepType usage example

from mypy_boto3_opensearch.literals import UpgradeStepType

def get_value() -> UpgradeStepType:
    return "PRE_UPGRADE_CHECK"
# UpgradeStepType definition

UpgradeStepType = Literal[
    "PRE_UPGRADE_CHECK",
    "SNAPSHOT",
    "UPGRADE",
]

VolumeTypeType#

# VolumeTypeType usage example

from mypy_boto3_opensearch.literals import VolumeTypeType

def get_value() -> VolumeTypeType:
    return "gp2"
# VolumeTypeType definition

VolumeTypeType = Literal[
    "gp2",
    "gp3",
    "io1",
    "standard",
]

VpcEndpointErrorCodeType#

# VpcEndpointErrorCodeType usage example

from mypy_boto3_opensearch.literals import VpcEndpointErrorCodeType

def get_value() -> VpcEndpointErrorCodeType:
    return "ENDPOINT_NOT_FOUND"
# VpcEndpointErrorCodeType definition

VpcEndpointErrorCodeType = Literal[
    "ENDPOINT_NOT_FOUND",
    "SERVER_ERROR",
]

VpcEndpointStatusType#

# VpcEndpointStatusType usage example

from mypy_boto3_opensearch.literals import VpcEndpointStatusType

def get_value() -> VpcEndpointStatusType:
    return "ACTIVE"
# VpcEndpointStatusType definition

VpcEndpointStatusType = Literal[
    "ACTIVE",
    "CREATE_FAILED",
    "CREATING",
    "DELETE_FAILED",
    "DELETING",
    "UPDATE_FAILED",
    "UPDATING",
]

ZoneStatusType#

# ZoneStatusType usage example

from mypy_boto3_opensearch.literals import ZoneStatusType

def get_value() -> ZoneStatusType:
    return "Active"
# ZoneStatusType definition

ZoneStatusType = Literal[
    "Active",
    "NotAvailable",
    "StandBy",
]

OpenSearchServiceServiceName#

# OpenSearchServiceServiceName usage example

from mypy_boto3_opensearch.literals import OpenSearchServiceServiceName

def get_value() -> OpenSearchServiceServiceName:
    return "opensearch"
# OpenSearchServiceServiceName definition

OpenSearchServiceServiceName = Literal[
    "opensearch",
]

ServiceName#

# ServiceName usage example

from mypy_boto3_opensearch.literals import ServiceName

def get_value() -> ServiceName:
    return "accessanalyzer"
# ServiceName definition

ServiceName = Literal[
    "accessanalyzer",
    "account",
    "acm",
    "acm-pca",
    "amp",
    "amplify",
    "amplifybackend",
    "amplifyuibuilder",
    "apigateway",
    "apigatewaymanagementapi",
    "apigatewayv2",
    "appconfig",
    "appconfigdata",
    "appfabric",
    "appflow",
    "appintegrations",
    "application-autoscaling",
    "application-insights",
    "application-signals",
    "applicationcostprofiler",
    "appmesh",
    "apprunner",
    "appstream",
    "appsync",
    "apptest",
    "arc-zonal-shift",
    "artifact",
    "athena",
    "auditmanager",
    "autoscaling",
    "autoscaling-plans",
    "b2bi",
    "backup",
    "backup-gateway",
    "batch",
    "bcm-data-exports",
    "bedrock",
    "bedrock-agent",
    "bedrock-agent-runtime",
    "bedrock-runtime",
    "billing",
    "billingconductor",
    "braket",
    "budgets",
    "ce",
    "chatbot",
    "chime",
    "chime-sdk-identity",
    "chime-sdk-media-pipelines",
    "chime-sdk-meetings",
    "chime-sdk-messaging",
    "chime-sdk-voice",
    "cleanrooms",
    "cleanroomsml",
    "cloud9",
    "cloudcontrol",
    "clouddirectory",
    "cloudformation",
    "cloudfront",
    "cloudfront-keyvaluestore",
    "cloudhsm",
    "cloudhsmv2",
    "cloudsearch",
    "cloudsearchdomain",
    "cloudtrail",
    "cloudtrail-data",
    "cloudwatch",
    "codeartifact",
    "codebuild",
    "codecatalyst",
    "codecommit",
    "codeconnections",
    "codedeploy",
    "codeguru-reviewer",
    "codeguru-security",
    "codeguruprofiler",
    "codepipeline",
    "codestar-connections",
    "codestar-notifications",
    "cognito-identity",
    "cognito-idp",
    "cognito-sync",
    "comprehend",
    "comprehendmedical",
    "compute-optimizer",
    "config",
    "connect",
    "connect-contact-lens",
    "connectcampaigns",
    "connectcampaignsv2",
    "connectcases",
    "connectparticipant",
    "controlcatalog",
    "controltower",
    "cost-optimization-hub",
    "cur",
    "customer-profiles",
    "databrew",
    "dataexchange",
    "datapipeline",
    "datasync",
    "datazone",
    "dax",
    "deadline",
    "detective",
    "devicefarm",
    "devops-guru",
    "directconnect",
    "discovery",
    "dlm",
    "dms",
    "docdb",
    "docdb-elastic",
    "drs",
    "ds",
    "ds-data",
    "dynamodb",
    "dynamodbstreams",
    "ebs",
    "ec2",
    "ec2-instance-connect",
    "ecr",
    "ecr-public",
    "ecs",
    "efs",
    "eks",
    "eks-auth",
    "elastic-inference",
    "elasticache",
    "elasticbeanstalk",
    "elastictranscoder",
    "elb",
    "elbv2",
    "emr",
    "emr-containers",
    "emr-serverless",
    "entityresolution",
    "es",
    "events",
    "evidently",
    "finspace",
    "finspace-data",
    "firehose",
    "fis",
    "fms",
    "forecast",
    "forecastquery",
    "frauddetector",
    "freetier",
    "fsx",
    "gamelift",
    "geo-maps",
    "geo-places",
    "geo-routes",
    "glacier",
    "globalaccelerator",
    "glue",
    "grafana",
    "greengrass",
    "greengrassv2",
    "groundstation",
    "guardduty",
    "health",
    "healthlake",
    "iam",
    "identitystore",
    "imagebuilder",
    "importexport",
    "inspector",
    "inspector-scan",
    "inspector2",
    "internetmonitor",
    "iot",
    "iot-data",
    "iot-jobs-data",
    "iot1click-devices",
    "iot1click-projects",
    "iotanalytics",
    "iotdeviceadvisor",
    "iotevents",
    "iotevents-data",
    "iotfleethub",
    "iotfleetwise",
    "iotsecuretunneling",
    "iotsitewise",
    "iotthingsgraph",
    "iottwinmaker",
    "iotwireless",
    "ivs",
    "ivs-realtime",
    "ivschat",
    "kafka",
    "kafkaconnect",
    "kendra",
    "kendra-ranking",
    "keyspaces",
    "kinesis",
    "kinesis-video-archived-media",
    "kinesis-video-media",
    "kinesis-video-signaling",
    "kinesis-video-webrtc-storage",
    "kinesisanalytics",
    "kinesisanalyticsv2",
    "kinesisvideo",
    "kms",
    "lakeformation",
    "lambda",
    "launch-wizard",
    "lex-models",
    "lex-runtime",
    "lexv2-models",
    "lexv2-runtime",
    "license-manager",
    "license-manager-linux-subscriptions",
    "license-manager-user-subscriptions",
    "lightsail",
    "location",
    "logs",
    "lookoutequipment",
    "lookoutmetrics",
    "lookoutvision",
    "m2",
    "machinelearning",
    "macie2",
    "mailmanager",
    "managedblockchain",
    "managedblockchain-query",
    "marketplace-agreement",
    "marketplace-catalog",
    "marketplace-deployment",
    "marketplace-entitlement",
    "marketplace-reporting",
    "marketplacecommerceanalytics",
    "mediaconnect",
    "mediaconvert",
    "medialive",
    "mediapackage",
    "mediapackage-vod",
    "mediapackagev2",
    "mediastore",
    "mediastore-data",
    "mediatailor",
    "medical-imaging",
    "memorydb",
    "meteringmarketplace",
    "mgh",
    "mgn",
    "migration-hub-refactor-spaces",
    "migrationhub-config",
    "migrationhuborchestrator",
    "migrationhubstrategy",
    "mq",
    "mturk",
    "mwaa",
    "neptune",
    "neptune-graph",
    "neptunedata",
    "network-firewall",
    "networkmanager",
    "networkmonitor",
    "oam",
    "omics",
    "opensearch",
    "opensearchserverless",
    "opsworks",
    "opsworkscm",
    "organizations",
    "osis",
    "outposts",
    "panorama",
    "partnercentral-selling",
    "payment-cryptography",
    "payment-cryptography-data",
    "pca-connector-ad",
    "pca-connector-scep",
    "pcs",
    "personalize",
    "personalize-events",
    "personalize-runtime",
    "pi",
    "pinpoint",
    "pinpoint-email",
    "pinpoint-sms-voice",
    "pinpoint-sms-voice-v2",
    "pipes",
    "polly",
    "pricing",
    "privatenetworks",
    "proton",
    "qapps",
    "qbusiness",
    "qconnect",
    "qldb",
    "qldb-session",
    "quicksight",
    "ram",
    "rbin",
    "rds",
    "rds-data",
    "redshift",
    "redshift-data",
    "redshift-serverless",
    "rekognition",
    "repostspace",
    "resiliencehub",
    "resource-explorer-2",
    "resource-groups",
    "resourcegroupstaggingapi",
    "robomaker",
    "rolesanywhere",
    "route53",
    "route53-recovery-cluster",
    "route53-recovery-control-config",
    "route53-recovery-readiness",
    "route53domains",
    "route53profiles",
    "route53resolver",
    "rum",
    "s3",
    "s3control",
    "s3outposts",
    "sagemaker",
    "sagemaker-a2i-runtime",
    "sagemaker-edge",
    "sagemaker-featurestore-runtime",
    "sagemaker-geospatial",
    "sagemaker-metrics",
    "sagemaker-runtime",
    "savingsplans",
    "scheduler",
    "schemas",
    "sdb",
    "secretsmanager",
    "securityhub",
    "securitylake",
    "serverlessrepo",
    "service-quotas",
    "servicecatalog",
    "servicecatalog-appregistry",
    "servicediscovery",
    "ses",
    "sesv2",
    "shield",
    "signer",
    "simspaceweaver",
    "sms",
    "sms-voice",
    "snow-device-management",
    "snowball",
    "sns",
    "socialmessaging",
    "sqs",
    "ssm",
    "ssm-contacts",
    "ssm-incidents",
    "ssm-quicksetup",
    "ssm-sap",
    "sso",
    "sso-admin",
    "sso-oidc",
    "stepfunctions",
    "storagegateway",
    "sts",
    "supplychain",
    "support",
    "support-app",
    "swf",
    "synthetics",
    "taxsettings",
    "textract",
    "timestream-influxdb",
    "timestream-query",
    "timestream-write",
    "tnb",
    "transcribe",
    "transfer",
    "translate",
    "trustedadvisor",
    "verifiedpermissions",
    "voice-id",
    "vpc-lattice",
    "waf",
    "waf-regional",
    "wafv2",
    "wellarchitected",
    "wisdom",
    "workdocs",
    "workmail",
    "workmailmessageflow",
    "workspaces",
    "workspaces-thin-client",
    "workspaces-web",
    "xray",
]

ResourceServiceName#

# ResourceServiceName usage example

from mypy_boto3_opensearch.literals import ResourceServiceName

def get_value() -> ResourceServiceName:
    return "cloudformation"
# ResourceServiceName definition

ResourceServiceName = Literal[
    "cloudformation",
    "cloudwatch",
    "dynamodb",
    "ec2",
    "glacier",
    "iam",
    "opsworks",
    "s3",
    "sns",
    "sqs",
]

PaginatorName#

# PaginatorName usage example

from mypy_boto3_opensearch.literals import PaginatorName

def get_value() -> PaginatorName:
    return "list_applications"
# PaginatorName definition

PaginatorName = Literal[
    "list_applications",
]

RegionName#

# RegionName usage example

from mypy_boto3_opensearch.literals import RegionName

def get_value() -> RegionName:
    return "af-south-1"
# RegionName definition

RegionName = Literal[
    "af-south-1",
    "ap-east-1",
    "ap-northeast-1",
    "ap-northeast-2",
    "ap-northeast-3",
    "ap-south-1",
    "ap-south-2",
    "ap-southeast-1",
    "ap-southeast-2",
    "ap-southeast-3",
    "ap-southeast-4",
    "ap-southeast-5",
    "ca-central-1",
    "ca-west-1",
    "eu-central-1",
    "eu-central-2",
    "eu-north-1",
    "eu-south-1",
    "eu-south-2",
    "eu-west-1",
    "eu-west-2",
    "eu-west-3",
    "il-central-1",
    "me-central-1",
    "me-south-1",
    "sa-east-1",
    "us-east-1",
    "us-east-2",
    "us-west-1",
    "us-west-2",
]