localstack/aws/api/opensearch/__init__.py
from datetime import datetime
from typing import Dict, List, Optional, TypedDict
from localstack.aws.api import RequestContext, ServiceException, ServiceRequest, handler
ARN = str
AWSAccount = str
AvailabilityZone = str
BackendRole = str
Boolean = bool
ChangeProgressStageName = str
ChangeProgressStageStatus = str
ClientToken = str
CloudWatchLogsLogGroupArn = str
CommitMessage = str
ConnectionAlias = str
ConnectionId = str
ConnectionStatusMessage = str
DataSourceDescription = str
DataSourceName = str
DeploymentType = str
DescribePackagesFilterValue = str
Description = str
DomainArn = str
DomainId = str
DomainName = str
DomainNameFqdn = str
Double = float
DryRun = bool
Endpoint = str
EngineVersion = str
ErrorMessage = str
ErrorType = str
GUID = str
IdentityPoolId = str
InstanceCount = int
InstanceRole = str
InstanceTypeString = str
Integer = int
IntegerClass = int
Issue = str
KmsKeyId = str
LimitName = str
LimitValue = str
MaintenanceStatusMessage = str
MaxResults = int
MaximumInstanceCount = int
Message = str
MinimumInstanceCount = int
NextToken = str
NodeId = str
NonEmptyString = str
NumberOfAZs = str
NumberOfNodes = str
NumberOfShards = str
OwnerId = str
PackageDescription = str
PackageID = str
PackageName = str
PackageVersion = str
Password = str
PluginClassName = str
PluginDescription = str
PluginName = str
PluginVersion = str
PolicyDocument = str
ReferencePath = str
Region = str
RequestId = str
ReservationToken = str
RoleArn = str
S3BucketName = str
S3Key = str
SAMLEntityId = str
SAMLMetadata = str
ScheduledAutoTuneDescription = str
ServiceUrl = str
StorageSubTypeName = str
StorageTypeName = str
String = str
TagKey = str
TagValue = str
TotalNumberOfStages = int
UIntValue = int
UpgradeName = str
UserPoolId = str
Username = str
VersionString = str
VolumeSize = str
VpcEndpointId = str
class ActionSeverity(str):
HIGH = "HIGH"
MEDIUM = "MEDIUM"
LOW = "LOW"
class ActionStatus(str):
PENDING_UPDATE = "PENDING_UPDATE"
IN_PROGRESS = "IN_PROGRESS"
FAILED = "FAILED"
COMPLETED = "COMPLETED"
NOT_ELIGIBLE = "NOT_ELIGIBLE"
ELIGIBLE = "ELIGIBLE"
class ActionType(str):
SERVICE_SOFTWARE_UPDATE = "SERVICE_SOFTWARE_UPDATE"
JVM_HEAP_SIZE_TUNING = "JVM_HEAP_SIZE_TUNING"
JVM_YOUNG_GEN_TUNING = "JVM_YOUNG_GEN_TUNING"
class AutoTuneDesiredState(str):
ENABLED = "ENABLED"
DISABLED = "DISABLED"
class AutoTuneState(str):
ENABLED = "ENABLED"
DISABLED = "DISABLED"
ENABLE_IN_PROGRESS = "ENABLE_IN_PROGRESS"
DISABLE_IN_PROGRESS = "DISABLE_IN_PROGRESS"
DISABLED_AND_ROLLBACK_SCHEDULED = "DISABLED_AND_ROLLBACK_SCHEDULED"
DISABLED_AND_ROLLBACK_IN_PROGRESS = "DISABLED_AND_ROLLBACK_IN_PROGRESS"
DISABLED_AND_ROLLBACK_COMPLETE = "DISABLED_AND_ROLLBACK_COMPLETE"
DISABLED_AND_ROLLBACK_ERROR = "DISABLED_AND_ROLLBACK_ERROR"
ERROR = "ERROR"
class AutoTuneType(str):
SCHEDULED_ACTION = "SCHEDULED_ACTION"
class ConfigChangeStatus(str):
Pending = "Pending"
Initializing = "Initializing"
Validating = "Validating"
ValidationFailed = "ValidationFailed"
ApplyingChanges = "ApplyingChanges"
Completed = "Completed"
PendingUserInput = "PendingUserInput"
Cancelled = "Cancelled"
class ConnectionMode(str):
DIRECT = "DIRECT"
VPC_ENDPOINT = "VPC_ENDPOINT"
class DeploymentStatus(str):
PENDING_UPDATE = "PENDING_UPDATE"
IN_PROGRESS = "IN_PROGRESS"
COMPLETED = "COMPLETED"
NOT_ELIGIBLE = "NOT_ELIGIBLE"
ELIGIBLE = "ELIGIBLE"
class DescribePackagesFilterName(str):
PackageID = "PackageID"
PackageName = "PackageName"
PackageStatus = "PackageStatus"
PackageType = "PackageType"
EngineVersion = "EngineVersion"
class DomainHealth(str):
Red = "Red"
Yellow = "Yellow"
Green = "Green"
NotAvailable = "NotAvailable"
class DomainPackageStatus(str):
ASSOCIATING = "ASSOCIATING"
ASSOCIATION_FAILED = "ASSOCIATION_FAILED"
ACTIVE = "ACTIVE"
DISSOCIATING = "DISSOCIATING"
DISSOCIATION_FAILED = "DISSOCIATION_FAILED"
class DomainProcessingStatusType(str):
Creating = "Creating"
Active = "Active"
Modifying = "Modifying"
UpgradingEngineVersion = "UpgradingEngineVersion"
UpdatingServiceSoftware = "UpdatingServiceSoftware"
Isolated = "Isolated"
Deleting = "Deleting"
class DomainState(str):
Active = "Active"
Processing = "Processing"
NotAvailable = "NotAvailable"
class DryRunMode(str):
Basic = "Basic"
Verbose = "Verbose"
class EngineType(str):
OpenSearch = "OpenSearch"
Elasticsearch = "Elasticsearch"
class IPAddressType(str):
ipv4 = "ipv4"
dualstack = "dualstack"
class InboundConnectionStatusCode(str):
PENDING_ACCEPTANCE = "PENDING_ACCEPTANCE"
APPROVED = "APPROVED"
PROVISIONING = "PROVISIONING"
ACTIVE = "ACTIVE"
REJECTING = "REJECTING"
REJECTED = "REJECTED"
DELETING = "DELETING"
DELETED = "DELETED"
class InitiatedBy(str):
CUSTOMER = "CUSTOMER"
SERVICE = "SERVICE"
class LogType(str):
INDEX_SLOW_LOGS = "INDEX_SLOW_LOGS"
SEARCH_SLOW_LOGS = "SEARCH_SLOW_LOGS"
ES_APPLICATION_LOGS = "ES_APPLICATION_LOGS"
AUDIT_LOGS = "AUDIT_LOGS"
class MaintenanceStatus(str):
PENDING = "PENDING"
IN_PROGRESS = "IN_PROGRESS"
COMPLETED = "COMPLETED"
FAILED = "FAILED"
TIMED_OUT = "TIMED_OUT"
class MaintenanceType(str):
REBOOT_NODE = "REBOOT_NODE"
RESTART_SEARCH_PROCESS = "RESTART_SEARCH_PROCESS"
RESTART_DASHBOARD = "RESTART_DASHBOARD"
class MasterNodeStatus(str):
Available = "Available"
UnAvailable = "UnAvailable"
class NodeStatus(str):
Active = "Active"
StandBy = "StandBy"
NotAvailable = "NotAvailable"
class NodeType(str):
Data = "Data"
Ultrawarm = "Ultrawarm"
Master = "Master"
class OpenSearchPartitionInstanceType(str):
m3_medium_search = "m3.medium.search"
m3_large_search = "m3.large.search"
m3_xlarge_search = "m3.xlarge.search"
m3_2xlarge_search = "m3.2xlarge.search"
m4_large_search = "m4.large.search"
m4_xlarge_search = "m4.xlarge.search"
m4_2xlarge_search = "m4.2xlarge.search"
m4_4xlarge_search = "m4.4xlarge.search"
m4_10xlarge_search = "m4.10xlarge.search"
m5_large_search = "m5.large.search"
m5_xlarge_search = "m5.xlarge.search"
m5_2xlarge_search = "m5.2xlarge.search"
m5_4xlarge_search = "m5.4xlarge.search"
m5_12xlarge_search = "m5.12xlarge.search"
m5_24xlarge_search = "m5.24xlarge.search"
r5_large_search = "r5.large.search"
r5_xlarge_search = "r5.xlarge.search"
r5_2xlarge_search = "r5.2xlarge.search"
r5_4xlarge_search = "r5.4xlarge.search"
r5_12xlarge_search = "r5.12xlarge.search"
r5_24xlarge_search = "r5.24xlarge.search"
c5_large_search = "c5.large.search"
c5_xlarge_search = "c5.xlarge.search"
c5_2xlarge_search = "c5.2xlarge.search"
c5_4xlarge_search = "c5.4xlarge.search"
c5_9xlarge_search = "c5.9xlarge.search"
c5_18xlarge_search = "c5.18xlarge.search"
t3_nano_search = "t3.nano.search"
t3_micro_search = "t3.micro.search"
t3_small_search = "t3.small.search"
t3_medium_search = "t3.medium.search"
t3_large_search = "t3.large.search"
t3_xlarge_search = "t3.xlarge.search"
t3_2xlarge_search = "t3.2xlarge.search"
or1_medium_search = "or1.medium.search"
or1_large_search = "or1.large.search"
or1_xlarge_search = "or1.xlarge.search"
or1_2xlarge_search = "or1.2xlarge.search"
or1_4xlarge_search = "or1.4xlarge.search"
or1_8xlarge_search = "or1.8xlarge.search"
or1_12xlarge_search = "or1.12xlarge.search"
or1_16xlarge_search = "or1.16xlarge.search"
ultrawarm1_medium_search = "ultrawarm1.medium.search"
ultrawarm1_large_search = "ultrawarm1.large.search"
ultrawarm1_xlarge_search = "ultrawarm1.xlarge.search"
t2_micro_search = "t2.micro.search"
t2_small_search = "t2.small.search"
t2_medium_search = "t2.medium.search"
r3_large_search = "r3.large.search"
r3_xlarge_search = "r3.xlarge.search"
r3_2xlarge_search = "r3.2xlarge.search"
r3_4xlarge_search = "r3.4xlarge.search"
r3_8xlarge_search = "r3.8xlarge.search"
i2_xlarge_search = "i2.xlarge.search"
i2_2xlarge_search = "i2.2xlarge.search"
d2_xlarge_search = "d2.xlarge.search"
d2_2xlarge_search = "d2.2xlarge.search"
d2_4xlarge_search = "d2.4xlarge.search"
d2_8xlarge_search = "d2.8xlarge.search"
c4_large_search = "c4.large.search"
c4_xlarge_search = "c4.xlarge.search"
c4_2xlarge_search = "c4.2xlarge.search"
c4_4xlarge_search = "c4.4xlarge.search"
c4_8xlarge_search = "c4.8xlarge.search"
r4_large_search = "r4.large.search"
r4_xlarge_search = "r4.xlarge.search"
r4_2xlarge_search = "r4.2xlarge.search"
r4_4xlarge_search = "r4.4xlarge.search"
r4_8xlarge_search = "r4.8xlarge.search"
r4_16xlarge_search = "r4.16xlarge.search"
i3_large_search = "i3.large.search"
i3_xlarge_search = "i3.xlarge.search"
i3_2xlarge_search = "i3.2xlarge.search"
i3_4xlarge_search = "i3.4xlarge.search"
i3_8xlarge_search = "i3.8xlarge.search"
i3_16xlarge_search = "i3.16xlarge.search"
r6g_large_search = "r6g.large.search"
r6g_xlarge_search = "r6g.xlarge.search"
r6g_2xlarge_search = "r6g.2xlarge.search"
r6g_4xlarge_search = "r6g.4xlarge.search"
r6g_8xlarge_search = "r6g.8xlarge.search"
r6g_12xlarge_search = "r6g.12xlarge.search"
m6g_large_search = "m6g.large.search"
m6g_xlarge_search = "m6g.xlarge.search"
m6g_2xlarge_search = "m6g.2xlarge.search"
m6g_4xlarge_search = "m6g.4xlarge.search"
m6g_8xlarge_search = "m6g.8xlarge.search"
m6g_12xlarge_search = "m6g.12xlarge.search"
c6g_large_search = "c6g.large.search"
c6g_xlarge_search = "c6g.xlarge.search"
c6g_2xlarge_search = "c6g.2xlarge.search"
c6g_4xlarge_search = "c6g.4xlarge.search"
c6g_8xlarge_search = "c6g.8xlarge.search"
c6g_12xlarge_search = "c6g.12xlarge.search"
r6gd_large_search = "r6gd.large.search"
r6gd_xlarge_search = "r6gd.xlarge.search"
r6gd_2xlarge_search = "r6gd.2xlarge.search"
r6gd_4xlarge_search = "r6gd.4xlarge.search"
r6gd_8xlarge_search = "r6gd.8xlarge.search"
r6gd_12xlarge_search = "r6gd.12xlarge.search"
r6gd_16xlarge_search = "r6gd.16xlarge.search"
t4g_small_search = "t4g.small.search"
t4g_medium_search = "t4g.medium.search"
class OpenSearchWarmPartitionInstanceType(str):
ultrawarm1_medium_search = "ultrawarm1.medium.search"
ultrawarm1_large_search = "ultrawarm1.large.search"
ultrawarm1_xlarge_search = "ultrawarm1.xlarge.search"
class OptionState(str):
RequiresIndexDocuments = "RequiresIndexDocuments"
Processing = "Processing"
Active = "Active"
class OutboundConnectionStatusCode(str):
VALIDATING = "VALIDATING"
VALIDATION_FAILED = "VALIDATION_FAILED"
PENDING_ACCEPTANCE = "PENDING_ACCEPTANCE"
APPROVED = "APPROVED"
PROVISIONING = "PROVISIONING"
ACTIVE = "ACTIVE"
REJECTING = "REJECTING"
REJECTED = "REJECTED"
DELETING = "DELETING"
DELETED = "DELETED"
class OverallChangeStatus(str):
PENDING = "PENDING"
PROCESSING = "PROCESSING"
COMPLETED = "COMPLETED"
FAILED = "FAILED"
class PackageStatus(str):
COPYING = "COPYING"
COPY_FAILED = "COPY_FAILED"
VALIDATING = "VALIDATING"
VALIDATION_FAILED = "VALIDATION_FAILED"
AVAILABLE = "AVAILABLE"
DELETING = "DELETING"
DELETED = "DELETED"
DELETE_FAILED = "DELETE_FAILED"
class PackageType(str):
TXT_DICTIONARY = "TXT-DICTIONARY"
ZIP_PLUGIN = "ZIP-PLUGIN"
class PrincipalType(str):
AWS_ACCOUNT = "AWS_ACCOUNT"
AWS_SERVICE = "AWS_SERVICE"
class PropertyValueType(str):
PLAIN_TEXT = "PLAIN_TEXT"
STRINGIFIED_JSON = "STRINGIFIED_JSON"
class ReservedInstancePaymentOption(str):
ALL_UPFRONT = "ALL_UPFRONT"
PARTIAL_UPFRONT = "PARTIAL_UPFRONT"
NO_UPFRONT = "NO_UPFRONT"
class RollbackOnDisable(str):
NO_ROLLBACK = "NO_ROLLBACK"
DEFAULT_ROLLBACK = "DEFAULT_ROLLBACK"
class ScheduleAt(str):
NOW = "NOW"
TIMESTAMP = "TIMESTAMP"
OFF_PEAK_WINDOW = "OFF_PEAK_WINDOW"
class ScheduledAutoTuneActionType(str):
JVM_HEAP_SIZE_TUNING = "JVM_HEAP_SIZE_TUNING"
JVM_YOUNG_GEN_TUNING = "JVM_YOUNG_GEN_TUNING"
class ScheduledAutoTuneSeverityType(str):
LOW = "LOW"
MEDIUM = "MEDIUM"
HIGH = "HIGH"
class ScheduledBy(str):
CUSTOMER = "CUSTOMER"
SYSTEM = "SYSTEM"
class SkipUnavailableStatus(str):
ENABLED = "ENABLED"
DISABLED = "DISABLED"
class TLSSecurityPolicy(str):
Policy_Min_TLS_1_0_2019_07 = "Policy-Min-TLS-1-0-2019-07"
Policy_Min_TLS_1_2_2019_07 = "Policy-Min-TLS-1-2-2019-07"
Policy_Min_TLS_1_2_PFS_2023_10 = "Policy-Min-TLS-1-2-PFS-2023-10"
class TimeUnit(str):
HOURS = "HOURS"
class UpgradeStatus(str):
IN_PROGRESS = "IN_PROGRESS"
SUCCEEDED = "SUCCEEDED"
SUCCEEDED_WITH_ISSUES = "SUCCEEDED_WITH_ISSUES"
FAILED = "FAILED"
class UpgradeStep(str):
PRE_UPGRADE_CHECK = "PRE_UPGRADE_CHECK"
SNAPSHOT = "SNAPSHOT"
UPGRADE = "UPGRADE"
class VolumeType(str):
standard = "standard"
gp2 = "gp2"
io1 = "io1"
gp3 = "gp3"
class VpcEndpointErrorCode(str):
ENDPOINT_NOT_FOUND = "ENDPOINT_NOT_FOUND"
SERVER_ERROR = "SERVER_ERROR"
class VpcEndpointStatus(str):
CREATING = "CREATING"
CREATE_FAILED = "CREATE_FAILED"
ACTIVE = "ACTIVE"
UPDATING = "UPDATING"
UPDATE_FAILED = "UPDATE_FAILED"
DELETING = "DELETING"
DELETE_FAILED = "DELETE_FAILED"
class ZoneStatus(str):
Active = "Active"
StandBy = "StandBy"
NotAvailable = "NotAvailable"
class AccessDeniedException(ServiceException):
code: str = "AccessDeniedException"
sender_fault: bool = False
status_code: int = 403
class BaseException(ServiceException):
code: str = "BaseException"
sender_fault: bool = False
status_code: int = 400
class ConflictException(ServiceException):
code: str = "ConflictException"
sender_fault: bool = False
status_code: int = 409
class DependencyFailureException(ServiceException):
code: str = "DependencyFailureException"
sender_fault: bool = False
status_code: int = 424
class DisabledOperationException(ServiceException):
code: str = "DisabledOperationException"
sender_fault: bool = False
status_code: int = 409
class InternalException(ServiceException):
code: str = "InternalException"
sender_fault: bool = False
status_code: int = 500
class InvalidPaginationTokenException(ServiceException):
code: str = "InvalidPaginationTokenException"
sender_fault: bool = False
status_code: int = 400
class InvalidTypeException(ServiceException):
code: str = "InvalidTypeException"
sender_fault: bool = False
status_code: int = 409
class LimitExceededException(ServiceException):
code: str = "LimitExceededException"
sender_fault: bool = False
status_code: int = 409
class ResourceAlreadyExistsException(ServiceException):
code: str = "ResourceAlreadyExistsException"
sender_fault: bool = False
status_code: int = 409
class ResourceNotFoundException(ServiceException):
code: str = "ResourceNotFoundException"
sender_fault: bool = False
status_code: int = 409
Long = int
SlotList = List[Long]
class SlotNotAvailableException(ServiceException):
code: str = "SlotNotAvailableException"
sender_fault: bool = False
status_code: int = 409
SlotSuggestions: Optional[SlotList]
class ValidationException(ServiceException):
code: str = "ValidationException"
sender_fault: bool = False
status_code: int = 400
class AWSDomainInformation(TypedDict, total=False):
OwnerId: Optional[OwnerId]
DomainName: DomainName
Region: Optional[Region]
class AcceptInboundConnectionRequest(ServiceRequest):
ConnectionId: ConnectionId
class InboundConnectionStatus(TypedDict, total=False):
StatusCode: Optional[InboundConnectionStatusCode]
Message: Optional[ConnectionStatusMessage]
class DomainInformationContainer(TypedDict, total=False):
AWSDomainInformation: Optional[AWSDomainInformation]
class InboundConnection(TypedDict, total=False):
LocalDomainInfo: Optional[DomainInformationContainer]
RemoteDomainInfo: Optional[DomainInformationContainer]
ConnectionId: Optional[ConnectionId]
ConnectionStatus: Optional[InboundConnectionStatus]
ConnectionMode: Optional[ConnectionMode]
class AcceptInboundConnectionResponse(TypedDict, total=False):
Connection: Optional[InboundConnection]
UpdateTimestamp = datetime
class OptionStatus(TypedDict, total=False):
CreationDate: UpdateTimestamp
UpdateDate: UpdateTimestamp
UpdateVersion: Optional[UIntValue]
State: OptionState
PendingDeletion: Optional[Boolean]
class AccessPoliciesStatus(TypedDict, total=False):
Options: PolicyDocument
Status: OptionStatus
class S3GlueDataCatalog(TypedDict, total=False):
RoleArn: Optional[RoleArn]
class DataSourceType(TypedDict, total=False):
S3GlueDataCatalog: Optional[S3GlueDataCatalog]
class AddDataSourceRequest(ServiceRequest):
DomainName: DomainName
Name: DataSourceName
DataSourceType: DataSourceType
Description: Optional[DataSourceDescription]
class AddDataSourceResponse(TypedDict, total=False):
Message: Optional[String]
class Tag(TypedDict, total=False):
Key: TagKey
Value: TagValue
TagList = List[Tag]
class AddTagsRequest(ServiceRequest):
ARN: ARN
TagList: TagList
LimitValueList = List[LimitValue]
class AdditionalLimit(TypedDict, total=False):
LimitName: Optional[LimitName]
LimitValues: Optional[LimitValueList]
AdditionalLimitList = List[AdditionalLimit]
AdvancedOptions = Dict[String, String]
class AdvancedOptionsStatus(TypedDict, total=False):
Options: AdvancedOptions
Status: OptionStatus
DisableTimestamp = datetime
class SAMLIdp(TypedDict, total=False):
MetadataContent: SAMLMetadata
EntityId: SAMLEntityId
class SAMLOptionsOutput(TypedDict, total=False):
Enabled: Optional[Boolean]
Idp: Optional[SAMLIdp]
SubjectKey: Optional[String]
RolesKey: Optional[String]
SessionTimeoutMinutes: Optional[IntegerClass]
class AdvancedSecurityOptions(TypedDict, total=False):
Enabled: Optional[Boolean]
InternalUserDatabaseEnabled: Optional[Boolean]
SAMLOptions: Optional[SAMLOptionsOutput]
AnonymousAuthDisableDate: Optional[DisableTimestamp]
AnonymousAuthEnabled: Optional[Boolean]
class SAMLOptionsInput(TypedDict, total=False):
Enabled: Optional[Boolean]
Idp: Optional[SAMLIdp]
MasterUserName: Optional[Username]
MasterBackendRole: Optional[BackendRole]
SubjectKey: Optional[String]
RolesKey: Optional[String]
SessionTimeoutMinutes: Optional[IntegerClass]
class MasterUserOptions(TypedDict, total=False):
MasterUserARN: Optional[ARN]
MasterUserName: Optional[Username]
MasterUserPassword: Optional[Password]
class AdvancedSecurityOptionsInput(TypedDict, total=False):
Enabled: Optional[Boolean]
InternalUserDatabaseEnabled: Optional[Boolean]
MasterUserOptions: Optional[MasterUserOptions]
SAMLOptions: Optional[SAMLOptionsInput]
AnonymousAuthEnabled: Optional[Boolean]
class AdvancedSecurityOptionsStatus(TypedDict, total=False):
Options: AdvancedSecurityOptions
Status: OptionStatus
class AssociatePackageRequest(ServiceRequest):
PackageID: PackageID
DomainName: DomainName
class ErrorDetails(TypedDict, total=False):
ErrorType: Optional[ErrorType]
ErrorMessage: Optional[ErrorMessage]
LastUpdated = datetime
class DomainPackageDetails(TypedDict, total=False):
PackageID: Optional[PackageID]
PackageName: Optional[PackageName]
PackageType: Optional[PackageType]
LastUpdated: Optional[LastUpdated]
DomainName: Optional[DomainName]
DomainPackageStatus: Optional[DomainPackageStatus]
PackageVersion: Optional[PackageVersion]
ReferencePath: Optional[ReferencePath]
ErrorDetails: Optional[ErrorDetails]
class AssociatePackageResponse(TypedDict, total=False):
DomainPackageDetails: Optional[DomainPackageDetails]
class AuthorizeVpcEndpointAccessRequest(ServiceRequest):
DomainName: DomainName
Account: AWSAccount
class AuthorizedPrincipal(TypedDict, total=False):
PrincipalType: Optional[PrincipalType]
Principal: Optional[String]
class AuthorizeVpcEndpointAccessResponse(TypedDict, total=False):
AuthorizedPrincipal: AuthorizedPrincipal
AuthorizedPrincipalList = List[AuthorizedPrincipal]
AutoTuneDate = datetime
class ScheduledAutoTuneDetails(TypedDict, total=False):
Date: Optional[AutoTuneDate]
ActionType: Optional[ScheduledAutoTuneActionType]
Action: Optional[ScheduledAutoTuneDescription]
Severity: Optional[ScheduledAutoTuneSeverityType]
class AutoTuneDetails(TypedDict, total=False):
ScheduledAutoTuneDetails: Optional[ScheduledAutoTuneDetails]
class AutoTune(TypedDict, total=False):
AutoTuneType: Optional[AutoTuneType]
AutoTuneDetails: Optional[AutoTuneDetails]
AutoTuneList = List[AutoTune]
DurationValue = int
class Duration(TypedDict, total=False):
Value: Optional[DurationValue]
Unit: Optional[TimeUnit]
StartAt = datetime
class AutoTuneMaintenanceSchedule(TypedDict, total=False):
StartAt: Optional[StartAt]
Duration: Optional[Duration]
CronExpressionForRecurrence: Optional[String]
AutoTuneMaintenanceScheduleList = List[AutoTuneMaintenanceSchedule]
class AutoTuneOptions(TypedDict, total=False):
DesiredState: Optional[AutoTuneDesiredState]
RollbackOnDisable: Optional[RollbackOnDisable]
MaintenanceSchedules: Optional[AutoTuneMaintenanceScheduleList]
UseOffPeakWindow: Optional[Boolean]
class AutoTuneOptionsInput(TypedDict, total=False):
DesiredState: Optional[AutoTuneDesiredState]
MaintenanceSchedules: Optional[AutoTuneMaintenanceScheduleList]
UseOffPeakWindow: Optional[Boolean]
class AutoTuneOptionsOutput(TypedDict, total=False):
State: Optional[AutoTuneState]
ErrorMessage: Optional[String]
UseOffPeakWindow: Optional[Boolean]
class AutoTuneStatus(TypedDict, total=False):
CreationDate: UpdateTimestamp
UpdateDate: UpdateTimestamp
UpdateVersion: Optional[UIntValue]
State: AutoTuneState
ErrorMessage: Optional[String]
PendingDeletion: Optional[Boolean]
class AutoTuneOptionsStatus(TypedDict, total=False):
Options: Optional[AutoTuneOptions]
Status: Optional[AutoTuneStatus]
class AvailabilityZoneInfo(TypedDict, total=False):
AvailabilityZoneName: Optional[AvailabilityZone]
ZoneStatus: Optional[ZoneStatus]
ConfiguredDataNodeCount: Optional[NumberOfNodes]
AvailableDataNodeCount: Optional[NumberOfNodes]
TotalShards: Optional[NumberOfShards]
TotalUnAssignedShards: Optional[NumberOfShards]
AvailabilityZoneInfoList = List[AvailabilityZoneInfo]
AvailabilityZoneList = List[AvailabilityZone]
class CancelDomainConfigChangeRequest(ServiceRequest):
DomainName: DomainName
DryRun: Optional[DryRun]
class CancelledChangeProperty(TypedDict, total=False):
PropertyName: Optional[String]
CancelledValue: Optional[String]
ActiveValue: Optional[String]
CancelledChangePropertyList = List[CancelledChangeProperty]
GUIDList = List[GUID]
class CancelDomainConfigChangeResponse(TypedDict, total=False):
CancelledChangeIds: Optional[GUIDList]
CancelledChangeProperties: Optional[CancelledChangePropertyList]
DryRun: Optional[DryRun]
class CancelServiceSoftwareUpdateRequest(ServiceRequest):
DomainName: DomainName
DeploymentCloseDateTimeStamp = datetime
class ServiceSoftwareOptions(TypedDict, total=False):
CurrentVersion: Optional[String]
NewVersion: Optional[String]
UpdateAvailable: Optional[Boolean]
Cancellable: Optional[Boolean]
UpdateStatus: Optional[DeploymentStatus]
Description: Optional[String]
AutomatedUpdateDate: Optional[DeploymentCloseDateTimeStamp]
OptionalDeployment: Optional[Boolean]
class CancelServiceSoftwareUpdateResponse(TypedDict, total=False):
ServiceSoftwareOptions: Optional[ServiceSoftwareOptions]
class ChangeProgressDetails(TypedDict, total=False):
ChangeId: Optional[GUID]
Message: Optional[Message]
ConfigChangeStatus: Optional[ConfigChangeStatus]
InitiatedBy: Optional[InitiatedBy]
StartTime: Optional[UpdateTimestamp]
LastUpdatedTime: Optional[UpdateTimestamp]
class ChangeProgressStage(TypedDict, total=False):
Name: Optional[ChangeProgressStageName]
Status: Optional[ChangeProgressStageStatus]
Description: Optional[Description]
LastUpdated: Optional[LastUpdated]
ChangeProgressStageList = List[ChangeProgressStage]
StringList = List[String]
class ChangeProgressStatusDetails(TypedDict, total=False):
ChangeId: Optional[GUID]
StartTime: Optional[UpdateTimestamp]
Status: Optional[OverallChangeStatus]
PendingProperties: Optional[StringList]
CompletedProperties: Optional[StringList]
TotalNumberOfStages: Optional[TotalNumberOfStages]
ChangeProgressStages: Optional[ChangeProgressStageList]
LastUpdatedTime: Optional[UpdateTimestamp]
ConfigChangeStatus: Optional[ConfigChangeStatus]
InitiatedBy: Optional[InitiatedBy]
class ColdStorageOptions(TypedDict, total=False):
Enabled: Boolean
class ZoneAwarenessConfig(TypedDict, total=False):
AvailabilityZoneCount: Optional[IntegerClass]
class ClusterConfig(TypedDict, total=False):
InstanceType: Optional[OpenSearchPartitionInstanceType]
InstanceCount: Optional[IntegerClass]
DedicatedMasterEnabled: Optional[Boolean]
ZoneAwarenessEnabled: Optional[Boolean]
ZoneAwarenessConfig: Optional[ZoneAwarenessConfig]
DedicatedMasterType: Optional[OpenSearchPartitionInstanceType]
DedicatedMasterCount: Optional[IntegerClass]
WarmEnabled: Optional[Boolean]
WarmType: Optional[OpenSearchWarmPartitionInstanceType]
WarmCount: Optional[IntegerClass]
ColdStorageOptions: Optional[ColdStorageOptions]
MultiAZWithStandbyEnabled: Optional[Boolean]
class ClusterConfigStatus(TypedDict, total=False):
Options: ClusterConfig
Status: OptionStatus
class CognitoOptions(TypedDict, total=False):
Enabled: Optional[Boolean]
UserPoolId: Optional[UserPoolId]
IdentityPoolId: Optional[IdentityPoolId]
RoleArn: Optional[RoleArn]
class CognitoOptionsStatus(TypedDict, total=False):
Options: CognitoOptions
Status: OptionStatus
VersionList = List[VersionString]
class CompatibleVersionsMap(TypedDict, total=False):
SourceVersion: Optional[VersionString]
TargetVersions: Optional[VersionList]
CompatibleVersionsList = List[CompatibleVersionsMap]
class CrossClusterSearchConnectionProperties(TypedDict, total=False):
SkipUnavailable: Optional[SkipUnavailableStatus]
class ConnectionProperties(TypedDict, total=False):
Endpoint: Optional[Endpoint]
CrossClusterSearch: Optional[CrossClusterSearchConnectionProperties]
class SoftwareUpdateOptions(TypedDict, total=False):
AutoSoftwareUpdateEnabled: Optional[Boolean]
StartTimeMinutes = int
StartTimeHours = int
class WindowStartTime(TypedDict, total=False):
Hours: StartTimeHours
Minutes: StartTimeMinutes
class OffPeakWindow(TypedDict, total=False):
WindowStartTime: Optional[WindowStartTime]
class OffPeakWindowOptions(TypedDict, total=False):
Enabled: Optional[Boolean]
OffPeakWindow: Optional[OffPeakWindow]
class DomainEndpointOptions(TypedDict, total=False):
EnforceHTTPS: Optional[Boolean]
TLSSecurityPolicy: Optional[TLSSecurityPolicy]
CustomEndpointEnabled: Optional[Boolean]
CustomEndpoint: Optional[DomainNameFqdn]
CustomEndpointCertificateArn: Optional[ARN]
class LogPublishingOption(TypedDict, total=False):
CloudWatchLogsLogGroupArn: Optional[CloudWatchLogsLogGroupArn]
Enabled: Optional[Boolean]
LogPublishingOptions = Dict[LogType, LogPublishingOption]
class NodeToNodeEncryptionOptions(TypedDict, total=False):
Enabled: Optional[Boolean]
class EncryptionAtRestOptions(TypedDict, total=False):
Enabled: Optional[Boolean]
KmsKeyId: Optional[KmsKeyId]
class VPCOptions(TypedDict, total=False):
SubnetIds: Optional[StringList]
SecurityGroupIds: Optional[StringList]
class SnapshotOptions(TypedDict, total=False):
AutomatedSnapshotStartHour: Optional[IntegerClass]
class EBSOptions(TypedDict, total=False):
EBSEnabled: Optional[Boolean]
VolumeType: Optional[VolumeType]
VolumeSize: Optional[IntegerClass]
Iops: Optional[IntegerClass]
Throughput: Optional[IntegerClass]
class CreateDomainRequest(ServiceRequest):
DomainName: DomainName
EngineVersion: Optional[VersionString]
ClusterConfig: Optional[ClusterConfig]
EBSOptions: Optional[EBSOptions]
AccessPolicies: Optional[PolicyDocument]
IPAddressType: Optional[IPAddressType]
SnapshotOptions: Optional[SnapshotOptions]
VPCOptions: Optional[VPCOptions]
CognitoOptions: Optional[CognitoOptions]
EncryptionAtRestOptions: Optional[EncryptionAtRestOptions]
NodeToNodeEncryptionOptions: Optional[NodeToNodeEncryptionOptions]
AdvancedOptions: Optional[AdvancedOptions]
LogPublishingOptions: Optional[LogPublishingOptions]
DomainEndpointOptions: Optional[DomainEndpointOptions]
AdvancedSecurityOptions: Optional[AdvancedSecurityOptionsInput]
TagList: Optional[TagList]
AutoTuneOptions: Optional[AutoTuneOptionsInput]
OffPeakWindowOptions: Optional[OffPeakWindowOptions]
SoftwareUpdateOptions: Optional[SoftwareUpdateOptions]
class ModifyingProperties(TypedDict, total=False):
Name: Optional[String]
ActiveValue: Optional[String]
PendingValue: Optional[String]
ValueType: Optional[PropertyValueType]
ModifyingPropertiesList = List[ModifyingProperties]
class VPCDerivedInfo(TypedDict, total=False):
VPCId: Optional[String]
SubnetIds: Optional[StringList]
AvailabilityZones: Optional[StringList]
SecurityGroupIds: Optional[StringList]
EndpointsMap = Dict[String, ServiceUrl]
class DomainStatus(TypedDict, total=False):
DomainId: DomainId
DomainName: DomainName
ARN: ARN
Created: Optional[Boolean]
Deleted: Optional[Boolean]
Endpoint: Optional[ServiceUrl]
EndpointV2: Optional[ServiceUrl]
Endpoints: Optional[EndpointsMap]
Processing: Optional[Boolean]
UpgradeProcessing: Optional[Boolean]
EngineVersion: Optional[VersionString]
ClusterConfig: ClusterConfig
EBSOptions: Optional[EBSOptions]
AccessPolicies: Optional[PolicyDocument]
IPAddressType: Optional[IPAddressType]
SnapshotOptions: Optional[SnapshotOptions]
VPCOptions: Optional[VPCDerivedInfo]
CognitoOptions: Optional[CognitoOptions]
EncryptionAtRestOptions: Optional[EncryptionAtRestOptions]
NodeToNodeEncryptionOptions: Optional[NodeToNodeEncryptionOptions]
AdvancedOptions: Optional[AdvancedOptions]
LogPublishingOptions: Optional[LogPublishingOptions]
ServiceSoftwareOptions: Optional[ServiceSoftwareOptions]
DomainEndpointOptions: Optional[DomainEndpointOptions]
AdvancedSecurityOptions: Optional[AdvancedSecurityOptions]
AutoTuneOptions: Optional[AutoTuneOptionsOutput]
ChangeProgressDetails: Optional[ChangeProgressDetails]
OffPeakWindowOptions: Optional[OffPeakWindowOptions]
SoftwareUpdateOptions: Optional[SoftwareUpdateOptions]
DomainProcessingStatus: Optional[DomainProcessingStatusType]
ModifyingProperties: Optional[ModifyingPropertiesList]
class CreateDomainResponse(TypedDict, total=False):
DomainStatus: Optional[DomainStatus]
class CreateOutboundConnectionRequest(ServiceRequest):
LocalDomainInfo: DomainInformationContainer
RemoteDomainInfo: DomainInformationContainer
ConnectionAlias: ConnectionAlias
ConnectionMode: Optional[ConnectionMode]
ConnectionProperties: Optional[ConnectionProperties]
class OutboundConnectionStatus(TypedDict, total=False):
StatusCode: Optional[OutboundConnectionStatusCode]
Message: Optional[ConnectionStatusMessage]
class CreateOutboundConnectionResponse(TypedDict, total=False):
LocalDomainInfo: Optional[DomainInformationContainer]
RemoteDomainInfo: Optional[DomainInformationContainer]
ConnectionAlias: Optional[ConnectionAlias]
ConnectionStatus: Optional[OutboundConnectionStatus]
ConnectionId: Optional[ConnectionId]
ConnectionMode: Optional[ConnectionMode]
ConnectionProperties: Optional[ConnectionProperties]
class PackageSource(TypedDict, total=False):
S3BucketName: Optional[S3BucketName]
S3Key: Optional[S3Key]
class CreatePackageRequest(ServiceRequest):
PackageName: PackageName
PackageType: PackageType
PackageDescription: Optional[PackageDescription]
PackageSource: PackageSource
UncompressedPluginSizeInBytes = int
class PluginProperties(TypedDict, total=False):
Name: Optional[PluginName]
Description: Optional[PluginDescription]
Version: Optional[PluginVersion]
ClassName: Optional[PluginClassName]
UncompressedSizeInBytes: Optional[UncompressedPluginSizeInBytes]
CreatedAt = datetime
class PackageDetails(TypedDict, total=False):
PackageID: Optional[PackageID]
PackageName: Optional[PackageName]
PackageType: Optional[PackageType]
PackageDescription: Optional[PackageDescription]
PackageStatus: Optional[PackageStatus]
CreatedAt: Optional[CreatedAt]
LastUpdatedAt: Optional[LastUpdated]
AvailablePackageVersion: Optional[PackageVersion]
ErrorDetails: Optional[ErrorDetails]
EngineVersion: Optional[EngineVersion]
AvailablePluginProperties: Optional[PluginProperties]
class CreatePackageResponse(TypedDict, total=False):
PackageDetails: Optional[PackageDetails]
class CreateVpcEndpointRequest(ServiceRequest):
DomainArn: DomainArn
VpcOptions: VPCOptions
ClientToken: Optional[ClientToken]
class VpcEndpoint(TypedDict, total=False):
VpcEndpointId: Optional[VpcEndpointId]
VpcEndpointOwner: Optional[AWSAccount]
DomainArn: Optional[DomainArn]
VpcOptions: Optional[VPCDerivedInfo]
Status: Optional[VpcEndpointStatus]
Endpoint: Optional[Endpoint]
class CreateVpcEndpointResponse(TypedDict, total=False):
VpcEndpoint: VpcEndpoint
class DataSourceDetails(TypedDict, total=False):
DataSourceType: Optional[DataSourceType]
Name: Optional[DataSourceName]
Description: Optional[DataSourceDescription]
DataSourceList = List[DataSourceDetails]
class DeleteDataSourceRequest(ServiceRequest):
DomainName: DomainName
Name: DataSourceName
class DeleteDataSourceResponse(TypedDict, total=False):
Message: Optional[String]
class DeleteDomainRequest(ServiceRequest):
DomainName: DomainName
class DeleteDomainResponse(TypedDict, total=False):
DomainStatus: Optional[DomainStatus]
class DeleteInboundConnectionRequest(ServiceRequest):
ConnectionId: ConnectionId
class DeleteInboundConnectionResponse(TypedDict, total=False):
Connection: Optional[InboundConnection]
class DeleteOutboundConnectionRequest(ServiceRequest):
ConnectionId: ConnectionId
class OutboundConnection(TypedDict, total=False):
LocalDomainInfo: Optional[DomainInformationContainer]
RemoteDomainInfo: Optional[DomainInformationContainer]
ConnectionId: Optional[ConnectionId]
ConnectionAlias: Optional[ConnectionAlias]
ConnectionStatus: Optional[OutboundConnectionStatus]
ConnectionMode: Optional[ConnectionMode]
ConnectionProperties: Optional[ConnectionProperties]
class DeleteOutboundConnectionResponse(TypedDict, total=False):
Connection: Optional[OutboundConnection]
class DeletePackageRequest(ServiceRequest):
PackageID: PackageID
class DeletePackageResponse(TypedDict, total=False):
PackageDetails: Optional[PackageDetails]
class DeleteVpcEndpointRequest(ServiceRequest):
VpcEndpointId: VpcEndpointId
class VpcEndpointSummary(TypedDict, total=False):
VpcEndpointId: Optional[VpcEndpointId]
VpcEndpointOwner: Optional[String]
DomainArn: Optional[DomainArn]
Status: Optional[VpcEndpointStatus]
class DeleteVpcEndpointResponse(TypedDict, total=False):
VpcEndpointSummary: VpcEndpointSummary
class DescribeDomainAutoTunesRequest(ServiceRequest):
DomainName: DomainName
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class DescribeDomainAutoTunesResponse(TypedDict, total=False):
AutoTunes: Optional[AutoTuneList]
NextToken: Optional[NextToken]
class DescribeDomainChangeProgressRequest(ServiceRequest):
DomainName: DomainName
ChangeId: Optional[GUID]
class DescribeDomainChangeProgressResponse(TypedDict, total=False):
ChangeProgressStatus: Optional[ChangeProgressStatusDetails]
class DescribeDomainConfigRequest(ServiceRequest):
DomainName: DomainName
class SoftwareUpdateOptionsStatus(TypedDict, total=False):
Options: Optional[SoftwareUpdateOptions]
Status: Optional[OptionStatus]
class OffPeakWindowOptionsStatus(TypedDict, total=False):
Options: Optional[OffPeakWindowOptions]
Status: Optional[OptionStatus]
class DomainEndpointOptionsStatus(TypedDict, total=False):
Options: DomainEndpointOptions
Status: OptionStatus
class LogPublishingOptionsStatus(TypedDict, total=False):
Options: Optional[LogPublishingOptions]
Status: Optional[OptionStatus]
class NodeToNodeEncryptionOptionsStatus(TypedDict, total=False):
Options: NodeToNodeEncryptionOptions
Status: OptionStatus
class EncryptionAtRestOptionsStatus(TypedDict, total=False):
Options: EncryptionAtRestOptions
Status: OptionStatus
class VPCDerivedInfoStatus(TypedDict, total=False):
Options: VPCDerivedInfo
Status: OptionStatus
class SnapshotOptionsStatus(TypedDict, total=False):
Options: SnapshotOptions
Status: OptionStatus
class IPAddressTypeStatus(TypedDict, total=False):
Options: IPAddressType
Status: OptionStatus
class EBSOptionsStatus(TypedDict, total=False):
Options: EBSOptions
Status: OptionStatus
class VersionStatus(TypedDict, total=False):
Options: VersionString
Status: OptionStatus
class DomainConfig(TypedDict, total=False):
EngineVersion: Optional[VersionStatus]
ClusterConfig: Optional[ClusterConfigStatus]
EBSOptions: Optional[EBSOptionsStatus]
AccessPolicies: Optional[AccessPoliciesStatus]
IPAddressType: Optional[IPAddressTypeStatus]
SnapshotOptions: Optional[SnapshotOptionsStatus]
VPCOptions: Optional[VPCDerivedInfoStatus]
CognitoOptions: Optional[CognitoOptionsStatus]
EncryptionAtRestOptions: Optional[EncryptionAtRestOptionsStatus]
NodeToNodeEncryptionOptions: Optional[NodeToNodeEncryptionOptionsStatus]
AdvancedOptions: Optional[AdvancedOptionsStatus]
LogPublishingOptions: Optional[LogPublishingOptionsStatus]
DomainEndpointOptions: Optional[DomainEndpointOptionsStatus]
AdvancedSecurityOptions: Optional[AdvancedSecurityOptionsStatus]
AutoTuneOptions: Optional[AutoTuneOptionsStatus]
ChangeProgressDetails: Optional[ChangeProgressDetails]
OffPeakWindowOptions: Optional[OffPeakWindowOptionsStatus]
SoftwareUpdateOptions: Optional[SoftwareUpdateOptionsStatus]
ModifyingProperties: Optional[ModifyingPropertiesList]
class DescribeDomainConfigResponse(TypedDict, total=False):
DomainConfig: DomainConfig
class DescribeDomainHealthRequest(ServiceRequest):
DomainName: DomainName
class EnvironmentInfo(TypedDict, total=False):
AvailabilityZoneInformation: Optional[AvailabilityZoneInfoList]
EnvironmentInfoList = List[EnvironmentInfo]
class DescribeDomainHealthResponse(TypedDict, total=False):
DomainState: Optional[DomainState]
AvailabilityZoneCount: Optional[NumberOfAZs]
ActiveAvailabilityZoneCount: Optional[NumberOfAZs]
StandByAvailabilityZoneCount: Optional[NumberOfAZs]
DataNodeCount: Optional[NumberOfNodes]
DedicatedMaster: Optional[Boolean]
MasterEligibleNodeCount: Optional[NumberOfNodes]
WarmNodeCount: Optional[NumberOfNodes]
MasterNode: Optional[MasterNodeStatus]
ClusterHealth: Optional[DomainHealth]
TotalShards: Optional[NumberOfShards]
TotalUnAssignedShards: Optional[NumberOfShards]
EnvironmentInformation: Optional[EnvironmentInfoList]
class DescribeDomainNodesRequest(ServiceRequest):
DomainName: DomainName
class DomainNodesStatus(TypedDict, total=False):
NodeId: Optional[NodeId]
NodeType: Optional[NodeType]
AvailabilityZone: Optional[AvailabilityZone]
InstanceType: Optional[OpenSearchPartitionInstanceType]
NodeStatus: Optional[NodeStatus]
StorageType: Optional[StorageTypeName]
StorageVolumeType: Optional[VolumeType]
StorageSize: Optional[VolumeSize]
DomainNodesStatusList = List[DomainNodesStatus]
class DescribeDomainNodesResponse(TypedDict, total=False):
DomainNodesStatusList: Optional[DomainNodesStatusList]
class DescribeDomainRequest(ServiceRequest):
DomainName: DomainName
class DescribeDomainResponse(TypedDict, total=False):
DomainStatus: DomainStatus
DomainNameList = List[DomainName]
class DescribeDomainsRequest(ServiceRequest):
DomainNames: DomainNameList
DomainStatusList = List[DomainStatus]
class DescribeDomainsResponse(TypedDict, total=False):
DomainStatusList: DomainStatusList
class DescribeDryRunProgressRequest(ServiceRequest):
DomainName: DomainName
DryRunId: Optional[GUID]
LoadDryRunConfig: Optional[Boolean]
class DryRunResults(TypedDict, total=False):
DeploymentType: Optional[DeploymentType]
Message: Optional[Message]
class ValidationFailure(TypedDict, total=False):
Code: Optional[String]
Message: Optional[String]
ValidationFailures = List[ValidationFailure]
class DryRunProgressStatus(TypedDict, total=False):
DryRunId: GUID
DryRunStatus: String
CreationDate: String
UpdateDate: String
ValidationFailures: Optional[ValidationFailures]
class DescribeDryRunProgressResponse(TypedDict, total=False):
DryRunProgressStatus: Optional[DryRunProgressStatus]
DryRunConfig: Optional[DomainStatus]
DryRunResults: Optional[DryRunResults]
ValueStringList = List[NonEmptyString]
class Filter(TypedDict, total=False):
Name: Optional[NonEmptyString]
Values: Optional[ValueStringList]
FilterList = List[Filter]
class DescribeInboundConnectionsRequest(ServiceRequest):
Filters: Optional[FilterList]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
InboundConnections = List[InboundConnection]
class DescribeInboundConnectionsResponse(TypedDict, total=False):
Connections: Optional[InboundConnections]
NextToken: Optional[NextToken]
class DescribeInstanceTypeLimitsRequest(ServiceRequest):
DomainName: Optional[DomainName]
InstanceType: OpenSearchPartitionInstanceType
EngineVersion: VersionString
class InstanceCountLimits(TypedDict, total=False):
MinimumInstanceCount: Optional[MinimumInstanceCount]
MaximumInstanceCount: Optional[MaximumInstanceCount]
class InstanceLimits(TypedDict, total=False):
InstanceCountLimits: Optional[InstanceCountLimits]
class StorageTypeLimit(TypedDict, total=False):
LimitName: Optional[LimitName]
LimitValues: Optional[LimitValueList]
StorageTypeLimitList = List[StorageTypeLimit]
class StorageType(TypedDict, total=False):
StorageTypeName: Optional[StorageTypeName]
StorageSubTypeName: Optional[StorageSubTypeName]
StorageTypeLimits: Optional[StorageTypeLimitList]
StorageTypeList = List[StorageType]
class Limits(TypedDict, total=False):
StorageTypes: Optional[StorageTypeList]
InstanceLimits: Optional[InstanceLimits]
AdditionalLimits: Optional[AdditionalLimitList]
LimitsByRole = Dict[InstanceRole, Limits]
class DescribeInstanceTypeLimitsResponse(TypedDict, total=False):
LimitsByRole: Optional[LimitsByRole]
class DescribeOutboundConnectionsRequest(ServiceRequest):
Filters: Optional[FilterList]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
OutboundConnections = List[OutboundConnection]
class DescribeOutboundConnectionsResponse(TypedDict, total=False):
Connections: Optional[OutboundConnections]
NextToken: Optional[NextToken]
DescribePackagesFilterValues = List[DescribePackagesFilterValue]
class DescribePackagesFilter(TypedDict, total=False):
Name: Optional[DescribePackagesFilterName]
Value: Optional[DescribePackagesFilterValues]
DescribePackagesFilterList = List[DescribePackagesFilter]
class DescribePackagesRequest(ServiceRequest):
Filters: Optional[DescribePackagesFilterList]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
PackageDetailsList = List[PackageDetails]
class DescribePackagesResponse(TypedDict, total=False):
PackageDetailsList: Optional[PackageDetailsList]
NextToken: Optional[String]
class DescribeReservedInstanceOfferingsRequest(ServiceRequest):
ReservedInstanceOfferingId: Optional[GUID]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class RecurringCharge(TypedDict, total=False):
RecurringChargeAmount: Optional[Double]
RecurringChargeFrequency: Optional[String]
RecurringChargeList = List[RecurringCharge]
class ReservedInstanceOffering(TypedDict, total=False):
ReservedInstanceOfferingId: Optional[GUID]
InstanceType: Optional[OpenSearchPartitionInstanceType]
Duration: Optional[Integer]
FixedPrice: Optional[Double]
UsagePrice: Optional[Double]
CurrencyCode: Optional[String]
PaymentOption: Optional[ReservedInstancePaymentOption]
RecurringCharges: Optional[RecurringChargeList]
ReservedInstanceOfferingList = List[ReservedInstanceOffering]
class DescribeReservedInstanceOfferingsResponse(TypedDict, total=False):
NextToken: Optional[NextToken]
ReservedInstanceOfferings: Optional[ReservedInstanceOfferingList]
class DescribeReservedInstancesRequest(ServiceRequest):
ReservedInstanceId: Optional[GUID]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class ReservedInstance(TypedDict, total=False):
ReservationName: Optional[ReservationToken]
ReservedInstanceId: Optional[GUID]
BillingSubscriptionId: Optional[Long]
ReservedInstanceOfferingId: Optional[String]
InstanceType: Optional[OpenSearchPartitionInstanceType]
StartTime: Optional[UpdateTimestamp]
Duration: Optional[Integer]
FixedPrice: Optional[Double]
UsagePrice: Optional[Double]
CurrencyCode: Optional[String]
InstanceCount: Optional[Integer]
State: Optional[String]
PaymentOption: Optional[ReservedInstancePaymentOption]
RecurringCharges: Optional[RecurringChargeList]
ReservedInstanceList = List[ReservedInstance]
class DescribeReservedInstancesResponse(TypedDict, total=False):
NextToken: Optional[String]
ReservedInstances: Optional[ReservedInstanceList]
VpcEndpointIdList = List[VpcEndpointId]
class DescribeVpcEndpointsRequest(ServiceRequest):
VpcEndpointIds: VpcEndpointIdList
class VpcEndpointError(TypedDict, total=False):
VpcEndpointId: Optional[VpcEndpointId]
ErrorCode: Optional[VpcEndpointErrorCode]
ErrorMessage: Optional[String]
VpcEndpointErrorList = List[VpcEndpointError]
VpcEndpoints = List[VpcEndpoint]
class DescribeVpcEndpointsResponse(TypedDict, total=False):
VpcEndpoints: VpcEndpoints
VpcEndpointErrors: VpcEndpointErrorList
class DissociatePackageRequest(ServiceRequest):
PackageID: PackageID
DomainName: DomainName
class DissociatePackageResponse(TypedDict, total=False):
DomainPackageDetails: Optional[DomainPackageDetails]
class DomainInfo(TypedDict, total=False):
DomainName: Optional[DomainName]
EngineType: Optional[EngineType]
DomainInfoList = List[DomainInfo]
class DomainMaintenanceDetails(TypedDict, total=False):
MaintenanceId: Optional[RequestId]
DomainName: Optional[DomainName]
Action: Optional[MaintenanceType]
NodeId: Optional[NodeId]
Status: Optional[MaintenanceStatus]
StatusMessage: Optional[MaintenanceStatusMessage]
CreatedAt: Optional[UpdateTimestamp]
UpdatedAt: Optional[UpdateTimestamp]
DomainMaintenanceList = List[DomainMaintenanceDetails]
DomainPackageDetailsList = List[DomainPackageDetails]
class GetCompatibleVersionsRequest(ServiceRequest):
DomainName: Optional[DomainName]
class GetCompatibleVersionsResponse(TypedDict, total=False):
CompatibleVersions: Optional[CompatibleVersionsList]
class GetDataSourceRequest(ServiceRequest):
DomainName: DomainName
Name: DataSourceName
class GetDataSourceResponse(TypedDict, total=False):
DataSourceType: Optional[DataSourceType]
Name: Optional[DataSourceName]
Description: Optional[DataSourceDescription]
class GetDomainMaintenanceStatusRequest(ServiceRequest):
DomainName: DomainName
MaintenanceId: RequestId
class GetDomainMaintenanceStatusResponse(TypedDict, total=False):
Status: Optional[MaintenanceStatus]
StatusMessage: Optional[MaintenanceStatusMessage]
NodeId: Optional[NodeId]
Action: Optional[MaintenanceType]
CreatedAt: Optional[UpdateTimestamp]
UpdatedAt: Optional[UpdateTimestamp]
class GetPackageVersionHistoryRequest(ServiceRequest):
PackageID: PackageID
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class PackageVersionHistory(TypedDict, total=False):
PackageVersion: Optional[PackageVersion]
CommitMessage: Optional[CommitMessage]
CreatedAt: Optional[CreatedAt]
PluginProperties: Optional[PluginProperties]
PackageVersionHistoryList = List[PackageVersionHistory]
class GetPackageVersionHistoryResponse(TypedDict, total=False):
PackageID: Optional[PackageID]
PackageVersionHistoryList: Optional[PackageVersionHistoryList]
NextToken: Optional[String]
class GetUpgradeHistoryRequest(ServiceRequest):
DomainName: DomainName
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
Issues = List[Issue]
class UpgradeStepItem(TypedDict, total=False):
UpgradeStep: Optional[UpgradeStep]
UpgradeStepStatus: Optional[UpgradeStatus]
Issues: Optional[Issues]
ProgressPercent: Optional[Double]
UpgradeStepsList = List[UpgradeStepItem]
StartTimestamp = datetime
class UpgradeHistory(TypedDict, total=False):
UpgradeName: Optional[UpgradeName]
StartTimestamp: Optional[StartTimestamp]
UpgradeStatus: Optional[UpgradeStatus]
StepsList: Optional[UpgradeStepsList]
UpgradeHistoryList = List[UpgradeHistory]
class GetUpgradeHistoryResponse(TypedDict, total=False):
UpgradeHistories: Optional[UpgradeHistoryList]
NextToken: Optional[String]
class GetUpgradeStatusRequest(ServiceRequest):
DomainName: DomainName
class GetUpgradeStatusResponse(TypedDict, total=False):
UpgradeStep: Optional[UpgradeStep]
StepStatus: Optional[UpgradeStatus]
UpgradeName: Optional[UpgradeName]
InstanceRoleList = List[InstanceRole]
class InstanceTypeDetails(TypedDict, total=False):
InstanceType: Optional[OpenSearchPartitionInstanceType]
EncryptionEnabled: Optional[Boolean]
CognitoEnabled: Optional[Boolean]
AppLogsEnabled: Optional[Boolean]
AdvancedSecurityEnabled: Optional[Boolean]
WarmEnabled: Optional[Boolean]
InstanceRole: Optional[InstanceRoleList]
AvailabilityZones: Optional[AvailabilityZoneList]
InstanceTypeDetailsList = List[InstanceTypeDetails]
class ListDataSourcesRequest(ServiceRequest):
DomainName: DomainName
class ListDataSourcesResponse(TypedDict, total=False):
DataSources: Optional[DataSourceList]
class ListDomainMaintenancesRequest(ServiceRequest):
DomainName: DomainName
Action: Optional[MaintenanceType]
Status: Optional[MaintenanceStatus]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class ListDomainMaintenancesResponse(TypedDict, total=False):
DomainMaintenances: Optional[DomainMaintenanceList]
NextToken: Optional[NextToken]
class ListDomainNamesRequest(ServiceRequest):
EngineType: Optional[EngineType]
class ListDomainNamesResponse(TypedDict, total=False):
DomainNames: Optional[DomainInfoList]
class ListDomainsForPackageRequest(ServiceRequest):
PackageID: PackageID
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class ListDomainsForPackageResponse(TypedDict, total=False):
DomainPackageDetailsList: Optional[DomainPackageDetailsList]
NextToken: Optional[String]
class ListInstanceTypeDetailsRequest(ServiceRequest):
EngineVersion: VersionString
DomainName: Optional[DomainName]
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
RetrieveAZs: Optional[Boolean]
InstanceType: Optional[InstanceTypeString]
class ListInstanceTypeDetailsResponse(TypedDict, total=False):
InstanceTypeDetails: Optional[InstanceTypeDetailsList]
NextToken: Optional[NextToken]
class ListPackagesForDomainRequest(ServiceRequest):
DomainName: DomainName
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class ListPackagesForDomainResponse(TypedDict, total=False):
DomainPackageDetailsList: Optional[DomainPackageDetailsList]
NextToken: Optional[String]
class ListScheduledActionsRequest(ServiceRequest):
DomainName: DomainName
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class ScheduledAction(TypedDict, total=False):
Id: String
Type: ActionType
Severity: ActionSeverity
ScheduledTime: Long
Description: Optional[String]
ScheduledBy: Optional[ScheduledBy]
Status: Optional[ActionStatus]
Mandatory: Optional[Boolean]
Cancellable: Optional[Boolean]
ScheduledActionsList = List[ScheduledAction]
class ListScheduledActionsResponse(TypedDict, total=False):
ScheduledActions: Optional[ScheduledActionsList]
NextToken: Optional[NextToken]
class ListTagsRequest(ServiceRequest):
ARN: ARN
class ListTagsResponse(TypedDict, total=False):
TagList: Optional[TagList]
class ListVersionsRequest(ServiceRequest):
MaxResults: Optional[MaxResults]
NextToken: Optional[NextToken]
class ListVersionsResponse(TypedDict, total=False):
Versions: Optional[VersionList]
NextToken: Optional[NextToken]
class ListVpcEndpointAccessRequest(ServiceRequest):
DomainName: DomainName
NextToken: Optional[NextToken]
class ListVpcEndpointAccessResponse(TypedDict, total=False):
AuthorizedPrincipalList: AuthorizedPrincipalList
NextToken: NextToken
class ListVpcEndpointsForDomainRequest(ServiceRequest):
DomainName: DomainName
NextToken: Optional[NextToken]
VpcEndpointSummaryList = List[VpcEndpointSummary]
class ListVpcEndpointsForDomainResponse(TypedDict, total=False):
VpcEndpointSummaryList: VpcEndpointSummaryList
NextToken: NextToken
class ListVpcEndpointsRequest(ServiceRequest):
NextToken: Optional[NextToken]
class ListVpcEndpointsResponse(TypedDict, total=False):
VpcEndpointSummaryList: VpcEndpointSummaryList
NextToken: NextToken
class PurchaseReservedInstanceOfferingRequest(ServiceRequest):
ReservedInstanceOfferingId: GUID
ReservationName: ReservationToken
InstanceCount: Optional[InstanceCount]
class PurchaseReservedInstanceOfferingResponse(TypedDict, total=False):
ReservedInstanceId: Optional[GUID]
ReservationName: Optional[ReservationToken]
class RejectInboundConnectionRequest(ServiceRequest):
ConnectionId: ConnectionId
class RejectInboundConnectionResponse(TypedDict, total=False):
Connection: Optional[InboundConnection]
class RemoveTagsRequest(ServiceRequest):
ARN: ARN
TagKeys: StringList
class RevokeVpcEndpointAccessRequest(ServiceRequest):
DomainName: DomainName
Account: AWSAccount
class RevokeVpcEndpointAccessResponse(TypedDict, total=False):
pass
class StartDomainMaintenanceRequest(ServiceRequest):
DomainName: DomainName
Action: MaintenanceType
NodeId: Optional[NodeId]
class StartDomainMaintenanceResponse(TypedDict, total=False):
MaintenanceId: Optional[RequestId]
class StartServiceSoftwareUpdateRequest(ServiceRequest):
DomainName: DomainName
ScheduleAt: Optional[ScheduleAt]
DesiredStartTime: Optional[Long]
class StartServiceSoftwareUpdateResponse(TypedDict, total=False):
ServiceSoftwareOptions: Optional[ServiceSoftwareOptions]
class UpdateDataSourceRequest(ServiceRequest):
DomainName: DomainName
Name: DataSourceName
DataSourceType: DataSourceType
Description: Optional[DataSourceDescription]
class UpdateDataSourceResponse(TypedDict, total=False):
Message: Optional[String]
class UpdateDomainConfigRequest(ServiceRequest):
DomainName: DomainName
ClusterConfig: Optional[ClusterConfig]
EBSOptions: Optional[EBSOptions]
SnapshotOptions: Optional[SnapshotOptions]
VPCOptions: Optional[VPCOptions]
CognitoOptions: Optional[CognitoOptions]
AdvancedOptions: Optional[AdvancedOptions]
AccessPolicies: Optional[PolicyDocument]
IPAddressType: Optional[IPAddressType]
LogPublishingOptions: Optional[LogPublishingOptions]
EncryptionAtRestOptions: Optional[EncryptionAtRestOptions]
DomainEndpointOptions: Optional[DomainEndpointOptions]
NodeToNodeEncryptionOptions: Optional[NodeToNodeEncryptionOptions]
AdvancedSecurityOptions: Optional[AdvancedSecurityOptionsInput]
AutoTuneOptions: Optional[AutoTuneOptions]
DryRun: Optional[DryRun]
DryRunMode: Optional[DryRunMode]
OffPeakWindowOptions: Optional[OffPeakWindowOptions]
SoftwareUpdateOptions: Optional[SoftwareUpdateOptions]
class UpdateDomainConfigResponse(TypedDict, total=False):
DomainConfig: DomainConfig
DryRunResults: Optional[DryRunResults]
DryRunProgressStatus: Optional[DryRunProgressStatus]
class UpdatePackageRequest(ServiceRequest):
PackageID: PackageID
PackageSource: PackageSource
PackageDescription: Optional[PackageDescription]
CommitMessage: Optional[CommitMessage]
class UpdatePackageResponse(TypedDict, total=False):
PackageDetails: Optional[PackageDetails]
class UpdateScheduledActionRequest(ServiceRequest):
DomainName: DomainName
ActionID: String
ActionType: ActionType
ScheduleAt: ScheduleAt
DesiredStartTime: Optional[Long]
class UpdateScheduledActionResponse(TypedDict, total=False):
ScheduledAction: Optional[ScheduledAction]
class UpdateVpcEndpointRequest(ServiceRequest):
VpcEndpointId: VpcEndpointId
VpcOptions: VPCOptions
class UpdateVpcEndpointResponse(TypedDict, total=False):
VpcEndpoint: VpcEndpoint
class UpgradeDomainRequest(ServiceRequest):
DomainName: DomainName
TargetVersion: VersionString
PerformCheckOnly: Optional[Boolean]
AdvancedOptions: Optional[AdvancedOptions]
class UpgradeDomainResponse(TypedDict, total=False):
UpgradeId: Optional[String]
DomainName: Optional[DomainName]
TargetVersion: Optional[VersionString]
PerformCheckOnly: Optional[Boolean]
AdvancedOptions: Optional[AdvancedOptions]
ChangeProgressDetails: Optional[ChangeProgressDetails]
class OpensearchApi:
service = "opensearch"
version = "2021-01-01"
@handler("AcceptInboundConnection")
def accept_inbound_connection(
self, context: RequestContext, connection_id: ConnectionId, **kwargs
) -> AcceptInboundConnectionResponse:
raise NotImplementedError
@handler("AddDataSource")
def add_data_source(
self,
context: RequestContext,
domain_name: DomainName,
name: DataSourceName,
data_source_type: DataSourceType,
description: DataSourceDescription = None,
**kwargs,
) -> AddDataSourceResponse:
raise NotImplementedError
@handler("AddTags")
def add_tags(self, context: RequestContext, arn: ARN, tag_list: TagList, **kwargs) -> None:
raise NotImplementedError
@handler("AssociatePackage")
def associate_package(
self, context: RequestContext, package_id: PackageID, domain_name: DomainName, **kwargs
) -> AssociatePackageResponse:
raise NotImplementedError
@handler("AuthorizeVpcEndpointAccess")
def authorize_vpc_endpoint_access(
self, context: RequestContext, domain_name: DomainName, account: AWSAccount, **kwargs
) -> AuthorizeVpcEndpointAccessResponse:
raise NotImplementedError
@handler("CancelDomainConfigChange")
def cancel_domain_config_change(
self, context: RequestContext, domain_name: DomainName, dry_run: DryRun = None, **kwargs
) -> CancelDomainConfigChangeResponse:
raise NotImplementedError
@handler("CancelServiceSoftwareUpdate")
def cancel_service_software_update(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> CancelServiceSoftwareUpdateResponse:
raise NotImplementedError
@handler("CreateDomain")
def create_domain(
self,
context: RequestContext,
domain_name: DomainName,
engine_version: VersionString = None,
cluster_config: ClusterConfig = None,
ebs_options: EBSOptions = None,
access_policies: PolicyDocument = None,
ip_address_type: IPAddressType = None,
snapshot_options: SnapshotOptions = None,
vpc_options: VPCOptions = None,
cognito_options: CognitoOptions = None,
encryption_at_rest_options: EncryptionAtRestOptions = None,
node_to_node_encryption_options: NodeToNodeEncryptionOptions = None,
advanced_options: AdvancedOptions = None,
log_publishing_options: LogPublishingOptions = None,
domain_endpoint_options: DomainEndpointOptions = None,
advanced_security_options: AdvancedSecurityOptionsInput = None,
tag_list: TagList = None,
auto_tune_options: AutoTuneOptionsInput = None,
off_peak_window_options: OffPeakWindowOptions = None,
software_update_options: SoftwareUpdateOptions = None,
**kwargs,
) -> CreateDomainResponse:
raise NotImplementedError
@handler("CreateOutboundConnection")
def create_outbound_connection(
self,
context: RequestContext,
local_domain_info: DomainInformationContainer,
remote_domain_info: DomainInformationContainer,
connection_alias: ConnectionAlias,
connection_mode: ConnectionMode = None,
connection_properties: ConnectionProperties = None,
**kwargs,
) -> CreateOutboundConnectionResponse:
raise NotImplementedError
@handler("CreatePackage")
def create_package(
self,
context: RequestContext,
package_name: PackageName,
package_type: PackageType,
package_source: PackageSource,
package_description: PackageDescription = None,
**kwargs,
) -> CreatePackageResponse:
raise NotImplementedError
@handler("CreateVpcEndpoint")
def create_vpc_endpoint(
self,
context: RequestContext,
domain_arn: DomainArn,
vpc_options: VPCOptions,
client_token: ClientToken = None,
**kwargs,
) -> CreateVpcEndpointResponse:
raise NotImplementedError
@handler("DeleteDataSource")
def delete_data_source(
self, context: RequestContext, domain_name: DomainName, name: DataSourceName, **kwargs
) -> DeleteDataSourceResponse:
raise NotImplementedError
@handler("DeleteDomain")
def delete_domain(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> DeleteDomainResponse:
raise NotImplementedError
@handler("DeleteInboundConnection")
def delete_inbound_connection(
self, context: RequestContext, connection_id: ConnectionId, **kwargs
) -> DeleteInboundConnectionResponse:
raise NotImplementedError
@handler("DeleteOutboundConnection")
def delete_outbound_connection(
self, context: RequestContext, connection_id: ConnectionId, **kwargs
) -> DeleteOutboundConnectionResponse:
raise NotImplementedError
@handler("DeletePackage")
def delete_package(
self, context: RequestContext, package_id: PackageID, **kwargs
) -> DeletePackageResponse:
raise NotImplementedError
@handler("DeleteVpcEndpoint")
def delete_vpc_endpoint(
self, context: RequestContext, vpc_endpoint_id: VpcEndpointId, **kwargs
) -> DeleteVpcEndpointResponse:
raise NotImplementedError
@handler("DescribeDomain")
def describe_domain(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> DescribeDomainResponse:
raise NotImplementedError
@handler("DescribeDomainAutoTunes")
def describe_domain_auto_tunes(
self,
context: RequestContext,
domain_name: DomainName,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> DescribeDomainAutoTunesResponse:
raise NotImplementedError
@handler("DescribeDomainChangeProgress")
def describe_domain_change_progress(
self, context: RequestContext, domain_name: DomainName, change_id: GUID = None, **kwargs
) -> DescribeDomainChangeProgressResponse:
raise NotImplementedError
@handler("DescribeDomainConfig")
def describe_domain_config(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> DescribeDomainConfigResponse:
raise NotImplementedError
@handler("DescribeDomainHealth")
def describe_domain_health(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> DescribeDomainHealthResponse:
raise NotImplementedError
@handler("DescribeDomainNodes")
def describe_domain_nodes(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> DescribeDomainNodesResponse:
raise NotImplementedError
@handler("DescribeDomains")
def describe_domains(
self, context: RequestContext, domain_names: DomainNameList, **kwargs
) -> DescribeDomainsResponse:
raise NotImplementedError
@handler("DescribeDryRunProgress")
def describe_dry_run_progress(
self,
context: RequestContext,
domain_name: DomainName,
dry_run_id: GUID = None,
load_dry_run_config: Boolean = None,
**kwargs,
) -> DescribeDryRunProgressResponse:
raise NotImplementedError
@handler("DescribeInboundConnections")
def describe_inbound_connections(
self,
context: RequestContext,
filters: FilterList = None,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> DescribeInboundConnectionsResponse:
raise NotImplementedError
@handler("DescribeInstanceTypeLimits")
def describe_instance_type_limits(
self,
context: RequestContext,
instance_type: OpenSearchPartitionInstanceType,
engine_version: VersionString,
domain_name: DomainName = None,
**kwargs,
) -> DescribeInstanceTypeLimitsResponse:
raise NotImplementedError
@handler("DescribeOutboundConnections")
def describe_outbound_connections(
self,
context: RequestContext,
filters: FilterList = None,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> DescribeOutboundConnectionsResponse:
raise NotImplementedError
@handler("DescribePackages")
def describe_packages(
self,
context: RequestContext,
filters: DescribePackagesFilterList = None,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> DescribePackagesResponse:
raise NotImplementedError
@handler("DescribeReservedInstanceOfferings")
def describe_reserved_instance_offerings(
self,
context: RequestContext,
reserved_instance_offering_id: GUID = None,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> DescribeReservedInstanceOfferingsResponse:
raise NotImplementedError
@handler("DescribeReservedInstances")
def describe_reserved_instances(
self,
context: RequestContext,
reserved_instance_id: GUID = None,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> DescribeReservedInstancesResponse:
raise NotImplementedError
@handler("DescribeVpcEndpoints")
def describe_vpc_endpoints(
self, context: RequestContext, vpc_endpoint_ids: VpcEndpointIdList, **kwargs
) -> DescribeVpcEndpointsResponse:
raise NotImplementedError
@handler("DissociatePackage")
def dissociate_package(
self, context: RequestContext, package_id: PackageID, domain_name: DomainName, **kwargs
) -> DissociatePackageResponse:
raise NotImplementedError
@handler("GetCompatibleVersions")
def get_compatible_versions(
self, context: RequestContext, domain_name: DomainName = None, **kwargs
) -> GetCompatibleVersionsResponse:
raise NotImplementedError
@handler("GetDataSource")
def get_data_source(
self, context: RequestContext, domain_name: DomainName, name: DataSourceName, **kwargs
) -> GetDataSourceResponse:
raise NotImplementedError
@handler("GetDomainMaintenanceStatus")
def get_domain_maintenance_status(
self, context: RequestContext, domain_name: DomainName, maintenance_id: RequestId, **kwargs
) -> GetDomainMaintenanceStatusResponse:
raise NotImplementedError
@handler("GetPackageVersionHistory")
def get_package_version_history(
self,
context: RequestContext,
package_id: PackageID,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> GetPackageVersionHistoryResponse:
raise NotImplementedError
@handler("GetUpgradeHistory")
def get_upgrade_history(
self,
context: RequestContext,
domain_name: DomainName,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> GetUpgradeHistoryResponse:
raise NotImplementedError
@handler("GetUpgradeStatus")
def get_upgrade_status(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> GetUpgradeStatusResponse:
raise NotImplementedError
@handler("ListDataSources")
def list_data_sources(
self, context: RequestContext, domain_name: DomainName, **kwargs
) -> ListDataSourcesResponse:
raise NotImplementedError
@handler("ListDomainMaintenances")
def list_domain_maintenances(
self,
context: RequestContext,
domain_name: DomainName,
action: MaintenanceType = None,
status: MaintenanceStatus = None,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> ListDomainMaintenancesResponse:
raise NotImplementedError
@handler("ListDomainNames")
def list_domain_names(
self, context: RequestContext, engine_type: EngineType = None, **kwargs
) -> ListDomainNamesResponse:
raise NotImplementedError
@handler("ListDomainsForPackage")
def list_domains_for_package(
self,
context: RequestContext,
package_id: PackageID,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> ListDomainsForPackageResponse:
raise NotImplementedError
@handler("ListInstanceTypeDetails")
def list_instance_type_details(
self,
context: RequestContext,
engine_version: VersionString,
domain_name: DomainName = None,
max_results: MaxResults = None,
next_token: NextToken = None,
retrieve_azs: Boolean = None,
instance_type: InstanceTypeString = None,
**kwargs,
) -> ListInstanceTypeDetailsResponse:
raise NotImplementedError
@handler("ListPackagesForDomain")
def list_packages_for_domain(
self,
context: RequestContext,
domain_name: DomainName,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> ListPackagesForDomainResponse:
raise NotImplementedError
@handler("ListScheduledActions")
def list_scheduled_actions(
self,
context: RequestContext,
domain_name: DomainName,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> ListScheduledActionsResponse:
raise NotImplementedError
@handler("ListTags")
def list_tags(self, context: RequestContext, arn: ARN, **kwargs) -> ListTagsResponse:
raise NotImplementedError
@handler("ListVersions")
def list_versions(
self,
context: RequestContext,
max_results: MaxResults = None,
next_token: NextToken = None,
**kwargs,
) -> ListVersionsResponse:
raise NotImplementedError
@handler("ListVpcEndpointAccess")
def list_vpc_endpoint_access(
self,
context: RequestContext,
domain_name: DomainName,
next_token: NextToken = None,
**kwargs,
) -> ListVpcEndpointAccessResponse:
raise NotImplementedError
@handler("ListVpcEndpoints")
def list_vpc_endpoints(
self, context: RequestContext, next_token: NextToken = None, **kwargs
) -> ListVpcEndpointsResponse:
raise NotImplementedError
@handler("ListVpcEndpointsForDomain")
def list_vpc_endpoints_for_domain(
self,
context: RequestContext,
domain_name: DomainName,
next_token: NextToken = None,
**kwargs,
) -> ListVpcEndpointsForDomainResponse:
raise NotImplementedError
@handler("PurchaseReservedInstanceOffering")
def purchase_reserved_instance_offering(
self,
context: RequestContext,
reserved_instance_offering_id: GUID,
reservation_name: ReservationToken,
instance_count: InstanceCount = None,
**kwargs,
) -> PurchaseReservedInstanceOfferingResponse:
raise NotImplementedError
@handler("RejectInboundConnection")
def reject_inbound_connection(
self, context: RequestContext, connection_id: ConnectionId, **kwargs
) -> RejectInboundConnectionResponse:
raise NotImplementedError
@handler("RemoveTags")
def remove_tags(
self, context: RequestContext, arn: ARN, tag_keys: StringList, **kwargs
) -> None:
raise NotImplementedError
@handler("RevokeVpcEndpointAccess")
def revoke_vpc_endpoint_access(
self, context: RequestContext, domain_name: DomainName, account: AWSAccount, **kwargs
) -> RevokeVpcEndpointAccessResponse:
raise NotImplementedError
@handler("StartDomainMaintenance")
def start_domain_maintenance(
self,
context: RequestContext,
domain_name: DomainName,
action: MaintenanceType,
node_id: NodeId = None,
**kwargs,
) -> StartDomainMaintenanceResponse:
raise NotImplementedError
@handler("StartServiceSoftwareUpdate")
def start_service_software_update(
self,
context: RequestContext,
domain_name: DomainName,
schedule_at: ScheduleAt = None,
desired_start_time: Long = None,
**kwargs,
) -> StartServiceSoftwareUpdateResponse:
raise NotImplementedError
@handler("UpdateDataSource")
def update_data_source(
self,
context: RequestContext,
domain_name: DomainName,
name: DataSourceName,
data_source_type: DataSourceType,
description: DataSourceDescription = None,
**kwargs,
) -> UpdateDataSourceResponse:
raise NotImplementedError
@handler("UpdateDomainConfig")
def update_domain_config(
self,
context: RequestContext,
domain_name: DomainName,
cluster_config: ClusterConfig = None,
ebs_options: EBSOptions = None,
snapshot_options: SnapshotOptions = None,
vpc_options: VPCOptions = None,
cognito_options: CognitoOptions = None,
advanced_options: AdvancedOptions = None,
access_policies: PolicyDocument = None,
ip_address_type: IPAddressType = None,
log_publishing_options: LogPublishingOptions = None,
encryption_at_rest_options: EncryptionAtRestOptions = None,
domain_endpoint_options: DomainEndpointOptions = None,
node_to_node_encryption_options: NodeToNodeEncryptionOptions = None,
advanced_security_options: AdvancedSecurityOptionsInput = None,
auto_tune_options: AutoTuneOptions = None,
dry_run: DryRun = None,
dry_run_mode: DryRunMode = None,
off_peak_window_options: OffPeakWindowOptions = None,
software_update_options: SoftwareUpdateOptions = None,
**kwargs,
) -> UpdateDomainConfigResponse:
raise NotImplementedError
@handler("UpdatePackage")
def update_package(
self,
context: RequestContext,
package_id: PackageID,
package_source: PackageSource,
package_description: PackageDescription = None,
commit_message: CommitMessage = None,
**kwargs,
) -> UpdatePackageResponse:
raise NotImplementedError
@handler("UpdateScheduledAction")
def update_scheduled_action(
self,
context: RequestContext,
domain_name: DomainName,
action_id: String,
action_type: ActionType,
schedule_at: ScheduleAt,
desired_start_time: Long = None,
**kwargs,
) -> UpdateScheduledActionResponse:
raise NotImplementedError
@handler("UpdateVpcEndpoint")
def update_vpc_endpoint(
self,
context: RequestContext,
vpc_endpoint_id: VpcEndpointId,
vpc_options: VPCOptions,
**kwargs,
) -> UpdateVpcEndpointResponse:
raise NotImplementedError
@handler("UpgradeDomain")
def upgrade_domain(
self,
context: RequestContext,
domain_name: DomainName,
target_version: VersionString,
perform_check_only: Boolean = None,
advanced_options: AdvancedOptions = None,
**kwargs,
) -> UpgradeDomainResponse:
raise NotImplementedError