Type definitions#
Index > OpenSearchService > Type definitions
Auto-generated documentation for OpenSearchService type annotations stubs module types-boto3-opensearch.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_opensearch.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]AutoTuneMaintenanceScheduleUnionTypeDef#
# AutoTuneMaintenanceScheduleUnionTypeDef Union usage example
from types_boto3_opensearch.type_defs import AutoTuneMaintenanceScheduleUnionTypeDef
def get_value() -> AutoTuneMaintenanceScheduleUnionTypeDef:
return ...
# AutoTuneMaintenanceScheduleUnionTypeDef definition
AutoTuneMaintenanceScheduleUnionTypeDef = Union[
AutoTuneMaintenanceScheduleTypeDef, # (1)
AutoTuneMaintenanceScheduleOutputTypeDef, # (2)
]AutoTuneOptionsUnionTypeDef#
# AutoTuneOptionsUnionTypeDef Union usage example
from types_boto3_opensearch.type_defs import AutoTuneOptionsUnionTypeDef
def get_value() -> AutoTuneOptionsUnionTypeDef:
return ...
# AutoTuneOptionsUnionTypeDef definition
AutoTuneOptionsUnionTypeDef = Union[
AutoTuneOptionsTypeDef, # (1)
AutoTuneOptionsExtraTypeDef, # (2)
]ClusterConfigUnionTypeDef#
# ClusterConfigUnionTypeDef Union usage example
from types_boto3_opensearch.type_defs import ClusterConfigUnionTypeDef
def get_value() -> ClusterConfigUnionTypeDef:
return ...
# ClusterConfigUnionTypeDef definition
ClusterConfigUnionTypeDef = Union[
ClusterConfigTypeDef, # (1)
ClusterConfigOutputTypeDef, # (2)
]NaturalLanguageQueryGenerationOptionsInputTypeDef#
# NaturalLanguageQueryGenerationOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import NaturalLanguageQueryGenerationOptionsInputTypeDef
def get_value() -> NaturalLanguageQueryGenerationOptionsInputTypeDef:
return {
"DesiredState": ...,
}
# NaturalLanguageQueryGenerationOptionsInputTypeDef definition
class NaturalLanguageQueryGenerationOptionsInputTypeDef(TypedDict):
DesiredState: NotRequired[NaturalLanguageQueryGenerationDesiredStateType], # (1)NaturalLanguageQueryGenerationOptionsOutputTypeDef#
# NaturalLanguageQueryGenerationOptionsOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import NaturalLanguageQueryGenerationOptionsOutputTypeDef
def get_value() -> NaturalLanguageQueryGenerationOptionsOutputTypeDef:
return {
"DesiredState": ...,
}
# NaturalLanguageQueryGenerationOptionsOutputTypeDef definition
class NaturalLanguageQueryGenerationOptionsOutputTypeDef(TypedDict):
DesiredState: NotRequired[NaturalLanguageQueryGenerationDesiredStateType], # (1)
CurrentState: NotRequired[NaturalLanguageQueryGenerationCurrentStateType], # (2)- See NaturalLanguageQueryGenerationDesiredStateType
- See NaturalLanguageQueryGenerationCurrentStateType
OptionStatusTypeDef#
# OptionStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import OptionStatusTypeDef
def get_value() -> OptionStatusTypeDef:
return {
"CreationDate": ...,
}
# OptionStatusTypeDef definition
class OptionStatusTypeDef(TypedDict):
CreationDate: datetime,
UpdateDate: datetime,
State: OptionStateType, # (1)
UpdateVersion: NotRequired[int],
PendingDeletion: NotRequired[bool],- See OptionStateType
AWSDomainInformationTypeDef#
# AWSDomainInformationTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AWSDomainInformationTypeDef
def get_value() -> AWSDomainInformationTypeDef:
return {
"OwnerId": ...,
}
# AWSDomainInformationTypeDef definition
class AWSDomainInformationTypeDef(TypedDict):
DomainName: str,
OwnerId: NotRequired[str],
Region: NotRequired[str],AcceptInboundConnectionRequestTypeDef#
# AcceptInboundConnectionRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AcceptInboundConnectionRequestTypeDef
def get_value() -> AcceptInboundConnectionRequestTypeDef:
return {
"ConnectionId": ...,
}
# AcceptInboundConnectionRequestTypeDef definition
class AcceptInboundConnectionRequestTypeDef(TypedDict):
ConnectionId: str,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,AdditionalLimitTypeDef#
# AdditionalLimitTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AdditionalLimitTypeDef
def get_value() -> AdditionalLimitTypeDef:
return {
"LimitName": ...,
}
# AdditionalLimitTypeDef definition
class AdditionalLimitTypeDef(TypedDict):
LimitName: NotRequired[str],
LimitValues: NotRequired[List[str]],JWTOptionsInputTypeDef#
# JWTOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import JWTOptionsInputTypeDef
def get_value() -> JWTOptionsInputTypeDef:
return {
"Enabled": ...,
}
# JWTOptionsInputTypeDef definition
class JWTOptionsInputTypeDef(TypedDict):
Enabled: NotRequired[bool],
SubjectKey: NotRequired[str],
RolesKey: NotRequired[str],
PublicKey: NotRequired[str],MasterUserOptionsTypeDef#
# MasterUserOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import MasterUserOptionsTypeDef
def get_value() -> MasterUserOptionsTypeDef:
return {
"MasterUserARN": ...,
}
# MasterUserOptionsTypeDef definition
class MasterUserOptionsTypeDef(TypedDict):
MasterUserARN: NotRequired[str],
MasterUserName: NotRequired[str],
MasterUserPassword: NotRequired[str],JWTOptionsOutputTypeDef#
# JWTOptionsOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import JWTOptionsOutputTypeDef
def get_value() -> JWTOptionsOutputTypeDef:
return {
"Enabled": ...,
}
# JWTOptionsOutputTypeDef definition
class JWTOptionsOutputTypeDef(TypedDict):
Enabled: NotRequired[bool],
SubjectKey: NotRequired[str],
RolesKey: NotRequired[str],
PublicKey: NotRequired[str],AppConfigTypeDef#
# AppConfigTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AppConfigTypeDef
def get_value() -> AppConfigTypeDef:
return {
"key": ...,
}
# AppConfigTypeDef definition
class AppConfigTypeDef(TypedDict):
key: NotRequired[AppConfigTypeType], # (1)
value: NotRequired[str],ApplicationSummaryTypeDef#
# ApplicationSummaryTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ApplicationSummaryTypeDef
def get_value() -> ApplicationSummaryTypeDef:
return {
"id": ...,
}
# ApplicationSummaryTypeDef definition
class ApplicationSummaryTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
name: NotRequired[str],
endpoint: NotRequired[str],
status: NotRequired[ApplicationStatusType], # (1)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],AuthorizeVpcEndpointAccessRequestTypeDef#
# AuthorizeVpcEndpointAccessRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AuthorizeVpcEndpointAccessRequestTypeDef
def get_value() -> AuthorizeVpcEndpointAccessRequestTypeDef:
return {
"DomainName": ...,
}
# AuthorizeVpcEndpointAccessRequestTypeDef definition
class AuthorizeVpcEndpointAccessRequestTypeDef(TypedDict):
DomainName: str,
Account: NotRequired[str],
Service: NotRequired[AWSServicePrincipalType], # (1)AuthorizedPrincipalTypeDef#
# AuthorizedPrincipalTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AuthorizedPrincipalTypeDef
def get_value() -> AuthorizedPrincipalTypeDef:
return {
"PrincipalType": ...,
}
# AuthorizedPrincipalTypeDef definition
class AuthorizedPrincipalTypeDef(TypedDict):
PrincipalType: NotRequired[PrincipalTypeType], # (1)
Principal: NotRequired[str],ScheduledAutoTuneDetailsTypeDef#
# ScheduledAutoTuneDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ScheduledAutoTuneDetailsTypeDef
def get_value() -> ScheduledAutoTuneDetailsTypeDef:
return {
"Date": ...,
}
# ScheduledAutoTuneDetailsTypeDef definition
class ScheduledAutoTuneDetailsTypeDef(TypedDict):
Date: NotRequired[datetime],
ActionType: NotRequired[ScheduledAutoTuneActionTypeType], # (1)
Action: NotRequired[str],
Severity: NotRequired[ScheduledAutoTuneSeverityTypeType], # (2)DurationTypeDef#
# DurationTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DurationTypeDef
def get_value() -> DurationTypeDef:
return {
"Value": ...,
}
# DurationTypeDef definition
class DurationTypeDef(TypedDict):
Value: NotRequired[int],
Unit: NotRequired[TimeUnitType], # (1)- See TimeUnitType
AutoTuneOptionsOutputTypeDef#
# AutoTuneOptionsOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneOptionsOutputTypeDef
def get_value() -> AutoTuneOptionsOutputTypeDef:
return {
"State": ...,
}
# AutoTuneOptionsOutputTypeDef definition
class AutoTuneOptionsOutputTypeDef(TypedDict):
State: NotRequired[AutoTuneStateType], # (1)
ErrorMessage: NotRequired[str],
UseOffPeakWindow: NotRequired[bool],AutoTuneStatusTypeDef#
# AutoTuneStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneStatusTypeDef
def get_value() -> AutoTuneStatusTypeDef:
return {
"CreationDate": ...,
}
# AutoTuneStatusTypeDef definition
class AutoTuneStatusTypeDef(TypedDict):
CreationDate: datetime,
UpdateDate: datetime,
State: AutoTuneStateType, # (1)
UpdateVersion: NotRequired[int],
ErrorMessage: NotRequired[str],
PendingDeletion: NotRequired[bool],AvailabilityZoneInfoTypeDef#
# AvailabilityZoneInfoTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AvailabilityZoneInfoTypeDef
def get_value() -> AvailabilityZoneInfoTypeDef:
return {
"AvailabilityZoneName": ...,
}
# AvailabilityZoneInfoTypeDef definition
class AvailabilityZoneInfoTypeDef(TypedDict):
AvailabilityZoneName: NotRequired[str],
ZoneStatus: NotRequired[ZoneStatusType], # (1)
ConfiguredDataNodeCount: NotRequired[str],
AvailableDataNodeCount: NotRequired[str],
TotalShards: NotRequired[str],
TotalUnAssignedShards: NotRequired[str],- See ZoneStatusType
CancelDomainConfigChangeRequestTypeDef#
# CancelDomainConfigChangeRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CancelDomainConfigChangeRequestTypeDef
def get_value() -> CancelDomainConfigChangeRequestTypeDef:
return {
"DomainName": ...,
}
# CancelDomainConfigChangeRequestTypeDef definition
class CancelDomainConfigChangeRequestTypeDef(TypedDict):
DomainName: str,
DryRun: NotRequired[bool],CancelledChangePropertyTypeDef#
# CancelledChangePropertyTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CancelledChangePropertyTypeDef
def get_value() -> CancelledChangePropertyTypeDef:
return {
"PropertyName": ...,
}
# CancelledChangePropertyTypeDef definition
class CancelledChangePropertyTypeDef(TypedDict):
PropertyName: NotRequired[str],
CancelledValue: NotRequired[str],
ActiveValue: NotRequired[str],CancelServiceSoftwareUpdateRequestTypeDef#
# CancelServiceSoftwareUpdateRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CancelServiceSoftwareUpdateRequestTypeDef
def get_value() -> CancelServiceSoftwareUpdateRequestTypeDef:
return {
"DomainName": ...,
}
# CancelServiceSoftwareUpdateRequestTypeDef definition
class CancelServiceSoftwareUpdateRequestTypeDef(TypedDict):
DomainName: str,ServiceSoftwareOptionsTypeDef#
# ServiceSoftwareOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ServiceSoftwareOptionsTypeDef
def get_value() -> ServiceSoftwareOptionsTypeDef:
return {
"CurrentVersion": ...,
}
# ServiceSoftwareOptionsTypeDef definition
class ServiceSoftwareOptionsTypeDef(TypedDict):
CurrentVersion: NotRequired[str],
NewVersion: NotRequired[str],
UpdateAvailable: NotRequired[bool],
Cancellable: NotRequired[bool],
UpdateStatus: NotRequired[DeploymentStatusType], # (1)
Description: NotRequired[str],
AutomatedUpdateDate: NotRequired[datetime],
OptionalDeployment: NotRequired[bool],ChangeProgressDetailsTypeDef#
# ChangeProgressDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ChangeProgressDetailsTypeDef
def get_value() -> ChangeProgressDetailsTypeDef:
return {
"ChangeId": ...,
}
# ChangeProgressDetailsTypeDef definition
class ChangeProgressDetailsTypeDef(TypedDict):
ChangeId: NotRequired[str],
Message: NotRequired[str],
ConfigChangeStatus: NotRequired[ConfigChangeStatusType], # (1)
InitiatedBy: NotRequired[InitiatedByType], # (2)
StartTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],ChangeProgressStageTypeDef#
# ChangeProgressStageTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ChangeProgressStageTypeDef
def get_value() -> ChangeProgressStageTypeDef:
return {
"Name": ...,
}
# ChangeProgressStageTypeDef definition
class ChangeProgressStageTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[str],
Description: NotRequired[str],
LastUpdated: NotRequired[datetime],CloudWatchDirectQueryDataSourceTypeDef#
# CloudWatchDirectQueryDataSourceTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CloudWatchDirectQueryDataSourceTypeDef
def get_value() -> CloudWatchDirectQueryDataSourceTypeDef:
return {
"RoleArn": ...,
}
# CloudWatchDirectQueryDataSourceTypeDef definition
class CloudWatchDirectQueryDataSourceTypeDef(TypedDict):
RoleArn: str,ColdStorageOptionsTypeDef#
# ColdStorageOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ColdStorageOptionsTypeDef
def get_value() -> ColdStorageOptionsTypeDef:
return {
"Enabled": ...,
}
# ColdStorageOptionsTypeDef definition
class ColdStorageOptionsTypeDef(TypedDict):
Enabled: bool,ZoneAwarenessConfigTypeDef#
# ZoneAwarenessConfigTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ZoneAwarenessConfigTypeDef
def get_value() -> ZoneAwarenessConfigTypeDef:
return {
"AvailabilityZoneCount": ...,
}
# ZoneAwarenessConfigTypeDef definition
class ZoneAwarenessConfigTypeDef(TypedDict):
AvailabilityZoneCount: NotRequired[int],CognitoOptionsTypeDef#
# CognitoOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CognitoOptionsTypeDef
def get_value() -> CognitoOptionsTypeDef:
return {
"Enabled": ...,
}
# CognitoOptionsTypeDef definition
class CognitoOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
UserPoolId: NotRequired[str],
IdentityPoolId: NotRequired[str],
RoleArn: NotRequired[str],CompatibleVersionsMapTypeDef#
# CompatibleVersionsMapTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CompatibleVersionsMapTypeDef
def get_value() -> CompatibleVersionsMapTypeDef:
return {
"SourceVersion": ...,
}
# CompatibleVersionsMapTypeDef definition
class CompatibleVersionsMapTypeDef(TypedDict):
SourceVersion: NotRequired[str],
TargetVersions: NotRequired[List[str]],CrossClusterSearchConnectionPropertiesTypeDef#
# CrossClusterSearchConnectionPropertiesTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CrossClusterSearchConnectionPropertiesTypeDef
def get_value() -> CrossClusterSearchConnectionPropertiesTypeDef:
return {
"SkipUnavailable": ...,
}
# CrossClusterSearchConnectionPropertiesTypeDef definition
class CrossClusterSearchConnectionPropertiesTypeDef(TypedDict):
SkipUnavailable: NotRequired[SkipUnavailableStatusType], # (1)DataSourceTypeDef#
# DataSourceTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DataSourceTypeDef
def get_value() -> DataSourceTypeDef:
return {
"dataSourceArn": ...,
}
# DataSourceTypeDef definition
class DataSourceTypeDef(TypedDict):
dataSourceArn: NotRequired[str],
dataSourceDescription: NotRequired[str],IamIdentityCenterOptionsInputTypeDef#
# IamIdentityCenterOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import IamIdentityCenterOptionsInputTypeDef
def get_value() -> IamIdentityCenterOptionsInputTypeDef:
return {
"enabled": ...,
}
# IamIdentityCenterOptionsInputTypeDef definition
class IamIdentityCenterOptionsInputTypeDef(TypedDict):
enabled: NotRequired[bool],
iamIdentityCenterInstanceArn: NotRequired[str],
iamRoleForIdentityCenterApplicationArn: NotRequired[str],IamIdentityCenterOptionsTypeDef#
# IamIdentityCenterOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import IamIdentityCenterOptionsTypeDef
def get_value() -> IamIdentityCenterOptionsTypeDef:
return {
"enabled": ...,
}
# IamIdentityCenterOptionsTypeDef definition
class IamIdentityCenterOptionsTypeDef(TypedDict):
enabled: NotRequired[bool],
iamIdentityCenterInstanceArn: NotRequired[str],
iamRoleForIdentityCenterApplicationArn: NotRequired[str],
iamIdentityCenterApplicationArn: NotRequired[str],DomainEndpointOptionsTypeDef#
# DomainEndpointOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainEndpointOptionsTypeDef
def get_value() -> DomainEndpointOptionsTypeDef:
return {
"EnforceHTTPS": ...,
}
# DomainEndpointOptionsTypeDef definition
class DomainEndpointOptionsTypeDef(TypedDict):
EnforceHTTPS: NotRequired[bool],
TLSSecurityPolicy: NotRequired[TLSSecurityPolicyType], # (1)
CustomEndpointEnabled: NotRequired[bool],
CustomEndpoint: NotRequired[str],
CustomEndpointCertificateArn: NotRequired[str],EBSOptionsTypeDef#
# EBSOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import EBSOptionsTypeDef
def get_value() -> EBSOptionsTypeDef:
return {
"EBSEnabled": ...,
}
# EBSOptionsTypeDef definition
class EBSOptionsTypeDef(TypedDict):
EBSEnabled: NotRequired[bool],
VolumeType: NotRequired[VolumeTypeType], # (1)
VolumeSize: NotRequired[int],
Iops: NotRequired[int],
Throughput: NotRequired[int],- See VolumeTypeType
EncryptionAtRestOptionsTypeDef#
# EncryptionAtRestOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import EncryptionAtRestOptionsTypeDef
def get_value() -> EncryptionAtRestOptionsTypeDef:
return {
"Enabled": ...,
}
# EncryptionAtRestOptionsTypeDef definition
class EncryptionAtRestOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
KmsKeyId: NotRequired[str],IdentityCenterOptionsInputTypeDef#
# IdentityCenterOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import IdentityCenterOptionsInputTypeDef
def get_value() -> IdentityCenterOptionsInputTypeDef:
return {
"EnabledAPIAccess": ...,
}
# IdentityCenterOptionsInputTypeDef definition
class IdentityCenterOptionsInputTypeDef(TypedDict):
EnabledAPIAccess: NotRequired[bool],
IdentityCenterInstanceARN: NotRequired[str],
SubjectKey: NotRequired[SubjectKeyIdCOptionType], # (1)
RolesKey: NotRequired[RolesKeyIdCOptionType], # (2)LogPublishingOptionTypeDef#
# LogPublishingOptionTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import LogPublishingOptionTypeDef
def get_value() -> LogPublishingOptionTypeDef:
return {
"CloudWatchLogsLogGroupArn": ...,
}
# LogPublishingOptionTypeDef definition
class LogPublishingOptionTypeDef(TypedDict):
CloudWatchLogsLogGroupArn: NotRequired[str],
Enabled: NotRequired[bool],NodeToNodeEncryptionOptionsTypeDef#
# NodeToNodeEncryptionOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import NodeToNodeEncryptionOptionsTypeDef
def get_value() -> NodeToNodeEncryptionOptionsTypeDef:
return {
"Enabled": ...,
}
# NodeToNodeEncryptionOptionsTypeDef definition
class NodeToNodeEncryptionOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],SnapshotOptionsTypeDef#
# SnapshotOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SnapshotOptionsTypeDef
def get_value() -> SnapshotOptionsTypeDef:
return {
"AutomatedSnapshotStartHour": ...,
}
# SnapshotOptionsTypeDef definition
class SnapshotOptionsTypeDef(TypedDict):
AutomatedSnapshotStartHour: NotRequired[int],SoftwareUpdateOptionsTypeDef#
# SoftwareUpdateOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SoftwareUpdateOptionsTypeDef
def get_value() -> SoftwareUpdateOptionsTypeDef:
return {
"AutoSoftwareUpdateEnabled": ...,
}
# SoftwareUpdateOptionsTypeDef definition
class SoftwareUpdateOptionsTypeDef(TypedDict):
AutoSoftwareUpdateEnabled: NotRequired[bool],VPCOptionsTypeDef#
# VPCOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VPCOptionsTypeDef
def get_value() -> VPCOptionsTypeDef:
return {
"SubnetIds": ...,
}
# VPCOptionsTypeDef definition
class VPCOptionsTypeDef(TypedDict):
SubnetIds: NotRequired[Sequence[str]],
SecurityGroupIds: NotRequired[Sequence[str]],OutboundConnectionStatusTypeDef#
# OutboundConnectionStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import OutboundConnectionStatusTypeDef
def get_value() -> OutboundConnectionStatusTypeDef:
return {
"StatusCode": ...,
}
# OutboundConnectionStatusTypeDef definition
class OutboundConnectionStatusTypeDef(TypedDict):
StatusCode: NotRequired[OutboundConnectionStatusCodeType], # (1)
Message: NotRequired[str],PackageConfigurationTypeDef#
# PackageConfigurationTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageConfigurationTypeDef
def get_value() -> PackageConfigurationTypeDef:
return {
"LicenseRequirement": ...,
}
# PackageConfigurationTypeDef definition
class PackageConfigurationTypeDef(TypedDict):
LicenseRequirement: RequirementLevelType, # (1)
ConfigurationRequirement: RequirementLevelType, # (1)
LicenseFilepath: NotRequired[str],
RequiresRestartForConfigurationUpdate: NotRequired[bool],PackageEncryptionOptionsTypeDef#
# PackageEncryptionOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageEncryptionOptionsTypeDef
def get_value() -> PackageEncryptionOptionsTypeDef:
return {
"KmsKeyIdentifier": ...,
}
# PackageEncryptionOptionsTypeDef definition
class PackageEncryptionOptionsTypeDef(TypedDict):
EncryptionEnabled: bool,
KmsKeyIdentifier: NotRequired[str],PackageSourceTypeDef#
# PackageSourceTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageSourceTypeDef
def get_value() -> PackageSourceTypeDef:
return {
"S3BucketName": ...,
}
# PackageSourceTypeDef definition
class PackageSourceTypeDef(TypedDict):
S3BucketName: NotRequired[str],
S3Key: NotRequired[str],PackageVendingOptionsTypeDef#
# PackageVendingOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageVendingOptionsTypeDef
def get_value() -> PackageVendingOptionsTypeDef:
return {
"VendingEnabled": ...,
}
# PackageVendingOptionsTypeDef definition
class PackageVendingOptionsTypeDef(TypedDict):
VendingEnabled: bool,S3GlueDataCatalogTypeDef#
# S3GlueDataCatalogTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import S3GlueDataCatalogTypeDef
def get_value() -> S3GlueDataCatalogTypeDef:
return {
"RoleArn": ...,
}
# S3GlueDataCatalogTypeDef definition
class S3GlueDataCatalogTypeDef(TypedDict):
RoleArn: NotRequired[str],DeleteApplicationRequestTypeDef#
# DeleteApplicationRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteApplicationRequestTypeDef
def get_value() -> DeleteApplicationRequestTypeDef:
return {
"id": ...,
}
# DeleteApplicationRequestTypeDef definition
class DeleteApplicationRequestTypeDef(TypedDict):
id: str,DeleteDataSourceRequestTypeDef#
# DeleteDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteDataSourceRequestTypeDef
def get_value() -> DeleteDataSourceRequestTypeDef:
return {
"DomainName": ...,
}
# DeleteDataSourceRequestTypeDef definition
class DeleteDataSourceRequestTypeDef(TypedDict):
DomainName: str,
Name: str,DeleteDirectQueryDataSourceRequestTypeDef#
# DeleteDirectQueryDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteDirectQueryDataSourceRequestTypeDef
def get_value() -> DeleteDirectQueryDataSourceRequestTypeDef:
return {
"DataSourceName": ...,
}
# DeleteDirectQueryDataSourceRequestTypeDef definition
class DeleteDirectQueryDataSourceRequestTypeDef(TypedDict):
DataSourceName: str,DeleteDomainRequestTypeDef#
# DeleteDomainRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteDomainRequestTypeDef
def get_value() -> DeleteDomainRequestTypeDef:
return {
"DomainName": ...,
}
# DeleteDomainRequestTypeDef definition
class DeleteDomainRequestTypeDef(TypedDict):
DomainName: str,DeleteInboundConnectionRequestTypeDef#
# DeleteInboundConnectionRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteInboundConnectionRequestTypeDef
def get_value() -> DeleteInboundConnectionRequestTypeDef:
return {
"ConnectionId": ...,
}
# DeleteInboundConnectionRequestTypeDef definition
class DeleteInboundConnectionRequestTypeDef(TypedDict):
ConnectionId: str,DeleteOutboundConnectionRequestTypeDef#
# DeleteOutboundConnectionRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteOutboundConnectionRequestTypeDef
def get_value() -> DeleteOutboundConnectionRequestTypeDef:
return {
"ConnectionId": ...,
}
# DeleteOutboundConnectionRequestTypeDef definition
class DeleteOutboundConnectionRequestTypeDef(TypedDict):
ConnectionId: str,DeletePackageRequestTypeDef#
# DeletePackageRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeletePackageRequestTypeDef
def get_value() -> DeletePackageRequestTypeDef:
return {
"PackageID": ...,
}
# DeletePackageRequestTypeDef definition
class DeletePackageRequestTypeDef(TypedDict):
PackageID: str,DeleteVpcEndpointRequestTypeDef#
# DeleteVpcEndpointRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteVpcEndpointRequestTypeDef
def get_value() -> DeleteVpcEndpointRequestTypeDef:
return {
"VpcEndpointId": ...,
}
# DeleteVpcEndpointRequestTypeDef definition
class DeleteVpcEndpointRequestTypeDef(TypedDict):
VpcEndpointId: str,VpcEndpointSummaryTypeDef#
# VpcEndpointSummaryTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VpcEndpointSummaryTypeDef
def get_value() -> VpcEndpointSummaryTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointSummaryTypeDef definition
class VpcEndpointSummaryTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcEndpointOwner: NotRequired[str],
DomainArn: NotRequired[str],
Status: NotRequired[VpcEndpointStatusType], # (1)DescribeDomainAutoTunesRequestTypeDef#
# DescribeDomainAutoTunesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainAutoTunesRequestTypeDef
def get_value() -> DescribeDomainAutoTunesRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainAutoTunesRequestTypeDef definition
class DescribeDomainAutoTunesRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeDomainChangeProgressRequestTypeDef#
# DescribeDomainChangeProgressRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainChangeProgressRequestTypeDef
def get_value() -> DescribeDomainChangeProgressRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainChangeProgressRequestTypeDef definition
class DescribeDomainChangeProgressRequestTypeDef(TypedDict):
DomainName: str,
ChangeId: NotRequired[str],DescribeDomainConfigRequestTypeDef#
# DescribeDomainConfigRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainConfigRequestTypeDef
def get_value() -> DescribeDomainConfigRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainConfigRequestTypeDef definition
class DescribeDomainConfigRequestTypeDef(TypedDict):
DomainName: str,DescribeDomainHealthRequestTypeDef#
# DescribeDomainHealthRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainHealthRequestTypeDef
def get_value() -> DescribeDomainHealthRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainHealthRequestTypeDef definition
class DescribeDomainHealthRequestTypeDef(TypedDict):
DomainName: str,DescribeDomainNodesRequestTypeDef#
# DescribeDomainNodesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainNodesRequestTypeDef
def get_value() -> DescribeDomainNodesRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainNodesRequestTypeDef definition
class DescribeDomainNodesRequestTypeDef(TypedDict):
DomainName: str,DomainNodesStatusTypeDef#
# DomainNodesStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainNodesStatusTypeDef
def get_value() -> DomainNodesStatusTypeDef:
return {
"NodeId": ...,
}
# DomainNodesStatusTypeDef definition
class DomainNodesStatusTypeDef(TypedDict):
NodeId: NotRequired[str],
NodeType: NotRequired[NodeTypeType], # (1)
AvailabilityZone: NotRequired[str],
InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType], # (2)
NodeStatus: NotRequired[NodeStatusType], # (3)
StorageType: NotRequired[str],
StorageVolumeType: NotRequired[VolumeTypeType], # (4)
StorageSize: NotRequired[str],- See NodeTypeType
- See OpenSearchPartitionInstanceTypeType
- See NodeStatusType
- See VolumeTypeType
DescribeDomainRequestTypeDef#
# DescribeDomainRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainRequestTypeDef
def get_value() -> DescribeDomainRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDomainRequestTypeDef definition
class DescribeDomainRequestTypeDef(TypedDict):
DomainName: str,DescribeDomainsRequestTypeDef#
# DescribeDomainsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainsRequestTypeDef
def get_value() -> DescribeDomainsRequestTypeDef:
return {
"DomainNames": ...,
}
# DescribeDomainsRequestTypeDef definition
class DescribeDomainsRequestTypeDef(TypedDict):
DomainNames: Sequence[str],DescribeDryRunProgressRequestTypeDef#
# DescribeDryRunProgressRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDryRunProgressRequestTypeDef
def get_value() -> DescribeDryRunProgressRequestTypeDef:
return {
"DomainName": ...,
}
# DescribeDryRunProgressRequestTypeDef definition
class DescribeDryRunProgressRequestTypeDef(TypedDict):
DomainName: str,
DryRunId: NotRequired[str],
LoadDryRunConfig: NotRequired[bool],DryRunResultsTypeDef#
# DryRunResultsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DryRunResultsTypeDef
def get_value() -> DryRunResultsTypeDef:
return {
"DeploymentType": ...,
}
# DryRunResultsTypeDef definition
class DryRunResultsTypeDef(TypedDict):
DeploymentType: NotRequired[str],
Message: NotRequired[str],FilterTypeDef#
# FilterTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Name": ...,
}
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
Name: NotRequired[str],
Values: NotRequired[Sequence[str]],DescribeInstanceTypeLimitsRequestTypeDef#
# DescribeInstanceTypeLimitsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeInstanceTypeLimitsRequestTypeDef
def get_value() -> DescribeInstanceTypeLimitsRequestTypeDef:
return {
"InstanceType": ...,
}
# DescribeInstanceTypeLimitsRequestTypeDef definition
class DescribeInstanceTypeLimitsRequestTypeDef(TypedDict):
InstanceType: OpenSearchPartitionInstanceTypeType, # (1)
EngineVersion: str,
DomainName: NotRequired[str],DescribePackagesFilterTypeDef#
# DescribePackagesFilterTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribePackagesFilterTypeDef
def get_value() -> DescribePackagesFilterTypeDef:
return {
"Name": ...,
}
# DescribePackagesFilterTypeDef definition
class DescribePackagesFilterTypeDef(TypedDict):
Name: NotRequired[DescribePackagesFilterNameType], # (1)
Value: NotRequired[Sequence[str]],DescribeReservedInstanceOfferingsRequestTypeDef#
# DescribeReservedInstanceOfferingsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeReservedInstanceOfferingsRequestTypeDef
def get_value() -> DescribeReservedInstanceOfferingsRequestTypeDef:
return {
"ReservedInstanceOfferingId": ...,
}
# DescribeReservedInstanceOfferingsRequestTypeDef definition
class DescribeReservedInstanceOfferingsRequestTypeDef(TypedDict):
ReservedInstanceOfferingId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeReservedInstancesRequestTypeDef#
# DescribeReservedInstancesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeReservedInstancesRequestTypeDef
def get_value() -> DescribeReservedInstancesRequestTypeDef:
return {
"ReservedInstanceId": ...,
}
# DescribeReservedInstancesRequestTypeDef definition
class DescribeReservedInstancesRequestTypeDef(TypedDict):
ReservedInstanceId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DescribeVpcEndpointsRequestTypeDef#
# DescribeVpcEndpointsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeVpcEndpointsRequestTypeDef
def get_value() -> DescribeVpcEndpointsRequestTypeDef:
return {
"VpcEndpointIds": ...,
}
# DescribeVpcEndpointsRequestTypeDef definition
class DescribeVpcEndpointsRequestTypeDef(TypedDict):
VpcEndpointIds: Sequence[str],VpcEndpointErrorTypeDef#
# VpcEndpointErrorTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VpcEndpointErrorTypeDef
def get_value() -> VpcEndpointErrorTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointErrorTypeDef definition
class VpcEndpointErrorTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
ErrorCode: NotRequired[VpcEndpointErrorCodeType], # (1)
ErrorMessage: NotRequired[str],SecurityLakeDirectQueryDataSourceTypeDef#
# SecurityLakeDirectQueryDataSourceTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SecurityLakeDirectQueryDataSourceTypeDef
def get_value() -> SecurityLakeDirectQueryDataSourceTypeDef:
return {
"RoleArn": ...,
}
# SecurityLakeDirectQueryDataSourceTypeDef definition
class SecurityLakeDirectQueryDataSourceTypeDef(TypedDict):
RoleArn: str,DissociatePackageRequestTypeDef#
# DissociatePackageRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DissociatePackageRequestTypeDef
def get_value() -> DissociatePackageRequestTypeDef:
return {
"PackageID": ...,
}
# DissociatePackageRequestTypeDef definition
class DissociatePackageRequestTypeDef(TypedDict):
PackageID: str,
DomainName: str,DissociatePackagesRequestTypeDef#
# DissociatePackagesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DissociatePackagesRequestTypeDef
def get_value() -> DissociatePackagesRequestTypeDef:
return {
"PackageList": ...,
}
# DissociatePackagesRequestTypeDef definition
class DissociatePackagesRequestTypeDef(TypedDict):
PackageList: Sequence[str],
DomainName: str,ModifyingPropertiesTypeDef#
# ModifyingPropertiesTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ModifyingPropertiesTypeDef
def get_value() -> ModifyingPropertiesTypeDef:
return {
"Name": ...,
}
# ModifyingPropertiesTypeDef definition
class ModifyingPropertiesTypeDef(TypedDict):
Name: NotRequired[str],
ActiveValue: NotRequired[str],
PendingValue: NotRequired[str],
ValueType: NotRequired[PropertyValueTypeType], # (1)DomainInfoTypeDef#
# DomainInfoTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainInfoTypeDef
def get_value() -> DomainInfoTypeDef:
return {
"DomainName": ...,
}
# DomainInfoTypeDef definition
class DomainInfoTypeDef(TypedDict):
DomainName: NotRequired[str],
EngineType: NotRequired[EngineTypeType], # (1)- See EngineTypeType
DomainMaintenanceDetailsTypeDef#
# DomainMaintenanceDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainMaintenanceDetailsTypeDef
def get_value() -> DomainMaintenanceDetailsTypeDef:
return {
"MaintenanceId": ...,
}
# DomainMaintenanceDetailsTypeDef definition
class DomainMaintenanceDetailsTypeDef(TypedDict):
MaintenanceId: NotRequired[str],
DomainName: NotRequired[str],
Action: NotRequired[MaintenanceTypeType], # (1)
NodeId: NotRequired[str],
Status: NotRequired[MaintenanceStatusType], # (2)
StatusMessage: NotRequired[str],
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],ErrorDetailsTypeDef#
# ErrorDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ErrorDetailsTypeDef
def get_value() -> ErrorDetailsTypeDef:
return {
"ErrorType": ...,
}
# ErrorDetailsTypeDef definition
class ErrorDetailsTypeDef(TypedDict):
ErrorType: NotRequired[str],
ErrorMessage: NotRequired[str],IdentityCenterOptionsTypeDef#
# IdentityCenterOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import IdentityCenterOptionsTypeDef
def get_value() -> IdentityCenterOptionsTypeDef:
return {
"EnabledAPIAccess": ...,
}
# IdentityCenterOptionsTypeDef definition
class IdentityCenterOptionsTypeDef(TypedDict):
EnabledAPIAccess: NotRequired[bool],
IdentityCenterInstanceARN: NotRequired[str],
SubjectKey: NotRequired[SubjectKeyIdCOptionType], # (1)
RolesKey: NotRequired[RolesKeyIdCOptionType], # (2)
IdentityCenterApplicationARN: NotRequired[str],
IdentityStoreId: NotRequired[str],VPCDerivedInfoTypeDef#
# VPCDerivedInfoTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VPCDerivedInfoTypeDef
def get_value() -> VPCDerivedInfoTypeDef:
return {
"VPCId": ...,
}
# VPCDerivedInfoTypeDef definition
class VPCDerivedInfoTypeDef(TypedDict):
VPCId: NotRequired[str],
SubnetIds: NotRequired[List[str]],
AvailabilityZones: NotRequired[List[str]],
SecurityGroupIds: NotRequired[List[str]],ValidationFailureTypeDef#
# ValidationFailureTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ValidationFailureTypeDef
def get_value() -> ValidationFailureTypeDef:
return {
"Code": ...,
}
# ValidationFailureTypeDef definition
class ValidationFailureTypeDef(TypedDict):
Code: NotRequired[str],
Message: NotRequired[str],GetApplicationRequestTypeDef#
# GetApplicationRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetApplicationRequestTypeDef
def get_value() -> GetApplicationRequestTypeDef:
return {
"id": ...,
}
# GetApplicationRequestTypeDef definition
class GetApplicationRequestTypeDef(TypedDict):
id: str,GetCompatibleVersionsRequestTypeDef#
# GetCompatibleVersionsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetCompatibleVersionsRequestTypeDef
def get_value() -> GetCompatibleVersionsRequestTypeDef:
return {
"DomainName": ...,
}
# GetCompatibleVersionsRequestTypeDef definition
class GetCompatibleVersionsRequestTypeDef(TypedDict):
DomainName: NotRequired[str],GetDataSourceRequestTypeDef#
# GetDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetDataSourceRequestTypeDef
def get_value() -> GetDataSourceRequestTypeDef:
return {
"DomainName": ...,
}
# GetDataSourceRequestTypeDef definition
class GetDataSourceRequestTypeDef(TypedDict):
DomainName: str,
Name: str,GetDirectQueryDataSourceRequestTypeDef#
# GetDirectQueryDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetDirectQueryDataSourceRequestTypeDef
def get_value() -> GetDirectQueryDataSourceRequestTypeDef:
return {
"DataSourceName": ...,
}
# GetDirectQueryDataSourceRequestTypeDef definition
class GetDirectQueryDataSourceRequestTypeDef(TypedDict):
DataSourceName: str,GetDomainMaintenanceStatusRequestTypeDef#
# GetDomainMaintenanceStatusRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetDomainMaintenanceStatusRequestTypeDef
def get_value() -> GetDomainMaintenanceStatusRequestTypeDef:
return {
"DomainName": ...,
}
# GetDomainMaintenanceStatusRequestTypeDef definition
class GetDomainMaintenanceStatusRequestTypeDef(TypedDict):
DomainName: str,
MaintenanceId: str,GetPackageVersionHistoryRequestTypeDef#
# GetPackageVersionHistoryRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetPackageVersionHistoryRequestTypeDef
def get_value() -> GetPackageVersionHistoryRequestTypeDef:
return {
"PackageID": ...,
}
# GetPackageVersionHistoryRequestTypeDef definition
class GetPackageVersionHistoryRequestTypeDef(TypedDict):
PackageID: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],GetUpgradeHistoryRequestTypeDef#
# GetUpgradeHistoryRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetUpgradeHistoryRequestTypeDef
def get_value() -> GetUpgradeHistoryRequestTypeDef:
return {
"DomainName": ...,
}
# GetUpgradeHistoryRequestTypeDef definition
class GetUpgradeHistoryRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],GetUpgradeStatusRequestTypeDef#
# GetUpgradeStatusRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetUpgradeStatusRequestTypeDef
def get_value() -> GetUpgradeStatusRequestTypeDef:
return {
"DomainName": ...,
}
# GetUpgradeStatusRequestTypeDef definition
class GetUpgradeStatusRequestTypeDef(TypedDict):
DomainName: str,InboundConnectionStatusTypeDef#
# InboundConnectionStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import InboundConnectionStatusTypeDef
def get_value() -> InboundConnectionStatusTypeDef:
return {
"StatusCode": ...,
}
# InboundConnectionStatusTypeDef definition
class InboundConnectionStatusTypeDef(TypedDict):
StatusCode: NotRequired[InboundConnectionStatusCodeType], # (1)
Message: NotRequired[str],InstanceCountLimitsTypeDef#
# InstanceCountLimitsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import InstanceCountLimitsTypeDef
def get_value() -> InstanceCountLimitsTypeDef:
return {
"MinimumInstanceCount": ...,
}
# InstanceCountLimitsTypeDef definition
class InstanceCountLimitsTypeDef(TypedDict):
MinimumInstanceCount: NotRequired[int],
MaximumInstanceCount: NotRequired[int],InstanceTypeDetailsTypeDef#
# InstanceTypeDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import InstanceTypeDetailsTypeDef
def get_value() -> InstanceTypeDetailsTypeDef:
return {
"InstanceType": ...,
}
# InstanceTypeDetailsTypeDef definition
class InstanceTypeDetailsTypeDef(TypedDict):
InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
EncryptionEnabled: NotRequired[bool],
CognitoEnabled: NotRequired[bool],
AppLogsEnabled: NotRequired[bool],
AdvancedSecurityEnabled: NotRequired[bool],
WarmEnabled: NotRequired[bool],
InstanceRole: NotRequired[List[str]],
AvailabilityZones: NotRequired[List[str]],KeyStoreAccessOptionTypeDef#
# KeyStoreAccessOptionTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import KeyStoreAccessOptionTypeDef
def get_value() -> KeyStoreAccessOptionTypeDef:
return {
"KeyAccessRoleArn": ...,
}
# KeyStoreAccessOptionTypeDef definition
class KeyStoreAccessOptionTypeDef(TypedDict):
KeyStoreAccessEnabled: bool,
KeyAccessRoleArn: NotRequired[str],PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],ListApplicationsRequestTypeDef#
# ListApplicationsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListApplicationsRequestTypeDef
def get_value() -> ListApplicationsRequestTypeDef:
return {
"nextToken": ...,
}
# ListApplicationsRequestTypeDef definition
class ListApplicationsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
statuses: NotRequired[Sequence[ApplicationStatusType]], # (1)
maxResults: NotRequired[int],ListDataSourcesRequestTypeDef#
# ListDataSourcesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDataSourcesRequestTypeDef
def get_value() -> ListDataSourcesRequestTypeDef:
return {
"DomainName": ...,
}
# ListDataSourcesRequestTypeDef definition
class ListDataSourcesRequestTypeDef(TypedDict):
DomainName: str,ListDirectQueryDataSourcesRequestTypeDef#
# ListDirectQueryDataSourcesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDirectQueryDataSourcesRequestTypeDef
def get_value() -> ListDirectQueryDataSourcesRequestTypeDef:
return {
"NextToken": ...,
}
# ListDirectQueryDataSourcesRequestTypeDef definition
class ListDirectQueryDataSourcesRequestTypeDef(TypedDict):
NextToken: NotRequired[str],ListDomainMaintenancesRequestTypeDef#
# ListDomainMaintenancesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDomainMaintenancesRequestTypeDef
def get_value() -> ListDomainMaintenancesRequestTypeDef:
return {
"DomainName": ...,
}
# ListDomainMaintenancesRequestTypeDef definition
class ListDomainMaintenancesRequestTypeDef(TypedDict):
DomainName: str,
Action: NotRequired[MaintenanceTypeType], # (1)
Status: NotRequired[MaintenanceStatusType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListDomainNamesRequestTypeDef#
# ListDomainNamesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDomainNamesRequestTypeDef
def get_value() -> ListDomainNamesRequestTypeDef:
return {
"EngineType": ...,
}
# ListDomainNamesRequestTypeDef definition
class ListDomainNamesRequestTypeDef(TypedDict):
EngineType: NotRequired[EngineTypeType], # (1)- See EngineTypeType
ListDomainsForPackageRequestTypeDef#
# ListDomainsForPackageRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDomainsForPackageRequestTypeDef
def get_value() -> ListDomainsForPackageRequestTypeDef:
return {
"PackageID": ...,
}
# ListDomainsForPackageRequestTypeDef definition
class ListDomainsForPackageRequestTypeDef(TypedDict):
PackageID: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListInstanceTypeDetailsRequestTypeDef#
# ListInstanceTypeDetailsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListInstanceTypeDetailsRequestTypeDef
def get_value() -> ListInstanceTypeDetailsRequestTypeDef:
return {
"EngineVersion": ...,
}
# ListInstanceTypeDetailsRequestTypeDef definition
class ListInstanceTypeDetailsRequestTypeDef(TypedDict):
EngineVersion: str,
DomainName: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
RetrieveAZs: NotRequired[bool],
InstanceType: NotRequired[str],ListPackagesForDomainRequestTypeDef#
# ListPackagesForDomainRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListPackagesForDomainRequestTypeDef
def get_value() -> ListPackagesForDomainRequestTypeDef:
return {
"DomainName": ...,
}
# ListPackagesForDomainRequestTypeDef definition
class ListPackagesForDomainRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListScheduledActionsRequestTypeDef#
# ListScheduledActionsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListScheduledActionsRequestTypeDef
def get_value() -> ListScheduledActionsRequestTypeDef:
return {
"DomainName": ...,
}
# ListScheduledActionsRequestTypeDef definition
class ListScheduledActionsRequestTypeDef(TypedDict):
DomainName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ScheduledActionTypeDef#
# ScheduledActionTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ScheduledActionTypeDef
def get_value() -> ScheduledActionTypeDef:
return {
"Id": ...,
}
# ScheduledActionTypeDef definition
class ScheduledActionTypeDef(TypedDict):
Id: str,
Type: ActionTypeType, # (1)
Severity: ActionSeverityType, # (2)
ScheduledTime: int,
Description: NotRequired[str],
ScheduledBy: NotRequired[ScheduledByType], # (3)
Status: NotRequired[ActionStatusType], # (4)
Mandatory: NotRequired[bool],
Cancellable: NotRequired[bool],- See ActionTypeType
- See ActionSeverityType
- See ScheduledByType
- See ActionStatusType
ListTagsRequestTypeDef#
# ListTagsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListTagsRequestTypeDef
def get_value() -> ListTagsRequestTypeDef:
return {
"ARN": ...,
}
# ListTagsRequestTypeDef definition
class ListTagsRequestTypeDef(TypedDict):
ARN: str,ListVersionsRequestTypeDef#
# ListVersionsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVersionsRequestTypeDef
def get_value() -> ListVersionsRequestTypeDef:
return {
"MaxResults": ...,
}
# ListVersionsRequestTypeDef definition
class ListVersionsRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],ListVpcEndpointAccessRequestTypeDef#
# ListVpcEndpointAccessRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVpcEndpointAccessRequestTypeDef
def get_value() -> ListVpcEndpointAccessRequestTypeDef:
return {
"DomainName": ...,
}
# ListVpcEndpointAccessRequestTypeDef definition
class ListVpcEndpointAccessRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],ListVpcEndpointsForDomainRequestTypeDef#
# ListVpcEndpointsForDomainRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVpcEndpointsForDomainRequestTypeDef
def get_value() -> ListVpcEndpointsForDomainRequestTypeDef:
return {
"DomainName": ...,
}
# ListVpcEndpointsForDomainRequestTypeDef definition
class ListVpcEndpointsForDomainRequestTypeDef(TypedDict):
DomainName: str,
NextToken: NotRequired[str],ListVpcEndpointsRequestTypeDef#
# ListVpcEndpointsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVpcEndpointsRequestTypeDef
def get_value() -> ListVpcEndpointsRequestTypeDef:
return {
"NextToken": ...,
}
# ListVpcEndpointsRequestTypeDef definition
class ListVpcEndpointsRequestTypeDef(TypedDict):
NextToken: NotRequired[str],NodeConfigTypeDef#
# NodeConfigTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import NodeConfigTypeDef
def get_value() -> NodeConfigTypeDef:
return {
"Enabled": ...,
}
# NodeConfigTypeDef definition
class NodeConfigTypeDef(TypedDict):
Enabled: NotRequired[bool],
Type: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
Count: NotRequired[int],WindowStartTimeTypeDef#
# WindowStartTimeTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import WindowStartTimeTypeDef
def get_value() -> WindowStartTimeTypeDef:
return {
"Hours": ...,
}
# WindowStartTimeTypeDef definition
class WindowStartTimeTypeDef(TypedDict):
Hours: int,
Minutes: int,PluginPropertiesTypeDef#
# PluginPropertiesTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PluginPropertiesTypeDef
def get_value() -> PluginPropertiesTypeDef:
return {
"Name": ...,
}
# PluginPropertiesTypeDef definition
class PluginPropertiesTypeDef(TypedDict):
Name: NotRequired[str],
Description: NotRequired[str],
Version: NotRequired[str],
ClassName: NotRequired[str],
UncompressedSizeInBytes: NotRequired[int],PurchaseReservedInstanceOfferingRequestTypeDef#
# PurchaseReservedInstanceOfferingRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PurchaseReservedInstanceOfferingRequestTypeDef
def get_value() -> PurchaseReservedInstanceOfferingRequestTypeDef:
return {
"ReservedInstanceOfferingId": ...,
}
# PurchaseReservedInstanceOfferingRequestTypeDef definition
class PurchaseReservedInstanceOfferingRequestTypeDef(TypedDict):
ReservedInstanceOfferingId: str,
ReservationName: str,
InstanceCount: NotRequired[int],RecurringChargeTypeDef#
# RecurringChargeTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import RecurringChargeTypeDef
def get_value() -> RecurringChargeTypeDef:
return {
"RecurringChargeAmount": ...,
}
# RecurringChargeTypeDef definition
class RecurringChargeTypeDef(TypedDict):
RecurringChargeAmount: NotRequired[float],
RecurringChargeFrequency: NotRequired[str],RejectInboundConnectionRequestTypeDef#
# RejectInboundConnectionRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import RejectInboundConnectionRequestTypeDef
def get_value() -> RejectInboundConnectionRequestTypeDef:
return {
"ConnectionId": ...,
}
# RejectInboundConnectionRequestTypeDef definition
class RejectInboundConnectionRequestTypeDef(TypedDict):
ConnectionId: str,RemoveTagsRequestTypeDef#
# RemoveTagsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import RemoveTagsRequestTypeDef
def get_value() -> RemoveTagsRequestTypeDef:
return {
"ARN": ...,
}
# RemoveTagsRequestTypeDef definition
class RemoveTagsRequestTypeDef(TypedDict):
ARN: str,
TagKeys: Sequence[str],RevokeVpcEndpointAccessRequestTypeDef#
# RevokeVpcEndpointAccessRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import RevokeVpcEndpointAccessRequestTypeDef
def get_value() -> RevokeVpcEndpointAccessRequestTypeDef:
return {
"DomainName": ...,
}
# RevokeVpcEndpointAccessRequestTypeDef definition
class RevokeVpcEndpointAccessRequestTypeDef(TypedDict):
DomainName: str,
Account: NotRequired[str],
Service: NotRequired[AWSServicePrincipalType], # (1)SAMLIdpTypeDef#
# SAMLIdpTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SAMLIdpTypeDef
def get_value() -> SAMLIdpTypeDef:
return {
"MetadataContent": ...,
}
# SAMLIdpTypeDef definition
class SAMLIdpTypeDef(TypedDict):
MetadataContent: str,
EntityId: str,StartDomainMaintenanceRequestTypeDef#
# StartDomainMaintenanceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import StartDomainMaintenanceRequestTypeDef
def get_value() -> StartDomainMaintenanceRequestTypeDef:
return {
"DomainName": ...,
}
# StartDomainMaintenanceRequestTypeDef definition
class StartDomainMaintenanceRequestTypeDef(TypedDict):
DomainName: str,
Action: MaintenanceTypeType, # (1)
NodeId: NotRequired[str],StartServiceSoftwareUpdateRequestTypeDef#
# StartServiceSoftwareUpdateRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import StartServiceSoftwareUpdateRequestTypeDef
def get_value() -> StartServiceSoftwareUpdateRequestTypeDef:
return {
"DomainName": ...,
}
# StartServiceSoftwareUpdateRequestTypeDef definition
class StartServiceSoftwareUpdateRequestTypeDef(TypedDict):
DomainName: str,
ScheduleAt: NotRequired[ScheduleAtType], # (1)
DesiredStartTime: NotRequired[int],- See ScheduleAtType
StorageTypeLimitTypeDef#
# StorageTypeLimitTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import StorageTypeLimitTypeDef
def get_value() -> StorageTypeLimitTypeDef:
return {
"LimitName": ...,
}
# StorageTypeLimitTypeDef definition
class StorageTypeLimitTypeDef(TypedDict):
LimitName: NotRequired[str],
LimitValues: NotRequired[List[str]],UpdatePackageScopeRequestTypeDef#
# UpdatePackageScopeRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdatePackageScopeRequestTypeDef
def get_value() -> UpdatePackageScopeRequestTypeDef:
return {
"PackageID": ...,
}
# UpdatePackageScopeRequestTypeDef definition
class UpdatePackageScopeRequestTypeDef(TypedDict):
PackageID: str,
Operation: PackageScopeOperationEnumType, # (1)
PackageUserList: Sequence[str],UpdateScheduledActionRequestTypeDef#
# UpdateScheduledActionRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateScheduledActionRequestTypeDef
def get_value() -> UpdateScheduledActionRequestTypeDef:
return {
"DomainName": ...,
}
# UpdateScheduledActionRequestTypeDef definition
class UpdateScheduledActionRequestTypeDef(TypedDict):
DomainName: str,
ActionID: str,
ActionType: ActionTypeType, # (1)
ScheduleAt: ScheduleAtType, # (2)
DesiredStartTime: NotRequired[int],- See ActionTypeType
- See ScheduleAtType
UpgradeDomainRequestTypeDef#
# UpgradeDomainRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpgradeDomainRequestTypeDef
def get_value() -> UpgradeDomainRequestTypeDef:
return {
"DomainName": ...,
}
# UpgradeDomainRequestTypeDef definition
class UpgradeDomainRequestTypeDef(TypedDict):
DomainName: str,
TargetVersion: str,
PerformCheckOnly: NotRequired[bool],
AdvancedOptions: NotRequired[Mapping[str, str]],UpgradeStepItemTypeDef#
# UpgradeStepItemTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpgradeStepItemTypeDef
def get_value() -> UpgradeStepItemTypeDef:
return {
"UpgradeStep": ...,
}
# UpgradeStepItemTypeDef definition
class UpgradeStepItemTypeDef(TypedDict):
UpgradeStep: NotRequired[UpgradeStepType], # (1)
UpgradeStepStatus: NotRequired[UpgradeStatusType], # (2)
Issues: NotRequired[List[str]],
ProgressPercent: NotRequired[float],- See UpgradeStepType
- See UpgradeStatusType
AIMLOptionsInputTypeDef#
# AIMLOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AIMLOptionsInputTypeDef
def get_value() -> AIMLOptionsInputTypeDef:
return {
"NaturalLanguageQueryGenerationOptions": ...,
}
# AIMLOptionsInputTypeDef definition
class AIMLOptionsInputTypeDef(TypedDict):
NaturalLanguageQueryGenerationOptions: NotRequired[NaturalLanguageQueryGenerationOptionsInputTypeDef], # (1)AIMLOptionsOutputTypeDef#
# AIMLOptionsOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AIMLOptionsOutputTypeDef
def get_value() -> AIMLOptionsOutputTypeDef:
return {
"NaturalLanguageQueryGenerationOptions": ...,
}
# AIMLOptionsOutputTypeDef definition
class AIMLOptionsOutputTypeDef(TypedDict):
NaturalLanguageQueryGenerationOptions: NotRequired[NaturalLanguageQueryGenerationOptionsOutputTypeDef], # (1)AccessPoliciesStatusTypeDef#
# AccessPoliciesStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AccessPoliciesStatusTypeDef
def get_value() -> AccessPoliciesStatusTypeDef:
return {
"Options": ...,
}
# AccessPoliciesStatusTypeDef definition
class AccessPoliciesStatusTypeDef(TypedDict):
Options: str,
Status: OptionStatusTypeDef, # (1)AdvancedOptionsStatusTypeDef#
# AdvancedOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AdvancedOptionsStatusTypeDef
def get_value() -> AdvancedOptionsStatusTypeDef:
return {
"Options": ...,
}
# AdvancedOptionsStatusTypeDef definition
class AdvancedOptionsStatusTypeDef(TypedDict):
Options: Dict[str, str],
Status: OptionStatusTypeDef, # (1)IPAddressTypeStatusTypeDef#
# IPAddressTypeStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import IPAddressTypeStatusTypeDef
def get_value() -> IPAddressTypeStatusTypeDef:
return {
"Options": ...,
}
# IPAddressTypeStatusTypeDef definition
class IPAddressTypeStatusTypeDef(TypedDict):
Options: IPAddressTypeType, # (1)
Status: OptionStatusTypeDef, # (2)- See IPAddressTypeType
- See OptionStatusTypeDef
VersionStatusTypeDef#
# VersionStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VersionStatusTypeDef
def get_value() -> VersionStatusTypeDef:
return {
"Options": ...,
}
# VersionStatusTypeDef definition
class VersionStatusTypeDef(TypedDict):
Options: str,
Status: OptionStatusTypeDef, # (1)DomainInformationContainerTypeDef#
# DomainInformationContainerTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainInformationContainerTypeDef
def get_value() -> DomainInformationContainerTypeDef:
return {
"AWSDomainInformation": ...,
}
# DomainInformationContainerTypeDef definition
class DomainInformationContainerTypeDef(TypedDict):
AWSDomainInformation: NotRequired[AWSDomainInformationTypeDef], # (1)AddDataSourceResponseTypeDef#
# AddDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AddDataSourceResponseTypeDef
def get_value() -> AddDataSourceResponseTypeDef:
return {
"Message": ...,
}
# AddDataSourceResponseTypeDef definition
class AddDataSourceResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)AddDirectQueryDataSourceResponseTypeDef#
# AddDirectQueryDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AddDirectQueryDataSourceResponseTypeDef
def get_value() -> AddDirectQueryDataSourceResponseTypeDef:
return {
"DataSourceArn": ...,
}
# AddDirectQueryDataSourceResponseTypeDef definition
class AddDirectQueryDataSourceResponseTypeDef(TypedDict):
DataSourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteDataSourceResponseTypeDef#
# DeleteDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteDataSourceResponseTypeDef
def get_value() -> DeleteDataSourceResponseTypeDef:
return {
"Message": ...,
}
# DeleteDataSourceResponseTypeDef definition
class DeleteDataSourceResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetDomainMaintenanceStatusResponseTypeDef#
# GetDomainMaintenanceStatusResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetDomainMaintenanceStatusResponseTypeDef
def get_value() -> GetDomainMaintenanceStatusResponseTypeDef:
return {
"Status": ...,
}
# GetDomainMaintenanceStatusResponseTypeDef definition
class GetDomainMaintenanceStatusResponseTypeDef(TypedDict):
Status: MaintenanceStatusType, # (1)
StatusMessage: str,
NodeId: str,
Action: MaintenanceTypeType, # (2)
CreatedAt: datetime,
UpdatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetUpgradeStatusResponseTypeDef#
# GetUpgradeStatusResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetUpgradeStatusResponseTypeDef
def get_value() -> GetUpgradeStatusResponseTypeDef:
return {
"UpgradeStep": ...,
}
# GetUpgradeStatusResponseTypeDef definition
class GetUpgradeStatusResponseTypeDef(TypedDict):
UpgradeStep: UpgradeStepType, # (1)
StepStatus: UpgradeStatusType, # (2)
UpgradeName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See UpgradeStepType
- See UpgradeStatusType
- See ResponseMetadataTypeDef
ListVersionsResponseTypeDef#
# ListVersionsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVersionsResponseTypeDef
def get_value() -> ListVersionsResponseTypeDef:
return {
"Versions": ...,
}
# ListVersionsResponseTypeDef definition
class ListVersionsResponseTypeDef(TypedDict):
Versions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],PurchaseReservedInstanceOfferingResponseTypeDef#
# PurchaseReservedInstanceOfferingResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PurchaseReservedInstanceOfferingResponseTypeDef
def get_value() -> PurchaseReservedInstanceOfferingResponseTypeDef:
return {
"ReservedInstanceId": ...,
}
# PurchaseReservedInstanceOfferingResponseTypeDef definition
class PurchaseReservedInstanceOfferingResponseTypeDef(TypedDict):
ReservedInstanceId: str,
ReservationName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartDomainMaintenanceResponseTypeDef#
# StartDomainMaintenanceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import StartDomainMaintenanceResponseTypeDef
def get_value() -> StartDomainMaintenanceResponseTypeDef:
return {
"MaintenanceId": ...,
}
# StartDomainMaintenanceResponseTypeDef definition
class StartDomainMaintenanceResponseTypeDef(TypedDict):
MaintenanceId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateDataSourceResponseTypeDef#
# UpdateDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateDataSourceResponseTypeDef
def get_value() -> UpdateDataSourceResponseTypeDef:
return {
"Message": ...,
}
# UpdateDataSourceResponseTypeDef definition
class UpdateDataSourceResponseTypeDef(TypedDict):
Message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateDirectQueryDataSourceResponseTypeDef#
# UpdateDirectQueryDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateDirectQueryDataSourceResponseTypeDef
def get_value() -> UpdateDirectQueryDataSourceResponseTypeDef:
return {
"DataSourceArn": ...,
}
# UpdateDirectQueryDataSourceResponseTypeDef definition
class UpdateDirectQueryDataSourceResponseTypeDef(TypedDict):
DataSourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdatePackageScopeResponseTypeDef#
# UpdatePackageScopeResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdatePackageScopeResponseTypeDef
def get_value() -> UpdatePackageScopeResponseTypeDef:
return {
"PackageID": ...,
}
# UpdatePackageScopeResponseTypeDef definition
class UpdatePackageScopeResponseTypeDef(TypedDict):
PackageID: str,
Operation: PackageScopeOperationEnumType, # (1)
PackageUserList: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)AddTagsRequestTypeDef#
# AddTagsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AddTagsRequestTypeDef
def get_value() -> AddTagsRequestTypeDef:
return {
"ARN": ...,
}
# AddTagsRequestTypeDef definition
class AddTagsRequestTypeDef(TypedDict):
ARN: str,
TagList: Sequence[TagTypeDef], # (1)- See TagTypeDef
ListTagsResponseTypeDef#
# ListTagsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListTagsResponseTypeDef
def get_value() -> ListTagsResponseTypeDef:
return {
"TagList": ...,
}
# ListTagsResponseTypeDef definition
class ListTagsResponseTypeDef(TypedDict):
TagList: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See TagTypeDef
- See ResponseMetadataTypeDef
ListApplicationsResponseTypeDef#
# ListApplicationsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListApplicationsResponseTypeDef
def get_value() -> ListApplicationsResponseTypeDef:
return {
"ApplicationSummaries": ...,
}
# ListApplicationsResponseTypeDef definition
class ListApplicationsResponseTypeDef(TypedDict):
ApplicationSummaries: List[ApplicationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],AuthorizeVpcEndpointAccessResponseTypeDef#
# AuthorizeVpcEndpointAccessResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AuthorizeVpcEndpointAccessResponseTypeDef
def get_value() -> AuthorizeVpcEndpointAccessResponseTypeDef:
return {
"AuthorizedPrincipal": ...,
}
# AuthorizeVpcEndpointAccessResponseTypeDef definition
class AuthorizeVpcEndpointAccessResponseTypeDef(TypedDict):
AuthorizedPrincipal: AuthorizedPrincipalTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListVpcEndpointAccessResponseTypeDef#
# ListVpcEndpointAccessResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVpcEndpointAccessResponseTypeDef
def get_value() -> ListVpcEndpointAccessResponseTypeDef:
return {
"AuthorizedPrincipalList": ...,
}
# ListVpcEndpointAccessResponseTypeDef definition
class ListVpcEndpointAccessResponseTypeDef(TypedDict):
AuthorizedPrincipalList: List[AuthorizedPrincipalTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)AutoTuneDetailsTypeDef#
# AutoTuneDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneDetailsTypeDef
def get_value() -> AutoTuneDetailsTypeDef:
return {
"ScheduledAutoTuneDetails": ...,
}
# AutoTuneDetailsTypeDef definition
class AutoTuneDetailsTypeDef(TypedDict):
ScheduledAutoTuneDetails: NotRequired[ScheduledAutoTuneDetailsTypeDef], # (1)AutoTuneMaintenanceScheduleOutputTypeDef#
# AutoTuneMaintenanceScheduleOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneMaintenanceScheduleOutputTypeDef
def get_value() -> AutoTuneMaintenanceScheduleOutputTypeDef:
return {
"StartAt": ...,
}
# AutoTuneMaintenanceScheduleOutputTypeDef definition
class AutoTuneMaintenanceScheduleOutputTypeDef(TypedDict):
StartAt: NotRequired[datetime],
Duration: NotRequired[DurationTypeDef], # (1)
CronExpressionForRecurrence: NotRequired[str],- See DurationTypeDef
AutoTuneMaintenanceScheduleTypeDef#
# AutoTuneMaintenanceScheduleTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneMaintenanceScheduleTypeDef
def get_value() -> AutoTuneMaintenanceScheduleTypeDef:
return {
"StartAt": ...,
}
# AutoTuneMaintenanceScheduleTypeDef definition
class AutoTuneMaintenanceScheduleTypeDef(TypedDict):
StartAt: NotRequired[TimestampTypeDef],
Duration: NotRequired[DurationTypeDef], # (1)
CronExpressionForRecurrence: NotRequired[str],- See DurationTypeDef
EnvironmentInfoTypeDef#
# EnvironmentInfoTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import EnvironmentInfoTypeDef
def get_value() -> EnvironmentInfoTypeDef:
return {
"AvailabilityZoneInformation": ...,
}
# EnvironmentInfoTypeDef definition
class EnvironmentInfoTypeDef(TypedDict):
AvailabilityZoneInformation: NotRequired[List[AvailabilityZoneInfoTypeDef]], # (1)CancelDomainConfigChangeResponseTypeDef#
# CancelDomainConfigChangeResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CancelDomainConfigChangeResponseTypeDef
def get_value() -> CancelDomainConfigChangeResponseTypeDef:
return {
"CancelledChangeIds": ...,
}
# CancelDomainConfigChangeResponseTypeDef definition
class CancelDomainConfigChangeResponseTypeDef(TypedDict):
CancelledChangeIds: List[str],
CancelledChangeProperties: List[CancelledChangePropertyTypeDef], # (1)
DryRun: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CancelServiceSoftwareUpdateResponseTypeDef#
# CancelServiceSoftwareUpdateResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CancelServiceSoftwareUpdateResponseTypeDef
def get_value() -> CancelServiceSoftwareUpdateResponseTypeDef:
return {
"ServiceSoftwareOptions": ...,
}
# CancelServiceSoftwareUpdateResponseTypeDef definition
class CancelServiceSoftwareUpdateResponseTypeDef(TypedDict):
ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)StartServiceSoftwareUpdateResponseTypeDef#
# StartServiceSoftwareUpdateResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import StartServiceSoftwareUpdateResponseTypeDef
def get_value() -> StartServiceSoftwareUpdateResponseTypeDef:
return {
"ServiceSoftwareOptions": ...,
}
# StartServiceSoftwareUpdateResponseTypeDef definition
class StartServiceSoftwareUpdateResponseTypeDef(TypedDict):
ServiceSoftwareOptions: ServiceSoftwareOptionsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpgradeDomainResponseTypeDef#
# UpgradeDomainResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpgradeDomainResponseTypeDef
def get_value() -> UpgradeDomainResponseTypeDef:
return {
"UpgradeId": ...,
}
# UpgradeDomainResponseTypeDef definition
class UpgradeDomainResponseTypeDef(TypedDict):
UpgradeId: str,
DomainName: str,
TargetVersion: str,
PerformCheckOnly: bool,
AdvancedOptions: Dict[str, str],
ChangeProgressDetails: ChangeProgressDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ChangeProgressStatusDetailsTypeDef#
# ChangeProgressStatusDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ChangeProgressStatusDetailsTypeDef
def get_value() -> ChangeProgressStatusDetailsTypeDef:
return {
"ChangeId": ...,
}
# ChangeProgressStatusDetailsTypeDef definition
class ChangeProgressStatusDetailsTypeDef(TypedDict):
ChangeId: NotRequired[str],
StartTime: NotRequired[datetime],
Status: NotRequired[OverallChangeStatusType], # (1)
PendingProperties: NotRequired[List[str]],
CompletedProperties: NotRequired[List[str]],
TotalNumberOfStages: NotRequired[int],
ChangeProgressStages: NotRequired[List[ChangeProgressStageTypeDef]], # (2)
LastUpdatedTime: NotRequired[datetime],
ConfigChangeStatus: NotRequired[ConfigChangeStatusType], # (3)
InitiatedBy: NotRequired[InitiatedByType], # (4)- See OverallChangeStatusType
- See ChangeProgressStageTypeDef
- See ConfigChangeStatusType
- See InitiatedByType
CognitoOptionsStatusTypeDef#
# CognitoOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CognitoOptionsStatusTypeDef
def get_value() -> CognitoOptionsStatusTypeDef:
return {
"Options": ...,
}
# CognitoOptionsStatusTypeDef definition
class CognitoOptionsStatusTypeDef(TypedDict):
Options: CognitoOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)GetCompatibleVersionsResponseTypeDef#
# GetCompatibleVersionsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetCompatibleVersionsResponseTypeDef
def get_value() -> GetCompatibleVersionsResponseTypeDef:
return {
"CompatibleVersions": ...,
}
# GetCompatibleVersionsResponseTypeDef definition
class GetCompatibleVersionsResponseTypeDef(TypedDict):
CompatibleVersions: List[CompatibleVersionsMapTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ConnectionPropertiesTypeDef#
# ConnectionPropertiesTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ConnectionPropertiesTypeDef
def get_value() -> ConnectionPropertiesTypeDef:
return {
"Endpoint": ...,
}
# ConnectionPropertiesTypeDef definition
class ConnectionPropertiesTypeDef(TypedDict):
Endpoint: NotRequired[str],
CrossClusterSearch: NotRequired[CrossClusterSearchConnectionPropertiesTypeDef], # (1)UpdateApplicationRequestTypeDef#
# UpdateApplicationRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateApplicationRequestTypeDef
def get_value() -> UpdateApplicationRequestTypeDef:
return {
"id": ...,
}
# UpdateApplicationRequestTypeDef definition
class UpdateApplicationRequestTypeDef(TypedDict):
id: str,
dataSources: NotRequired[Sequence[DataSourceTypeDef]], # (1)
appConfigs: NotRequired[Sequence[AppConfigTypeDef]], # (2)- See DataSourceTypeDef
- See AppConfigTypeDef
CreateApplicationRequestTypeDef#
# CreateApplicationRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateApplicationRequestTypeDef
def get_value() -> CreateApplicationRequestTypeDef:
return {
"name": ...,
}
# CreateApplicationRequestTypeDef definition
class CreateApplicationRequestTypeDef(TypedDict):
name: str,
clientToken: NotRequired[str],
dataSources: NotRequired[Sequence[DataSourceTypeDef]], # (1)
iamIdentityCenterOptions: NotRequired[IamIdentityCenterOptionsInputTypeDef], # (2)
appConfigs: NotRequired[Sequence[AppConfigTypeDef]], # (3)
tagList: NotRequired[Sequence[TagTypeDef]], # (4)CreateApplicationResponseTypeDef#
# CreateApplicationResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateApplicationResponseTypeDef
def get_value() -> CreateApplicationResponseTypeDef:
return {
"id": ...,
}
# CreateApplicationResponseTypeDef definition
class CreateApplicationResponseTypeDef(TypedDict):
id: str,
name: str,
arn: str,
dataSources: List[DataSourceTypeDef], # (1)
iamIdentityCenterOptions: IamIdentityCenterOptionsTypeDef, # (2)
appConfigs: List[AppConfigTypeDef], # (3)
tagList: List[TagTypeDef], # (4)
createdAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See DataSourceTypeDef
- See IamIdentityCenterOptionsTypeDef
- See AppConfigTypeDef
- See TagTypeDef
- See ResponseMetadataTypeDef
GetApplicationResponseTypeDef#
# GetApplicationResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetApplicationResponseTypeDef
def get_value() -> GetApplicationResponseTypeDef:
return {
"id": ...,
}
# GetApplicationResponseTypeDef definition
class GetApplicationResponseTypeDef(TypedDict):
id: str,
arn: str,
name: str,
endpoint: str,
status: ApplicationStatusType, # (1)
iamIdentityCenterOptions: IamIdentityCenterOptionsTypeDef, # (2)
dataSources: List[DataSourceTypeDef], # (3)
appConfigs: List[AppConfigTypeDef], # (4)
createdAt: datetime,
lastUpdatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See ApplicationStatusType
- See IamIdentityCenterOptionsTypeDef
- See DataSourceTypeDef
- See AppConfigTypeDef
- See ResponseMetadataTypeDef
UpdateApplicationResponseTypeDef#
# UpdateApplicationResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateApplicationResponseTypeDef
def get_value() -> UpdateApplicationResponseTypeDef:
return {
"id": ...,
}
# UpdateApplicationResponseTypeDef definition
class UpdateApplicationResponseTypeDef(TypedDict):
id: str,
name: str,
arn: str,
dataSources: List[DataSourceTypeDef], # (1)
iamIdentityCenterOptions: IamIdentityCenterOptionsTypeDef, # (2)
appConfigs: List[AppConfigTypeDef], # (3)
createdAt: datetime,
lastUpdatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See DataSourceTypeDef
- See IamIdentityCenterOptionsTypeDef
- See AppConfigTypeDef
- See ResponseMetadataTypeDef
DomainEndpointOptionsStatusTypeDef#
# DomainEndpointOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainEndpointOptionsStatusTypeDef
def get_value() -> DomainEndpointOptionsStatusTypeDef:
return {
"Options": ...,
}
# DomainEndpointOptionsStatusTypeDef definition
class DomainEndpointOptionsStatusTypeDef(TypedDict):
Options: DomainEndpointOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)EBSOptionsStatusTypeDef#
# EBSOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import EBSOptionsStatusTypeDef
def get_value() -> EBSOptionsStatusTypeDef:
return {
"Options": ...,
}
# EBSOptionsStatusTypeDef definition
class EBSOptionsStatusTypeDef(TypedDict):
Options: EBSOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)- See EBSOptionsTypeDef
- See OptionStatusTypeDef
EncryptionAtRestOptionsStatusTypeDef#
# EncryptionAtRestOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import EncryptionAtRestOptionsStatusTypeDef
def get_value() -> EncryptionAtRestOptionsStatusTypeDef:
return {
"Options": ...,
}
# EncryptionAtRestOptionsStatusTypeDef definition
class EncryptionAtRestOptionsStatusTypeDef(TypedDict):
Options: EncryptionAtRestOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)LogPublishingOptionsStatusTypeDef#
# LogPublishingOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import LogPublishingOptionsStatusTypeDef
def get_value() -> LogPublishingOptionsStatusTypeDef:
return {
"Options": ...,
}
# LogPublishingOptionsStatusTypeDef definition
class LogPublishingOptionsStatusTypeDef(TypedDict):
Options: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]], # (1)
Status: NotRequired[OptionStatusTypeDef], # (2)NodeToNodeEncryptionOptionsStatusTypeDef#
# NodeToNodeEncryptionOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import NodeToNodeEncryptionOptionsStatusTypeDef
def get_value() -> NodeToNodeEncryptionOptionsStatusTypeDef:
return {
"Options": ...,
}
# NodeToNodeEncryptionOptionsStatusTypeDef definition
class NodeToNodeEncryptionOptionsStatusTypeDef(TypedDict):
Options: NodeToNodeEncryptionOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)SnapshotOptionsStatusTypeDef#
# SnapshotOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SnapshotOptionsStatusTypeDef
def get_value() -> SnapshotOptionsStatusTypeDef:
return {
"Options": ...,
}
# SnapshotOptionsStatusTypeDef definition
class SnapshotOptionsStatusTypeDef(TypedDict):
Options: SnapshotOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)SoftwareUpdateOptionsStatusTypeDef#
# SoftwareUpdateOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SoftwareUpdateOptionsStatusTypeDef
def get_value() -> SoftwareUpdateOptionsStatusTypeDef:
return {
"Options": ...,
}
# SoftwareUpdateOptionsStatusTypeDef definition
class SoftwareUpdateOptionsStatusTypeDef(TypedDict):
Options: NotRequired[SoftwareUpdateOptionsTypeDef], # (1)
Status: NotRequired[OptionStatusTypeDef], # (2)CreateVpcEndpointRequestTypeDef#
# CreateVpcEndpointRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateVpcEndpointRequestTypeDef
def get_value() -> CreateVpcEndpointRequestTypeDef:
return {
"DomainArn": ...,
}
# CreateVpcEndpointRequestTypeDef definition
class CreateVpcEndpointRequestTypeDef(TypedDict):
DomainArn: str,
VpcOptions: VPCOptionsTypeDef, # (1)
ClientToken: NotRequired[str],UpdateVpcEndpointRequestTypeDef#
# UpdateVpcEndpointRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateVpcEndpointRequestTypeDef
def get_value() -> UpdateVpcEndpointRequestTypeDef:
return {
"VpcEndpointId": ...,
}
# UpdateVpcEndpointRequestTypeDef definition
class UpdateVpcEndpointRequestTypeDef(TypedDict):
VpcEndpointId: str,
VpcOptions: VPCOptionsTypeDef, # (1)UpdatePackageRequestTypeDef#
# UpdatePackageRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdatePackageRequestTypeDef
def get_value() -> UpdatePackageRequestTypeDef:
return {
"PackageID": ...,
}
# UpdatePackageRequestTypeDef definition
class UpdatePackageRequestTypeDef(TypedDict):
PackageID: str,
PackageSource: PackageSourceTypeDef, # (1)
PackageDescription: NotRequired[str],
CommitMessage: NotRequired[str],
PackageConfiguration: NotRequired[PackageConfigurationTypeDef], # (2)
PackageEncryptionOptions: NotRequired[PackageEncryptionOptionsTypeDef], # (3)CreatePackageRequestTypeDef#
# CreatePackageRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreatePackageRequestTypeDef
def get_value() -> CreatePackageRequestTypeDef:
return {
"PackageName": ...,
}
# CreatePackageRequestTypeDef definition
class CreatePackageRequestTypeDef(TypedDict):
PackageName: str,
PackageType: PackageTypeType, # (1)
PackageSource: PackageSourceTypeDef, # (2)
PackageDescription: NotRequired[str],
PackageConfiguration: NotRequired[PackageConfigurationTypeDef], # (3)
EngineVersion: NotRequired[str],
PackageVendingOptions: NotRequired[PackageVendingOptionsTypeDef], # (4)
PackageEncryptionOptions: NotRequired[PackageEncryptionOptionsTypeDef], # (5)- See PackageTypeType
- See PackageSourceTypeDef
- See PackageConfigurationTypeDef
- See PackageVendingOptionsTypeDef
- See PackageEncryptionOptionsTypeDef
DataSourceTypeTypeDef#
# DataSourceTypeTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DataSourceTypeTypeDef
def get_value() -> DataSourceTypeTypeDef:
return {
"S3GlueDataCatalog": ...,
}
# DataSourceTypeTypeDef definition
class DataSourceTypeTypeDef(TypedDict):
S3GlueDataCatalog: NotRequired[S3GlueDataCatalogTypeDef], # (1)DeleteVpcEndpointResponseTypeDef#
# DeleteVpcEndpointResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteVpcEndpointResponseTypeDef
def get_value() -> DeleteVpcEndpointResponseTypeDef:
return {
"VpcEndpointSummary": ...,
}
# DeleteVpcEndpointResponseTypeDef definition
class DeleteVpcEndpointResponseTypeDef(TypedDict):
VpcEndpointSummary: VpcEndpointSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListVpcEndpointsForDomainResponseTypeDef#
# ListVpcEndpointsForDomainResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVpcEndpointsForDomainResponseTypeDef
def get_value() -> ListVpcEndpointsForDomainResponseTypeDef:
return {
"VpcEndpointSummaryList": ...,
}
# ListVpcEndpointsForDomainResponseTypeDef definition
class ListVpcEndpointsForDomainResponseTypeDef(TypedDict):
VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListVpcEndpointsResponseTypeDef#
# ListVpcEndpointsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListVpcEndpointsResponseTypeDef
def get_value() -> ListVpcEndpointsResponseTypeDef:
return {
"VpcEndpointSummaryList": ...,
}
# ListVpcEndpointsResponseTypeDef definition
class ListVpcEndpointsResponseTypeDef(TypedDict):
VpcEndpointSummaryList: List[VpcEndpointSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDomainNodesResponseTypeDef#
# DescribeDomainNodesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainNodesResponseTypeDef
def get_value() -> DescribeDomainNodesResponseTypeDef:
return {
"DomainNodesStatusList": ...,
}
# DescribeDomainNodesResponseTypeDef definition
class DescribeDomainNodesResponseTypeDef(TypedDict):
DomainNodesStatusList: List[DomainNodesStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeInboundConnectionsRequestTypeDef#
# DescribeInboundConnectionsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeInboundConnectionsRequestTypeDef
def get_value() -> DescribeInboundConnectionsRequestTypeDef:
return {
"Filters": ...,
}
# DescribeInboundConnectionsRequestTypeDef definition
class DescribeInboundConnectionsRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],- See FilterTypeDef
DescribeOutboundConnectionsRequestTypeDef#
# DescribeOutboundConnectionsRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeOutboundConnectionsRequestTypeDef
def get_value() -> DescribeOutboundConnectionsRequestTypeDef:
return {
"Filters": ...,
}
# DescribeOutboundConnectionsRequestTypeDef definition
class DescribeOutboundConnectionsRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],- See FilterTypeDef
DescribePackagesRequestTypeDef#
# DescribePackagesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribePackagesRequestTypeDef
def get_value() -> DescribePackagesRequestTypeDef:
return {
"Filters": ...,
}
# DescribePackagesRequestTypeDef definition
class DescribePackagesRequestTypeDef(TypedDict):
Filters: NotRequired[Sequence[DescribePackagesFilterTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],DirectQueryDataSourceTypeTypeDef#
# DirectQueryDataSourceTypeTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DirectQueryDataSourceTypeTypeDef
def get_value() -> DirectQueryDataSourceTypeTypeDef:
return {
"CloudWatchLog": ...,
}
# DirectQueryDataSourceTypeTypeDef definition
class DirectQueryDataSourceTypeTypeDef(TypedDict):
CloudWatchLog: NotRequired[CloudWatchDirectQueryDataSourceTypeDef], # (1)
SecurityLake: NotRequired[SecurityLakeDirectQueryDataSourceTypeDef], # (2)ListDomainNamesResponseTypeDef#
# ListDomainNamesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDomainNamesResponseTypeDef
def get_value() -> ListDomainNamesResponseTypeDef:
return {
"DomainNames": ...,
}
# ListDomainNamesResponseTypeDef definition
class ListDomainNamesResponseTypeDef(TypedDict):
DomainNames: List[DomainInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDomainMaintenancesResponseTypeDef#
# ListDomainMaintenancesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDomainMaintenancesResponseTypeDef
def get_value() -> ListDomainMaintenancesResponseTypeDef:
return {
"DomainMaintenances": ...,
}
# ListDomainMaintenancesResponseTypeDef definition
class ListDomainMaintenancesResponseTypeDef(TypedDict):
DomainMaintenances: List[DomainMaintenanceDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],IdentityCenterOptionsStatusTypeDef#
# IdentityCenterOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import IdentityCenterOptionsStatusTypeDef
def get_value() -> IdentityCenterOptionsStatusTypeDef:
return {
"Options": ...,
}
# IdentityCenterOptionsStatusTypeDef definition
class IdentityCenterOptionsStatusTypeDef(TypedDict):
Options: IdentityCenterOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)VPCDerivedInfoStatusTypeDef#
# VPCDerivedInfoStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VPCDerivedInfoStatusTypeDef
def get_value() -> VPCDerivedInfoStatusTypeDef:
return {
"Options": ...,
}
# VPCDerivedInfoStatusTypeDef definition
class VPCDerivedInfoStatusTypeDef(TypedDict):
Options: VPCDerivedInfoTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)VpcEndpointTypeDef#
# VpcEndpointTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import VpcEndpointTypeDef
def get_value() -> VpcEndpointTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointTypeDef definition
class VpcEndpointTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcEndpointOwner: NotRequired[str],
DomainArn: NotRequired[str],
VpcOptions: NotRequired[VPCDerivedInfoTypeDef], # (1)
Status: NotRequired[VpcEndpointStatusType], # (2)
Endpoint: NotRequired[str],DryRunProgressStatusTypeDef#
# DryRunProgressStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DryRunProgressStatusTypeDef
def get_value() -> DryRunProgressStatusTypeDef:
return {
"DryRunId": ...,
}
# DryRunProgressStatusTypeDef definition
class DryRunProgressStatusTypeDef(TypedDict):
DryRunId: str,
DryRunStatus: str,
CreationDate: str,
UpdateDate: str,
ValidationFailures: NotRequired[List[ValidationFailureTypeDef]], # (1)InstanceLimitsTypeDef#
# InstanceLimitsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import InstanceLimitsTypeDef
def get_value() -> InstanceLimitsTypeDef:
return {
"InstanceCountLimits": ...,
}
# InstanceLimitsTypeDef definition
class InstanceLimitsTypeDef(TypedDict):
InstanceCountLimits: NotRequired[InstanceCountLimitsTypeDef], # (1)ListInstanceTypeDetailsResponseTypeDef#
# ListInstanceTypeDetailsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListInstanceTypeDetailsResponseTypeDef
def get_value() -> ListInstanceTypeDetailsResponseTypeDef:
return {
"InstanceTypeDetails": ...,
}
# ListInstanceTypeDetailsResponseTypeDef definition
class ListInstanceTypeDetailsResponseTypeDef(TypedDict):
InstanceTypeDetails: List[InstanceTypeDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],PackageAssociationConfigurationTypeDef#
# PackageAssociationConfigurationTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageAssociationConfigurationTypeDef
def get_value() -> PackageAssociationConfigurationTypeDef:
return {
"KeyStoreAccessOption": ...,
}
# PackageAssociationConfigurationTypeDef definition
class PackageAssociationConfigurationTypeDef(TypedDict):
KeyStoreAccessOption: NotRequired[KeyStoreAccessOptionTypeDef], # (1)ListApplicationsRequestPaginateTypeDef#
# ListApplicationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListApplicationsRequestPaginateTypeDef
def get_value() -> ListApplicationsRequestPaginateTypeDef:
return {
"statuses": ...,
}
# ListApplicationsRequestPaginateTypeDef definition
class ListApplicationsRequestPaginateTypeDef(TypedDict):
statuses: NotRequired[Sequence[ApplicationStatusType]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListScheduledActionsResponseTypeDef#
# ListScheduledActionsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListScheduledActionsResponseTypeDef
def get_value() -> ListScheduledActionsResponseTypeDef:
return {
"ScheduledActions": ...,
}
# ListScheduledActionsResponseTypeDef definition
class ListScheduledActionsResponseTypeDef(TypedDict):
ScheduledActions: List[ScheduledActionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdateScheduledActionResponseTypeDef#
# UpdateScheduledActionResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateScheduledActionResponseTypeDef
def get_value() -> UpdateScheduledActionResponseTypeDef:
return {
"ScheduledAction": ...,
}
# UpdateScheduledActionResponseTypeDef definition
class UpdateScheduledActionResponseTypeDef(TypedDict):
ScheduledAction: ScheduledActionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)NodeOptionTypeDef#
# NodeOptionTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import NodeOptionTypeDef
def get_value() -> NodeOptionTypeDef:
return {
"NodeType": ...,
}
# NodeOptionTypeDef definition
class NodeOptionTypeDef(TypedDict):
NodeType: NotRequired[NodeOptionsNodeTypeType], # (1)
NodeConfig: NotRequired[NodeConfigTypeDef], # (2)OffPeakWindowTypeDef#
# OffPeakWindowTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import OffPeakWindowTypeDef
def get_value() -> OffPeakWindowTypeDef:
return {
"WindowStartTime": ...,
}
# OffPeakWindowTypeDef definition
class OffPeakWindowTypeDef(TypedDict):
WindowStartTime: NotRequired[WindowStartTimeTypeDef], # (1)PackageDetailsTypeDef#
# PackageDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageDetailsTypeDef
def get_value() -> PackageDetailsTypeDef:
return {
"PackageID": ...,
}
# PackageDetailsTypeDef definition
class PackageDetailsTypeDef(TypedDict):
PackageID: NotRequired[str],
PackageName: NotRequired[str],
PackageType: NotRequired[PackageTypeType], # (1)
PackageDescription: NotRequired[str],
PackageStatus: NotRequired[PackageStatusType], # (2)
CreatedAt: NotRequired[datetime],
LastUpdatedAt: NotRequired[datetime],
AvailablePackageVersion: NotRequired[str],
ErrorDetails: NotRequired[ErrorDetailsTypeDef], # (3)
EngineVersion: NotRequired[str],
AvailablePluginProperties: NotRequired[PluginPropertiesTypeDef], # (4)
AvailablePackageConfiguration: NotRequired[PackageConfigurationTypeDef], # (5)
AllowListedUserList: NotRequired[List[str]],
PackageOwner: NotRequired[str],
PackageVendingOptions: NotRequired[PackageVendingOptionsTypeDef], # (6)
PackageEncryptionOptions: NotRequired[PackageEncryptionOptionsTypeDef], # (7)- See PackageTypeType
- See PackageStatusType
- See ErrorDetailsTypeDef
- See PluginPropertiesTypeDef
- See PackageConfigurationTypeDef
- See PackageVendingOptionsTypeDef
- See PackageEncryptionOptionsTypeDef
PackageVersionHistoryTypeDef#
# PackageVersionHistoryTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageVersionHistoryTypeDef
def get_value() -> PackageVersionHistoryTypeDef:
return {
"PackageVersion": ...,
}
# PackageVersionHistoryTypeDef definition
class PackageVersionHistoryTypeDef(TypedDict):
PackageVersion: NotRequired[str],
CommitMessage: NotRequired[str],
CreatedAt: NotRequired[datetime],
PluginProperties: NotRequired[PluginPropertiesTypeDef], # (1)
PackageConfiguration: NotRequired[PackageConfigurationTypeDef], # (2)ReservedInstanceOfferingTypeDef#
# ReservedInstanceOfferingTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ReservedInstanceOfferingTypeDef
def get_value() -> ReservedInstanceOfferingTypeDef:
return {
"ReservedInstanceOfferingId": ...,
}
# ReservedInstanceOfferingTypeDef definition
class ReservedInstanceOfferingTypeDef(TypedDict):
ReservedInstanceOfferingId: NotRequired[str],
InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
Duration: NotRequired[int],
FixedPrice: NotRequired[float],
UsagePrice: NotRequired[float],
CurrencyCode: NotRequired[str],
PaymentOption: NotRequired[ReservedInstancePaymentOptionType], # (2)
RecurringCharges: NotRequired[List[RecurringChargeTypeDef]], # (3)- See OpenSearchPartitionInstanceTypeType
- See ReservedInstancePaymentOptionType
- See RecurringChargeTypeDef
ReservedInstanceTypeDef#
# ReservedInstanceTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ReservedInstanceTypeDef
def get_value() -> ReservedInstanceTypeDef:
return {
"ReservationName": ...,
}
# ReservedInstanceTypeDef definition
class ReservedInstanceTypeDef(TypedDict):
ReservationName: NotRequired[str],
ReservedInstanceId: NotRequired[str],
BillingSubscriptionId: NotRequired[int],
ReservedInstanceOfferingId: NotRequired[str],
InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
StartTime: NotRequired[datetime],
Duration: NotRequired[int],
FixedPrice: NotRequired[float],
UsagePrice: NotRequired[float],
CurrencyCode: NotRequired[str],
InstanceCount: NotRequired[int],
State: NotRequired[str],
PaymentOption: NotRequired[ReservedInstancePaymentOptionType], # (2)
RecurringCharges: NotRequired[List[RecurringChargeTypeDef]], # (3)- See OpenSearchPartitionInstanceTypeType
- See ReservedInstancePaymentOptionType
- See RecurringChargeTypeDef
SAMLOptionsInputTypeDef#
# SAMLOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SAMLOptionsInputTypeDef
def get_value() -> SAMLOptionsInputTypeDef:
return {
"Enabled": ...,
}
# SAMLOptionsInputTypeDef definition
class SAMLOptionsInputTypeDef(TypedDict):
Enabled: NotRequired[bool],
Idp: NotRequired[SAMLIdpTypeDef], # (1)
MasterUserName: NotRequired[str],
MasterBackendRole: NotRequired[str],
SubjectKey: NotRequired[str],
RolesKey: NotRequired[str],
SessionTimeoutMinutes: NotRequired[int],- See SAMLIdpTypeDef
SAMLOptionsOutputTypeDef#
# SAMLOptionsOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import SAMLOptionsOutputTypeDef
def get_value() -> SAMLOptionsOutputTypeDef:
return {
"Enabled": ...,
}
# SAMLOptionsOutputTypeDef definition
class SAMLOptionsOutputTypeDef(TypedDict):
Enabled: NotRequired[bool],
Idp: NotRequired[SAMLIdpTypeDef], # (1)
SubjectKey: NotRequired[str],
RolesKey: NotRequired[str],
SessionTimeoutMinutes: NotRequired[int],- See SAMLIdpTypeDef
StorageTypeTypeDef#
# StorageTypeTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import StorageTypeTypeDef
def get_value() -> StorageTypeTypeDef:
return {
"StorageTypeName": ...,
}
# StorageTypeTypeDef definition
class StorageTypeTypeDef(TypedDict):
StorageTypeName: NotRequired[str],
StorageSubTypeName: NotRequired[str],
StorageTypeLimits: NotRequired[List[StorageTypeLimitTypeDef]], # (1)UpgradeHistoryTypeDef#
# UpgradeHistoryTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpgradeHistoryTypeDef
def get_value() -> UpgradeHistoryTypeDef:
return {
"UpgradeName": ...,
}
# UpgradeHistoryTypeDef definition
class UpgradeHistoryTypeDef(TypedDict):
UpgradeName: NotRequired[str],
StartTimestamp: NotRequired[datetime],
UpgradeStatus: NotRequired[UpgradeStatusType], # (1)
StepsList: NotRequired[List[UpgradeStepItemTypeDef]], # (2)AIMLOptionsStatusTypeDef#
# AIMLOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AIMLOptionsStatusTypeDef
def get_value() -> AIMLOptionsStatusTypeDef:
return {
"Options": ...,
}
# AIMLOptionsStatusTypeDef definition
class AIMLOptionsStatusTypeDef(TypedDict):
Options: NotRequired[AIMLOptionsOutputTypeDef], # (1)
Status: NotRequired[OptionStatusTypeDef], # (2)InboundConnectionTypeDef#
# InboundConnectionTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import InboundConnectionTypeDef
def get_value() -> InboundConnectionTypeDef:
return {
"LocalDomainInfo": ...,
}
# InboundConnectionTypeDef definition
class InboundConnectionTypeDef(TypedDict):
LocalDomainInfo: NotRequired[DomainInformationContainerTypeDef], # (1)
RemoteDomainInfo: NotRequired[DomainInformationContainerTypeDef], # (1)
ConnectionId: NotRequired[str],
ConnectionStatus: NotRequired[InboundConnectionStatusTypeDef], # (3)
ConnectionMode: NotRequired[ConnectionModeType], # (4)- See DomainInformationContainerTypeDef
- See DomainInformationContainerTypeDef
- See InboundConnectionStatusTypeDef
- See ConnectionModeType
AutoTuneTypeDef#
# AutoTuneTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneTypeDef
def get_value() -> AutoTuneTypeDef:
return {
"AutoTuneType": ...,
}
# AutoTuneTypeDef definition
class AutoTuneTypeDef(TypedDict):
AutoTuneType: NotRequired[AutoTuneTypeType], # (1)
AutoTuneDetails: NotRequired[AutoTuneDetailsTypeDef], # (2)AutoTuneOptionsExtraTypeDef#
# AutoTuneOptionsExtraTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneOptionsExtraTypeDef
def get_value() -> AutoTuneOptionsExtraTypeDef:
return {
"DesiredState": ...,
}
# AutoTuneOptionsExtraTypeDef definition
class AutoTuneOptionsExtraTypeDef(TypedDict):
DesiredState: NotRequired[AutoTuneDesiredStateType], # (1)
RollbackOnDisable: NotRequired[RollbackOnDisableType], # (2)
MaintenanceSchedules: NotRequired[List[AutoTuneMaintenanceScheduleOutputTypeDef]], # (3)
UseOffPeakWindow: NotRequired[bool],AutoTuneOptionsTypeDef#
# AutoTuneOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneOptionsTypeDef
def get_value() -> AutoTuneOptionsTypeDef:
return {
"DesiredState": ...,
}
# AutoTuneOptionsTypeDef definition
class AutoTuneOptionsTypeDef(TypedDict):
DesiredState: NotRequired[AutoTuneDesiredStateType], # (1)
RollbackOnDisable: NotRequired[RollbackOnDisableType], # (2)
MaintenanceSchedules: NotRequired[Sequence[AutoTuneMaintenanceScheduleTypeDef]], # (3)
UseOffPeakWindow: NotRequired[bool],DescribeDomainHealthResponseTypeDef#
# DescribeDomainHealthResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainHealthResponseTypeDef
def get_value() -> DescribeDomainHealthResponseTypeDef:
return {
"DomainState": ...,
}
# DescribeDomainHealthResponseTypeDef definition
class DescribeDomainHealthResponseTypeDef(TypedDict):
DomainState: DomainStateType, # (1)
AvailabilityZoneCount: str,
ActiveAvailabilityZoneCount: str,
StandByAvailabilityZoneCount: str,
DataNodeCount: str,
DedicatedMaster: bool,
MasterEligibleNodeCount: str,
WarmNodeCount: str,
MasterNode: MasterNodeStatusType, # (2)
ClusterHealth: DomainHealthType, # (3)
TotalShards: str,
TotalUnAssignedShards: str,
EnvironmentInformation: List[EnvironmentInfoTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See DomainStateType
- See MasterNodeStatusType
- See DomainHealthType
- See EnvironmentInfoTypeDef
- See ResponseMetadataTypeDef
DescribeDomainChangeProgressResponseTypeDef#
# DescribeDomainChangeProgressResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainChangeProgressResponseTypeDef
def get_value() -> DescribeDomainChangeProgressResponseTypeDef:
return {
"ChangeProgressStatus": ...,
}
# DescribeDomainChangeProgressResponseTypeDef definition
class DescribeDomainChangeProgressResponseTypeDef(TypedDict):
ChangeProgressStatus: ChangeProgressStatusDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateOutboundConnectionRequestTypeDef#
# CreateOutboundConnectionRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateOutboundConnectionRequestTypeDef
def get_value() -> CreateOutboundConnectionRequestTypeDef:
return {
"LocalDomainInfo": ...,
}
# CreateOutboundConnectionRequestTypeDef definition
class CreateOutboundConnectionRequestTypeDef(TypedDict):
LocalDomainInfo: DomainInformationContainerTypeDef, # (1)
RemoteDomainInfo: DomainInformationContainerTypeDef, # (1)
ConnectionAlias: str,
ConnectionMode: NotRequired[ConnectionModeType], # (3)
ConnectionProperties: NotRequired[ConnectionPropertiesTypeDef], # (4)- See DomainInformationContainerTypeDef
- See DomainInformationContainerTypeDef
- See ConnectionModeType
- See ConnectionPropertiesTypeDef
CreateOutboundConnectionResponseTypeDef#
# CreateOutboundConnectionResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateOutboundConnectionResponseTypeDef
def get_value() -> CreateOutboundConnectionResponseTypeDef:
return {
"LocalDomainInfo": ...,
}
# CreateOutboundConnectionResponseTypeDef definition
class CreateOutboundConnectionResponseTypeDef(TypedDict):
LocalDomainInfo: DomainInformationContainerTypeDef, # (1)
RemoteDomainInfo: DomainInformationContainerTypeDef, # (1)
ConnectionAlias: str,
ConnectionStatus: OutboundConnectionStatusTypeDef, # (3)
ConnectionId: str,
ConnectionMode: ConnectionModeType, # (4)
ConnectionProperties: ConnectionPropertiesTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See DomainInformationContainerTypeDef
- See DomainInformationContainerTypeDef
- See OutboundConnectionStatusTypeDef
- See ConnectionModeType
- See ConnectionPropertiesTypeDef
- See ResponseMetadataTypeDef
OutboundConnectionTypeDef#
# OutboundConnectionTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import OutboundConnectionTypeDef
def get_value() -> OutboundConnectionTypeDef:
return {
"LocalDomainInfo": ...,
}
# OutboundConnectionTypeDef definition
class OutboundConnectionTypeDef(TypedDict):
LocalDomainInfo: NotRequired[DomainInformationContainerTypeDef], # (1)
RemoteDomainInfo: NotRequired[DomainInformationContainerTypeDef], # (1)
ConnectionId: NotRequired[str],
ConnectionAlias: NotRequired[str],
ConnectionStatus: NotRequired[OutboundConnectionStatusTypeDef], # (3)
ConnectionMode: NotRequired[ConnectionModeType], # (4)
ConnectionProperties: NotRequired[ConnectionPropertiesTypeDef], # (5)- See DomainInformationContainerTypeDef
- See DomainInformationContainerTypeDef
- See OutboundConnectionStatusTypeDef
- See ConnectionModeType
- See ConnectionPropertiesTypeDef
AddDataSourceRequestTypeDef#
# AddDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AddDataSourceRequestTypeDef
def get_value() -> AddDataSourceRequestTypeDef:
return {
"DomainName": ...,
}
# AddDataSourceRequestTypeDef definition
class AddDataSourceRequestTypeDef(TypedDict):
DomainName: str,
Name: str,
DataSourceType: DataSourceTypeTypeDef, # (1)
Description: NotRequired[str],DataSourceDetailsTypeDef#
# DataSourceDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DataSourceDetailsTypeDef
def get_value() -> DataSourceDetailsTypeDef:
return {
"DataSourceType": ...,
}
# DataSourceDetailsTypeDef definition
class DataSourceDetailsTypeDef(TypedDict):
DataSourceType: NotRequired[DataSourceTypeTypeDef], # (1)
Name: NotRequired[str],
Description: NotRequired[str],
Status: NotRequired[DataSourceStatusType], # (2)GetDataSourceResponseTypeDef#
# GetDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetDataSourceResponseTypeDef
def get_value() -> GetDataSourceResponseTypeDef:
return {
"DataSourceType": ...,
}
# GetDataSourceResponseTypeDef definition
class GetDataSourceResponseTypeDef(TypedDict):
DataSourceType: DataSourceTypeTypeDef, # (1)
Name: str,
Description: str,
Status: DataSourceStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateDataSourceRequestTypeDef#
# UpdateDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateDataSourceRequestTypeDef
def get_value() -> UpdateDataSourceRequestTypeDef:
return {
"DomainName": ...,
}
# UpdateDataSourceRequestTypeDef definition
class UpdateDataSourceRequestTypeDef(TypedDict):
DomainName: str,
Name: str,
DataSourceType: DataSourceTypeTypeDef, # (1)
Description: NotRequired[str],
Status: NotRequired[DataSourceStatusType], # (2)AddDirectQueryDataSourceRequestTypeDef#
# AddDirectQueryDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AddDirectQueryDataSourceRequestTypeDef
def get_value() -> AddDirectQueryDataSourceRequestTypeDef:
return {
"DataSourceName": ...,
}
# AddDirectQueryDataSourceRequestTypeDef definition
class AddDirectQueryDataSourceRequestTypeDef(TypedDict):
DataSourceName: str,
DataSourceType: DirectQueryDataSourceTypeTypeDef, # (1)
OpenSearchArns: Sequence[str],
Description: NotRequired[str],
TagList: NotRequired[Sequence[TagTypeDef]], # (2)DirectQueryDataSourceTypeDef#
# DirectQueryDataSourceTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DirectQueryDataSourceTypeDef
def get_value() -> DirectQueryDataSourceTypeDef:
return {
"DataSourceName": ...,
}
# DirectQueryDataSourceTypeDef definition
class DirectQueryDataSourceTypeDef(TypedDict):
DataSourceName: NotRequired[str],
DataSourceType: NotRequired[DirectQueryDataSourceTypeTypeDef], # (1)
Description: NotRequired[str],
OpenSearchArns: NotRequired[List[str]],
DataSourceArn: NotRequired[str],
TagList: NotRequired[List[TagTypeDef]], # (2)GetDirectQueryDataSourceResponseTypeDef#
# GetDirectQueryDataSourceResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetDirectQueryDataSourceResponseTypeDef
def get_value() -> GetDirectQueryDataSourceResponseTypeDef:
return {
"DataSourceName": ...,
}
# GetDirectQueryDataSourceResponseTypeDef definition
class GetDirectQueryDataSourceResponseTypeDef(TypedDict):
DataSourceName: str,
DataSourceType: DirectQueryDataSourceTypeTypeDef, # (1)
Description: str,
OpenSearchArns: List[str],
DataSourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateDirectQueryDataSourceRequestTypeDef#
# UpdateDirectQueryDataSourceRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateDirectQueryDataSourceRequestTypeDef
def get_value() -> UpdateDirectQueryDataSourceRequestTypeDef:
return {
"DataSourceName": ...,
}
# UpdateDirectQueryDataSourceRequestTypeDef definition
class UpdateDirectQueryDataSourceRequestTypeDef(TypedDict):
DataSourceName: str,
DataSourceType: DirectQueryDataSourceTypeTypeDef, # (1)
OpenSearchArns: Sequence[str],
Description: NotRequired[str],CreateVpcEndpointResponseTypeDef#
# CreateVpcEndpointResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateVpcEndpointResponseTypeDef
def get_value() -> CreateVpcEndpointResponseTypeDef:
return {
"VpcEndpoint": ...,
}
# CreateVpcEndpointResponseTypeDef definition
class CreateVpcEndpointResponseTypeDef(TypedDict):
VpcEndpoint: VpcEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeVpcEndpointsResponseTypeDef#
# DescribeVpcEndpointsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeVpcEndpointsResponseTypeDef
def get_value() -> DescribeVpcEndpointsResponseTypeDef:
return {
"VpcEndpoints": ...,
}
# DescribeVpcEndpointsResponseTypeDef definition
class DescribeVpcEndpointsResponseTypeDef(TypedDict):
VpcEndpoints: List[VpcEndpointTypeDef], # (1)
VpcEndpointErrors: List[VpcEndpointErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateVpcEndpointResponseTypeDef#
# UpdateVpcEndpointResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateVpcEndpointResponseTypeDef
def get_value() -> UpdateVpcEndpointResponseTypeDef:
return {
"VpcEndpoint": ...,
}
# UpdateVpcEndpointResponseTypeDef definition
class UpdateVpcEndpointResponseTypeDef(TypedDict):
VpcEndpoint: VpcEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)AssociatePackageRequestTypeDef#
# AssociatePackageRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AssociatePackageRequestTypeDef
def get_value() -> AssociatePackageRequestTypeDef:
return {
"PackageID": ...,
}
# AssociatePackageRequestTypeDef definition
class AssociatePackageRequestTypeDef(TypedDict):
PackageID: str,
DomainName: str,
PrerequisitePackageIDList: NotRequired[Sequence[str]],
AssociationConfiguration: NotRequired[PackageAssociationConfigurationTypeDef], # (1)DomainPackageDetailsTypeDef#
# DomainPackageDetailsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainPackageDetailsTypeDef
def get_value() -> DomainPackageDetailsTypeDef:
return {
"PackageID": ...,
}
# DomainPackageDetailsTypeDef definition
class DomainPackageDetailsTypeDef(TypedDict):
PackageID: NotRequired[str],
PackageName: NotRequired[str],
PackageType: NotRequired[PackageTypeType], # (1)
LastUpdated: NotRequired[datetime],
DomainName: NotRequired[str],
DomainPackageStatus: NotRequired[DomainPackageStatusType], # (2)
PackageVersion: NotRequired[str],
PrerequisitePackageIDList: NotRequired[List[str]],
ReferencePath: NotRequired[str],
ErrorDetails: NotRequired[ErrorDetailsTypeDef], # (3)
AssociationConfiguration: NotRequired[PackageAssociationConfigurationTypeDef], # (4)- See PackageTypeType
- See DomainPackageStatusType
- See ErrorDetailsTypeDef
- See PackageAssociationConfigurationTypeDef
PackageDetailsForAssociationTypeDef#
# PackageDetailsForAssociationTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import PackageDetailsForAssociationTypeDef
def get_value() -> PackageDetailsForAssociationTypeDef:
return {
"PackageID": ...,
}
# PackageDetailsForAssociationTypeDef definition
class PackageDetailsForAssociationTypeDef(TypedDict):
PackageID: str,
PrerequisitePackageIDList: NotRequired[Sequence[str]],
AssociationConfiguration: NotRequired[PackageAssociationConfigurationTypeDef], # (1)ClusterConfigOutputTypeDef#
# ClusterConfigOutputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ClusterConfigOutputTypeDef
def get_value() -> ClusterConfigOutputTypeDef:
return {
"InstanceType": ...,
}
# ClusterConfigOutputTypeDef definition
class ClusterConfigOutputTypeDef(TypedDict):
InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
InstanceCount: NotRequired[int],
DedicatedMasterEnabled: NotRequired[bool],
ZoneAwarenessEnabled: NotRequired[bool],
ZoneAwarenessConfig: NotRequired[ZoneAwarenessConfigTypeDef], # (2)
DedicatedMasterType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
DedicatedMasterCount: NotRequired[int],
WarmEnabled: NotRequired[bool],
WarmType: NotRequired[OpenSearchWarmPartitionInstanceTypeType], # (4)
WarmCount: NotRequired[int],
ColdStorageOptions: NotRequired[ColdStorageOptionsTypeDef], # (5)
MultiAZWithStandbyEnabled: NotRequired[bool],
NodeOptions: NotRequired[List[NodeOptionTypeDef]], # (6)- See OpenSearchPartitionInstanceTypeType
- See ZoneAwarenessConfigTypeDef
- See OpenSearchPartitionInstanceTypeType
- See OpenSearchWarmPartitionInstanceTypeType
- See ColdStorageOptionsTypeDef
- See NodeOptionTypeDef
ClusterConfigTypeDef#
# ClusterConfigTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ClusterConfigTypeDef
def get_value() -> ClusterConfigTypeDef:
return {
"InstanceType": ...,
}
# ClusterConfigTypeDef definition
class ClusterConfigTypeDef(TypedDict):
InstanceType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
InstanceCount: NotRequired[int],
DedicatedMasterEnabled: NotRequired[bool],
ZoneAwarenessEnabled: NotRequired[bool],
ZoneAwarenessConfig: NotRequired[ZoneAwarenessConfigTypeDef], # (2)
DedicatedMasterType: NotRequired[OpenSearchPartitionInstanceTypeType], # (1)
DedicatedMasterCount: NotRequired[int],
WarmEnabled: NotRequired[bool],
WarmType: NotRequired[OpenSearchWarmPartitionInstanceTypeType], # (4)
WarmCount: NotRequired[int],
ColdStorageOptions: NotRequired[ColdStorageOptionsTypeDef], # (5)
MultiAZWithStandbyEnabled: NotRequired[bool],
NodeOptions: NotRequired[Sequence[NodeOptionTypeDef]], # (6)- See OpenSearchPartitionInstanceTypeType
- See ZoneAwarenessConfigTypeDef
- See OpenSearchPartitionInstanceTypeType
- See OpenSearchWarmPartitionInstanceTypeType
- See ColdStorageOptionsTypeDef
- See NodeOptionTypeDef
OffPeakWindowOptionsTypeDef#
# OffPeakWindowOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import OffPeakWindowOptionsTypeDef
def get_value() -> OffPeakWindowOptionsTypeDef:
return {
"Enabled": ...,
}
# OffPeakWindowOptionsTypeDef definition
class OffPeakWindowOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
OffPeakWindow: NotRequired[OffPeakWindowTypeDef], # (1)CreatePackageResponseTypeDef#
# CreatePackageResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreatePackageResponseTypeDef
def get_value() -> CreatePackageResponseTypeDef:
return {
"PackageDetails": ...,
}
# CreatePackageResponseTypeDef definition
class CreatePackageResponseTypeDef(TypedDict):
PackageDetails: PackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeletePackageResponseTypeDef#
# DeletePackageResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeletePackageResponseTypeDef
def get_value() -> DeletePackageResponseTypeDef:
return {
"PackageDetails": ...,
}
# DeletePackageResponseTypeDef definition
class DeletePackageResponseTypeDef(TypedDict):
PackageDetails: PackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribePackagesResponseTypeDef#
# DescribePackagesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribePackagesResponseTypeDef
def get_value() -> DescribePackagesResponseTypeDef:
return {
"PackageDetailsList": ...,
}
# DescribePackagesResponseTypeDef definition
class DescribePackagesResponseTypeDef(TypedDict):
PackageDetailsList: List[PackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],UpdatePackageResponseTypeDef#
# UpdatePackageResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdatePackageResponseTypeDef
def get_value() -> UpdatePackageResponseTypeDef:
return {
"PackageDetails": ...,
}
# UpdatePackageResponseTypeDef definition
class UpdatePackageResponseTypeDef(TypedDict):
PackageDetails: PackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetPackageVersionHistoryResponseTypeDef#
# GetPackageVersionHistoryResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetPackageVersionHistoryResponseTypeDef
def get_value() -> GetPackageVersionHistoryResponseTypeDef:
return {
"PackageID": ...,
}
# GetPackageVersionHistoryResponseTypeDef definition
class GetPackageVersionHistoryResponseTypeDef(TypedDict):
PackageID: str,
PackageVersionHistoryList: List[PackageVersionHistoryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeReservedInstanceOfferingsResponseTypeDef#
# DescribeReservedInstanceOfferingsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeReservedInstanceOfferingsResponseTypeDef
def get_value() -> DescribeReservedInstanceOfferingsResponseTypeDef:
return {
"NextToken": ...,
}
# DescribeReservedInstanceOfferingsResponseTypeDef definition
class DescribeReservedInstanceOfferingsResponseTypeDef(TypedDict):
ReservedInstanceOfferings: List[ReservedInstanceOfferingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],DescribeReservedInstancesResponseTypeDef#
# DescribeReservedInstancesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeReservedInstancesResponseTypeDef
def get_value() -> DescribeReservedInstancesResponseTypeDef:
return {
"NextToken": ...,
}
# DescribeReservedInstancesResponseTypeDef definition
class DescribeReservedInstancesResponseTypeDef(TypedDict):
ReservedInstances: List[ReservedInstanceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AdvancedSecurityOptionsInputTypeDef#
# AdvancedSecurityOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AdvancedSecurityOptionsInputTypeDef
def get_value() -> AdvancedSecurityOptionsInputTypeDef:
return {
"Enabled": ...,
}
# AdvancedSecurityOptionsInputTypeDef definition
class AdvancedSecurityOptionsInputTypeDef(TypedDict):
Enabled: NotRequired[bool],
InternalUserDatabaseEnabled: NotRequired[bool],
MasterUserOptions: NotRequired[MasterUserOptionsTypeDef], # (1)
SAMLOptions: NotRequired[SAMLOptionsInputTypeDef], # (2)
JWTOptions: NotRequired[JWTOptionsInputTypeDef], # (3)
AnonymousAuthEnabled: NotRequired[bool],AdvancedSecurityOptionsTypeDef#
# AdvancedSecurityOptionsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AdvancedSecurityOptionsTypeDef
def get_value() -> AdvancedSecurityOptionsTypeDef:
return {
"Enabled": ...,
}
# AdvancedSecurityOptionsTypeDef definition
class AdvancedSecurityOptionsTypeDef(TypedDict):
Enabled: NotRequired[bool],
InternalUserDatabaseEnabled: NotRequired[bool],
SAMLOptions: NotRequired[SAMLOptionsOutputTypeDef], # (1)
JWTOptions: NotRequired[JWTOptionsOutputTypeDef], # (2)
AnonymousAuthDisableDate: NotRequired[datetime],
AnonymousAuthEnabled: NotRequired[bool],LimitsTypeDef#
# LimitsTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import LimitsTypeDef
def get_value() -> LimitsTypeDef:
return {
"StorageTypes": ...,
}
# LimitsTypeDef definition
class LimitsTypeDef(TypedDict):
StorageTypes: NotRequired[List[StorageTypeTypeDef]], # (1)
InstanceLimits: NotRequired[InstanceLimitsTypeDef], # (2)
AdditionalLimits: NotRequired[List[AdditionalLimitTypeDef]], # (3)GetUpgradeHistoryResponseTypeDef#
# GetUpgradeHistoryResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import GetUpgradeHistoryResponseTypeDef
def get_value() -> GetUpgradeHistoryResponseTypeDef:
return {
"UpgradeHistories": ...,
}
# GetUpgradeHistoryResponseTypeDef definition
class GetUpgradeHistoryResponseTypeDef(TypedDict):
UpgradeHistories: List[UpgradeHistoryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AcceptInboundConnectionResponseTypeDef#
# AcceptInboundConnectionResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AcceptInboundConnectionResponseTypeDef
def get_value() -> AcceptInboundConnectionResponseTypeDef:
return {
"Connection": ...,
}
# AcceptInboundConnectionResponseTypeDef definition
class AcceptInboundConnectionResponseTypeDef(TypedDict):
Connection: InboundConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteInboundConnectionResponseTypeDef#
# DeleteInboundConnectionResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteInboundConnectionResponseTypeDef
def get_value() -> DeleteInboundConnectionResponseTypeDef:
return {
"Connection": ...,
}
# DeleteInboundConnectionResponseTypeDef definition
class DeleteInboundConnectionResponseTypeDef(TypedDict):
Connection: InboundConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeInboundConnectionsResponseTypeDef#
# DescribeInboundConnectionsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeInboundConnectionsResponseTypeDef
def get_value() -> DescribeInboundConnectionsResponseTypeDef:
return {
"Connections": ...,
}
# DescribeInboundConnectionsResponseTypeDef definition
class DescribeInboundConnectionsResponseTypeDef(TypedDict):
Connections: List[InboundConnectionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],RejectInboundConnectionResponseTypeDef#
# RejectInboundConnectionResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import RejectInboundConnectionResponseTypeDef
def get_value() -> RejectInboundConnectionResponseTypeDef:
return {
"Connection": ...,
}
# RejectInboundConnectionResponseTypeDef definition
class RejectInboundConnectionResponseTypeDef(TypedDict):
Connection: InboundConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDomainAutoTunesResponseTypeDef#
# DescribeDomainAutoTunesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainAutoTunesResponseTypeDef
def get_value() -> DescribeDomainAutoTunesResponseTypeDef:
return {
"AutoTunes": ...,
}
# DescribeDomainAutoTunesResponseTypeDef definition
class DescribeDomainAutoTunesResponseTypeDef(TypedDict):
AutoTunes: List[AutoTuneTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AutoTuneOptionsStatusTypeDef#
# AutoTuneOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneOptionsStatusTypeDef
def get_value() -> AutoTuneOptionsStatusTypeDef:
return {
"Options": ...,
}
# AutoTuneOptionsStatusTypeDef definition
class AutoTuneOptionsStatusTypeDef(TypedDict):
Options: NotRequired[AutoTuneOptionsExtraTypeDef], # (1)
Status: NotRequired[AutoTuneStatusTypeDef], # (2)AutoTuneOptionsInputTypeDef#
# AutoTuneOptionsInputTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AutoTuneOptionsInputTypeDef
def get_value() -> AutoTuneOptionsInputTypeDef:
return {
"DesiredState": ...,
}
# AutoTuneOptionsInputTypeDef definition
class AutoTuneOptionsInputTypeDef(TypedDict):
DesiredState: NotRequired[AutoTuneDesiredStateType], # (1)
MaintenanceSchedules: NotRequired[Sequence[AutoTuneMaintenanceScheduleUnionTypeDef]], # (2)
UseOffPeakWindow: NotRequired[bool],- See AutoTuneDesiredStateType
- See AutoTuneMaintenanceScheduleTypeDef AutoTuneMaintenanceScheduleOutputTypeDef
DeleteOutboundConnectionResponseTypeDef#
# DeleteOutboundConnectionResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteOutboundConnectionResponseTypeDef
def get_value() -> DeleteOutboundConnectionResponseTypeDef:
return {
"Connection": ...,
}
# DeleteOutboundConnectionResponseTypeDef definition
class DeleteOutboundConnectionResponseTypeDef(TypedDict):
Connection: OutboundConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeOutboundConnectionsResponseTypeDef#
# DescribeOutboundConnectionsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeOutboundConnectionsResponseTypeDef
def get_value() -> DescribeOutboundConnectionsResponseTypeDef:
return {
"Connections": ...,
}
# DescribeOutboundConnectionsResponseTypeDef definition
class DescribeOutboundConnectionsResponseTypeDef(TypedDict):
Connections: List[OutboundConnectionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDataSourcesResponseTypeDef
def get_value() -> ListDataSourcesResponseTypeDef:
return {
"DataSources": ...,
}
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
DataSources: List[DataSourceDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDirectQueryDataSourcesResponseTypeDef#
# ListDirectQueryDataSourcesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDirectQueryDataSourcesResponseTypeDef
def get_value() -> ListDirectQueryDataSourcesResponseTypeDef:
return {
"NextToken": ...,
}
# ListDirectQueryDataSourcesResponseTypeDef definition
class ListDirectQueryDataSourcesResponseTypeDef(TypedDict):
DirectQueryDataSources: List[DirectQueryDataSourceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AssociatePackageResponseTypeDef#
# AssociatePackageResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AssociatePackageResponseTypeDef
def get_value() -> AssociatePackageResponseTypeDef:
return {
"DomainPackageDetails": ...,
}
# AssociatePackageResponseTypeDef definition
class AssociatePackageResponseTypeDef(TypedDict):
DomainPackageDetails: DomainPackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)AssociatePackagesResponseTypeDef#
# AssociatePackagesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AssociatePackagesResponseTypeDef
def get_value() -> AssociatePackagesResponseTypeDef:
return {
"DomainPackageDetailsList": ...,
}
# AssociatePackagesResponseTypeDef definition
class AssociatePackagesResponseTypeDef(TypedDict):
DomainPackageDetailsList: List[DomainPackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DissociatePackageResponseTypeDef#
# DissociatePackageResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DissociatePackageResponseTypeDef
def get_value() -> DissociatePackageResponseTypeDef:
return {
"DomainPackageDetails": ...,
}
# DissociatePackageResponseTypeDef definition
class DissociatePackageResponseTypeDef(TypedDict):
DomainPackageDetails: DomainPackageDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DissociatePackagesResponseTypeDef#
# DissociatePackagesResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DissociatePackagesResponseTypeDef
def get_value() -> DissociatePackagesResponseTypeDef:
return {
"DomainPackageDetailsList": ...,
}
# DissociatePackagesResponseTypeDef definition
class DissociatePackagesResponseTypeDef(TypedDict):
DomainPackageDetailsList: List[DomainPackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDomainsForPackageResponseTypeDef#
# ListDomainsForPackageResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListDomainsForPackageResponseTypeDef
def get_value() -> ListDomainsForPackageResponseTypeDef:
return {
"DomainPackageDetailsList": ...,
}
# ListDomainsForPackageResponseTypeDef definition
class ListDomainsForPackageResponseTypeDef(TypedDict):
DomainPackageDetailsList: List[DomainPackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],ListPackagesForDomainResponseTypeDef#
# ListPackagesForDomainResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ListPackagesForDomainResponseTypeDef
def get_value() -> ListPackagesForDomainResponseTypeDef:
return {
"DomainPackageDetailsList": ...,
}
# ListPackagesForDomainResponseTypeDef definition
class ListPackagesForDomainResponseTypeDef(TypedDict):
DomainPackageDetailsList: List[DomainPackageDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],AssociatePackagesRequestTypeDef#
# AssociatePackagesRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AssociatePackagesRequestTypeDef
def get_value() -> AssociatePackagesRequestTypeDef:
return {
"PackageList": ...,
}
# AssociatePackagesRequestTypeDef definition
class AssociatePackagesRequestTypeDef(TypedDict):
PackageList: Sequence[PackageDetailsForAssociationTypeDef], # (1)
DomainName: str,ClusterConfigStatusTypeDef#
# ClusterConfigStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import ClusterConfigStatusTypeDef
def get_value() -> ClusterConfigStatusTypeDef:
return {
"Options": ...,
}
# ClusterConfigStatusTypeDef definition
class ClusterConfigStatusTypeDef(TypedDict):
Options: ClusterConfigOutputTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)OffPeakWindowOptionsStatusTypeDef#
# OffPeakWindowOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import OffPeakWindowOptionsStatusTypeDef
def get_value() -> OffPeakWindowOptionsStatusTypeDef:
return {
"Options": ...,
}
# OffPeakWindowOptionsStatusTypeDef definition
class OffPeakWindowOptionsStatusTypeDef(TypedDict):
Options: NotRequired[OffPeakWindowOptionsTypeDef], # (1)
Status: NotRequired[OptionStatusTypeDef], # (2)AdvancedSecurityOptionsStatusTypeDef#
# AdvancedSecurityOptionsStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import AdvancedSecurityOptionsStatusTypeDef
def get_value() -> AdvancedSecurityOptionsStatusTypeDef:
return {
"Options": ...,
}
# AdvancedSecurityOptionsStatusTypeDef definition
class AdvancedSecurityOptionsStatusTypeDef(TypedDict):
Options: AdvancedSecurityOptionsTypeDef, # (1)
Status: OptionStatusTypeDef, # (2)DomainStatusTypeDef#
# DomainStatusTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainStatusTypeDef
def get_value() -> DomainStatusTypeDef:
return {
"DomainId": ...,
}
# DomainStatusTypeDef definition
class DomainStatusTypeDef(TypedDict):
DomainId: str,
DomainName: str,
ARN: str,
ClusterConfig: ClusterConfigOutputTypeDef, # (1)
Created: NotRequired[bool],
Deleted: NotRequired[bool],
Endpoint: NotRequired[str],
EndpointV2: NotRequired[str],
Endpoints: NotRequired[Dict[str, str]],
DomainEndpointV2HostedZoneId: NotRequired[str],
Processing: NotRequired[bool],
UpgradeProcessing: NotRequired[bool],
EngineVersion: NotRequired[str],
EBSOptions: NotRequired[EBSOptionsTypeDef], # (2)
AccessPolicies: NotRequired[str],
IPAddressType: NotRequired[IPAddressTypeType], # (3)
SnapshotOptions: NotRequired[SnapshotOptionsTypeDef], # (4)
VPCOptions: NotRequired[VPCDerivedInfoTypeDef], # (5)
CognitoOptions: NotRequired[CognitoOptionsTypeDef], # (6)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (7)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef], # (8)
AdvancedOptions: NotRequired[Dict[str, str]],
LogPublishingOptions: NotRequired[Dict[LogTypeType, LogPublishingOptionTypeDef]], # (9)
ServiceSoftwareOptions: NotRequired[ServiceSoftwareOptionsTypeDef], # (10)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef], # (11)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsTypeDef], # (12)
IdentityCenterOptions: NotRequired[IdentityCenterOptionsTypeDef], # (13)
AutoTuneOptions: NotRequired[AutoTuneOptionsOutputTypeDef], # (14)
ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef], # (15)
OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef], # (16)
SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef], # (17)
DomainProcessingStatus: NotRequired[DomainProcessingStatusTypeType], # (18)
ModifyingProperties: NotRequired[List[ModifyingPropertiesTypeDef]], # (19)
AIMLOptions: NotRequired[AIMLOptionsOutputTypeDef], # (20)- See ClusterConfigOutputTypeDef
- See EBSOptionsTypeDef
- See IPAddressTypeType
- See SnapshotOptionsTypeDef
- See VPCDerivedInfoTypeDef
- See CognitoOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See NodeToNodeEncryptionOptionsTypeDef
- See LogTypeType LogPublishingOptionTypeDef
- See ServiceSoftwareOptionsTypeDef
- See DomainEndpointOptionsTypeDef
- See AdvancedSecurityOptionsTypeDef
- See IdentityCenterOptionsTypeDef
- See AutoTuneOptionsOutputTypeDef
- See ChangeProgressDetailsTypeDef
- See OffPeakWindowOptionsTypeDef
- See SoftwareUpdateOptionsTypeDef
- See DomainProcessingStatusTypeType
- See ModifyingPropertiesTypeDef
- See AIMLOptionsOutputTypeDef
DescribeInstanceTypeLimitsResponseTypeDef#
# DescribeInstanceTypeLimitsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeInstanceTypeLimitsResponseTypeDef
def get_value() -> DescribeInstanceTypeLimitsResponseTypeDef:
return {
"LimitsByRole": ...,
}
# DescribeInstanceTypeLimitsResponseTypeDef definition
class DescribeInstanceTypeLimitsResponseTypeDef(TypedDict):
LimitsByRole: Dict[str, LimitsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See LimitsTypeDef
- See ResponseMetadataTypeDef
CreateDomainRequestTypeDef#
# CreateDomainRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateDomainRequestTypeDef
def get_value() -> CreateDomainRequestTypeDef:
return {
"DomainName": ...,
}
# CreateDomainRequestTypeDef definition
class CreateDomainRequestTypeDef(TypedDict):
DomainName: str,
EngineVersion: NotRequired[str],
ClusterConfig: NotRequired[ClusterConfigUnionTypeDef], # (1)
EBSOptions: NotRequired[EBSOptionsTypeDef], # (2)
AccessPolicies: NotRequired[str],
IPAddressType: NotRequired[IPAddressTypeType], # (3)
SnapshotOptions: NotRequired[SnapshotOptionsTypeDef], # (4)
VPCOptions: NotRequired[VPCOptionsTypeDef], # (5)
CognitoOptions: NotRequired[CognitoOptionsTypeDef], # (6)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (7)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef], # (8)
AdvancedOptions: NotRequired[Mapping[str, str]],
LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]], # (9)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef], # (10)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef], # (11)
IdentityCenterOptions: NotRequired[IdentityCenterOptionsInputTypeDef], # (12)
TagList: NotRequired[Sequence[TagTypeDef]], # (13)
AutoTuneOptions: NotRequired[AutoTuneOptionsInputTypeDef], # (14)
OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef], # (15)
SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef], # (16)
AIMLOptions: NotRequired[AIMLOptionsInputTypeDef], # (17)- See ClusterConfigTypeDef ClusterConfigOutputTypeDef
- See EBSOptionsTypeDef
- See IPAddressTypeType
- See SnapshotOptionsTypeDef
- See VPCOptionsTypeDef
- See CognitoOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See NodeToNodeEncryptionOptionsTypeDef
- See LogTypeType LogPublishingOptionTypeDef
- See DomainEndpointOptionsTypeDef
- See AdvancedSecurityOptionsInputTypeDef
- See IdentityCenterOptionsInputTypeDef
- See TagTypeDef
- See AutoTuneOptionsInputTypeDef
- See OffPeakWindowOptionsTypeDef
- See SoftwareUpdateOptionsTypeDef
- See AIMLOptionsInputTypeDef
UpdateDomainConfigRequestTypeDef#
# UpdateDomainConfigRequestTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateDomainConfigRequestTypeDef
def get_value() -> UpdateDomainConfigRequestTypeDef:
return {
"DomainName": ...,
}
# UpdateDomainConfigRequestTypeDef definition
class UpdateDomainConfigRequestTypeDef(TypedDict):
DomainName: str,
ClusterConfig: NotRequired[ClusterConfigUnionTypeDef], # (1)
EBSOptions: NotRequired[EBSOptionsTypeDef], # (2)
SnapshotOptions: NotRequired[SnapshotOptionsTypeDef], # (3)
VPCOptions: NotRequired[VPCOptionsTypeDef], # (4)
CognitoOptions: NotRequired[CognitoOptionsTypeDef], # (5)
AdvancedOptions: NotRequired[Mapping[str, str]],
AccessPolicies: NotRequired[str],
IPAddressType: NotRequired[IPAddressTypeType], # (6)
LogPublishingOptions: NotRequired[Mapping[LogTypeType, LogPublishingOptionTypeDef]], # (7)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (8)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsTypeDef], # (9)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsTypeDef], # (10)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsInputTypeDef], # (11)
IdentityCenterOptions: NotRequired[IdentityCenterOptionsInputTypeDef], # (12)
AutoTuneOptions: NotRequired[AutoTuneOptionsUnionTypeDef], # (13)
DryRun: NotRequired[bool],
DryRunMode: NotRequired[DryRunModeType], # (14)
OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsTypeDef], # (15)
SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsTypeDef], # (16)
AIMLOptions: NotRequired[AIMLOptionsInputTypeDef], # (17)- See ClusterConfigTypeDef ClusterConfigOutputTypeDef
- See EBSOptionsTypeDef
- See SnapshotOptionsTypeDef
- See VPCOptionsTypeDef
- See CognitoOptionsTypeDef
- See IPAddressTypeType
- See LogTypeType LogPublishingOptionTypeDef
- See EncryptionAtRestOptionsTypeDef
- See DomainEndpointOptionsTypeDef
- See NodeToNodeEncryptionOptionsTypeDef
- See AdvancedSecurityOptionsInputTypeDef
- See IdentityCenterOptionsInputTypeDef
- See AutoTuneOptionsTypeDef AutoTuneOptionsExtraTypeDef
- See DryRunModeType
- See OffPeakWindowOptionsTypeDef
- See SoftwareUpdateOptionsTypeDef
- See AIMLOptionsInputTypeDef
DomainConfigTypeDef#
# DomainConfigTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DomainConfigTypeDef
def get_value() -> DomainConfigTypeDef:
return {
"EngineVersion": ...,
}
# DomainConfigTypeDef definition
class DomainConfigTypeDef(TypedDict):
EngineVersion: NotRequired[VersionStatusTypeDef], # (1)
ClusterConfig: NotRequired[ClusterConfigStatusTypeDef], # (2)
EBSOptions: NotRequired[EBSOptionsStatusTypeDef], # (3)
AccessPolicies: NotRequired[AccessPoliciesStatusTypeDef], # (4)
IPAddressType: NotRequired[IPAddressTypeStatusTypeDef], # (5)
SnapshotOptions: NotRequired[SnapshotOptionsStatusTypeDef], # (6)
VPCOptions: NotRequired[VPCDerivedInfoStatusTypeDef], # (7)
CognitoOptions: NotRequired[CognitoOptionsStatusTypeDef], # (8)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsStatusTypeDef], # (9)
NodeToNodeEncryptionOptions: NotRequired[NodeToNodeEncryptionOptionsStatusTypeDef], # (10)
AdvancedOptions: NotRequired[AdvancedOptionsStatusTypeDef], # (11)
LogPublishingOptions: NotRequired[LogPublishingOptionsStatusTypeDef], # (12)
DomainEndpointOptions: NotRequired[DomainEndpointOptionsStatusTypeDef], # (13)
AdvancedSecurityOptions: NotRequired[AdvancedSecurityOptionsStatusTypeDef], # (14)
IdentityCenterOptions: NotRequired[IdentityCenterOptionsStatusTypeDef], # (15)
AutoTuneOptions: NotRequired[AutoTuneOptionsStatusTypeDef], # (16)
ChangeProgressDetails: NotRequired[ChangeProgressDetailsTypeDef], # (17)
OffPeakWindowOptions: NotRequired[OffPeakWindowOptionsStatusTypeDef], # (18)
SoftwareUpdateOptions: NotRequired[SoftwareUpdateOptionsStatusTypeDef], # (19)
ModifyingProperties: NotRequired[List[ModifyingPropertiesTypeDef]], # (20)
AIMLOptions: NotRequired[AIMLOptionsStatusTypeDef], # (21)- See VersionStatusTypeDef
- See ClusterConfigStatusTypeDef
- See EBSOptionsStatusTypeDef
- See AccessPoliciesStatusTypeDef
- See IPAddressTypeStatusTypeDef
- See SnapshotOptionsStatusTypeDef
- See VPCDerivedInfoStatusTypeDef
- See CognitoOptionsStatusTypeDef
- See EncryptionAtRestOptionsStatusTypeDef
- See NodeToNodeEncryptionOptionsStatusTypeDef
- See AdvancedOptionsStatusTypeDef
- See LogPublishingOptionsStatusTypeDef
- See DomainEndpointOptionsStatusTypeDef
- See AdvancedSecurityOptionsStatusTypeDef
- See IdentityCenterOptionsStatusTypeDef
- See AutoTuneOptionsStatusTypeDef
- See ChangeProgressDetailsTypeDef
- See OffPeakWindowOptionsStatusTypeDef
- See SoftwareUpdateOptionsStatusTypeDef
- See ModifyingPropertiesTypeDef
- See AIMLOptionsStatusTypeDef
CreateDomainResponseTypeDef#
# CreateDomainResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import CreateDomainResponseTypeDef
def get_value() -> CreateDomainResponseTypeDef:
return {
"DomainStatus": ...,
}
# CreateDomainResponseTypeDef definition
class CreateDomainResponseTypeDef(TypedDict):
DomainStatus: DomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteDomainResponseTypeDef#
# DeleteDomainResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DeleteDomainResponseTypeDef
def get_value() -> DeleteDomainResponseTypeDef:
return {
"DomainStatus": ...,
}
# DeleteDomainResponseTypeDef definition
class DeleteDomainResponseTypeDef(TypedDict):
DomainStatus: DomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDomainResponseTypeDef#
# DescribeDomainResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainResponseTypeDef
def get_value() -> DescribeDomainResponseTypeDef:
return {
"DomainStatus": ...,
}
# DescribeDomainResponseTypeDef definition
class DescribeDomainResponseTypeDef(TypedDict):
DomainStatus: DomainStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDomainsResponseTypeDef#
# DescribeDomainsResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainsResponseTypeDef
def get_value() -> DescribeDomainsResponseTypeDef:
return {
"DomainStatusList": ...,
}
# DescribeDomainsResponseTypeDef definition
class DescribeDomainsResponseTypeDef(TypedDict):
DomainStatusList: List[DomainStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDryRunProgressResponseTypeDef#
# DescribeDryRunProgressResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDryRunProgressResponseTypeDef
def get_value() -> DescribeDryRunProgressResponseTypeDef:
return {
"DryRunProgressStatus": ...,
}
# DescribeDryRunProgressResponseTypeDef definition
class DescribeDryRunProgressResponseTypeDef(TypedDict):
DryRunProgressStatus: DryRunProgressStatusTypeDef, # (1)
DryRunConfig: DomainStatusTypeDef, # (2)
DryRunResults: DryRunResultsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See DryRunProgressStatusTypeDef
- See DomainStatusTypeDef
- See DryRunResultsTypeDef
- See ResponseMetadataTypeDef
DescribeDomainConfigResponseTypeDef#
# DescribeDomainConfigResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import DescribeDomainConfigResponseTypeDef
def get_value() -> DescribeDomainConfigResponseTypeDef:
return {
"DomainConfig": ...,
}
# DescribeDomainConfigResponseTypeDef definition
class DescribeDomainConfigResponseTypeDef(TypedDict):
DomainConfig: DomainConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateDomainConfigResponseTypeDef#
# UpdateDomainConfigResponseTypeDef TypedDict usage example
from types_boto3_opensearch.type_defs import UpdateDomainConfigResponseTypeDef
def get_value() -> UpdateDomainConfigResponseTypeDef:
return {
"DomainConfig": ...,
}
# UpdateDomainConfigResponseTypeDef definition
class UpdateDomainConfigResponseTypeDef(TypedDict):
DomainConfig: DomainConfigTypeDef, # (1)
DryRunResults: DryRunResultsTypeDef, # (2)
DryRunProgressStatus: DryRunProgressStatusTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)